Authorization Rules - Event Hubs - List Keys

Riferimento

Service:: Event Hubs

API Version:: 2024-01-01

Ottiene le stringhe di connessione ACS e SAS per l'hub eventi.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
authorizationRuleName	path	True	string	Nome della regola di autorizzazione.
eventHubName	path	True	string	Nome dell'hub eventi
namespaceName	path	True	string	Nome dello spazio dei nomi Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione di Azure.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	AccessKeys	Le stringhe di connessione sono state restituite correttamente.
Other Status Codes	ErrorResponse	Risposta di errore eventhub che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
AccessKeys	Spazio dei nomi/Stringa di connessione EventHub
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore indica che il servizio Hub eventi non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

AccessKeys

Spazio dei nomi/Stringa di connessione EventHub

Nome	Tipo	Descrizione
aliasPrimaryConnectionString	string	Stringa di connessione primario dell'alias se GEO DR è abilitato
aliasSecondaryConnectionString	string	Stringa di connessione secondario dell'alias se GEO DR è abilitato
keyName	string	Stringa che descrive AuthorizationRule.
primaryConnectionString	string	Stringa di connessione primaria dello spazio dei nomi creato AuthorizationRule.
primaryKey	string	Chiave primaria a 256 bit con codifica Base 64 per la firma e la convalida del token di firma di accesso condiviso.
secondaryConnectionString	string	Stringa di connessione secondario dello spazio dei nomi creato AuthorizationRule.
secondaryKey	string	Chiave primaria a 256 bit con codifica Base 64 per la firma e la convalida del token di firma di accesso condiviso.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore indica che il servizio Hub eventi non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

Share via