Módosítja az Azure Cosmos DB-adatbázisfiók feladatátvételi prioritását. A 0 feladatátvételi prioritás írási régiót jelöl. A feladatátvételi prioritás maximális értéke = (régiók teljes száma – 1). A feladatátvételi prioritás értékeinek egyedinek kell lenniük minden olyan régióban, amelyben az adatbázisfiók létezik.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange?api-version=2023-11-15
URI-paraméterek
| Name |
In |
Kötelező |
Típus |
Description |
|
accountName
|
path |
True
|
string
|
Cosmos DB-adatbázisfiók neve.
Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
|
|
resourceGroupName
|
path |
True
|
string
|
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
|
|
subscriptionId
|
path |
True
|
string
|
A cél-előfizetés azonosítója.
|
|
api-version
|
query |
True
|
string
|
A művelethez használandó API-verzió.
|
Kérelem törzse
| Name |
Kötelező |
Típus |
Description |
|
failoverPolicies
|
True
|
FailoverPolicy[]
|
Feladatátvételi szabályzatok listája.
|
Válaszok
| Name |
Típus |
Description |
|
202 Accepted
|
|
Elfogadott. A feladatátvételi szabályzat módosítási művelete aszinkron módon fejeződik be.
Headers
- azure-AsyncOperation: string
- location: string
|
|
204 No Content
|
|
Nincs tartalom
|
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
A felhasználói fiók megszemélyesítése
|
Példák
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
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
Definíciók
| Name |
Description |
|
FailoverPolicies
|
A feladatátvétel prioritásának módosítására vonatkozó új feladatátvételi szabályzatok listája.
|
|
FailoverPolicy
|
Az adatbázisfiók adott régiójára vonatkozó feladatátvételi szabályzat.
|
FailoverPolicies
A feladatátvétel prioritásának módosítására vonatkozó új feladatátvételi szabályzatok listája.
| Name |
Típus |
Description |
|
failoverPolicies
|
FailoverPolicy[]
|
Feladatátvételi szabályzatok listája.
|
FailoverPolicy
Az adatbázisfiók adott régiójára vonatkozó feladatátvételi szabályzat.
| Name |
Típus |
Description |
|
failoverPriority
|
integer
|
A régió feladatátvételi prioritása. A 0 feladatátvételi prioritás írási régiót jelöl. A feladatátvételi prioritás maximális értéke = (régiók teljes száma – 1). A feladatátvételi prioritás értékeinek egyedinek kell lenniük minden olyan régióban, amelyben az adatbázisfiók létezik.
|
|
id
|
string
|
Annak a régiónak az egyedi azonosítója, ahová az adatbázisfiók replikál. Példa: <accountName-locationName>><.
|
|
locationName
|
string
|
Annak a régiónak a neve, amelyben az adatbázisfiók létezik.
|