Class: Azure::Cosmosdb::Mgmt::V2020_04_01::Models::DatabaseAccountCreateUpdateParameters

Inherits:
ARMResourceProperties
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb

Overview

Parameters to create and update Cosmos DB database accounts.

Instance Attribute Summary collapse

Attributes inherited from ARMResourceProperties

#id, #location, #name, #tags, #type

Class Method Summary collapse

Instance Attribute Details

#api_properties ⇒ ApiProperties

only for MongoDB API.

Returns:

  • (ApiProperties) —

    API specific properties. Currently, supported



81
82
83
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 81

def api_properties
  @api_properties
end

#capabilities ⇒ Array<Capability>

account

Returns:

  • (Array<Capability>) —

    List of Cosmos DB capabilities for the



48
49
50
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 48

def capabilities
  @capabilities
end

#connector_offer ⇒ ConnectorOffer

Cosmos DB database C* account. Possible values include: ‘Small’

Returns:



63
64
65
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 63

def connector_offer
  @connector_offer
end

#consistency_policy ⇒ ConsistencyPolicy

account.

Returns:



23
24
25
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 23

def consistency_policy
  @consistency_policy
end

#cors ⇒ Array<CorsPolicy>

account.

Returns:

  • (Array<CorsPolicy>) —

    The CORS policy for the Cosmos DB database



88
89
90
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 88

def cors
  @cors
end

#database_account_offer_type ⇒ String

‘Standard’ .

Returns:

  • (String) —

    The offer type for the database. Default value:



31
32
33
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 31

def 
  @database_account_offer_type
end

#disable_key_based_metadata_write_access ⇒ Boolean

(databases, containers, throughput) via account keys

Returns:

  • (Boolean) —

    Disable write operations on metadata resources



67
68
69
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 67

def disable_key_based_metadata_write_access
  @disable_key_based_metadata_write_access
end

#enable_analytical_storage ⇒ Boolean

Returns Flag to indicate whether to enable storage analytics.

Returns:

  • (Boolean) —

    Flag to indicate whether to enable storage analytics.



84
85
86
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 84

def enable_analytical_storage
  @enable_analytical_storage
end

#enable_automatic_failover ⇒ Boolean

rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

Returns:

  • (Boolean) —

    Enables automatic failover of the write region in the



44
45
46
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 44

def enable_automatic_failover
  @enable_automatic_failover
end

#enable_cassandra_connector ⇒ Boolean

account

Returns:

  • (Boolean) —

    Enables the cassandra connector on the Cosmos DB C*



59
60
61
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 59

def enable_cassandra_connector
  @enable_cassandra_connector
end

#enable_free_tier ⇒ Boolean

Returns Flag to indicate whether Free Tier is enabled.

Returns:

  • (Boolean) —

    Flag to indicate whether Free Tier is enabled.



77
78
79
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 77

def enable_free_tier
  @enable_free_tier
end

#enable_multiple_write_locations ⇒ Boolean

Returns Enables the account to write in multiple locations.

Returns:

  • (Boolean) —

    Enables the account to write in multiple locations



55
56
57
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 55

def enable_multiple_write_locations
  @enable_multiple_write_locations
end

#ip_rules ⇒ Array<IpAddressOrRange>

Returns List of IpRules.

Returns:



34
35
36
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 34

def ip_rules
  @ip_rules
end

#is_virtual_network_filter_enabled ⇒ Boolean

Network ACL rules.

Returns:

  • (Boolean) —

    Flag to indicate whether to enable/disable Virtual



38
39
40
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 38

def is_virtual_network_filter_enabled
  @is_virtual_network_filter_enabled
end

#key_vault_key_uri ⇒ String

Returns The URI of the key vault.

Returns:

  • (String) —

    The URI of the key vault



70
71
72
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 70

def key_vault_key_uri
  @key_vault_key_uri
end

#kind ⇒ DatabaseAccountKind

This can only be set at database account creation. Possible values include: ‘GlobalDocumentDB’, ‘MongoDB’, ‘Parse’. Default value: ‘GlobalDocumentDB’ .

Returns:



19
20
21
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 19

def kind
  @kind
end

#locations ⇒ Array<Location>

locations enabled for the Cosmos DB account.

Returns:

  • (Array<Location>) —

    An array that contains the georeplication



27
28
29
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 27

def locations
  @locations
end

#public_network_access ⇒ PublicNetworkAccess

allowed. Possible values include: ‘Enabled’, ‘Disabled’

Returns:



74
75
76
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 74

def public_network_access
  @public_network_access
end

#virtual_network_rules ⇒ Array<VirtualNetworkRule>

configured for the Cosmos DB account.

Returns:



52
53
54
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 52

def virtual_network_rules
  @virtual_network_rules
end

Class Method Details

.mapper ⇒ Object

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



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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_create_update_parameters.rb', line 95

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'DatabaseAccountCreateUpdateParameters',
    type: {
      name: 'Composite',
      class_name: 'DatabaseAccountCreateUpdateParameters',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kind',
          default_value: 'GlobalDocumentDB',
          type: {
            name: 'String'
          }
        },
        consistency_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.consistencyPolicy',
          type: {
            name: 'Composite',
            class_name: 'ConsistencyPolicy'
          }
        },
        locations: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.locations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'LocationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Location'
                }
            }
          }
        },
        database_account_offer_type: {
          client_side_validation: true,
          required: true,
          is_constant: true,
          serialized_name: 'properties.databaseAccountOfferType',
          default_value: 'Standard',
          type: {
            name: 'String'
          }
        },
        ip_rules: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.ipRules',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'IpAddressOrRangeElementType',
                type: {
                  name: 'Composite',
                  class_name: 'IpAddressOrRange'
                }
            }
          }
        },
        is_virtual_network_filter_enabled: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isVirtualNetworkFilterEnabled',
          type: {
            name: 'Boolean'
          }
        },
        enable_automatic_failover: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableAutomaticFailover',
          type: {
            name: 'Boolean'
          }
        },
        capabilities: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.capabilities',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'CapabilityElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Capability'
                }
            }
          }
        },
        virtual_network_rules: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.virtualNetworkRules',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VirtualNetworkRuleElementType',
                type: {
                  name: 'Composite',
                  class_name: 'VirtualNetworkRule'
                }
            }
          }
        },
        enable_multiple_write_locations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableMultipleWriteLocations',
          type: {
            name: 'Boolean'
          }
        },
        enable_cassandra_connector: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableCassandraConnector',
          type: {
            name: 'Boolean'
          }
        },
        connector_offer: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.connectorOffer',
          type: {
            name: 'String'
          }
        },
        disable_key_based_metadata_write_access: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.disableKeyBasedMetadataWriteAccess',
          type: {
            name: 'Boolean'
          }
        },
        key_vault_key_uri: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.keyVaultKeyUri',
          type: {
            name: 'String'
          }
        },
        public_network_access: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.publicNetworkAccess',
          type: {
            name: 'String'
          }
        },
        enable_free_tier: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableFreeTier',
          type: {
            name: 'Boolean'
          }
        },
        api_properties: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.apiProperties',
          type: {
            name: 'Composite',
            class_name: 'ApiProperties'
          }
        },
        enable_analytical_storage: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableAnalyticalStorage',
          type: {
            name: 'Boolean'
          }
        },
        cors: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.cors',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'CorsPolicyElementType',
                type: {
                  name: 'Composite',
                  class_name: 'CorsPolicy'
                }
            }
          }
        }
      }
    }
  }
end