Disaster Recovery Configs - List Keys

Servicio:

Service Bus

Versión de la API:

2024-01-01

Obtiene las cadenas de conexión principal y secundaria para el espacio de nombres.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
alias	path	True	string minLength: 1 maxLength: 50	Nombre de configuración de recuperación ante desastres
authorizationRuleName	path	True	string minLength: 1 maxLength: 50	Nombre de la regla de autorización.
namespaceName	path	True	string minLength: 6 maxLength: 50	Nombre del espacio de nombres
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	AccessKeys	Las cadenas de conexión se devolvieron correctamente.
Other Status Codes	ErrorResponse	Respuesta de error de ServiceBus que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

DisasterRecoveryConfigsAuthorizationRuleListKey

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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"
}

Definiciones

Nombre	Description
AccessKeys	Espacio de nombres/Cadena de conexión de ServiceBus
Error	Objeto de error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error de administración de recursos.

AccessKeys

Object

Espacio de nombres/Cadena de conexión de ServiceBus

Nombre	Tipo	Description
aliasPrimaryConnectionString	string	Cadena de conexión principal del alias si está habilitada la recuperación ante desastres geográficas
aliasSecondaryConnectionString	string	Cadena de conexión secundaria del alias si está habilitada la recuperación ante desastres geográficas
keyName	string	Cadena que describe la regla de autorización.
primaryConnectionString	string	Cadena de conexión principal de la regla de autorización de espacio de nombres creada.
primaryKey	string	Clave principal de 256 bits codificada en base64 para firmar y validar el token de SAS.
secondaryConnectionString	string	Cadena de conexión secundaria de la regla de autorización de espacio de nombres creada.
secondaryKey	string	Clave principal de 256 bits codificada en base64 para firmar y validar el token de SAS.

Error

Object

Objeto de error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Object

Respuesta de error de administración de recursos.

Nombre	Tipo	Description
error	Error	Objeto de error.