Apis - Head
Ellenőrzi, hogy létezik-e megadott API.
HEAD https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}?api-version=2024-03-01
URI-paraméterek
| Name | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
api
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$ |
Az API neve. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket. |
|
service
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$ |
Az Azure API Center szolgáltatás neve. |
|
subscription
|
path | True |
string (uuid) |
A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie. |
|
workspace
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$ |
A munkaterület neve. |
|
api-version
|
query | True |
string minLength: 1 |
A művelethez használandó API-verzió. |
Válaszok
| Name | Típus | Description |
|---|---|---|
| 200 OK |
A kérés sikeres volt. |
|
| Other Status Codes |
Váratlan hibaválasz. |
Biztonság
azure_auth
Azure Active Directory Oauth2-folyamat.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
| Name | Description |
|---|---|
| user_impersonation | a felhasználói fiók megszemélyesítése |
Példák
Apis_Head
Mintakérelem
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
Mintaválasz
Etag: AAAAAAAACCI=
Definíciók
| Name | Description |
|---|---|
|
Error |
Az erőforrás-kezelési hiba további információi. |
|
Error |
A hiba részletei. |
|
Error |
Hibaválasz |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
| Name | Típus | Description |
|---|---|---|
| info |
object |
A további információk. |
| type |
string |
A további információtípus. |
ErrorDetail
A hiba részletei.
| Name | Típus | Description |
|---|---|---|
| additionalInfo |
A hiba további információi. |
|
| code |
string |
A hibakód. |
| details |
A hiba részletei. |
|
| message |
string |
A hibaüzenet. |
| target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
| Name | Típus | Description |
|---|---|---|
| error |
A hibaobjektum. |