Instance Failover Groups - Failover

Hizmet:: SQL Database

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

Geçerli birincil yönetilen örnekten bu yönetilen örneğe yük devredilir.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}/failover?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ü.

Yanıtlar

Name	Tür	Description
200 OK	InstanceFailoverGroup	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

InstanceFailoverGroup

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

Planned failover of a failover group

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

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/InstanceFailoverGroupFailover.json
// this example is just showing the usage of "InstanceFailoverGroups_Failover" 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 InstanceFailoverGroupResource created on azure
// for more information of creating InstanceFailoverGroupResource, please refer to the document of InstanceFailoverGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
AzureLocation locationName = new AzureLocation("Japan West");
string failoverGroupName = "failover-group-test-3";
ResourceIdentifier instanceFailoverGroupResourceId = InstanceFailoverGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, locationName, failoverGroupName);
InstanceFailoverGroupResource instanceFailoverGroup = client.GetInstanceFailoverGroupResource(instanceFailoverGroupResourceId);

// invoke the operation
ArmOperation<InstanceFailoverGroupResource> lro = await instanceFailoverGroup.FailoverAsync(WaitUntil.Completed);
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/JapanWest/instanceFailoverGroups/failover-group-test-3",
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan East",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "secondaryType": "Geo"
  }
}

Durum kodu:: 202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/JapanWest/instanceFailoverGroupOperationResults/failover-group-test-3?api-version=2022-05-01-preview

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.