Class: Azure::Cosmosdb::Mgmt::V2019_08_01::Models::DatabaseAccountUpdateParameters

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-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

#capabilities ⇒ Array<Capability>

account

Returns:

  • (Array<Capability>) —

    List of Cosmos DB capabilities for the



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

def capabilities
  @capabilities
end

#connector_offer ⇒ ConnectorOffer

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

Returns:



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

def connector_offer
  @connector_offer
end

#consistency_policy ⇒ ConsistencyPolicy

account.

Returns:



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

def consistency_policy
  @consistency_policy
end

#disable_key_based_metadata_write_access ⇒ Boolean

(databases, containers, throughput) via account keys

Returns:

  • (Boolean) —

    Disable write operations on metadata resources



68
69
70
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/database_account_update_parameters.rb', line 68

def disable_key_based_metadata_write_access
  @disable_key_based_metadata_write_access
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



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

def enable_automatic_failover
  @enable_automatic_failover
end

#enable_cassandra_connector ⇒ Boolean

account

Returns:

  • (Boolean) —

    Enables the cassandra connector on the Cosmos DB C*



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

def enable_cassandra_connector
  @enable_cassandra_connector
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



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

def enable_multiple_write_locations
  @enable_multiple_write_locations
end

#ip_range_filter ⇒ String

set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

Returns:

  • (String) —

    Cosmos DB Firewall Support: This value specifies the



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

def ip_range_filter
  @ip_range_filter
end

#is_virtual_network_filter_enabled ⇒ Boolean

Network ACL rules.

Returns:

  • (Boolean) —

    Flag to indicate whether to enable/disable Virtual



39
40
41
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/database_account_update_parameters.rb', line 39

def is_virtual_network_filter_enabled
  @is_virtual_network_filter_enabled
end

#location ⇒ String

resource belongs.

Returns:

  • (String) —

    The location of the resource group to which the



20
21
22
 
# File 'lib/2019-08-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/2019-08-01/generated/azure_mgmt_cosmosdb/models/database_account_update_parameters.rb', line 28

def locations
  @locations
end

#tags ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


16
17
18
 
# File 'lib/2019-08-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:



53
54
55
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/database_account_update_parameters.rb', line 53

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.



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
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
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/database_account_update_parameters.rb', line 75

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_range_filter: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.ipRangeFilter',
          type: {
            name: 'String'
          }
        },
        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'
          }
        }
      }
    }
  }
end