Condividi tramite

Servizio Microsoft.ApiManagement/apis/schemas 2022-08-01

  • Articolo

Definizione di risorsa Bicep

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

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

Formato di risorsa

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    contentType: 'string'
    document: {
      components: any()
      definitions: any()
      value: 'string'
    }
  }
}

Valori delle proprietà

service/apis/schemas

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatorio)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
padre 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 esterna alla risorsa padre.		 Nome simbolico per la risorsa di tipo: apis
properties Proprietà dello schema API. SchemaContractProperties

SchemaContractProperties

Nome Descrizione Valore
contentType Deve essere un tipo di supporto valido usato in un'intestazione Content-Type come definito in RFC 2616. Tipo di supporto del documento dello schema ,ad esempio application/json, application/xml.
- Swagger Uso dello schema application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Uso dello schema application/vnd.ms-azure-apim.xsd+xml
- OpenApi Uso dello schema 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. SchemaDocumentProperties (obbligatorio)

SchemaDocumentProperties

Nome Descrizione Valore
components Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v2/v3. In caso contrario, null. Per Bicep, è possibile usare la funzione any().
definitions Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v1, null in caso contrario. Per Bicep, è possibile usare la funzione any().
Valore Stringa con escape JSON che definisce il documento che rappresenta lo schema. Usato per schemi diversi da Swagger/OpenAPI. string

Definizione di risorsa del modello di Resource Manager

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

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

Formato di risorsa

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

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

Valori delle proprietà

service/apis/schemas

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.ApiManagement/service/apis/schemas'
apiVersion Versione dell'API della risorsa '2022-08-01'
name Nome della risorsa

Informazioni su come impostare nomi e tipi per le risorse figlio nei modelli di Resource Manager JSON.		 stringa (obbligatorio)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
properties Proprietà dello schema API. SchemaContractProperties

SchemaContractProperties

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

SchemaDocumentProperties

Nome Descrizione Valore
components Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v2/v3, null in caso contrario.
definitions Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v1, null in caso contrario.
Valore Stringa di escape json che definisce il documento che rappresenta lo schema. Usato per schemi diversi da Swagger/OpenAPI. string

Definizione della risorsa Terraform (provider AzAPI)

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

  • Gruppi di risorse

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

Formato di risorsa

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/schemas@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      contentType = "string"
      document = {
        value = "string"
      }
    }
  })
}

Valori delle proprietà

service/apis/schemas

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.ApiManagement/service/apis/schemas@2022-08-01"
name Nome della risorsa stringa (obbligatoria)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: api
properties Proprietà dello schema API. SchemaContractProperties

SchemaContractProperties

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

SchemaDocumentProperties

Nome Descrizione Valore
components Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v2/v3, null in caso contrario.
definitions Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v1, null in caso contrario.
Valore Stringa di escape json che definisce il documento che rappresenta lo schema. Usato per schemi diversi da Swagger/OpenAPI. string