Gateway - Regenerate Key

Service:

API Management

API-versie:

2024-05-01

Genereert de opgegeven gatewaysleutel opnieuw die alle tokens ongeldig maakt die ermee zijn gemaakt.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey?api-version=2024-05-01

URI-parameters

Name	In	Vereist	Type	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	Gateway-entiteits-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Mag geen waarde 'beheerd' hebben
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
keyType	True	KeyType	De sleutel die opnieuw wordt gegenereerd.

Antwoorden

Name	Type	Description
204 No Content		Sleutel is opnieuw gegenereerd
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGatewayRegenerateKey

Voorbeeldaanvraag

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gwId/regenerateKey?api-version=2024-05-01

{
  "keyType": "primary"
}

Voorbeeldrespons

Statuscode:

204

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GatewayKeyRegenerationRequestContract	Contracteigenschappen voor het opnieuw genereren van gatewaysleutels.
KeyType	De sleutel die opnieuw wordt gegenereerd.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GatewayKeyRegenerationRequestContract

Object

Contracteigenschappen voor het opnieuw genereren van gatewaysleutels.

Name	Type	Description
keyType	KeyType	De sleutel die opnieuw wordt gegenereerd.

KeyType

Inventarisatie

De sleutel die opnieuw wordt gegenereerd.

Waarde	Description
primary
secondary