ArmCosmosDBModelFactory.CosmosDBAccountLocation Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB.Models

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

ArmCosmosDBModelFactory.cs

Initializes a new instance of CosmosDBAccountLocation.

public static Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountLocation CosmosDBAccountLocation (string id = default, Azure.Core.AzureLocation? locationName = default, string documentEndpoint = default, string provisioningState = default, int? failoverPriority = default, bool? isZoneRedundant = default);

static member CosmosDBAccountLocation : string * Nullable<Azure.Core.AzureLocation> * string * string * Nullable<int> * Nullable<bool> -> Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountLocation

Public Shared Function CosmosDBAccountLocation (Optional id As String = Nothing, Optional locationName As Nullable(Of AzureLocation) = Nothing, Optional documentEndpoint As String = Nothing, Optional provisioningState As String = Nothing, Optional failoverPriority As Nullable(Of Integer) = Nothing, Optional isZoneRedundant As Nullable(Of Boolean) = Nothing) As CosmosDBAccountLocation

Parameters

id

String

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.

locationName

Nullable<AzureLocation>

The name of the region.

documentEndpoint

String

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/.

provisioningState

String

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

failoverPriority

Nullable<Int32>

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.

isZoneRedundant

Nullable<Boolean>

Flag to indicate whether or not this region is an AvailabilityZone region.

Returns

CosmosDBAccountLocation

A new CosmosDBAccountLocation instance for mocking.