Поделиться через

Hybrid Connections - List Keys

Служба:
Relay
Версия API:
2024-01-01

Основные и вторичные строки подключения к гибридному подключению.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/listKeys?api-version=2024-01-01

Параметры URI

Имя В Обязательно Тип Описание
authorizationRuleName
 path True

string

minLength: 1

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

string

minLength: 1

Имя гибридного подключения.
namespaceName
 path True

string

minLength: 6
maxLength: 50

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

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId
 path True

string

minLength: 1

Идентификатор целевой подписки.
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

AccessKeys

Операция Azure успешно завершена.
Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

RelayHybridConnectionAuthorizationRuleListKey

Образец запроса

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/hybridConnections/example-Relay-Hybrid-01/authorizationRules/example-RelayAuthRules-01/listKeys?api-version=2024-01-01

Пример ответа

Код состояния:
200 
{
  "keyName": "example-RelayAuthRules-01",
  "primaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "secondaryKey": "############################################"
}

Определения

Имя Описание
AccessKeys

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

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

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

Ответ на ошибку

AccessKeys

Object

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

Имя Тип Описание
keyName

string

Строка, описывающая правило авторизации.
primaryConnectionString

string

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

string

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

string

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

string

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

ErrorAdditionalInfo

Object

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

Имя Тип Описание
info

object

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

string

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

ErrorDetail

Object

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

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