Class: Azure::Cosmosdb::Mgmt::V2020_09_01::Models::DatabaseAccountGetResults

Inherits:
ARMResourceProperties show all
Includes:
MsRestAzure
Defined in:
lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb

Overview

An Azure Cosmos DB database account.

Instance Attribute Summary collapse

Attributes inherited from ARMResourceProperties

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

Class Method Summary collapse

Instance Attribute Details

#api_properties ⇒ ApiProperties

Returns API specific properties.

Returns:



104
105
106
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 104

def api_properties
  @api_properties
end

#backup_policy ⇒ BackupPolicy

backups on an account.

Returns:

  • (BackupPolicy) —

    The object representing the policy for taking



111
112
113
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 111

def backup_policy
  @backup_policy
end

#capabilities ⇒ Array<Capability>

account

Returns:

  • (Array<Capability>) —

    List of Cosmos DB capabilities for the



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

def capabilities
  @capabilities
end

#connector_offer ⇒ ConnectorOffer

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

Returns:



87
88
89
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 87

def connector_offer
  @connector_offer
end

#consistency_policy ⇒ ConsistencyPolicy

database account.

Returns:



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

def consistency_policy
  @consistency_policy
end

#cors ⇒ Array<CorsPolicy>

account.

Returns:

  • (Array<CorsPolicy>) —

    The CORS policy for the Cosmos DB database



115
116
117
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 115

def cors
  @cors
end

#database_account_offer_type ⇒ DatabaseAccountOfferType

database account. Default value: Standard. Possible values include: ‘Standard’

Returns:



31
32
33
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.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



91
92
93
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 91

def disable_key_based_metadata_write_access
  @disable_key_based_metadata_write_access
end

#document_endpoint ⇒ String

account.

Returns:

  • (String) —

    The connection endpoint for the Cosmos DB database



26
27
28
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 26

def document_endpoint
  @document_endpoint
end

#enable_analytical_storage ⇒ Boolean

Returns Flag to indicate whether to enable storage analytics.

Returns:

  • (Boolean) —

    Flag to indicate whether to enable storage analytics.



107
108
109
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 107

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-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.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*



83
84
85
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 83

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.



101
102
103
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 101

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



79
80
81
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 79

def enable_multiple_write_locations
  @enable_multiple_write_locations
end

#failover_policies ⇒ Array<FailoverPolicy>

ordered by their failover priorities.

Returns:



68
69
70
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 68

def failover_policies
  @failover_policies
end

#ip_rules ⇒ Array<IpAddressOrRange>

Returns List of IpRules.

Returns:



34
35
36
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.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-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.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



94
95
96
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 94

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-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 19

def kind
  @kind
end

#locations ⇒ Array<Location>

enabled for the Cosmos DB account.

Returns:

  • (Array<Location>) —

    An array that contains all of the locations



64
65
66
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 64

def locations
  @locations
end

#private_endpoint_connections ⇒ Array<PrivateEndpointConnection>

Connections configured for the Cosmos DB account.

Returns:



76
77
78
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 76

def private_endpoint_connections
  @private_endpoint_connections
end

#provisioning_state ⇒ String

Returns:

  • (String) 


22
23
24
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 22

def provisioning_state
  @provisioning_state
end

#public_network_access ⇒ PublicNetworkAccess

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

Returns:



98
99
100
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 98

def public_network_access
  @public_network_access
end

#read_locations ⇒ Array<Location>

enabled for the Cosmos DB account.

Returns:

  • (Array<Location>) —

    An array that contains of the read locations



60
61
62
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 60

def read_locations
  @read_locations
end

#virtual_network_rules ⇒ Array<VirtualNetworkRule>

configured for the Cosmos DB account.

Returns:



72
73
74
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 72

def virtual_network_rules
  @virtual_network_rules
end

#write_locations ⇒ Array<Location>

the Cosmos DB account.

Returns:

  • (Array<Location>) —

    An array that contains the write location for



56
57
58
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 56

def write_locations
  @write_locations
end

Class Method Details

.mapper ⇒ Object

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



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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/2020-09-01/generated/azure_mgmt_cosmosdb/models/database_account_get_results.rb', line 122

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'DatabaseAccountGetResults',
    type: {
      name: 'Composite',
      class_name: 'DatabaseAccountGetResults',
      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'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        document_endpoint: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.documentEndpoint',
          type: {
            name: 'String'
          }
        },
        database_account_offer_type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.databaseAccountOfferType',
          type: {
            name: 'Enum',
            module: 'DatabaseAccountOfferType'
          }
        },
        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'
          }
        },
        consistency_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.consistencyPolicy',
          type: {
            name: 'Composite',
            class_name: 'ConsistencyPolicy'
          }
        },
        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'
                }
            }
          }
        },
        write_locations: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.writeLocations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'LocationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Location'
                }
            }
          }
        },
        read_locations: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.readLocations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'LocationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Location'
                }
            }
          }
        },
        locations: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.locations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'LocationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Location'
                }
            }
          }
        },
        failover_policies: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.failoverPolicies',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'FailoverPolicyElementType',
                type: {
                  name: 'Composite',
                  class_name: 'FailoverPolicy'
                }
            }
          }
        },
        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'
                }
            }
          }
        },
        private_endpoint_connections: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.privateEndpointConnections',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'PrivateEndpointConnectionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'PrivateEndpointConnection'
                }
            }
          }
        },
        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'
          }
        },
        backup_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.backupPolicy',
          type: {
            name: 'Composite',
            polymorphic_discriminator: 'type',
            uber_parent: 'BackupPolicy',
            class_name: 'BackupPolicy'
          }
        },
        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