class Azure::Cosmosdb::Mgmt::V2020_04_01::Models::Location

A region in which the Azure Cosmos DB database account is deployed.

Attributes

document_endpoint[RW]

@return [String] The connection endpoint for the specific region. Example: <accountName>-<locationName>.documents.azure.com:443/

failover_priority[RW]

@return [Integer] The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

id[RW]

@return [String] The unique identifier of the region within the database account. Example: &lt;accountName&gt;-&lt;locationName&gt;.

is_zone_redundant[RW]

@return [Boolean] Flag to indicate whether or not this region is an AvailabilityZone region

location_name[RW]

@return [String] The name of the region.

provisioning_state[RW]

@return [String]

Public Class Methods

mapper() click to toggle source

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

# File lib/2020-04-01/generated/azure_mgmt_cosmosdb/models/location.rb, line 46
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Location',
    type: {
      name: 'Composite',
      class_name: 'Location',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        location_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'locationName',
          type: {
            name: 'String'
          }
        },
        document_endpoint: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'documentEndpoint',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'provisioningState',
          type: {
            name: 'String'
          }
        },
        failover_priority: {
          client_side_validation: true,
          required: false,
          serialized_name: 'failoverPriority',
          constraints: {
            InclusiveMinimum: 0
          },
          type: {
            name: 'Number'
          }
        },
        is_zone_redundant: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isZoneRedundant',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end