Event Hubs - Authorization Rules - Regenerate Keys

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

Name In Required Type Description
authorizationRuleName
path True
  • string

O nome da regra da autorização.

eventHubName
path True
  • string

O nome do Centro de Eventos

namespaceName
path True
  • string

O nome Namespace

resourceGroupName
path True
  • string

Nome do grupo de recursos dentro da subscrição azul.

subscriptionId
path True
  • string

Credenciais de subscrição que identificam exclusivamente uma subscrição Microsoft Azure. O ID de subscrição faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão API do cliente.

Corpo do Pedido

Name Required Type Description
keyType True

A chave de acesso para regenerar.

key
  • string

Opcional, se o valor chave fornecido for definido para KeyType ou conjunto de valor de chave autogerido para keyType

Respostas

Name Type Description
200 OK

As cordas de ligação regeneraram-se com sucesso.

Other Status Codes

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

Segurança

azure_auth

Flow de Azure Ative Directory OAuth2

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

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 Event Hub não é capaz de processar o pedido de entrada. A razão é fornecida na mensagem de erro.

KeyType

A chave de acesso para regenerar.

RegenerateAccessKeyParameters

Os parâmetros fornecidos à operação Regra de Autorização regeneração especificam qual a chave que deve ser reposta.

AccessKeys

Cadeia de conexão Namespace/EventHub

Name Type Description
aliasPrimaryConnectionString
  • string

Cadeia de ligação primária do pseudónimo se o GEO DR estiver ativado

aliasSecondaryConnectionString
  • string

Cadeia de ligação secundário do pseudónimo se o GEO DR estiver habilitado

keyName
  • string

Uma corda que descreve a Regra de Autorização.

primaryConnectionString
  • string

Cadeia de ligação primária da regra de autorização de espaço de nome criado.

primaryKey
  • string

Uma chave primária codificada de 64 bits para assinar e validar o token SAS.

secondaryConnectionString
  • string

Cadeia de ligação secundários da regra de autorização de espaço de nome criado.

secondaryKey
  • string

Uma chave primária codificada de 64 bits para assinar e validar o token SAS.

ErrorResponse

A resposta de erro indica que o serviço Event Hub não é capaz de processar o pedido de entrada. A razão é fornecida na mensagem de erro.

Name Type Description
code
  • string

Código de erro.

message
  • string

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

KeyType

A chave de acesso para regenerar.

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

Os parâmetros fornecidos à operação Regra de Autorização regeneração especificam qual a chave que deve ser reposta.

Name Type Description
key
  • string

Opcional, se o valor chave fornecido for definido para KeyType ou conjunto de valor de chave autogerido para keyType

keyType

A chave de acesso para regenerar.