Class: Azure::Cosmosdb::Mgmt::V2020_04_01::Models::DatabaseAccountUpdateParameters

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

Overview

Parameters for patching Azure Cosmos DB database account properties.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#api_properties ⇒ ApiProperties

only for MongoDB API.

Returns:

  • (ApiProperties) —

    API specific properties. Currently, supported



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

def api_properties
  @api_properties
end

#capabilities ⇒ Array<Capability>

account

Returns:

  • (Array<Capability>) —

    List of Cosmos DB capabilities for the



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

def capabilities
  @capabilities
end

#connector_offer ⇒ ConnectorOffer

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

Returns:



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

def connector_offer
  @connector_offer
end

#consistency_policy ⇒ ConsistencyPolicy

account.

Returns:



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

def consistency_policy
  @consistency_policy
end

#cors ⇒ Array<CorsPolicy>

account.

Returns:

  • (Array<CorsPolicy>) —

    The CORS policy for the Cosmos DB database



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

def cors
  @cors
end

#disable_key_based_metadata_write_access ⇒ Boolean

(databases, containers, throughput) via account keys

Returns:

  • (Boolean) —

    Disable write operations on metadata resources



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

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.



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

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



41
42
43
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_update_parameters.rb', line 41

def enable_automatic_failover
  @enable_automatic_failover
end

#enable_cassandra_connector ⇒ Boolean

account

Returns:

  • (Boolean) —

    Enables the cassandra connector on the Cosmos DB C*



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

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.



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

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



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

def enable_multiple_write_locations
  @enable_multiple_write_locations
end

#ip_rules ⇒ Array<IpAddressOrRange>

Returns List of IpRules.

Returns:



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

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



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

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



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

def key_vault_key_uri
  @key_vault_key_uri
end

#location ⇒ String

resource belongs.

Returns:

  • (String) —

    The location of the resource group to which the



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

def location
  @location
end

#locations ⇒ Array<Location>

locations enabled for the Cosmos DB account.

Returns:

  • (Array<Location>) —

    An array that contains the georeplication



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

def locations
  @locations
end

#public_network_access ⇒ PublicNetworkAccess

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

Returns:



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

def public_network_access
  @public_network_access
end

#tags ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


16
17
18
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_update_parameters.rb', line 16

def tags
  @tags
end

#virtual_network_rules ⇒ Array<VirtualNetworkRule>

configured for the Cosmos DB account.

Returns:



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

def virtual_network_rules
  @virtual_network_rules
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/database_account_update_parameters.rb', line 92

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'DatabaseAccountUpdateParameters',
    type: {
      name: 'Composite',
      class_name: 'DatabaseAccountUpdateParameters',
      model_properties: {
        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'
                }
            }
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          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: false,
          serialized_name: 'properties.locations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'LocationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Location'
                }
            }
          }
        },
        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