Database Accounts - Failover Priority Change

リファレンス

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange?api-version=2023-11-15

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	Cosmos DB データベースアカウント名。 Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
failoverPolicies	True	FailoverPolicy[]	フェールオーバーポリシーの一覧。

応答

名前	型	説明
202 Accepted		受理されました。フェールオーバーポリシーの変更操作は非同期的に完了します。 Headers azure-AsyncOperation: string location: string
204 No Content		コンテンツなし

名前

型

説明

202 Accepted

受理されました。フェールオーバーポリシーの変更操作は非同期的に完了します。

Headers

azure-AsyncOperation: string
location: string

204 No Content

コンテンツなし

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

CosmosDBDatabaseAccountFailoverPriorityChange

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1-failover/failoverPriorityChange?api-version=2023-11-15

{
  "failoverPolicies": [
    {
      "locationName": "eastus",
      "failoverPriority": 0
    },
    {
      "locationName": "westus",
      "failoverPriority": 1
    }
  ]
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_database_account_failover_priority_change.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    client.database_accounts.begin_failover_priority_change(
        resource_group_name="rg1",
        account_name="ddb1-failover",
        failover_parameters={
            "failoverPolicies": [
                {"failoverPriority": 0, "locationName": "eastus"},
                {"failoverPriority": 1, "locationName": "westus"},
            ]
        },
    ).result()


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json
func ExampleDatabaseAccountsClient_BeginFailoverPriorityChange() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDatabaseAccountsClient().BeginFailoverPriorityChange(ctx, "rg1", "ddb1-failover", armcosmos.FailoverPolicies{
		FailoverPolicies: []*armcosmos.FailoverPolicy{
			{
				FailoverPriority: to.Ptr[int32](0),
				LocationName:     to.Ptr("eastus"),
			},
			{
				FailoverPriority: to.Ptr[int32](1),
				LocationName:     to.Ptr("westus"),
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Changes the failover priority for the Azure Cosmos DB database account. 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.
 *
 * @summary Changes the failover priority for the Azure Cosmos DB database account. 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.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json
 */
async function cosmosDbDatabaseAccountFailoverPriorityChange() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1-failover";
  const failoverParameters = {
    failoverPolicies: [
      { failoverPriority: 0, locationName: "eastus" },
      { failoverPriority: 1, locationName: "westus" },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.beginFailoverPriorityChangeAndWait(
    resourceGroupName,
    accountName,
    failoverParameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 202

Location: https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15
Azure-AsyncOperation: https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15

Status code:: 204

定義

名前	説明
FailoverPolicies	フェールオーバー優先度の変更に関する新しいフェールオーバーポリシーの一覧。
FailoverPolicy	データベースアカウントの特定のリージョンのフェールオーバーポリシー。

FailoverPolicies

フェールオーバー優先度の変更に関する新しいフェールオーバーポリシーの一覧。

名前	型	説明
failoverPolicies	FailoverPolicy[]	フェールオーバーポリシーの一覧。

FailoverPolicy

データベースアカウントの特定のリージョンのフェールオーバーポリシー。

名前	型	説明
failoverPriority	integer	リージョンのフェールオーバー優先度。フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。フェールオーバーの優先度の値は、データベースアカウントが存在するリージョンごとに一意である必要があります。
id	string	データベースアカウントがレプリケートされるリージョンの一意識別子。例: <accountName-locationName>><。
locationName	string	データベースアカウントが存在するリージョンの名前。

Database Accounts - Failover Priority Change

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

Scopes

例

CosmosDBDatabaseAccountFailoverPriorityChange

Sample Request

Sample Response

定義

FailoverPolicies

FailoverPolicy

その他のリソース