Location interface

パッケージ:

@azure/arm-cosmosdb

Azure Cosmos DB データベース アカウントがデプロイされているリージョン。

プロパティ

documentEndpoint	特定のリージョンの接続エンドポイント。 例: https://< accountName-locationName.documents.azure.com:443/>>< 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
failoverPriority	リージョンのフェールオーバー優先度。 フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。 フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。 フェールオーバーの優先度の値は、データベース アカウントが存在するリージョンごとに一意である必要があります。
id	データベース アカウント内のリージョンの一意識別子。 例: <accountName-locationName>><。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
isZoneRedundant	このリージョンが AvailabilityZone リージョンかどうかを示すフラグ
locationName	領域の名前。
provisioningState	操作が呼び出されたときの Cosmos DB アカウントの状態。 状態は、次のいずれかになります。 'Creating' – Cosmos DB アカウントが作成されています。 アカウントが作成中状態の場合、Cosmos DB アカウントの作成操作の入力として指定されたプロパティのみが返されます。 'Succeeded' – Cosmos DB アカウントがアクティブで使用されています。 '更新中' – Cosmos DB アカウントが更新されています。 '削除中' – Cosmos DB アカウントが削除されています。 'Failed' – Cosmos DB アカウントの作成に失敗しました。 'DeleteFailed' – Cosmos DB アカウントの削除に失敗しました。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

documentEndpoint

特定のリージョンの接続エンドポイント。 例: https://< accountName-locationName.documents.azure.com:443/>>< 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

documentEndpoint?: string

プロパティ値

string

failoverPriority

リージョンのフェールオーバー優先度。 フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。 フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。 フェールオーバーの優先度の値は、データベース アカウントが存在するリージョンごとに一意である必要があります。

failoverPriority?: number

プロパティ値

number

id

データベース アカウント内のリージョンの一意識別子。 例: <accountName-locationName>><。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

string

isZoneRedundant

このリージョンが AvailabilityZone リージョンかどうかを示すフラグ

isZoneRedundant?: boolean

プロパティ値

boolean

locationName

領域の名前。

locationName?: string

プロパティ値

string

provisioningState

操作が呼び出されたときの Cosmos DB アカウントの状態。 状態は、次のいずれかになります。 'Creating' – Cosmos DB アカウントが作成されています。 アカウントが作成中状態の場合、Cosmos DB アカウントの作成操作の入力として指定されたプロパティのみが返されます。 'Succeeded' – Cosmos DB アカウントがアクティブで使用されています。 '更新中' – Cosmos DB アカウントが更新されています。 '削除中' – Cosmos DB アカウントが削除されています。 'Failed' – Cosmos DB アカウントの作成に失敗しました。 'DeleteFailed' – Cosmos DB アカウントの削除に失敗しました。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

provisioningState?: string

プロパティ値

string