Metadata Schemas - Get

Referentie

Service:: API Center

API-versie:: 2024-03-01

Retourneert details van het metagegevensschema.

GET 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	MetadataSchema	De Azure-bewerking is voltooid. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Een onverwacht foutbericht.

Name

Type

Description

200 OK

MetadataSchema

De Azure-bewerking is voltooid.

Kopteksten

ETag: string

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_Get

Voorbeeldaanvraag

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


/**
 * Samples for MetadataSchemas Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Get.json
     */
    /**
     * Sample code: MetadataSchemas_Get.
     * 
     * @param manager Entry point to ApiCenterManager.
     */
    public static void metadataSchemasGet(com.azure.resourcemanager.apicenter.ApiCenterManager manager) {
        manager.metadataSchemas().getWithResponse("contoso-resources", "contoso", "lastName",
            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

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_get.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.get(
        resource_group_name="contoso-resources",
        service_name="contoso",
        metadata_schema_name="lastName",
    )
    print(response)


# x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Get.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

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_Get.json
func ExampleMetadataSchemasClient_Get() {
	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)
	}
	res, err := clientFactory.NewMetadataSchemasClient().Get(ctx, "contoso-resources", "contoso", "lastName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MetadataSchema = armapicenter.MetadataSchema{
	// 	Name: to.Ptr("author"),
	// 	Type: to.Ptr("Microsoft.ApiCenter/services/metadataSchemas"),
	// 	ID: to.Ptr("/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author"),
	// 	SystemData: &armapicenter.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-03T18:27:09.128Z"); return t}()),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-03T18:27:09.128Z"); return t}()),
	// 	},
	// 	Properties: &armapicenter.MetadataSchemaProperties{
	// 		Schema: to.Ptr("{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}"),
	// 		AssignedTo: []*armapicenter.MetadataAssignment{
	// 			{
	// 				Deprecated: to.Ptr(true),
	// 				Entity: to.Ptr(armapicenter.MetadataAssignmentEntityAPI),
	// 		}},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Returns details of the metadata schema.
 *
 * @summary Returns details of the metadata schema.
 * x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Get.json
 */
async function metadataSchemasGet() {
  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 = "lastName";
  const credential = new DefaultAzureCredential();
  const client = new AzureAPICenter(credential, subscriptionId);
  const result = await client.metadataSchemas.get(
    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

{
  "type": "Microsoft.ApiCenter/services/metadataSchemas",
  "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author",
  "name": "author",
  "systemData": {
    "createdAt": "2023-07-03T18:27:09.128871Z",
    "lastModifiedAt": "2023-07-03T18:27:09.1288716Z"
  },
  "properties": {
    "assignedTo": [
      {
        "entity": "api",
        "deprecated": true
      }
    ],
    "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}"
  }
}

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
MetadataAssignment	Toewijzingsmetagegevens
MetadataAssignmentEntity	Toewijzingsentiteit voor metagegevens
MetadataSchema	Metagegevensschema-entiteit. Wordt gebruikt voor het definiëren van metagegevens voor de entiteiten in de API-catalogus.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

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.

MetadataAssignment

Toewijzingsmetagegevens

Name	Type	Description
deprecated	boolean	Afgeschafte toewijzing
entity	MetadataAssignmentEntity	De entiteiten waarop dit metagegevensschemaonderdeel wordt toegepast.
required	boolean	Vereiste toewijzing

MetadataAssignmentEntity

Toewijzingsentiteit voor metagegevens

Name	Type	Description
api	string	Toegewezen aan API
deployment	string	Toegewezen aan implementatie
environment	string	Toegewezen aan omgeving

MetadataSchema

Metagegevensschema-entiteit. Wordt gebruikt voor het definiëren van metagegevens voor de entiteiten in de API-catalogus.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.assignedTo	MetadataAssignment[]	De toegewezen personen
properties.schema	string	Het schema dat het type definieert.
systemData	systemData	Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

Delen via

Metadata Schemas - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

MetadataSchemas_Get

Voorbeeldaanvraag

Voorbeeldrespons

Definities

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

MetadataAssignment

MetadataAssignmentEntity

MetadataSchema

systemData

Aanvullende resources