Event Hubs - Authorization Rules - Regenerate Keys

Regenera as cadeias de conexão ACS e SAS para o Hub 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 URI

Name In Required Type Description
authorizationRuleName
path True
  • string

O nome da regra de autorização.

eventHubName
path True
  • string

O nome do Hub de Eventos

namespaceName
path True
  • string

O nome do namespace

resourceGroupName
path True
  • string

Nome do grupo de recursos na assinatura do azure.

subscriptionId
path True
  • string

Credenciais de assinatura que identificam exclusivamente uma assinatura Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API do cliente.

Corpo da solicitação

Name Required Type Description
keyType True

A chave de acesso a ser regenerada.

key
  • string

Opcional, se o valor da chave for fornecido, será definido para KeyType ou conjunto de valor de chave gerado automaticamente para keyType

Respostas

Name Type Description
200 OK

Cadeias de conexão regeneradas com êxito.

Other Status Codes

Resposta de erro do Eventhub descrevendo por que a operação falhou.

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

AccessKeys

Cadeia de conexão Namespace/EventHub

ErrorResponse

A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

KeyType

A chave de acesso a ser regenerada.

RegenerateAccessKeyParameters

Os parâmetros fornecidos para a operação Regra de Autorização regenerada especificam qual chave precisa ser redefinida.

AccessKeys

Cadeia de conexão Namespace/EventHub

Name Type Description
aliasPrimaryConnectionString
  • string

Cadeia de conexão primário do alias se o GEO DR estiver habilitado

aliasSecondaryConnectionString
  • string

Cadeia de conexão secundário do alias se a DR GEO estiver habilitada

keyName
  • string

Uma cadeia de caracteres que descreve o AuthorizationRule.

primaryConnectionString
  • string

Cadeia de conexão primária do Namespace AuthorizationRule criado.

primaryKey
  • string

Uma chave primária de 256 bits codificada em base64 para assinatura e validação do token SAS.

secondaryConnectionString
  • string

Cadeia de conexão secundária do Namespace AuthorizationRule criado.

secondaryKey
  • string

Uma chave primária de 256 bits codificada em base64 para assinatura e validação do token SAS.

ErrorResponse

A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Name Type Description
code
  • string

Código do erro.

message
  • string

Mensagem de erro indicando por que a operação falhou.

KeyType

A chave de acesso a ser regenerada.

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

Os parâmetros fornecidos para a operação Regra de Autorização regenerada especificam qual chave precisa ser redefinida.

Name Type Description
key
  • string

Opcional, se o valor da chave for fornecido, será definido para KeyType ou conjunto de valor de chave gerado automaticamente para keyType

keyType

A chave de acesso a ser regenerada.