Event Hubs - Authorization Rules - Regenerate Keys

Повторно создает строки подключения ACS и SAS для концентратора событий.

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

Параметры URI

Name In Required Type Description
authorizationRuleName
path True
  • string

Имя правила авторизации.

eventHubName
path True
  • string

Имя концентратора событий

namespaceName
path True
  • string

Имя пространства имен

resourceGroupName
path True
  • string

Имя группы ресурсов в подписке Azure.

subscriptionId
path True
  • string

Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписку. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True
  • string

Версия API клиента.

Текст запроса

Name Required Type Description
keyType True

Ключ доступа для повторного создания.

key
  • string

Необязательный, если указано значение ключа, задается для KeyType или автоматически созданного значения ключа для keyType.

Ответы

Name Type Description
200 OK

Строки подключения успешно созданы повторно.

Other Status Codes

Ответ об ошибке концентратора событий, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

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

Определения

AccessKeys

Namespace/EventHub Connection String

ErrorResponse

Ответ об ошибке указывает, что служба концентратора событий не может обработать входящий запрос. Причина указана в сообщении об ошибке.

KeyType

Ключ доступа для повторного создания.

RegenerateAccessKeyParameters

Параметры, предоставленные для операции повторного создания правила авторизации, указывают, какой ключ необходимо сбросить.

AccessKeys

Namespace/EventHub Connection String

Name Type Description
aliasPrimaryConnectionString
  • string

Основной строка подключения псевдонима, если включен геоизбыточное аварийное восстановление

aliasSecondaryConnectionString
  • string

Дополнительный строка подключения псевдонима, если включена геоизбыточное аварийное восстановление

keyName
  • string

Строка, описывающая AuthorizationRule.

primaryConnectionString
  • string

Основной строка подключения созданного пространства имен AuthorizationRule.

primaryKey
  • string

256-битный первичный ключ в кодировке Base64 для подписи и проверки маркера SAS.

secondaryConnectionString
  • string

Вторичная строка подключения созданного пространства имен AuthorizationRule.

secondaryKey
  • string

256-битный первичный ключ в кодировке Base64 для подписи и проверки маркера SAS.

ErrorResponse

Ответ об ошибке указывает, что служба концентратора событий не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Name Type Description
code
  • string

Код ошибки.

message
  • string

Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

KeyType

Ключ доступа для повторного создания.

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

Параметры, предоставленные для операции повторного создания правила авторизации, указывают, какой ключ необходимо сбросить.

Name Type Description
key
  • string

Необязательный, если указано значение ключа, задается для KeyType или автоматически созданного значения ключа для keyType.

keyType

Ключ доступа для повторного создания.