Metadata Schemas - Create Or Update
Crée ou met à jour un schéma de métadonnées existant.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/metadataSchemas/{metadataSchemaName}?api-version=2024-03-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
metadata
|
path | True |
string |
Nom du schéma de métadonnées. Modèle d’expression régulière: |
resource
|
path | True |
string |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
service
|
path | True |
string |
Nom du service Azure API Center. Modèle d’expression régulière: |
subscription
|
path | True |
string uuid |
ID de l’abonnement cible. La valeur doit être un UUID. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
properties.schema | True |
string |
Schéma définissant le type. |
properties.assignedTo |
Les personnes assignées |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
L’opération de mise à jour de la ressource « MetadataSchema » a réussi En-têtes ETag: string |
|
201 Created |
L’opération de création de la ressource « MetadataSchema » a réussi En-têtes ETag: string |
|
Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
MetadataSchemas_CreateOrUpdate
Exemple de requête
PUT 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
{
"properties": {
"assignedTo": [
{
"entity": "api",
"deprecated": true
}
],
"schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}"
}
}
Exemple de réponse
{
"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]+$\"}"
}
}
{
"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]+$\"}"
}
}
Définitions
Nom | Description |
---|---|
created |
Type d’identité qui a créé la ressource. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Metadata |
Métadonnées d’affectation |
Metadata |
Entité d’affectation pour les métadonnées |
Metadata |
Entité de schéma de métadonnées. Utilisé pour définir des métadonnées pour les entités dans le catalogue d’API. |
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
createdByType
Type d’identité qui a créé la ressource.
Nom | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires |
type |
string |
Type d’informations supplémentaires. |
ErrorDetail
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |
MetadataAssignment
Métadonnées d’affectation
Nom | Type | Description |
---|---|---|
deprecated |
boolean |
Affectation déconseillée |
entity |
Entités auxquelles ce composant de schéma de métadonnées est appliqué. |
|
required |
boolean |
Affectation requise |
MetadataAssignmentEntity
Entité d’affectation pour les métadonnées
Nom | Type | Description |
---|---|---|
api |
string |
Affecté à l’API |
deployment |
string |
Affecté au déploiement |
environment |
string |
Affecté à l’environnement |
MetadataSchema
Entité de schéma de métadonnées. Utilisé pour définir des métadonnées pour les entités dans le catalogue d’API.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} » |
name |
string |
nom de la ressource. |
properties.assignedTo |
Les personnes assignées |
|
properties.schema |
string |
Schéma définissant le type. |
systemData |
Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. |
|
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
systemData
Métadonnées relatives à la création et à la dernière modification de la ressource.
Nom | Type | Description |
---|---|---|
createdAt |
string |
Horodatage de la création de ressources (UTC). |
createdBy |
string |
Identité qui a créé la ressource. |
createdByType |
Type d’identité qui a créé la ressource. |
|
lastModifiedAt |
string |
Horodatage de la dernière modification de la ressource (UTC) |
lastModifiedBy |
string |
Identité qui a modifié la dernière ressource. |
lastModifiedByType |
Type d’identité qui a modifié la dernière ressource. |