你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Disaster Recovery Configs - List

Service:

Service Bus

API Version:

2021-11-01

获取所有别名 (灾难恢复配置)

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs?api-version=2021-11-01

URI 参数

名称	在	必需	类型	说明
namespaceName	path	True	string	命名空间名称
resourceGroupName	path	True	string	Azure 订阅中资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	ArmDisasterRecoveryListResult	已成功检索 servicebus 命名空间的别名 (灾难恢复配置列表)
Other Status Codes	ErrorResponse	描述操作失败原因的 ServiceBus 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

SBAliasList

Sample Request

HTTP

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfigs?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for DisasterRecoveryConfigs List. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs
     * /SBAliasList.json
     */
    /**
     * Sample code: SBAliasList.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void sBAliasList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getDisasterRecoveryConfigs().list("ardsouzatestRG",
            "sdk-Namespace-8860", 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.servicebus import ServiceBusManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicebus
# USAGE
    python sb_alias_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 = ServiceBusManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.disaster_recovery_configs.list(
        resource_group_name="ardsouzatestRG",
        namespace_name="sdk-Namespace-8860",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs/SBAliasList.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

Go

package armservicebus_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/servicebus/armservicebus"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs/SBAliasList.json
func ExampleDisasterRecoveryConfigsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDisasterRecoveryConfigsClient().NewListPager("ardsouzatestRG", "sdk-Namespace-8860", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ArmDisasterRecoveryListResult = armservicebus.ArmDisasterRecoveryListResult{
		// 	Value: []*armservicebus.ArmDisasterRecovery{
		// 		{
		// 			Name: to.Ptr("sdk-DisasterRecovery-3814"),
		// 			Type: to.Ptr("Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig"),
		// 			ID: to.Ptr("/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-DisasterRecovery-3814"),
		// 			Properties: &armservicebus.ArmDisasterRecoveryProperties{
		// 				PartnerNamespace: to.Ptr("sdk-Namespace-37"),
		// 				ProvisioningState: to.Ptr(armservicebus.ProvisioningStateDRSucceeded),
		// 				Role: to.Ptr(armservicebus.RoleDisasterRecoveryPrimary),
		// 			},
		// 	}},
		// }
	}
}

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 { ServiceBusManagementClient } = require("@azure/arm-servicebus");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets all Alias(Disaster Recovery configurations)
 *
 * @summary Gets all Alias(Disaster Recovery configurations)
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs/SBAliasList.json
 */
async function sbAliasList() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "ardsouzatestRG";
  const namespaceName = "sdk-Namespace-8860";
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.disasterRecoveryConfigs.list(resourceGroupName, namespaceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

sbAliasList().catch(console.error);

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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-DisasterRecovery-3814",
      "name": "sdk-DisasterRecovery-3814",
      "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig",
      "properties": {
        "provisioningState": "Accepted",
        "partnerNamespace": "sdk-Namespace-37",
        "role": "Primary"
      }
    }
  ]
}

定义

名称	说明
ArmDisasterRecovery	别名 (灾难恢复配置) 列表
ArmDisasterRecoveryListResult	列出别名 (灾难恢复配置) 操作的结果。
createdByType	创建资源的标识类型。
Error	错误对象。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorResponse	资源管理错误响应。
ProvisioningStateDR	别名 (灾难恢复配置的预配状态) - 可能的值“Accepted”、“Succeeded”或“Failed”
RoleDisasterRecovery	GEO DR 中命名空间的角色 - 可能的值“Primary”或“PrimaryNotReplicating”或“Secondary”
systemData	与此资源相关的系统元数据。

ArmDisasterRecovery

别名 (灾难恢复配置) 列表

名称	类型	说明
id	string	资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	资源所在的地理位置
name	string	资源的名称
properties.alternateName	string	主/辅助事件中心命名空间名称，是 GEO DR 配对的一部分
properties.partnerNamespace	string	主/辅助事件中心命名空间名称的 ARM ID，是 GEO DR 配对的一部分
properties.pendingReplicationOperationsCount	integer	待复制的实体数。
properties.provisioningState	ProvisioningStateDR	别名 (灾难恢复配置的预配状态) - 可能的值“Accepted”、“Succeeded”或“Failed”
properties.role	RoleDisasterRecovery	GEO DR 中命名空间的角色 - 可能的值“Primary”或“PrimaryNotReplicating”或“Secondary”
systemData	systemData	与此资源相关的系统元数据。
type	string	资源类型。 例如“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”

ArmDisasterRecoveryListResult

列出别名 (灾难恢复配置) 操作的结果。

名称	类型	说明
nextLink	string	链接到下一组结果。 如果 Value 包含灾难恢复配置 (别名的不完整列表，则不为空)
value	ArmDisasterRecovery[]	别名 (灾难恢复配置) 列表

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

Error

错误对象。

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

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorResponse

资源管理错误响应。

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

ProvisioningStateDR

别名 (灾难恢复配置的预配状态) - 可能的值“Accepted”、“Succeeded”或“Failed”

名称	类型	说明
Accepted	string
Failed	string
Succeeded	string

RoleDisasterRecovery

GEO DR 中命名空间的角色 - 可能的值“Primary”或“PrimaryNotReplicating”或“Secondary”

名称	类型	说明
Primary	string
PrimaryNotReplicating	string
Secondary	string

systemData

与此资源相关的系统元数据。

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