Namespaces - List Keys

Servicio:

Relay

Versión de la API:

2024-01-01

Cadenas de conexión principal y secundaria al espacio de nombres.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
authorizationRuleName	path	True	string minLength: 1	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 dentro de la suscripción de Azure.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	AccessKeys	Exitoso.
Other Status Codes	ErrorResponse	Respuesta de error de retransmisión 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

RelayNameSpaceAuthorizationRuleListKey

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/authorizationRules/example-RelayAuthRules-01/listKeys?api-version=2024-01-01

Respuesta de muestra

status code:

200

{
  "primaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "example-RelayAuthRules-01"
}

Definiciones

Nombre	Description
AccessKeys	Cadena de conexión de espacio de nombres o retransmisión
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

AccessKeys

Object

Cadena de conexión de espacio de nombres o retransmisión

Nombre	Tipo	Description
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 secundaria de 256 bits codificada en base64 para firmar y validar el token de SAS.

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.

ErrorDetail

Object

Detalle del error.

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

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.