Partilhar via

Serviço/apis/esquemas Microsoft.ApiManagement 2021-04-01-preview

  • Artigo

Definição de recursos do bíceps

O tipo de recurso service/apis/schemas pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/apis/schemas, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

ApiSchemaContractProperties

Designação Descrição Valor
contentType Deve ser um tipo de mídia válido usado em um cabeçalho Content-Type, conforme definido na RFC 2616. Tipo de mídia do documento do esquema (por exemplo, application/json, application/xml).
- Swagger Uso do esquema application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Uso do esquema application/vnd.ms-azure-apim.xsd+xml
- OpenApi Uso do esquema application/vnd.oai.openapi.components+json
- WADL Schema uso application/vnd.ms-azure-apim.wadl.grammars+xml.		 string (obrigatório)
documento Crie ou atualize as propriedades do documento de esquema da API. ApiSchemaDocumentProperties

ApiSchemaDocumentProperties

Designação Descrição Valor
Componentes Definições de tipos. Usado apenas para esquemas Swagger/OpenAPI v2/v3, null caso contrário. qualquer
Definições Definições de tipos. Usado apenas para esquemas Swagger/OpenAPI v1, nulo caso contrário. qualquer
valor Json escapou da cadeia de caracteres definindo o documento que representa o esquema. Usado para esquemas diferentes de Swagger/OpenAPI. string

Microsoft.ApiManagement/service/apis/schemas

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80 (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: service/apis
propriedades Propriedades do esquema da API. ApiSchemaContractProperties

Definição de recurso de modelo ARM

O tipo de recurso service/apis/schemas pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/apis/schemas, adicione o JSON a seguir ao seu modelo.

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

Valores de propriedade

ApiSchemaContractProperties

Designação Descrição Valor
contentType Deve ser um tipo de mídia válido usado em um cabeçalho Content-Type, conforme definido na RFC 2616. Tipo de mídia do documento do esquema (por exemplo, application/json, application/xml).
- Swagger Uso do esquema application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Uso do esquema application/vnd.ms-azure-apim.xsd+xml
- OpenApi Uso do esquema application/vnd.oai.openapi.components+json
- WADL Schema uso application/vnd.ms-azure-apim.wadl.grammars+xml.		 string (obrigatório)
documento Crie ou atualize as propriedades do documento de esquema da API. ApiSchemaDocumentProperties

ApiSchemaDocumentProperties

Designação Descrição Valor
Componentes Definições de tipos. Usado apenas para esquemas Swagger/OpenAPI v2/v3, null caso contrário. qualquer
Definições Definições de tipos. Usado apenas para esquemas Swagger/OpenAPI v1, nulo caso contrário. qualquer
valor Json escapou da cadeia de caracteres definindo o documento que representa o esquema. Usado para esquemas diferentes de Swagger/OpenAPI. string

Microsoft.ApiManagement/service/apis/schemas

Designação Descrição Valor
apiVersion A versão api '2021-04-01-pré-visualização'
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80 (obrigatório)
propriedades Propriedades do esquema da API. ApiSchemaContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/apis/schemas'

Exemplos de uso

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso service/apis/schemas pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/apis/schemas, adicione o seguinte Terraform ao seu modelo.

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"
      }
    }
  })
}

Valores de propriedade

ApiSchemaContractProperties

Designação Descrição Valor
contentType Deve ser um tipo de mídia válido usado em um cabeçalho Content-Type, conforme definido na RFC 2616. Tipo de mídia do documento do esquema (por exemplo, application/json, application/xml).
- Swagger Uso do esquema application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Uso do esquema application/vnd.ms-azure-apim.xsd+xml
- OpenApi Uso do esquema application/vnd.oai.openapi.components+json
- WADL Schema uso application/vnd.ms-azure-apim.wadl.grammars+xml.		 string (obrigatório)
documento Crie ou atualize as propriedades do documento de esquema da API. ApiSchemaDocumentProperties

ApiSchemaDocumentProperties

Designação Descrição Valor
Componentes Definições de tipos. Usado apenas para esquemas Swagger/OpenAPI v2/v3, null caso contrário. qualquer
Definições Definições de tipos. Usado apenas para esquemas Swagger/OpenAPI v1, nulo caso contrário. qualquer
valor Json escapou da cadeia de caracteres definindo o documento que representa o esquema. Usado para esquemas diferentes de Swagger/OpenAPI. string

Microsoft.ApiManagement/service/apis/schemas

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80 (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: service/apis
propriedades Propriedades do esquema da API. ApiSchemaContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview"