Metadata Schemas - Head

Service:

API Center

API-versie:

2024-03-01

Controleert of het opgegeven metagegevensschema bestaat.

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

URI-parameters

Name	In	Vereist	Type	Description
metadataSchemaName	path	True	string	De naam van het metagegevensschema. Regex-patroon: ^[a-zA-Z0-9-]{3,90}$
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string	De naam van de Azure API Center-service. Regex-patroon: ^[a-zA-Z0-9-]{3,90}$
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.

Antwoorden

Name	Type	Description
200 OK		De aanvraag is geslaagd.
Other Status Codes	ErrorResponse	Een onverwacht foutbericht.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

MetadataSchemas_Head

Voorbeeldaanvraag

HTTP

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

Java

/**
 * Samples for MetadataSchemas Head.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Head.json
     */
    /**
     * Sample code: MetadataSchemas_Head.
     * 
     * @param manager Entry point to ApiCenterManager.
     */
    public static void metadataSchemasHead(com.azure.resourcemanager.apicenter.ApiCenterManager manager) {
        manager.metadataSchemas().headWithResponse("contoso-resources", "contoso", "author",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apicenter import ApiCenterMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apicenter
# USAGE
    python metadata_schemas_head.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiCenterMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.metadata_schemas.head(
        resource_group_name="contoso-resources",
        service_name="contoso",
        metadata_schema_name="author",
    )
    print(response)


# x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Head.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapicenter_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apicenter/armapicenter"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Head.json
func ExampleMetadataSchemasClient_Head() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapicenter.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewMetadataSchemasClient().Head(ctx, "contoso-resources", "contoso", "author", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureAPICenter } = require("@azure/arm-apicenter");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Checks if specified metadata schema exists.
 *
 * @summary Checks if specified metadata schema exists.
 * x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Head.json
 */
async function metadataSchemasHead() {
  const subscriptionId =
    process.env["APICENTER_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APICENTER_RESOURCE_GROUP"] || "contoso-resources";
  const serviceName = "contoso";
  const metadataSchemaName = "author";
  const credential = new DefaultAzureCredential();
  const client = new AzureAPICenter(credential, subscriptionId);
  const result = await client.metadataSchemas.head(
    resourceGroupName,
    serviceName,
    metadataSchemaName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

Statuscode:

200

Etag: AAAAAAAACCI=

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

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.