Delen via


Gateway - Generate Token

Hiermee haalt u het autorisatietoken voor gedeelde toegang voor de gateway op.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken?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
expiry True

string (date-time)

De verlooptijd van het token. De maximale verlooptijd van het token is ingesteld op 30 dagen. De datum voldoet aan de volgende indeling: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.

keyType True

KeyType

De sleutel die moet worden gebruikt om een gatewaytoken te genereren.

Antwoorden

Name Type Description
200 OK

GatewayTokenContract

De hoofdtekst van het antwoord bevat het autorisatietoken voor de gateway.

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

ApiManagementGatewayGenerateToken

Voorbeeldaanvraag

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

{
  "keyType": "primary",
  "expiry": "2020-04-21T00:44:24.2845269Z"
}

Voorbeeldrespons

{
  "value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

GatewayTokenContract

Gatewaytoegangstoken.

GatewayTokenRequestContract

Gatewaytoken vraagt contracteigenschappen aan.

KeyType

De sleutel die opnieuw wordt gegenereerd.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

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

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

GatewayTokenContract

Gatewaytoegangstoken.

Name Type Description
value

string

De waarde van het verificatietoken voor gedeelde toegang voor de gateway.

GatewayTokenRequestContract

Gatewaytoken vraagt contracteigenschappen aan.

Name Type Default value Description
expiry

string (date-time)

De verlooptijd van het token. De maximale verlooptijd van het token is ingesteld op 30 dagen. De datum voldoet aan de volgende indeling: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.

keyType

KeyType

primary

De sleutel die moet worden gebruikt om een gatewaytoken te genereren.

KeyType

De sleutel die opnieuw wordt gegenereerd.

Waarde Description
primary
secondary