Distributed Availability Groups - Set Role

Hizmet:: SQL Database

API Sürümü:: 2025-01-01

Dağıtılmış kullanılabilirlik grubundaki yönetilen örneğin rolünü ayarlar.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
distributedAvailabilityGroupName	path	True	string	Dağıtılmış kullanılabilirlik grubu adı.
managedInstanceName	path	True	string	Yönetilen örneğin adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. İsim büyük/küçük harfe duyarsızdır.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
instanceRole	True	InstanceRole	Dağıtılmış kullanılabilirlik grubundaki yönetilen örneğin yeni rolü Birincil veya İkincil olabilir.
roleChangeType	True	RoleChangeType	Rol değişikliğinin türü Planlı veya Zorlanmış olabilir.

Yanıtlar

Name	Tür	Description
200 OK	DistributedAvailabilityGroup	Azure işlemi başarıyla tamamlandı.
202 Accepted		Kaynak işlemi kabul edildi. Üst Bilgiler Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Name

Tür

Description

200 OK

DistributedAvailabilityGroup

Azure işlemi başarıyla tamamlandı.

202 Accepted

Kaynak işlemi kabul edildi.

Üst Bilgiler

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Set distributed availability group primary replica to managed instance.

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

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

Örnek yanıt

Durum kodu:: 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"
  }
}

Durum kodu:: 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

Tanımlar

Name	Description
CertificateInfo	Sertifika bilgileri
createdByType	Kaynağı oluşturan kimliğin türü.
DistributedAvailabilityGroup	Box ile Sql Managed Instance arasında dağıtık erişilebilirlik grubu.
DistributedAvailabilityGroupDatabase	Veritabanına özgü bilgiler
DistributedAvailabilityGroupSetRole	Dağıtılmış kullanılabilirlik grubu yük devretme isteği.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
FailoverModeType	Bağlantı failover modu - desteklenen SQL Server ile iki yönlü failover için kullanılmak üzere tasarlanmışsa Manuel olabilir veya Azure'a tek yönlü failover için None olabilir.
InstanceRole	Dağıtılmış kullanılabilirlik grubundaki yönetilen örneğin yeni rolü Birincil veya İkincil olabilir.
LinkRole	SQL server yan bağlantı rolü
ReplicaConnectedState	Bağlantı bağlı durumu
ReplicaSynchronizationHealth	Bağlantı sistem durumu
ReplicationModeType	Bağlantının çoğaltma modu
RoleChangeType	Rol değişikliğinin türü Planlı veya Zorlanmış olabilir.
SeedingModeType	Veritabanı çekirdek oluşturma modu – Desteklenen senaryolar için Otomatik (varsayılan) veya El ile olabilir.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

CertificateInfo

Nesne

Sertifika bilgileri

Name	Tür	Description
certificateName	string	Sertifika adı
expiryDate	string (date-time)	Sertifikanın süre sonu tarihi

createdByType

Numaralandırma

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

DistributedAvailabilityGroup

Nesne

Box ile Sql Managed Instance arasında dağıtık erişilebilirlik grubu.

Name	Tür	Description
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Kaynağın adı
properties.databases	DistributedAvailabilityGroupDatabase[]	Dağıtılmış kullanılabilirlik grubundaki veritabanları
properties.distributedAvailabilityGroupId	string (uuid)	Dağıtılmış kullanılabilirlik grubunun kimliği
properties.distributedAvailabilityGroupName	string	Dağıtılmış kullanılabilirlik grubunun adı
properties.failoverMode	FailoverModeType	Bağlantı failover modu - desteklenen SQL Server ile iki yönlü failover için kullanılmak üzere tasarlanmışsa Manuel olabilir veya Azure'a tek yönlü failover için None olabilir.
properties.instanceAvailabilityGroupName	string	Yönetilen örnek tarafı kullanılabilirlik grubu adı
properties.instanceLinkRole	LinkRole	Yönetilen örnek tarafı bağlantı rolü
properties.partnerAvailabilityGroupName	string	SQL server tarafı kullanılabilirlik grubu adı
properties.partnerEndpoint	string	SQL server yan uç noktası - IP veya DNS çözümlenebilir adı
properties.partnerLinkRole	LinkRole	SQL server yan bağlantı rolü
properties.replicationMode	ReplicationModeType	Bağlantının çoğaltma modu
properties.seedingMode	SeedingModeType	Veritabanı çekirdek oluşturma modu – Desteklenen senaryolar için Otomatik (varsayılan) veya El ile olabilir.
systemData	systemData	Azure Resource Manager metadata içeren createdBy ve modifiedBy bilgileri.
type	string	Kaynağın türü. Örneğin "Microsoft. Compute/virtualMachines" veya "Microsoft. Depo/Depolama Hesapları"

DistributedAvailabilityGroupDatabase

Nesne

Veritabanına özgü bilgiler

Name	Tür	Description
connectedState	ReplicaConnectedState	Bağlantı bağlı durumu
databaseName	string	Bağlantıdaki veritabanının adı
instanceRedoReplicationLagSeconds	integer (int32)	Managed Instance bağlantı tarafı birincil olduğunda tekrar gecikmesi
instanceReplicaId	string (uuid)	Yönetilen örnek çoğaltma kimliği
instanceSendReplicationLagSeconds	integer (int32)	Managed Instance bağlantı tarafı birincil olduğunda replikasyon gecikmesi
lastBackupLsn	string	Son yedekleme LSN
lastBackupTime	string (date-time)	Son yedekleme LSN zamanı
lastCommitLsn	string	Son işleme LSN
lastCommitTime	string (date-time)	Son işleme LSN zamanı
lastHardenedLsn	string	Son sağlamlaştırılmış LSN
lastHardenedTime	string (date-time)	Son sağlamlaştırılmış LSN süresi
lastReceivedLsn	string	Son alınan LSN
lastReceivedTime	string (date-time)	Son alınan LSN zamanı
lastSentLsn	string	Son gönderilen LSN
lastSentTime	string (date-time)	Son gönderilen LSN zamanı
mostRecentLinkError	string	En son bağlantı bağlantısı hatası açıklaması
partnerAuthCertValidity	CertificateInfo	SQL server sertifika geçerliliği
partnerReplicaId	string (uuid)	SQL server çoğaltma kimliği
replicaState	string	Geçerli bağlantı durumu
seedingProgress	string	Tohumlama ilerleme durumu
synchronizationHealth	ReplicaSynchronizationHealth	Bağlantı sistem durumu

DistributedAvailabilityGroupSetRole

Nesne

Dağıtılmış kullanılabilirlik grubu yük devretme isteği.

Name	Tür	Description
instanceRole	InstanceRole	Dağıtılmış kullanılabilirlik grubundaki yönetilen örneğin yeni rolü Birincil veya İkincil olabilir.
roleChangeType	RoleChangeType	Rol değişikliğinin türü Planlı veya Zorlanmış olabilir.

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi

ErrorResponse

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

FailoverModeType

Numaralandırma

Bağlantı failover modu - desteklenen SQL Server ile iki yönlü failover için kullanılmak üzere tasarlanmışsa Manuel olabilir veya Azure'a tek yönlü failover için None olabilir.

Değer	Description
None	Hiçbiri
Manual	Kılavuz

InstanceRole

Numaralandırma

Dağıtılmış kullanılabilirlik grubundaki yönetilen örneğin yeni rolü Birincil veya İkincil olabilir.

Değer	Description
Primary	Birincil
Secondary	Secondary

LinkRole

Numaralandırma

SQL server yan bağlantı rolü

Değer	Description
Primary	Birincil
Secondary	Secondary

ReplicaConnectedState

Numaralandırma

Bağlantı bağlı durumu

Değer	Description
DISCONNECTED	DISCONNECTED
CONNECTED	BAĞLI

ReplicaSynchronizationHealth

Numaralandırma

Bağlantı sistem durumu

Değer	Description
NOT_HEALTHY	NOT_HEALTHY
PARTIALLY_HEALTHY	PARTIALLY_HEALTHY
HEALTHY	SAĞLIKLI

ReplicationModeType

Numaralandırma

Bağlantının çoğaltma modu

Değer	Description
Async	Async
Sync	Senkronizasyon

RoleChangeType

Numaralandırma

Rol değişikliğinin türü Planlı veya Zorlanmış olabilir.

Değer	Description
Forced	Zorla
Planned	Planlandı

SeedingModeType

Numaralandırma

Veritabanı çekirdek oluşturma modu – Desteklenen senaryolar için Otomatik (varsayılan) veya El ile olabilir.

Değer	Description
Automatic	Automatic
Manual	Kılavuz

systemData

Nesne

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.