Class: Azure::StorageCache::Mgmt::V2020_10_01::Models::CacheUsernameDownloadSettings

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb

Overview

Settings for Extended Groups username and group download.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#auto_download_certificate ⇒ Boolean

downloaded. This applies to ‘caCertificateURI’ only if ‘requireValidCertificate’ is true.

Returns:

  • (Boolean) —

    Determines if the certificate should be automatically



51
52
53
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 51

def auto_download_certificate
  @auto_download_certificate
end

#ca_certificate_uri ⇒ String

secure connection. This field must be populated when ‘requireValidCertificate’ is set to true.

Returns:

  • (String) —

    The URI of the CA certificate to validate the LDAP



56
57
58
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 56

def ca_certificate_uri
  @ca_certificate_uri
end

#credentials ⇒ CacheUsernameDownloadSettingsCredentials

are the credentials for the secure LDAP connection.

Returns:



65
66
67
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 65

def credentials
  @credentials
end

#encrypt_ldap_connection ⇒ Boolean

encrypted.

Returns:

  • (Boolean) —

    Whether or not the LDAP connection should be



42
43
44
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 42

def encrypt_ldap_connection
  @encrypt_ldap_connection
end

#extended_groups ⇒ Boolean

Returns Whether or not Extended Groups is enabled.

Returns:

  • (Boolean) —

    Whether or not Extended Groups is enabled.



16
17
18
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 16

def extended_groups
  @extended_groups
end

#group_file_uri ⇒ String

/etc/group file format). This field must be populated when ‘usernameSource’ is set to ‘File’.

Returns:

  • (String) —

    The URI of the file containing group information (in



26
27
28
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 26

def group_file_uri
  @group_file_uri
end

#ldap_base_dn ⇒ String

Returns The base distinguished name for the LDAP domain.

Returns:

  • (String) —

    The base distinguished name for the LDAP domain.



38
39
40
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 38

def ldap_base_dn
  @ldap_base_dn
end

#ldap_server ⇒ String

LDAP server to use.

Returns:

  • (String) —

    The fully qualified domain name or IP address of the



35
36
37
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 35

def ldap_server
  @ldap_server
end

#require_valid_certificate ⇒ Boolean

certificate authority. When true, caCertificateURI must be provided.

Returns:

  • (Boolean) —

    Determines if the certificates must be validated by a



46
47
48
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 46

def require_valid_certificate
  @require_valid_certificate
end

#user_file_uri ⇒ String

/etc/passwd file format). This field must be populated when ‘usernameSource’ is set to ‘File’.

Returns:

  • (String) —

    The URI of the file containing user information (in



31
32
33
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 31

def user_file_uri
  @user_file_uri
end

#username_downloaded ⇒ UsernameDownloadedType

has performed the username download successfully. Possible values include: ‘Yes’, ‘No’, ‘Error’

Returns:



61
62
63
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 61

def username_downloaded
  @username_downloaded
end

#username_source ⇒ UsernameSource

username and group names for clients. Possible values include: ‘AD’, ‘LDAP’, ‘File’, ‘None’. Default value: ‘None’ .

Returns:



21
22
23
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 21

def username_source
  @username_source
end

Class Method Details

.mapper ⇒ Object

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



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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/2020-10-01/generated/azure_mgmt_storagecache/models/cache_username_download_settings.rb', line 72

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'CacheUsernameDownloadSettings',
    type: {
      name: 'Composite',
      class_name: 'CacheUsernameDownloadSettings',
      model_properties: {
        extended_groups: {
          client_side_validation: true,
          required: false,
          serialized_name: 'extendedGroups',
          type: {
            name: 'Boolean'
          }
        },
        username_source: {
          client_side_validation: true,
          required: false,
          serialized_name: 'usernameSource',
          default_value: 'None',
          type: {
            name: 'String'
          }
        },
        group_file_uri: {
          client_side_validation: true,
          required: false,
          serialized_name: 'groupFileURI',
          type: {
            name: 'String'
          }
        },
        user_file_uri: {
          client_side_validation: true,
          required: false,
          serialized_name: 'userFileURI',
          type: {
            name: 'String'
          }
        },
        ldap_server: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ldapServer',
          type: {
            name: 'String'
          }
        },
        ldap_base_dn: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ldapBaseDN',
          type: {
            name: 'String'
          }
        },
        encrypt_ldap_connection: {
          client_side_validation: true,
          required: false,
          serialized_name: 'encryptLdapConnection',
          type: {
            name: 'Boolean'
          }
        },
        require_valid_certificate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'requireValidCertificate',
          type: {
            name: 'Boolean'
          }
        },
        auto_download_certificate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'autoDownloadCertificate',
          type: {
            name: 'Boolean'
          }
        },
        ca_certificate_uri: {
          client_side_validation: true,
          required: false,
          serialized_name: 'caCertificateURI',
          type: {
            name: 'String'
          }
        },
        username_downloaded: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'usernameDownloaded',
          type: {
            name: 'String'
          }
        },
        credentials: {
          client_side_validation: true,
          required: false,
          serialized_name: 'credentials',
          type: {
            name: 'Composite',
            class_name: 'CacheUsernameDownloadSettingsCredentials'
          }
        }
      }
    }
  }
end