Namespaces - List Keys

Referencia

Service:: Notification Hubs

API Version:: 2023-09-01

Obtiene connectionStrings principal y secundario en el espacio de nombres.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
authorizationRuleName	path	True	string	Nombre de la regla de autorización Regex pattern: `^[a-zA-Z0-9!()*-._]+$`
namespaceName	path	True	string	Nombre del espacio de nombres Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]*$`
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string uuid	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	ResourceListKeys	Correcto
Other Status Codes	ErrorResponse	Código de error con motivo.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Namespaces_ListKeys

Sample Request

HTTP

POST https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/RootManageSharedAccessKey/listKeys?api-version=2023-09-01

Sample Response

Status code:: 200

{
  "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "RootManageSharedAccessKey"
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ResourceListKeys	Respuesta para la solicitud POST que devuelve claves de acceso de Espacio de nombres o NotificationHub (cadenas de conexión).

ErrorAdditionalInfo

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

Detalle del error.

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

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ResourceListKeys

Respuesta para la solicitud POST que devuelve claves de acceso de Espacio de nombres o NotificationHub (cadenas de conexión).

Nombre	Tipo	Description
keyName	string	Obtiene o establece keyName del authorizationRule creado.
primaryConnectionString	string	Obtiene o establece primaryConnectionString de AuthorizationRule.
primaryKey	string	Obtiene o establece primaryKey del authorizationRule creado.
secondaryConnectionString	string	Obtiene o establece secondaryConnectionString del objeto AuthorizationRule creado.
secondaryKey	string	Obtiene o establece secondaryKey del authorizationRule creado.

Share via