Freigeben über


Communication Services - List Keys

Dient zum Auflisten von Schlüsseln.
Rufen Sie die Zugriffsschlüssel der CommunicationService-Ressource ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
communicationServiceName
path True

string

Der Name der CommunicationService-Ressource.

Regex pattern: ^[-\w]+$

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

uuid

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

CommunicationServiceKeys

Erfolg. Die Antwort beschreibt die CommunicationService-Zugriffsschlüssel.

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

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

Definitionen

Name Beschreibung
CommunicationServiceKeys

Eine Klasse, die die Zugriffsschlüssel eines CommunicationService darstellt.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

CommunicationServiceKeys

Eine Klasse, die die Zugriffsschlüssel eines CommunicationService darstellt.

Name Typ Beschreibung
primaryConnectionString

string

CommunicationService Verbindungszeichenfolge über den primaryKey erstellt

primaryKey

string

Der primäre Zugriffsschlüssel.

secondaryConnectionString

string

CommunicationService Verbindungszeichenfolge über secondaryKey erstellt

secondaryKey

string

Der sekundäre Zugriffsschlüssel.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.