Instance Failover Groups - List By Location

服务:

SQL Database

API 版本:

2025-01-01

列出某个区域中的故障转移组。

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

URI 参数

名称	在	必需	类型	说明
locationName	path	True	string	资源所在的区域的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	InstanceFailoverGroupListResult	Azure 运营顺利完成。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

List failover group

示例请求

HTTP

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

Java

/**
 * Samples for InstanceFailoverGroups ListByLocation.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/InstanceFailoverGroupList.json
     */
    /**
     * Sample code: List failover group.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void listFailoverGroup(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getInstanceFailoverGroups().listByLocation("Default", "Japan East",
            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 instance_failover_group_list.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.instance_failover_groups.list_by_location(
        resource_group_name="Default",
        location_name="Japan East",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/InstanceFailoverGroupList.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 lists the failover groups in a location.
 *
 * @summary lists the failover groups in a location.
 * x-ms-original-file: 2025-01-01/InstanceFailoverGroupList.json
 */
async function listFailoverGroup() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.instanceFailoverGroups.listByLocation("Default", "Japan East")) {
    resArray.push(item);
  }

  console.log(resArray);
}

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.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/InstanceFailoverGroupList.json
// this example is just showing the usage of "InstanceFailoverGroups_ListByLocation" 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 and iterate over the result
await foreach (InstanceFailoverGroupResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

示例响应

状态代码:

200

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

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
InstanceFailoverGroup	实例故障转移组。
InstanceFailoverGroupListResult	InstanceFailoverGroup 列表操作的响应。
InstanceFailoverGroupReadOnlyEndpoint	故障转移组实例的只读终结点。
InstanceFailoverGroupReadWriteEndpoint	故障转移组实例的读写终结点。
InstanceFailoverGroupReplicationRole	故障转移组实例的本地复制角色。
ManagedInstancePairInfo	故障转移组中的托管实例对。
PartnerRegionInfo	故障转移组的合作伙伴区域信息。
ReadOnlyEndpointFailoverPolicy	故障转移组只读终结点的故障转移策略。
ReadWriteEndpointFailoverPolicy	故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。
SecondaryInstanceType	异地辅助实例的类型。 仅当实例用作 DR 选项时，请设置“备用”。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

InstanceFailoverGroup

对象

实例故障转移组。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.managedInstancePairs	ManagedInstancePairInfo[]	故障转移组中托管实例对的列表。
properties.partnerRegions	PartnerRegionInfo[]	故障转移组的合作伙伴区域信息。
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	故障转移组实例的只读终结点。
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	故障转移组实例的读写终结点。
properties.replicationRole	InstanceFailoverGroupReplicationRole	故障转移组实例的本地复制角色。
properties.replicationState	string	故障转移组实例的复制状态。
properties.secondaryType	SecondaryInstanceType	异地辅助实例的类型。 仅当实例用作 DR 选项时，请设置“备用”。
systemData	systemData	Azure 资源管理器 包含 createdBy 和 modifiedBy 信息的元数据。
type	string	资源类型。 例如，“Microsoft。计算/虚拟机“或”Microsoft“。存储/存储账户”

InstanceFailoverGroupListResult

对象

InstanceFailoverGroup 列表操作的响应。

名称	类型	说明
nextLink	string (uri)	指向下一页项的链接
value	InstanceFailoverGroup[]	本页的InstanceFailoverGroup项目

InstanceFailoverGroupReadOnlyEndpoint

对象

故障转移组实例的只读终结点。

名称	类型	说明
failoverPolicy	ReadOnlyEndpointFailoverPolicy	故障转移组只读终结点的故障转移策略。

InstanceFailoverGroupReadWriteEndpoint

对象

故障转移组实例的读写终结点。

名称	类型	说明
failoverPolicy	ReadWriteEndpointFailoverPolicy	故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。
failoverWithDataLossGracePeriodMinutes	integer (int32)	尝试对读写终结点执行故障转移前的宽限期，并丢失数据。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。

InstanceFailoverGroupReplicationRole

枚举

故障转移组实例的本地复制角色。

值	说明
Primary	主要
Secondary	次级

ManagedInstancePairInfo

对象

故障转移组中的托管实例对。

名称	类型	说明
partnerManagedInstanceId	string	Partner 托管实例 in pair 的 ID
primaryManagedInstanceId	string	Primary 托管实例 的 id in pair。

PartnerRegionInfo

对象

故障转移组的合作伙伴区域信息。

名称	类型	说明
location	string	合作伙伴托管实例的地理位置。
replicationRole	InstanceFailoverGroupReplicationRole	合作伙伴托管实例的复制角色。

ReadOnlyEndpointFailoverPolicy

枚举

故障转移组只读终结点的故障转移策略。

值	说明
Disabled	已禁用
Enabled	已启用

ReadWriteEndpointFailoverPolicy

枚举

故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。

值	说明
Manual	手动
Automatic	自动

SecondaryInstanceType

枚举

异地辅助实例的类型。 仅当实例用作 DR 选项时，请设置“备用”。

值	说明
Geo	地理位置
Standby	备用

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳 （UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。