Topics – Authorization Rules - Regenerate Keys

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys?api-version=2021-11-01

Параметры URI

Name In Required Type Description
authorizationRuleName
path True
  • string

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

namespaceName
path True
  • string

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

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

topicName
path True
  • string

Имя раздела.

api-version
query True
  • string

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

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

Name Required Type Description
keyType True

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

key
  • string

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

Ответы

Name Type Description
200 OK

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

Other Status Codes

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

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

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 олицетворение учетной записи пользователя

Примеры

TopicAuthorizationRuleRegenerateKey

Sample Request

POST https://management.azure.com/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace8408/topics/sdk-Topics2075/authorizationRules/sdk-Authrules5067/regenerateKeys?api-version=2021-11-01
{
  "keyType": "PrimaryKey"
}

Sample Response

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984",
  "primaryKey": "#############################################",
  "secondaryKey": "#############################################",
  "keyName": "sdk-AuthRules-4310"
}

Определения

AccessKeys

Строка подключения пространства имен или ServiceBus

Error

Объект ошибки.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorResponse

Ответ об ошибке управления ресурсами.

KeyType

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

RegenerateAccessKeyParameters

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

AccessKeys

Строка подключения пространства имен или ServiceBus

Name Type Description
aliasPrimaryConnectionString
  • string

Первичная строка подключения псевдонима, если географическое восстановление включено

aliasSecondaryConnectionString
  • string

Вторичная строка подключения псевдонима, если географическое восстановление включено

keyName
  • string

Строка с описанием правила авторизации.

primaryConnectionString
  • string

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

primaryKey
  • string

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

secondaryConnectionString
  • string

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

secondaryKey
  • string

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

Error

Объект ошибки.

Name Type Description
additionalInfo

Дополнительные сведения об ошибке.

code
  • string

Код ошибки.

details

Сведения об ошибке.

message
  • string

Сообщение об ошибке.

target
  • string

Цель ошибки.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Name Type Description
info
  • object

Дополнительные сведения.

type
  • string

Тип дополнительных сведений.

ErrorResponse

Ответ об ошибке управления ресурсами.

Name Type Description
error

Объект ошибки.

KeyType

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

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

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

Name Type Description
key
  • string

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

keyType

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