Service Microsoft.ApiManagement/apis/schemas 2021-12-01-preview
Définition de ressource Bicep
Le type de ressource service/apis/schemas peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.ApiManagement/service/apis/schemas, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2021-12-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
contentType: 'string'
document: {
components: any()
definitions: any()
value: 'string'
}
}
}
Valeurs de propriétés
service/apis/schemas
Nom | Description | Valeur |
---|---|---|
name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep. |
string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique. |
parent | Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente. |
Nom symbolique de la ressource de type : apis |
properties | Propriétés du schéma d’API. | SchemaContractProperties |
SchemaContractProperties
Nom | Description | Valeur |
---|---|---|
contentType | Doit être un type de média valide utilisé dans un en-tête Content-Type tel que défini dans la RFC 2616. Type de média du document de schéma (par exemple application/json, application/xml). - Swagger Utilisation du schéma application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Utilisation du schéma application/vnd.ms-azure-apim.xsd+xml - OpenApi Utilisation du schéma application/vnd.oai.openapi.components+json - WADL Schema utilisez application/vnd.ms-azure-apim.wadl.grammars+xml . |
string (obligatoire) |
document | Créez ou mettez à jour les propriétés du document de schéma d’API. | SchemaDocumentProperties |
SchemaDocumentProperties
Nom | Description | Valeur |
---|---|---|
components | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v2/v3 uniquement ; sinon, null. | Pour Bicep, vous pouvez utiliser la fonction any(). |
definitions | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v1 uniquement ; sinon, null. | Pour Bicep, vous pouvez utiliser la fonction any(). |
value | Chaîne d’échappement Json définissant le document représentant le schéma. Utilisé pour les schémas autres que Swagger/OpenAPI. | string |
Définition de ressources de modèle ARM
Le type de ressource service/apis/schemas peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.ApiManagement/service/apis/schemas, ajoutez le json suivant à votre modèle.
{
"type": "Microsoft.ApiManagement/service/apis/schemas",
"apiVersion": "2021-12-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Valeurs de propriétés
service/apis/schemas
Nom | Description | Valeur |
---|---|---|
type | Type de ressource | « Microsoft.ApiManagement/service/apis/schemas » |
apiVersion | Version de l’API de ressource | '2021-12-01-preview' |
name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON. |
string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique. |
properties | Propriétés du schéma d’API. | SchemaContractProperties |
SchemaContractProperties
Nom | Description | Valeur |
---|---|---|
contentType | Doit être un type de média valide utilisé dans un en-tête Content-Type tel que défini dans la RFC 2616. Type de média du document de schéma (par exemple, application/json, application/xml). - Swagger Utilisation du schéma application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Utilisation du schéma application/vnd.ms-azure-apim.xsd+xml - OpenApi Utilisation du schéma application/vnd.oai.openapi.components+json - WADL Schema utilisez application/vnd.ms-azure-apim.wadl.grammars+xml . |
chaîne (obligatoire) |
document | Créez ou mettez à jour les propriétés du document de schéma d’API. | SchemaDocumentProperties |
SchemaDocumentProperties
Nom | Description | Valeur |
---|---|---|
components | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v2/v3 uniquement, null dans le cas contraire. | |
definitions | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v1 uniquement, null dans le cas contraire. | |
value | Chaîne d’échappement Json définissant le document représentant le schéma. Utilisé pour les schémas autres que Swagger/OpenAPI. | string |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource service/apis/schémas peut être déployé avec des opérations qui ciblent :
- Groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.ApiManagement/service/apis/schemas, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/schemas@2021-12-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
value = "string"
}
}
})
}
Valeurs de propriétés
service/apis/schemas
Nom | Description | Valeur |
---|---|---|
type | Type de ressource | « Microsoft.ApiManagement/service/apis/schemas@2021-12-01-preview » |
name | Nom de la ressource | chaîne (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique. |
parent_id | ID de la ressource qui est le parent de cette ressource. | ID pour la ressource de type : apis |
properties | Propriétés du schéma d’API. | SchemaContractProperties |
SchemaContractProperties
Nom | Description | Valeur |
---|---|---|
contentType | Doit être un type de média valide utilisé dans un en-tête Content-Type tel que défini dans la RFC 2616. Type de média du document de schéma (par exemple, application/json, application/xml). - Swagger Utilisation du schéma application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Utilisation du schéma application/vnd.ms-azure-apim.xsd+xml - OpenApi Utilisation du schéma application/vnd.oai.openapi.components+json - WADL Schema utilisez application/vnd.ms-azure-apim.wadl.grammars+xml . |
chaîne (obligatoire) |
document | Créez ou mettez à jour les propriétés du document de schéma d’API. | SchemaDocumentProperties |
SchemaDocumentProperties
Nom | Description | Valeur |
---|---|---|
components | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v2/v3 uniquement, null dans le cas contraire. | |
definitions | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v1 uniquement, null dans le cas contraire. | |
value | Chaîne d’échappement Json définissant le document représentant le schéma. Utilisé pour les schémas autres que Swagger/OpenAPI. | string |