Class: Azure::Batch::Mgmt::V2018_12_01::Models::CertificateReference

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-12-01/generated/azure_mgmt_batch/models/certificate_reference.rb

Overview

A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#id ⇒ String

on the pool. This must be inside the same batch account as the pool.

Returns:

  • (String) —

    The fully qualified ID of the certificate to install



19
20
21
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/certificate_reference.rb', line 19

def id
  @id
end

#store_location ⇒ CertificateStoreLocation

store on the compute node into which to install the certificate. The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of ‘remoteUser’, a ‘certs’ directory is created in the user’s home directory (e.g., /home/user-name/certs) and certificates are placed in that directory. Possible values include: ‘CurrentUser’, ‘LocalMachine’

Returns:



34
35
36
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/certificate_reference.rb', line 34

def store_location
  @store_location
end

#store_name ⇒ String

into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

Returns:

  • (String) —

    The name of the certificate store on the compute node



44
45
46
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/certificate_reference.rb', line 44

def store_name
  @store_name
end

#visibility ⇒ Array<CertificateVisibility>

compute node should have access to the private data of the certificate.

Returns:



48
49
50
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/certificate_reference.rb', line 48

def visibility
  @visibility
end

Class Method Details

.mapper ⇒ Object

Mapper for CertificateReference class as Ruby Hash. This will be used for serialization/deserialization.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/certificate_reference.rb', line 55

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'CertificateReference',
    type: {
      name: 'Composite',
      class_name: 'CertificateReference',
      model_properties: {
        id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        store_location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'storeLocation',
          type: {
            name: 'Enum',
            module: 'CertificateStoreLocation'
          }
        },
        store_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'storeName',
          type: {
            name: 'String'
          }
        },
        visibility: {
          client_side_validation: true,
          required: false,
          serialized_name: 'visibility',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'CertificateVisibilityElementType',
                type: {
                  name: 'Enum',
                  module: 'CertificateVisibility'
                }
            }
          }
        }
      }
    }
  }
end