Delen via

Gateway - List Debug Credentials

Service:
API Management
API-versie:
2024-05-01

Maak nieuwe foutopsporingsreferenties voor de gateway.

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

string (arm-id)

Volledige resource-id van een API.
purposes True

GatewayListDebugCredentialsContractPurpose[]

Doeleinden van foutopsporingsreferenties.
credentialsExpireAfter

string (duration)

Referenties verlopen in ISO8601 indeling. De maximale duur van de referenties is PT1H. Wanneer de eigenschap niet is opgegeven, wordt de waarde PT1H gebruikt.

Antwoorden

Name Type Description
200 OK

GatewayDebugCredentialsContract

De hoofdtekst van het antwoord bevat foutopsporingsreferenties die moeten worden gebruikt in de gateway.
Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

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

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGatewayListDebugCredentials

Voorbeeldaanvraag

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

{
  "credentialsExpireAfter": "PT1H",
  "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1",
  "purposes": [
    "tracing"
  ]
}

Voorbeeldrespons

Statuscode:
200 
{
  "token": "p=tracing&aid=a1&ex=20230504000000&sn=ZdfxSJoCsOJE0/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/8LchGl7gu/Q=="
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie
GatewayDebugCredentialsContract

Gateway-foutopsporingsreferenties.
GatewayListDebugCredentialsContract

Lijst met eigenschappen voor foutopsporing van referenties.
GatewayListDebugCredentialsContractPurpose

Doeleinden van foutopsporingsreferenties.

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.

GatewayDebugCredentialsContract

Object

Gateway-foutopsporingsreferenties.

Name Type Description
token

string

Gateway-foutopsporingstoken.

GatewayListDebugCredentialsContract

Object

Lijst met eigenschappen voor foutopsporing van referenties.

Name Type Description
apiId

string (arm-id)

Volledige resource-id van een API.
credentialsExpireAfter

string (duration)

Referenties verlopen in ISO8601 indeling. De maximale duur van de referenties is PT1H. Wanneer de eigenschap niet is opgegeven, wordt de waarde PT1H gebruikt.
purposes

GatewayListDebugCredentialsContractPurpose[]

Doeleinden van foutopsporingsreferenties.

GatewayListDebugCredentialsContractPurpose

Inventarisatie

Doeleinden van foutopsporingsreferenties.

Waarde Description
tracing

Het traceringsdoel.