class Azure::Cosmosdb::Mgmt::V2020_06_01_preview::Models::DatabaseAccountUpdateParameters

Parameters for patching Azure Cosmos DB database account properties.

Attributes

api_properties[RW]

@return [ApiProperties] API specific properties. Currently, supported only for MongoDB API.

backup_policy[RW]

@return [BackupPolicy] The object representing the policy for taking backups on an account.

capabilities[RW]

@return [Array<Capability>] List of Cosmos DB capabilities for the account

connector_offer[RW]

@return [ConnectorOffer] The cassandra connector offer type for the Cosmos DB database C* account. Possible values include: 'Small'

consistency_policy[RW]

@return [ConsistencyPolicy] The consistency policy for the Cosmos DB account.

cors[RW]

@return [Array<CorsPolicy>] The CORS policy for the Cosmos DB database account.

disable_key_based_metadata_write_access[RW]

@return [Boolean] Disable write operations on metadata resources (databases, containers, throughput) via account keys

enable_analytical_storage[RW]

@return [Boolean] Flag to indicate whether to enable storage analytics.

enable_automatic_failover[RW]

@return [Boolean] Enables automatic failover of the write region in the 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.

enable_cassandra_connector[RW]

@return [Boolean] Enables the cassandra connector on the Cosmos DB C* account

enable_free_tier[RW]

@return [Boolean] Flag to indicate whether Free Tier is enabled.

enable_multiple_write_locations[RW]

@return [Boolean] Enables the account to write in multiple locations

identity[RW]

@return [ManagedServiceIdentity]

ip_rules[RW]

@return [Array<IpAddressOrRange>] List of IpRules.

is_virtual_network_filter_enabled[RW]

@return [Boolean] Flag to indicate whether to enable/disable Virtual Network ACL rules.

key_vault_key_uri[RW]

@return [String] The URI of the key vault

location[RW]

@return [String] The location of the resource group to which the resource belongs.

locations[RW]

@return [Array<Location>] An array that contains the georeplication locations enabled for the Cosmos DB account.

public_network_access[RW]

@return [PublicNetworkAccess] Whether requests from Public Network are allowed. Possible values include: 'Enabled', 'Disabled'

tags[RW]

@return [Hash{String => String}]

virtual_network_rules[RW]

@return [Array<VirtualNetworkRule>] List of Virtual Network ACL rules configured for the Cosmos DB account.

Public Class Methods

mapper() click to toggle source

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

# File lib/2020-06-01-preview/generated/azure_mgmt_cosmosdb/models/database_account_update_parameters.rb, line 99
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'
          }
        },
        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'
                }
            }
          }
        },
        identity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'identity',
          type: {
            name: 'Composite',
            class_name: 'ManagedServiceIdentity'
          }
        }
      }
    }
  }
end