Instance Failover Groups - Create Or Update

Hizmet:: SQL Database

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

Yük devretme grubu oluşturur veya güncelleştirir.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}?api-version=2025-01-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
failoverGroupName	path	True	string	Yük devretme grubunun adı.
locationName	path	True	string	Kaynağın bulunduğu bölgenin 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
properties.managedInstancePairs	True	ManagedInstancePairInfo[]	Yük devretme grubundaki yönetilen örnek çiftlerinin listesi.
properties.partnerRegions	True	PartnerRegionInfo[]	Yük devretme grubu için iş ortağı bölge bilgileri.
properties.readWriteEndpoint	True	InstanceFailoverGroupReadWriteEndpoint	Yük devretme grubu örneğinin okuma-yazma uç noktası.
properties.readOnlyEndpoint		InstanceFailoverGroupReadOnlyEndpoint	Yük devretme grubu örneğinin salt okunur uç noktası.
properties.secondaryType		SecondaryInstanceType	Coğrafi ikincil örneğin türü. Örnek yalnızca DR seçeneği olarak kullanılıyorsa 'Bekleme' değerini ayarlayın.

Yanıtlar

Name	Tür	Description
200 OK	InstanceFailoverGroup	Resource 'InstanceFailoverGroup' güncelleme işlemi başarılı oldu
201 Created	InstanceFailoverGroup	Resource 'InstanceFailoverGroup' oluşturma işlemi başarılı oldu Üst Bilgiler Location: string Retry-After: integer
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

Create failover group

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups/failover-group-test-3?api-version=2025-01-01

{
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan West"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "secondaryType": "Geo"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
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/InstanceFailoverGroupCreateOrUpdate.json
// this example is just showing the usage of "InstanceFailoverGroups_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this InstanceFailoverGroupResource
AzureLocation locationName = new AzureLocation("Japan East");
InstanceFailoverGroupCollection collection = resourceGroupResource.GetInstanceFailoverGroups(locationName);

// invoke the operation
string failoverGroupName = "failover-group-test-3";
InstanceFailoverGroupData data = new InstanceFailoverGroupData
{
    SecondaryType = GeoSecondaryInstanceType.Geo,
    ReadWriteEndpoint = new InstanceFailoverGroupReadWriteEndpoint(ReadWriteEndpointFailoverPolicy.Automatic)
    {
        FailoverWithDataLossGracePeriodMinutes = 480,
    },
    ReadOnlyEndpointFailoverPolicy = ReadOnlyEndpointFailoverPolicy.Disabled,
    PartnerRegions = {new PartnerRegionInfo
    {
    Location = new AzureLocation("Japan West"),
    }},
    ManagedInstancePairs = {new ManagedInstancePairInfo
    {
    PrimaryManagedInstanceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"),
    PartnerManagedInstanceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"),
    }},
};
ArmOperation<InstanceFailoverGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, failoverGroupName, data);
InstanceFailoverGroupResource 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
InstanceFailoverGroupData 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": "failover-group-test-3",
  "type": "Microsoft.Sql/locations/instanceFailoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-3",
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "secondaryType": "Geo"
  }
}

Durum kodu:: 201

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/locations/instanceFailoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-3",
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "secondaryType": "Geo"
  }
}

Durum kodu:: 202

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
InstanceFailoverGroup	Örnek yük devretme grubu.
InstanceFailoverGroupReadOnlyEndpoint	Yük devretme grubu örneğinin salt okunur uç noktası.
InstanceFailoverGroupReadWriteEndpoint	Yük devretme grubu örneğinin okuma-yazma uç noktası.
InstanceFailoverGroupReplicationRole	Yük devretme grubu örneğinin yerel çoğaltma rolü.
ManagedInstancePairInfo	Yük devretme grubundaki Yönetilen Örnek çiftleri.
PartnerRegionInfo	Yük devretme grubu için iş ortağı bölge bilgileri.
ReadOnlyEndpointFailoverPolicy	Yük devretme grubu için salt okunur uç noktanın yük devretme ilkesi.
ReadWriteEndpointFailoverPolicy	Yük devretme grubu için okuma-yazma uç noktasının yük devretme ilkesi. FailoverPolicy Otomatik ise failoverWithDataLossGracePeriodMinutes gereklidir.
SecondaryInstanceType	Coğrafi ikincil örneğin türü. Örnek yalnızca DR seçeneği olarak kullanılıyorsa 'Bekleme' değerini ayarlayın.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Numaralandırma

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

Değer	Description
User
Application
ManagedIdentity
Key

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.

InstanceFailoverGroup

Nesne

Örnek yük devretme 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.managedInstancePairs	ManagedInstancePairInfo[]	Yük devretme grubundaki yönetilen örnek çiftlerinin listesi.
properties.partnerRegions	PartnerRegionInfo[]	Yük devretme grubu için iş ortağı bölge bilgileri.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Yük devretme grubu örneğinin salt okunur uç noktası.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Yük devretme grubu örneğinin okuma-yazma uç noktası.
properties.replicationRole	InstanceFailoverGroupReplicationRole	Yük devretme grubu örneğinin yerel çoğaltma rolü.
properties.replicationState	string	Yük devretme grubu örneğinin çoğaltma durumu.
properties.secondaryType	SecondaryInstanceType	Coğrafi ikincil örneğin türü. Örnek yalnızca DR seçeneği olarak kullanılıyorsa 'Bekleme' değerini ayarlayın.
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ı"

InstanceFailoverGroupReadOnlyEndpoint

Nesne

Yük devretme grubu örneğinin salt okunur uç noktası.

Name	Tür	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Yük devretme grubu için salt okunur uç noktanın yük devretme ilkesi.

InstanceFailoverGroupReadWriteEndpoint

Nesne

Yük devretme grubu örneğinin okuma-yazma uç noktası.

Name	Tür	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	Yük devretme grubu için okuma-yazma uç noktasının yük devretme ilkesi. FailoverPolicy Otomatik ise failoverWithDataLossGracePeriodMinutes gereklidir.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Okuma-yazma uç noktası için veri kaybıyla yük devretmeden önce yetkisiz kullanım süresi denendi. FailoverPolicy Otomatik ise failoverWithDataLossGracePeriodMinutes gereklidir.

InstanceFailoverGroupReplicationRole

Numaralandırma

Yük devretme grubu örneğinin yerel çoğaltma rolü.

Değer	Description
Primary	Birincil
Secondary	Secondary

ManagedInstancePairInfo

Nesne

Yük devretme grubundaki Yönetilen Örnek çiftleri.

Name	Tür	Description
partnerManagedInstanceId	string	Partner Managed Instance'ın İkisi Id.
primaryManagedInstanceId	string	Primary Managed Instance'ın kimliği çift.

PartnerRegionInfo

Nesne

Yük devretme grubu için iş ortağı bölge bilgileri.

Name	Tür	Description
location	string	İş ortağı tarafından yönetilen örneklerin coğrafi konumu.
replicationRole	InstanceFailoverGroupReplicationRole	İş ortağı tarafından yönetilen örneklerin çoğaltma rolü.

ReadOnlyEndpointFailoverPolicy

Numaralandırma

Yük devretme grubu için salt okunur uç noktanın yük devretme ilkesi.

Değer	Description
Disabled	Disabled
Enabled	Enabled

ReadWriteEndpointFailoverPolicy

Numaralandırma

Yük devretme grubu için okuma-yazma uç noktasının yük devretme ilkesi. FailoverPolicy Otomatik ise failoverWithDataLossGracePeriodMinutes gereklidir.

Değer	Description
Manual	Kılavuz
Automatic	Automatic

SecondaryInstanceType

Numaralandırma

Coğrafi ikincil örneğin türü. Örnek yalnızca DR seçeneği olarak kullanılıyorsa 'Bekleme' değerini ayarlayın.

Değer	Description
Geo	Coğrafya
Standby	Bekleme

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ü.