Condividi tramite


Authorization Rules - Namespaces - Regenerate Keys

Rigenera le stringhe di connessione primaria o secondaria per lo spazio dei nomi specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
authorizationRuleName
path True

string

Nome della regola di autorizzazione.

namespaceName
path True

string

Nome dello spazio dei nomi

Criterio di espressione regolare: ^[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.

Corpo della richiesta

Nome Necessario Tipo Descrizione
keyType True

KeyType

Chiave di accesso da rigenerare.

key

string

Facoltativo, se il valore della chiave specificato, è impostato per KeyType o il valore chiave generato automaticamente impostato per keyType

Risposte

Nome Tipo Descrizione
200 OK

AccessKeys

Stringhe di connessione rigenerate 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

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

NameSpaceAuthorizationRuleRegenerateKey

Esempio di richiesta

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-8980/authorizationRules/sdk-Authrules-8929/regenerateKeys?api-version=2024-01-01

{
  "keyType": "PrimaryKey"
}

Risposta di esempio

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-8980.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-8929;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-8980.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-8929;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-Authrules-8929"
}

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.

KeyType

Chiave di accesso da rigenerare.

RegenerateAccessKeyParameters

I parametri forniti all'operazione Rigenera regola di autorizzazione specifica la chiave da reimpostare.

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.

KeyType

Chiave di accesso da rigenerare.

Nome Tipo Descrizione
PrimaryKey

string

SecondaryKey

string

RegenerateAccessKeyParameters

I parametri forniti all'operazione Rigenera regola di autorizzazione specifica la chiave da reimpostare.

Nome Tipo Descrizione
key

string

Facoltativo, se il valore della chiave specificato, è impostato per KeyType o il valore chiave generato automaticamente impostato per keyType

keyType

KeyType

Chiave di accesso da rigenerare.