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


Communication Services - List Keys

Отображает ключи.
Получение ключей доступа ресурса CommunicationService.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/listKeys?api-version=2023-03-31

Параметры URI

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

string

Имя ресурса CommunicationService.

Regex pattern: ^[-\w]+$

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

uuid

Идентификатор целевой подписки. Значение должно быть UUID.

api-version
query True

string

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

Ответы

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

CommunicationServiceKeys

Успешно. В ответе описываются ключи доступа CommunicationService.

Other Status Codes

ErrorResponse

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

Примеры

List keys

Sample Request

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource/listKeys?api-version=2023-03-31

Sample Response

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

Определения

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

Класс , представляющий ключи доступа объекта CommunicationService.

ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

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

CommunicationServiceKeys

Класс , представляющий ключи доступа объекта CommunicationService.

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

string

Строка подключения CommunicationService, созданные с помощью primaryKey

primaryKey

string

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

secondaryConnectionString

string

Строка подключения CommunicationService, созданные с помощью secondaryKey

secondaryKey

string

Вторичный ключ доступа.

ErrorAdditionalInfo

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

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

object

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

type

string

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

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

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

ErrorResponse

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

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

ErrorDetail

Объект error.