Authorization Rules - Event Hubs - List Keys

Referencia

Service:: Event Hubs

API Version:: 2024-01-01

Obtiene las cadenas de conexión de ACS y SAS para el centro de eventos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
authorizationRuleName	path	True	string	Nombre de la regla de autorización.
eventHubName	path	True	string	El nombre del centro de eventos
namespaceName	path	True	string	El nombre del espacio de nombres Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	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 una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de la API de cliente.

Respuestas

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

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

EventHubAuthorizationRuleListKey

Sample Request

HTTP

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-namespace-960/eventhubs/sdk-EventHub-532/authorizationRules/sdk-Authrules-2513/listKeys?api-version=2024-01-01

Sample Response

Status code:: 200

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-960.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-2513;SharedAccessKey=############################################;EntityPath=sdk-EventHub-532",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-960.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-2513;SharedAccessKey=############################################;EntityPath=sdk-EventHub-532",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-Authrules-2513"
}

Definiciones

Nombre	Description
AccessKeys	Espacio de nombres/Cadena de conexión de EventHub
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	La respuesta de error indica que el servicio event hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

AccessKeys

Espacio de nombres/Cadena de conexión de EventHub

Nombre	Tipo	Description
aliasPrimaryConnectionString	string	Cadena de conexión principal del alias si la recuperación ante desastres geográficas está habilitada
aliasSecondaryConnectionString	string	Cadena de conexión secundario del alias si la recuperación ante desastres geográficas está habilitada
keyName	string	Cadena que describe AuthorizationRule.
primaryConnectionString	string	Cadena de conexión principal del espacio de nombres creado AuthorizationRule.
primaryKey	string	Una clave principal de 256 bits con codificación base64 para firmar y validar el token SAS.
secondaryConnectionString	string	Cadena de conexión secundario del espacio de nombres creado AuthorizationRule.
secondaryKey	string	Una clave principal de 256 bits con codificación base64 para firmar y validar el token SAS.

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

La respuesta de error indica que el servicio event hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.