Event Hubs - Authorization Rules - Regenerate Keys

Regenera 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}/regenerateKeys?api-version=2021-06-01-preview

Parámetros de identificador URI

Name In Required Type Description
authorizationRuleName
path True
  • string

Nombre de la regla de autorización.

eventHubName
path True
  • string

Nombre del centro de eventos

namespaceName
path True
  • string

Nombre del espacio de nombres

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.

Cuerpo de la solicitud

Name Required Type Description
keyType True

Clave de acceso que se va a regenerar.

key
  • string

Opcional, si se proporciona el valor de clave, se establece para KeyType o para keytype generado automáticamente para keyType.

Respuestas

Name Type Description
200 OK

Cadenas de conexión regeneradas correctamente.

Other Status Codes

Respuesta de error del centro de eventos que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

EventHubAuthorizationRuleRegenerateKey

Sample Request

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-1534/regenerateKeys?api-version=2021-06-01-preview

{
  "keyType": "PrimaryKey"
}

Sample Response

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

Definiciones

AccessKeys

Espacio de nombres/Cadena de conexión de EventHub

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.

KeyType

Clave de acceso que se va a regenerar.

RegenerateAccessKeyParameters

Los parámetros proporcionados a la operación Regenerar regla de autorización especifican qué clave debe restablecerse.

AccessKeys

Espacio de nombres/Cadena de conexión de EventHub

Name Type 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 secundaria 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 secundaria 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.

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.

Name Type Description
code
  • string

Código de error.

message
  • string

Mensaje de error que indica por qué se produjo un error en la operación.

KeyType

Clave de acceso que se va a regenerar.

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

Los parámetros proporcionados a la operación Regenerar regla de autorización especifican qué clave debe restablecerse.

Name Type Description
key
  • string

Opcional, si se proporciona el valor de clave, se establece para KeyType o para keytype generado automáticamente para keyType.

keyType

Clave de acceso que se va a regenerar.