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 帳戶。 'Delete' – 正在刪除 Cosmos DB 帳戶。 'Failed' – Cosmos DB 帳戶建立失敗。 'DeletionFailed' – 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 帳戶。 'Delete' – 正在刪除 Cosmos DB 帳戶。 'Failed' – Cosmos DB 帳戶建立失敗。 'DeletionFailed' – Cosmos DB 帳戶刪除失敗。 注意：這個屬性不會串行化。 它只能由伺服器填入。

provisioningState?: string

屬性值

string