Dela via


Apis - Head

Kontrollerar om det angivna API:et finns.

HEAD https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}?api-version=2024-03-01

URI-parametrar

Name I Obligatorisk Typ Description
apiName
path True

string

Namnet på API:et.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9-]{3,90}$

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName
path True

string

Namnet på Azure API Center-tjänsten.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9-]{3,90}$

subscriptionId
path True

string

uuid

ID för målprenumerationen. Värdet måste vara ett UUID.

workspaceName
path True

string

Namnet på arbetsytan.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9-]{3,90}$

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

Begäran har slutförts.

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Apis_Head

Exempelbegäran

HEAD https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api?api-version=2024-03-01

Exempelsvar

Etag: AAAAAAAACCI=

Definitioner

Name Description
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.