Communication Services - Regenerate Key
Ponowne generowanie klucza
Wygeneruj ponownie klucz dostępu communicationService. W tym samym czasie nie można ponownie wygenerować klucza podstawowego i klucza pomocniczego.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/regenerateKey?api-version=2023-04-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
communication
|
path | True |
string |
Nazwa zasobu CommunicationService. Wzorzec wyrażenia regularnego: |
resource
|
path | True |
string |
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter. |
subscription
|
path | True |
string uuid |
Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
keyType |
Typ klucza do ponownego wygenerowania. Musi mieć wartość "primary" lub "secondary" (bez uwzględniania wielkości liter). |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Pomyślnie ukończono ponowne generowanie żądania klucza. Odpowiedź zawiera nowy klucz. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Przykłady
Regenerate key
Przykładowe żądanie
Przykładowa odpowiedź
{
"primaryKey": "1234",
"primaryConnectionString": "endpoint=http://example.com;accesskey=1234"
}
Definicje
Nazwa | Opis |
---|---|
Communication |
Klasa reprezentująca klucze dostępu usługi CommunicationService. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Key |
Typ klucza do ponownego wygenerowania. Musi mieć wartość "primary" lub "secondary" (bez uwzględniania wielkości liter). |
Regenerate |
Parametry opisują żądanie ponownego generowania kluczy dostępu |
CommunicationServiceKeys
Klasa reprezentująca klucze dostępu usługi CommunicationService.
Nazwa | Typ | Opis |
---|---|---|
primaryConnectionString |
string |
Parametry połączenia usługi CommunicationService skonstruowane za pośrednictwem klucza primaryKey |
primaryKey |
string |
Podstawowy klucz dostępu. |
secondaryConnectionString |
string |
Parametry połączenia usługi CommunicationService skonstruowane za pośrednictwem klucza secondaryKey |
secondaryKey |
string |
Pomocniczy klucz dostępu. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
KeyType
Typ klucza do ponownego wygenerowania. Musi mieć wartość "primary" lub "secondary" (bez uwzględniania wielkości liter).
Nazwa | Typ | Opis |
---|---|---|
Primary |
string |
|
Secondary |
string |
RegenerateKeyParameters
Parametry opisują żądanie ponownego generowania kluczy dostępu
Nazwa | Typ | Opis |
---|---|---|
keyType |
Typ klucza do ponownego wygenerowania. Musi mieć wartość "primary" lub "secondary" (bez uwzględniania wielkości liter). |