Service Microsoft.ApiManagement/workspaces/apis/schemas 2023-09-01-preview
Définition de ressource Bicep
Le type de ressource service/workspaces/apis/schemas peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.ApiManagement/service/workspaces/apis/schemas, ajoutez le code Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
contentType: 'string'
document: {
components: any()
definitions: any()
value: 'string'
}
}
}
Valeurs de propriété
service/workspaces/apis/schemas
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep. |
chaîne (obligatoire) |
| parent | Dans Bicep, vous pouvez spécifier la ressource parente d’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 : API |
| Propriétés | Propriétés du schéma d’API. | SchemaContractProperties |
SchemaContractProperties
| Nom | Description | Valeur |
|---|---|---|
| contentType | Doit être un type multimé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 Schéma utiliser application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schéma utiliser application/vnd.ms-azure-apim.xsd+xml - OpenApi Schéma utiliser application/vnd.oai.openapi.components+json - WADL Schema utiliser application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema utiliser application/vnd.ms-azure-apim.odata.schema - gRPC Schema utiliser text/protobuf. |
chaîne (obligatoire) |
| document | Créez ou mettez à jour les propriétés du document de schéma d’API. | SchemaDocumentProperties (obligatoire) |
SchemaDocumentProperties
| Nom | Description | Valeur |
|---|---|---|
| Composants | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v2/v3 uniquement, null sinon. | Pour Bicep, vous pouvez utiliser la fonction any(). |
| Définitions | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v1 uniquement, null sinon. | Pour Bicep, vous pouvez utiliser la fonction any(). |
| valeur | Chaîne d’échappement JSON définissant le document représentant le schéma. Utilisé pour les schémas autres que Swagger/OpenAPI. | corde |
Définition de ressource de modèle ARM
Le type de ressource service/workspaces/apis/schemas peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.ApiManagement/service/workspaces/apis/schemas, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/schemas",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Valeurs de propriété
service/workspaces/apis/schemas
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft.ApiManagement/service/workspaces/apis/schemas' |
| apiVersion | Version de l’API de ressource | '2023-09-01-preview' |
| nom | Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON. |
chaîne (obligatoire) |
| Propriétés | Propriétés du schéma d’API. | SchemaContractProperties |
SchemaContractProperties
| Nom | Description | Valeur |
|---|---|---|
| contentType | Doit être un type multimé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 Schéma utiliser application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schéma utiliser application/vnd.ms-azure-apim.xsd+xml - OpenApi Schéma utiliser application/vnd.oai.openapi.components+json - WADL Schema utiliser application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema utiliser application/vnd.ms-azure-apim.odata.schema - gRPC Schema utiliser text/protobuf. |
chaîne (obligatoire) |
| document | Créez ou mettez à jour les propriétés du document de schéma d’API. | SchemaDocumentProperties (obligatoire) |
SchemaDocumentProperties
| Nom | Description | Valeur |
|---|---|---|
| Composants | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v2/v3 uniquement, null sinon. | |
| Définitions | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v1 uniquement, null sinon. | |
| valeur | Chaîne d’échappement JSON définissant le document représentant le schéma. Utilisé pour les schémas autres que Swagger/OpenAPI. | corde |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource service/workspaces/apis/schemas 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 de ressource
Pour créer une ressource Microsoft.ApiManagement/service/workspaces/apis/schemas, ajoutez le terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
value = "string"
}
}
})
}
Valeurs de propriété
service/workspaces/apis/schemas
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-09-01-preview » |
| nom | Nom de la ressource | chaîne (obligatoire) |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : api |
| Propriétés | Propriétés du schéma d’API. | SchemaContractProperties |
SchemaContractProperties
| Nom | Description | Valeur |
|---|---|---|
| contentType | Doit être un type multimé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 Schéma utiliser application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schéma utiliser application/vnd.ms-azure-apim.xsd+xml - OpenApi Schéma utiliser application/vnd.oai.openapi.components+json - WADL Schema utiliser application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema utiliser application/vnd.ms-azure-apim.odata.schema - gRPC Schema utiliser text/protobuf. |
chaîne (obligatoire) |
| document | Créez ou mettez à jour les propriétés du document de schéma d’API. | SchemaDocumentProperties (obligatoire) |
SchemaDocumentProperties
| Nom | Description | Valeur |
|---|---|---|
| Composants | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v2/v3 uniquement, null sinon. | |
| Définitions | Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v1 uniquement, null sinon. | |
| valeur | Chaîne d’échappement JSON définissant le document représentant le schéma. Utilisé pour les schémas autres que Swagger/OpenAPI. | corde |