Gateway - List Debug Credentials

Referentie

Service:: API Management

API-versie:: 2023-09-01-preview

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=2023-09-01-preview

URI-parameters

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

Aanvraagbody

Name	Vereist	Type	Description
apiId	True	string	Volledige resource-id van een API.
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Doeleinden van foutopsporing van referenties.
credentialsExpireAfter		string	Referenties verlopen in ISO8601-indeling. De maximale duur van de referenties is PT1H. Wanneer eigenschap niet is opgegeven, wordt de waarde PT1H gebruikt.

Antwoorden

Name	Type	Description
200 OK	GatewayDebugCredentialsContract	De antwoordtekst bevat foutopsporingsreferenties voor gebruik in de gateway.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGatewayListDebugCredentials

Sample request

HTTP

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

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

Sample response

Status code:: 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	Gatewayfoutopsporingsreferenties.
GatewayListDebugCredentialsContract	Eigenschappen van foutopsporingsreferenties weergeven.
GatewayListDebugCredentialsContractPurpose	Doeleinden van foutopsporing van referenties.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

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

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout 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.

GatewayDebugCredentialsContract

Gatewayfoutopsporingsreferenties.

Name	Type	Description
token	string	Gatewayfoutopsporingstoken.

GatewayListDebugCredentialsContract

Eigenschappen van foutopsporingsreferenties weergeven.

Name	Type	Description
apiId	string	Volledige resource-id van een API.
credentialsExpireAfter	string	Referenties verlopen in ISO8601-indeling. De maximale duur van de referenties is PT1H. Wanneer eigenschap niet is opgegeven, wordt de waarde PT1H gebruikt.
purposes	GatewayListDebugCredentialsContractPurpose[]	Doeleinden van foutopsporing van referenties.

GatewayListDebugCredentialsContractPurpose

Doeleinden van foutopsporing van referenties.

Name	Type	Description
tracing	string	Het traceringsdoel.

Delen via