Disaster Recovery Configs - List Keys

Служба:

Service Bus

Версия API:

2024-01-01

Возвращает основные и вторичные строки подключения для пространства имен.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}/listKeys?api-version=2024-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
alias	path	True	string minLength: 1 maxLength: 50	Имя конфигурации аварийного восстановления
authorizationRuleName	path	True	string minLength: 1 maxLength: 50	Имя правила авторизации.
namespaceName	path	True	string minLength: 6 maxLength: 50	Имя пространства имен
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	AccessKeys	Строки подключения успешно возвращены.
Other Status Codes	ErrorResponse	Ответ об ошибке ServiceBus, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

DisasterRecoveryConfigsAuthorizationRuleListKey

Образец запроса

HTTP

POST https://management.azure.com/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2702/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/authorizationRules/sdk-Authrules-1746/listKeys?api-version=2024-01-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus.Models;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json
// this example is just showing the usage of "DisasterRecoveryAuthorizationRules_ListKeys" 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 ServiceBusDisasterRecoveryAuthorizationRuleResource created on azure
// for more information of creating ServiceBusDisasterRecoveryAuthorizationRuleResource, please refer to the document of ServiceBusDisasterRecoveryAuthorizationRuleResource
string subscriptionId = "exampleSubscriptionId";
string resourceGroupName = "exampleResourceGroup";
string namespaceName = "sdk-Namespace-2702";
string @alias = "sdk-DisasterRecovery-4047";
string authorizationRuleName = "sdk-Authrules-1746";
ResourceIdentifier serviceBusDisasterRecoveryAuthorizationRuleResourceId = ServiceBusDisasterRecoveryAuthorizationRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, @alias, authorizationRuleName);
ServiceBusDisasterRecoveryAuthorizationRuleResource serviceBusDisasterRecoveryAuthorizationRule = client.GetServiceBusDisasterRecoveryAuthorizationRuleResource(serviceBusDisasterRecoveryAuthorizationRuleResourceId);

// invoke the operation
ServiceBusAccessKeys result = await serviceBusDisasterRecoveryAuthorizationRule.GetKeysAsync();

Console.WriteLine($"Succeeded: {result}");

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

Пример ответа

Код состояния:

200

{
  "aliasPrimaryConnectionString": "Endpoint=sb://sdk-disasterrecovery-4047.servicebus.windows-int.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "aliasSecondaryConnectionString": "Endpoint=sb://sdk-disasterrecovery-4047.servicebus.windows-int.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-Authrules-1746"
}

Определения

Имя	Описание
AccessKeys	Строка подключения к пространству имен или ServiceBus
Error	Объект ошибки.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Ответ об ошибке управления ресурсами.

AccessKeys

Object

Строка подключения к пространству имен или ServiceBus

Имя	Тип	Описание
aliasPrimaryConnectionString	string	Основная строка подключения псевдонима, если включена геообработка аварийного восстановления
aliasSecondaryConnectionString	string	Вторичная строка подключения псевдонима, если включена геообработка аварийного восстановления
keyName	string	Строка, описывающая правило авторизации.
primaryConnectionString	string	Основная строка подключения созданного правила авторизации пространства имен.
primaryKey	string	256-разрядный первичный ключ в кодировке Base64 для подписывания и проверки маркера SAS.
secondaryConnectionString	string	Вторичная строка подключения созданного правила авторизации пространства имен.
secondaryKey	string	256-разрядный первичный ключ в кодировке Base64 для подписывания и проверки маркера SAS.

Error

Object

Объект ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorResponse

Object

Ответ об ошибке управления ресурсами.

Имя	Тип	Описание
error	Error	Объект ошибки.