Servizio Microsoft.ApiManagement/apis/schemas
- più recenti
- 2023-09-01-preview
- 2022-08-01
- 2021-08-01
Definizione di risorsa Bicep
Il tipo di risorsa service/apis/schemas può essere distribuito con operazioni destinate a:
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@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
contentType: 'string'
document: {
components: any()
definitions: any()
value: 'string'
}
}
}
Valori delle proprietà
service/apis/schemas
| Nome | Descrizione | Valore |
|---|---|---|
| nome | 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. |
| 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: api |
| proprietà | Proprietà dello schema DELL'API. | SchemaContractProperties |
SchemaContractProperties
| 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 - OData Schema usare application/vnd.ms-azure-apim.odata.schema - gRPC Schema usare text/protobuf. |
stringa (obbligatorio) |
| documento | Creare o aggiornare le proprietà del documento dello schema API. | SchemaDocumentProperties (obbligatorio) |
SchemaDocumentProperties
| Nome | Descrizione | Valore |
|---|---|---|
| Componenti | Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v2/v3, null in caso contrario. | Per Bicep, è possibile usare la funzione any() |
| Definizioni | 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. | corda |
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa service/apis/schemas può essere distribuito con operazioni destinate a:
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": "2023-09-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Valori delle proprietà
service/apis/schemas
| Nome | Descrizione | Valore |
|---|---|---|
| digitare | Tipo di risorsa | 'Microsoft.ApiManagement/service/apis/schemas' |
| apiVersion | Versione dell'API della risorsa | '2023-09-01-preview' |
| nome | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in 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. |
| proprietà | Proprietà dello schema DELL'API. | SchemaContractProperties |
SchemaContractProperties
| 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 - OData Schema usare application/vnd.ms-azure-apim.odata.schema - gRPC Schema usare text/protobuf. |
stringa (obbligatorio) |
| documento | Creare o aggiornare le proprietà del documento dello schema API. | SchemaDocumentProperties (obbligatorio) |
SchemaDocumentProperties
| Nome | Descrizione | Valore |
|---|---|---|
| Componenti | Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v2/v3, null in caso contrario. | |
| Definizioni | Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v1, null in caso contrario. | |
| valore | Stringa con escape JSON che definisce il documento che rappresenta lo schema. Usato per schemi diversi da Swagger/OpenAPI. | corda |
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@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
value = "string"
}
}
})
}
Valori delle proprietà
service/apis/schemas
| Nome | Descrizione | Valore |
|---|---|---|
| digitare | Tipo di risorsa | "Microsoft.ApiManagement/service/apis/schemas@2023-09-01-preview" |
| nome | Nome della risorsa | stringa (obbligatorio) 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 |
| proprietà | Proprietà dello schema DELL'API. | SchemaContractProperties |
SchemaContractProperties
| 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 - OData Schema usare application/vnd.ms-azure-apim.odata.schema - gRPC Schema usare text/protobuf. |
stringa (obbligatorio) |
| documento | Creare o aggiornare le proprietà del documento dello schema API. | SchemaDocumentProperties (obbligatorio) |
SchemaDocumentProperties
| Nome | Descrizione | Valore |
|---|---|---|
| Componenti | Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v2/v3, null in caso contrario. | |
| Definizioni | Definizioni dei tipi. Usato solo per schemi Swagger/OpenAPI v1, null in caso contrario. | |
| valore | Stringa con escape JSON che definisce il documento che rappresenta lo schema. Usato per schemi diversi da Swagger/OpenAPI. | corda |