Condividi tramite

Servizio Microsoft.ApiManagement/apis/schemas 2021-04-01-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa service/apis/schemas può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/apis/schemas, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    contentType: 'string'
    document: {
      components: any(Azure.Bicep.Types.Concrete.AnyType)
      definitions: any(Azure.Bicep.Types.Concrete.AnyType)
      value: 'string'
    }
  }
}

Valori delle proprietà

ApiSchemaContractProperties

Nome Descrizione Valore
contentType Deve essere un tipo di supporto valido utilizzato in un'intestazione Content-Type, come definito nella RFC 2616. Tipo di supporto del documento dello schema ,ad esempio application/json, application/xml.
- Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema usare application/vnd.ms-azure-apim.wadl.grammars+xml.		 stringa (obbligatorio)
documento Creare o aggiornare le proprietà del documento dello schema API. ApiSchemaDocumentProperties

ApiSchemaDocumentProperties

Nome Descrizione Valore
Componenti Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v2/v3, null in caso contrario. qualunque
Definizioni Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v1, null in caso contrario. qualunque
valore Stringa con escape JSON che definisce il documento che rappresenta lo schema. Usato per schemi diversi da Swagger/OpenAPI. corda

Microsoft.ApiManagement/service/apis/schemas

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio/API
proprietà Proprietà dello schema DELL'API. ApiSchemaContractProperties

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/apis/schemas può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/apis/schemas, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service/apis/schemas",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "properties": {
    "contentType": "string",
    "document": {
      "components": {},
      "definitions": {},
      "value": "string"
    }
  }
}

Valori delle proprietà

ApiSchemaContractProperties

Nome Descrizione Valore
contentType Deve essere un tipo di supporto valido utilizzato in un'intestazione Content-Type, come definito nella RFC 2616. Tipo di supporto del documento dello schema ,ad esempio application/json, application/xml.
- Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema usare application/vnd.ms-azure-apim.wadl.grammars+xml.		 stringa (obbligatorio)
documento Creare o aggiornare le proprietà del documento dello schema API. ApiSchemaDocumentProperties

ApiSchemaDocumentProperties

Nome Descrizione Valore
Componenti Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v2/v3, null in caso contrario. qualunque
Definizioni Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v1, null in caso contrario. qualunque
valore Stringa con escape JSON che definisce il documento che rappresenta lo schema. Usato per schemi diversi da Swagger/OpenAPI. corda

Microsoft.ApiManagement/service/apis/schemas

Nome Descrizione Valore
apiVersion Versione dell'API '2021-04-01-preview'
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
proprietà Proprietà dello schema DELL'API. ApiSchemaContractProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/apis/schemas'

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/apis/schemas può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/apis/schemas, aggiungere il formato Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      contentType = "string"
      document = {
        components = ?
        definitions = ?
        value = "string"
      }
    }
  })
}

Valori delle proprietà

ApiSchemaContractProperties

Nome Descrizione Valore
contentType Deve essere un tipo di supporto valido utilizzato in un'intestazione Content-Type, come definito nella RFC 2616. Tipo di supporto del documento dello schema ,ad esempio application/json, application/xml.
- Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema usare application/vnd.ms-azure-apim.wadl.grammars+xml.		 stringa (obbligatorio)
documento Creare o aggiornare le proprietà del documento dello schema API. ApiSchemaDocumentProperties

ApiSchemaDocumentProperties

Nome Descrizione Valore
Componenti Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v2/v3, null in caso contrario. qualunque
Definizioni Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v1, null in caso contrario. qualunque
valore Stringa con escape JSON che definisce il documento che rappresenta lo schema. Usato per schemi diversi da Swagger/OpenAPI. corda

Microsoft.ApiManagement/service/apis/schemas

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio/API
proprietà Proprietà dello schema DELL'API. ApiSchemaContractProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview"