Distributed Availability Groups - Set Role

Usługa:

SQL Database

Wersja interfejsu API:

2025-01-01

Ustawia rolę dla wystąpienia zarządzanego w rozproszonej grupie dostępności.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}/setRole?api-version=2025-01-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
distributedAvailabilityGroupName	path	True	string	Nazwa rozproszonej grupy dostępności.
managedInstanceName	path	True	string	Nazwa wystąpienia zarządzanego.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
instanceRole	True	InstanceRole	Nowa rola wystąpienia zarządzanego w rozproszonej grupie dostępności może być podstawowa lub pomocnicza.
roleChangeType	True	RoleChangeType	Typ zmiany roli może być planowany lub wymuszony.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DistributedAvailabilityGroup	Operacja Azure zakończyła się pomyślnie.
202 Accepted		Zaakceptowano operację zasobu. Nagłówki Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Set distributed availability group primary replica to managed instance.

Przykładowe żądanie

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag/setRole?api-version=2025-01-01

{
  "instanceRole": "Primary",
  "roleChangeType": "Forced"
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/DistributedAvailabilityGroupsSetRole.json
// this example is just showing the usage of "DistributedAvailabilityGroups_SetRole" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDistributedAvailabilityGroupResource created on azure
// for more information of creating SqlDistributedAvailabilityGroupResource, please refer to the document of SqlDistributedAvailabilityGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testrg";
string managedInstanceName = "testcl";
string distributedAvailabilityGroupName = "dag";
ResourceIdentifier sqlDistributedAvailabilityGroupResourceId = SqlDistributedAvailabilityGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, distributedAvailabilityGroupName);
SqlDistributedAvailabilityGroupResource sqlDistributedAvailabilityGroup = client.GetSqlDistributedAvailabilityGroupResource(sqlDistributedAvailabilityGroupResourceId);

// invoke the operation
DistributedAvailabilityGroupSetRole distributedAvailabilityGroupSetRole = new DistributedAvailabilityGroupSetRole(DistributedAvailabilityGroupManagedInstanceRole.Primary, DistributedAvailabilityGroupRoleChangeType.Forced);
ArmOperation<SqlDistributedAvailabilityGroupResource> lro = await sqlDistributedAvailabilityGroup.SetRoleAsync(WaitUntil.Completed, distributedAvailabilityGroupSetRole);
SqlDistributedAvailabilityGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDistributedAvailabilityGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "name": "dag",
  "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
  "properties": {
    "distributedAvailabilityGroupName": "dag",
    "instanceLinkRole": "Primary"
  }
}

Kod stanu:

202

Location: https://management.azure.com/subscriptions/f2669dff-5f08-45dd-b857-b2a60b72cdc9/providers/Microsoft.Sql/locations/westus/distributedAvailabilityGroupsOperationResults/00000000-1111-2222-3333-444444444444?api-version=2021-05-01-preview

Definicje

Nazwa	Opis
CertificateInfo	Informacje o certyfikacie
createdByType	Typ tożsamości, która utworzyła zasób.
DistributedAvailabilityGroup	Rozproszona grupa dostępności między Boxem a SQL Managed Instance.
DistributedAvailabilityGroupDatabase	Informacje specyficzne dla bazy danych
DistributedAvailabilityGroupSetRole	Żądanie trybu failover rozproszonej grupy dostępności.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
FailoverModeType	Tryb awaryjnego łącza – może być ręczny, jeśli przeznaczony jest do dwukierunkowego przełączania awaryjnego z obsługiwanym SQL Server, lub None do jednokierunkowego przełączania awaryjnego do Azure.
InstanceRole	Nowa rola wystąpienia zarządzanego w rozproszonej grupie dostępności może być podstawowa lub pomocnicza.
LinkRole	Rola linku bocznego programu SQL Server
ReplicaConnectedState	Stan połączenia połączonego
ReplicaSynchronizationHealth	Stan kondycji łącza
ReplicationModeType	Tryb replikacji łącza
RoleChangeType	Typ zmiany roli może być planowany lub wymuszony.
SeedingModeType	Tryb rozmieszczania bazy danych — może być automatyczny (domyślny) lub ręczny w obsługiwanych scenariuszach.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CertificateInfo

Objekt

Informacje o certyfikacie

Nazwa	Typ	Opis
certificateName	string	Nazwa certyfikatu
expiryDate	string (date-time)	Data wygaśnięcia certyfikatu

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DistributedAvailabilityGroup

Objekt

Rozproszona grupa dostępności między Boxem a SQL Managed Instance.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.databases	DistributedAvailabilityGroupDatabase[]	Bazy danych w rozproszonej grupie dostępności
properties.distributedAvailabilityGroupId	string (uuid)	Identyfikator rozproszonej grupy dostępności
properties.distributedAvailabilityGroupName	string	Nazwa rozproszonej grupy dostępności
properties.failoverMode	FailoverModeType	Tryb awaryjnego łącza – może być ręczny, jeśli przeznaczony jest do dwukierunkowego przełączania awaryjnego z obsługiwanym SQL Server, lub None do jednokierunkowego przełączania awaryjnego do Azure.
properties.instanceAvailabilityGroupName	string	Nazwa grupy dostępności po stronie wystąpienia zarządzanego
properties.instanceLinkRole	LinkRole	Rola łącza po stronie wystąpienia zarządzanego
properties.partnerAvailabilityGroupName	string	Nazwa grupy dostępności po stronie serwera SQL
properties.partnerEndpoint	string	Punkt końcowy po stronie serwera SQL — nazwa rozpoznawania adresów IP lub DNS
properties.partnerLinkRole	LinkRole	Rola linku bocznego programu SQL Server
properties.replicationMode	ReplicationModeType	Tryb replikacji łącza
properties.seedingMode	SeedingModeType	Tryb rozmieszczania bazy danych — może być automatyczny (domyślny) lub ręczny w obsługiwanych scenariuszach.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

DistributedAvailabilityGroupDatabase

Objekt

Informacje specyficzne dla bazy danych

Nazwa	Typ	Opis
connectedState	ReplicaConnectedState	Stan połączenia połączonego
databaseName	string	Nazwa bazy danych w linku
instanceRedoReplicationLagSeconds	integer (int32)	Opóźnienia w redo, gdy Managed Instance jest po stronie linku głównym
instanceReplicaId	string (uuid)	Identyfikator repliki wystąpienia zarządzanego
instanceSendReplicationLagSeconds	integer (int32)	Opóźnienie replikacji, gdy strona linku Managed Instance jest podstawową
lastBackupLsn	string	Ostatnia kopia zapasowa LSN
lastBackupTime	string (date-time)	Czas ostatniej kopii zapasowej LSN
lastCommitLsn	string	Ostatnie zatwierdzenie LSN
lastCommitTime	string (date-time)	Czas ostatniego zatwierdzenia LSN
lastHardenedLsn	string	Ostatnia wzmocniona nazwa LSN
lastHardenedTime	string (date-time)	Czas ostatniego utwardzenia sieci LSN
lastReceivedLsn	string	Ostatnio odebrano LSN
lastReceivedTime	string (date-time)	Czas ostatniego odebrania nazwy LSN
lastSentLsn	string	Ostatnio wysłana nazwa LSN
lastSentTime	string (date-time)	Czas ostatniego wysłania sieci LSN
mostRecentLinkError	string	Najnowszy opis błędu połączenia łącza
partnerAuthCertValidity	CertificateInfo	Ważność certyfikatu programu SQL Server
partnerReplicaId	string (uuid)	Identyfikator repliki programu SQL Server
replicaState	string	Bieżący stan łącza
seedingProgress	string	Postęp rozmieszczania
synchronizationHealth	ReplicaSynchronizationHealth	Stan kondycji łącza

DistributedAvailabilityGroupSetRole

Objekt

Żądanie trybu failover rozproszonej grupy dostępności.

Nazwa	Typ	Opis
instanceRole	InstanceRole	Nowa rola wystąpienia zarządzanego w rozproszonej grupie dostępności może być podstawowa lub pomocnicza.
roleChangeType	RoleChangeType	Typ zmiany roli może być planowany lub wymuszony.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Błąd dodatkowe informacje.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

FailoverModeType

Wyliczenie

Tryb awaryjnego łącza – może być ręczny, jeśli przeznaczony jest do dwukierunkowego przełączania awaryjnego z obsługiwanym SQL Server, lub None do jednokierunkowego przełączania awaryjnego do Azure.

Wartość	Opis
None	Żadne
Manual	Instrukcja

InstanceRole

Wyliczenie

Nowa rola wystąpienia zarządzanego w rozproszonej grupie dostępności może być podstawowa lub pomocnicza.

Wartość	Opis
Primary	Podstawowe
Secondary	Podrzędny

LinkRole

Wyliczenie

Rola linku bocznego programu SQL Server

Wartość	Opis
Primary	Podstawowe
Secondary	Podrzędny

ReplicaConnectedState

Wyliczenie

Stan połączenia połączonego

Wartość	Opis
DISCONNECTED	DISCONNECTED
CONNECTED	PODŁĄCZONY

ReplicaSynchronizationHealth

Wyliczenie

Stan kondycji łącza

Wartość	Opis
NOT_HEALTHY	NOT_HEALTHY
PARTIALLY_HEALTHY	PARTIALLY_HEALTHY
HEALTHY	ZDROWO

ReplicationModeType

Wyliczenie

Tryb replikacji łącza

Wartość	Opis
Async	Async
Sync	Synchronizacja

RoleChangeType

Wyliczenie

Typ zmiany roli może być planowany lub wymuszony.

Wartość	Opis
Forced	Zmuszona
Planned	Planowane

SeedingModeType

Wyliczenie

Tryb rozmieszczania bazy danych — może być automatyczny (domyślny) lub ręczny w obsługiwanych scenariuszach.

Wartość	Opis
Automatic	Automatycznie
Manual	Instrukcja

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.