Freigeben über


Communication Services - Regenerate Key

Schlüssel neu generieren
Generieren Sie den CommunicationService-Zugriffsschlüssel neu. PrimaryKey und SecondaryKey können nicht gleichzeitig neu generiert werden.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
communicationServiceName
path True

string

Der Name der CommunicationService-Ressource.

RegEx-Muster: ^[-\w]+$

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

uuid

Die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name Typ Beschreibung
keyType

KeyType

Der keyType, der neu generiert werden soll. Muss entweder "primär" oder "sekundär" sein(Groß-/Kleinschreibung wird nicht beachtet).

Antworten

Name Typ Beschreibung
200 OK

CommunicationServiceKeys

Die Schlüsselanforderung wurde erfolgreich neu generiert. Die Antwort enthält den neuen Schlüssel.

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

Regenerate key

Beispielanforderung

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

{
  "keyType": "Primary"
}

Beispiel für eine Antwort

{
  "primaryKey": "1234",
  "primaryConnectionString": "endpoint=http://example.com;accesskey=1234"
}

Definitionen

Name Beschreibung
CommunicationServiceKeys

Eine Klasse, die die Zugriffstasten eines CommunicationService darstellt.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

KeyType

Der keyType, der neu generiert werden soll. Muss entweder "primär" oder "sekundär" sein(Groß-/Kleinschreibung wird nicht beachtet).

RegenerateKeyParameters

Parameter beschreiben die Anforderung zum Generieren von Zugriffstasten

CommunicationServiceKeys

Eine Klasse, die die Zugriffstasten eines CommunicationService darstellt.

Name Typ Beschreibung
primaryConnectionString

string

CommunicationService-Verbindungszeichenfolge, die über den primaryKey erstellt wurde

primaryKey

string

Der primäre Zugriffsschlüssel.

secondaryConnectionString

string

CommunicationService-Verbindungszeichenfolge, die über den secondaryKey erstellt wird

secondaryKey

string

Die sekundäre Zugriffstaste.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

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.

KeyType

Der keyType, der neu generiert werden soll. Muss entweder "primär" oder "sekundär" sein(Groß-/Kleinschreibung wird nicht beachtet).

Name Typ Beschreibung
Primary

string

Secondary

string

RegenerateKeyParameters

Parameter beschreiben die Anforderung zum Generieren von Zugriffstasten

Name Typ Beschreibung
keyType

KeyType

Der keyType, der neu generiert werden soll. Muss entweder "primär" oder "sekundär" sein(Groß-/Kleinschreibung wird nicht beachtet).