Distributed Availability Groups - Set Role

Servizio:

SQL Database

Versione API:

2025-01-01

Imposta il ruolo per l'istanza gestita in un gruppo di disponibilità distribuito.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
distributedAvailabilityGroupName	path	True	string	Nome del gruppo di disponibilità distribuito.
managedInstanceName	path	True	string	Nome dell'istanza gestita.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
instanceRole	True	InstanceRole	Il nuovo ruolo dell'istanza gestita in un gruppo di disponibilità distribuito può essere Primario o Secondario.
roleChangeType	True	RoleChangeType	Il tipo di modifica del ruolo può essere Pianificato o Forzato.

Risposte

Nome	Tipo	Descrizione
200 OK	DistributedAvailabilityGroup	Operazione Azure completata con successo.
202 Accepted		Operazione sulle risorse accettata. Intestazioni Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Set distributed availability group primary replica to managed instance.

Esempio di richiesta

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"
}

Java

import com.azure.resourcemanager.sql.models.DistributedAvailabilityGroupSetRole;
import com.azure.resourcemanager.sql.models.InstanceRole;
import com.azure.resourcemanager.sql.models.RoleChangeType;

/**
 * Samples for DistributedAvailabilityGroups SetRole.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsSetRole.json
     */
    /**
     * Sample code: Set distributed availability group primary replica to managed instance.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void setDistributedAvailabilityGroupPrimaryReplicaToManagedInstance(
        com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDistributedAvailabilityGroups()
            .setRole(
                "testrg", "testcl", "dag", new DistributedAvailabilityGroupSetRole()
                    .withInstanceRole(InstanceRole.PRIMARY).withRoleChangeType(RoleChangeType.FORCED),
                com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python distributed_availability_groups_set_role.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 = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.distributed_availability_groups.begin_set_role(
        resource_group_name="testrg",
        managed_instance_name="testcl",
        distributed_availability_group_name="dag",
        parameters={"instanceRole": "Primary", "roleChangeType": "Forced"},
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsSetRole.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

JavaScript

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

/**
 * This sample demonstrates how to sets the role for managed instance in a distributed availability group.
 *
 * @summary sets the role for managed instance in a distributed availability group.
 * x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsSetRole.json
 */
async function setDistributedAvailabilityGroupPrimaryReplicaToManagedInstance() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.distributedAvailabilityGroups.setRole("testrg", "testcl", "dag", {
    instanceRole: "Primary",
    roleChangeType: "Forced",
  });
  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

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

Risposta di esempio

Codice di stato:

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"
  }
}

Codice di stato:

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

Definizioni

Nome	Descrizione
CertificateInfo	Informazioni relative al certificato
createdByType	Tipo di identità che ha creato la risorsa.
DistributedAvailabilityGroup	Gruppo di disponibilità distribuito tra box e Sql Istanza gestita.
DistributedAvailabilityGroupDatabase	Informazioni specifiche del database
DistributedAvailabilityGroupSetRole	Richiesta di failover del gruppo di disponibilità distribuito.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
FailoverModeType	La modalità di failover del collegamento - può essere manuale se pensata per il failover bidirezionale con un SQL Server supportato, oppure None per il failover unidirezionale verso Azure.
InstanceRole	Il nuovo ruolo dell'istanza gestita in un gruppo di disponibilità distribuito può essere Primario o Secondario.
LinkRole	Ruolo collegamento lato SQL Server
ReplicaConnectedState	Collegare lo stato connesso
ReplicaSynchronizationHealth	Stato di integrità del collegamento
ReplicationModeType	Modalità di replica del collegamento
RoleChangeType	Il tipo di modifica del ruolo può essere Pianificato o Forzato.
SeedingModeType	Modalità di seeding del database: può essere Automatica (impostazione predefinita) o Manuale per gli scenari supportati.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

CertificateInfo

Oggetto

Informazioni relative al certificato

Nome	Tipo	Descrizione
certificateName	string	Nome del certificato
expiryDate	string (date-time)	Data di scadenza del certificato

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

DistributedAvailabilityGroup

Oggetto

Gruppo di disponibilità distribuito tra box e Sql Istanza gestita.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties.databases	DistributedAvailabilityGroupDatabase[]	Database nel gruppo di disponibilità distribuito
properties.distributedAvailabilityGroupId	string (uuid)	ID del gruppo di disponibilità distribuito
properties.distributedAvailabilityGroupName	string	Nome del gruppo di disponibilità distribuito
properties.failoverMode	FailoverModeType	La modalità di failover del collegamento - può essere manuale se pensata per il failover bidirezionale con un SQL Server supportato, oppure None per il failover unidirezionale verso Azure.
properties.instanceAvailabilityGroupName	string	Nome del gruppo di disponibilità lato istanza gestita
properties.instanceLinkRole	LinkRole	Ruolo collegamento laterale dell'istanza gestita
properties.partnerAvailabilityGroupName	string	Nome del gruppo di disponibilità lato SQL Server
properties.partnerEndpoint	string	Endpoint lato SQL Server - IP o nome risolvibile DNS
properties.partnerLinkRole	LinkRole	Ruolo collegamento lato SQL Server
properties.replicationMode	ReplicationModeType	Modalità di replica del collegamento
properties.seedingMode	SeedingModeType	Modalità di seeding del database: può essere Automatica (impostazione predefinita) o Manuale per gli scenari supportati.
systemData	systemData	Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

DistributedAvailabilityGroupDatabase

Oggetto

Informazioni specifiche del database

Nome	Tipo	Descrizione
connectedState	ReplicaConnectedState	Collegare lo stato connesso
databaseName	string	Nome del database in collegamento
instanceRedoReplicationLagSeconds	integer (int32)	Ritardo quando il lato link Istanza gestita è principale
instanceReplicaId	string (uuid)	ID replica dell'istanza gestita
instanceSendReplicationLagSeconds	integer (int32)	Ritardo di replicazione quando il lato link Istanza gestita è primario
lastBackupLsn	string	LSN ultimo backup
lastBackupTime	string (date-time)	Ora dell'ultimo backup LSN
lastCommitLsn	string	Ultimo LSN commit
lastCommitTime	string (date-time)	Ora dell'ultimo commit LSN
lastHardenedLsn	string	Ultimo LSN con protezione avanzata
lastHardenedTime	string (date-time)	Ultimo tempo LSN con protezione avanzata
lastReceivedLsn	string	Ultimo LSN ricevuto
lastReceivedTime	string (date-time)	Ora dell'ultimo LSN ricevuto
lastSentLsn	string	Ultimo LSN inviato
lastSentTime	string (date-time)	Ora dell'ultimo LSN inviato
mostRecentLinkError	string	Descrizione dell'errore di connessione al collegamento più recente
partnerAuthCertValidity	CertificateInfo	Validità del certificato di SQL Server
partnerReplicaId	string (uuid)	ID replica di SQL Server
replicaState	string	Stato del collegamento corrente
seedingProgress	string	Avanzamento del seeding
synchronizationHealth	ReplicaSynchronizationHealth	Stato di integrità del collegamento

DistributedAvailabilityGroupSetRole

Oggetto

Richiesta di failover del gruppo di disponibilità distribuito.

Nome	Tipo	Descrizione
instanceRole	InstanceRole	Il nuovo ruolo dell'istanza gestita in un gruppo di disponibilità distribuito può essere Primario o Secondario.
roleChangeType	RoleChangeType	Il tipo di modifica del ruolo può essere Pianificato o Forzato.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

FailoverModeType

Enumerazione

La modalità di failover del collegamento - può essere manuale se pensata per il failover bidirezionale con un SQL Server supportato, oppure None per il failover unidirezionale verso Azure.

Valore	Descrizione
None	Nessuno
Manual	Manuale

InstanceRole

Enumerazione

Il nuovo ruolo dell'istanza gestita in un gruppo di disponibilità distribuito può essere Primario o Secondario.

Valore	Descrizione
Primary	Primary
Secondary	Secondario

LinkRole

Enumerazione

Ruolo collegamento lato SQL Server

Valore	Descrizione
Primary	Primary
Secondary	Secondario

ReplicaConnectedState

Enumerazione

Collegare lo stato connesso

Valore	Descrizione
DISCONNECTED	SCONNESSO
CONNECTED	CONNECTED

ReplicaSynchronizationHealth

Enumerazione

Stato di integrità del collegamento

Valore	Descrizione
NOT_HEALTHY	NOT_HEALTHY
PARTIALLY_HEALTHY	PARTIALLY_HEALTHY
HEALTHY	SANI

ReplicationModeType

Enumerazione

Modalità di replica del collegamento

Valore	Descrizione
Async	Async
Sync	Sincronizzazione

RoleChangeType

Enumerazione

Il tipo di modifica del ruolo può essere Pianificato o Forzato.

Valore	Descrizione
Forced	Forzato
Planned	Pianificato

SeedingModeType

Enumerazione

Modalità di seeding del database: può essere Automatica (impostazione predefinita) o Manuale per gli scenari supportati.

Valore	Descrizione
Automatic	Automatico
Manual	Manuale

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.