Gateway - Regenerate Key
Generiert den angegebenen Gatewayschlüssel neu, wobei alle damit erstellten Token ungültig werden.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey?api-version=2021-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
gateway
|
path | True |
string |
Gatewayentitätsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Darf nicht über den Wert "verwaltet" verfügen |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. |
service
|
path | True |
string |
Der Name des API Management-Diensts. RegEx-Muster: |
subscription
|
path | True |
string |
Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf. |
api-version
|
query | True |
string |
Version der API, die mit der Clientanforderung verwendet werden soll. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
keyType | True |
Der neu generierte Schlüssel. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
204 No Content |
Schlüssel erfolgreich neu generiert |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ApiManagementGatewayRegenerateKey
Beispielanforderung
Beispiel für eine Antwort
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehlerfeldvertrag. |
Error |
Fehlerantwort. |
Gateway |
Vertragseigenschaften der Gatewayschlüsselregenerationsanforderung. |
Key |
Der neu generierte Schlüssel. |
ErrorFieldContract
Fehlerfeldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
error.details |
Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
GatewayKeyRegenerationRequestContract
Vertragseigenschaften der Gatewayschlüsselregenerationsanforderung.
Name | Typ | Beschreibung |
---|---|---|
keyType |
Der neu generierte Schlüssel. |
KeyType
Der neu generierte Schlüssel.
Name | Typ | Beschreibung |
---|---|---|
primary |
string |
|
secondary |
string |