Compartilhar via

Microsoft.ApiManagement service/apis/schemas 2023-05-01-preview

  • Artigo

Definição de recurso do Bicep

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

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

Formato de recurso

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2023-05-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'
    }
  }
}

Valores de propriedade

Microsoft.ApiManagement/service/apis/schemas

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (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 o recurso do tipo: serviço/apis
Propriedades Propriedades do esquema de API. schemaContractProperties

SchemaContractProperties

Nome Descrição Valor
contentType Deve ser um tipo de mídia válido usado em um cabeçalho Content-Type, conforme definido no RFC 2616. Tipo de mídia do documento de esquema (por exemplo, application/json, application/xml).
- Swagger o uso do esquema application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL o uso do esquema application/vnd.ms-azure-apim.xsd+xml
- OpenApi o uso do esquema application/vnd.oai.openapi.components+json
- WADL Schema usar application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema usar application/vnd.ms-azure-apim.odata.schema
- gRPC Schema usar text/protobuf.		 cadeia de caracteres (obrigatório)
documento Criar ou atualizar propriedades do documento de esquema de API. schemaDocumentProperties (obrigatório)

SchemaDocumentProperties

Nome Descrição Valor
Componentes Definições de tipos. Usado somente para esquemas Swagger/OpenAPI v2/v3, nulo caso contrário. qualquer
Definições Definições de tipos. Usado somente 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. corda

Definição de recurso de modelo do ARM

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

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

Formato de 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": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "contentType": "string",
    "document": {
      "components": {},
      "definitions": {},
      "value": "string"
    }
  }
}

Valores de propriedade

Microsoft.ApiManagement/service/apis/schemas

Nome Descrição Valor
apiVersion A versão da API '2023-05-01-preview'
nome O nome do recurso corda

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

SchemaContractProperties

Nome Descrição Valor
contentType Deve ser um tipo de mídia válido usado em um cabeçalho Content-Type, conforme definido no RFC 2616. Tipo de mídia do documento de esquema (por exemplo, application/json, application/xml).
- Swagger o uso do esquema application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL o uso do esquema application/vnd.ms-azure-apim.xsd+xml
- OpenApi o uso do esquema application/vnd.oai.openapi.components+json
- WADL Schema usar application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema usar application/vnd.ms-azure-apim.odata.schema
- gRPC Schema usar text/protobuf.		 cadeia de caracteres (obrigatório)
documento Criar ou atualizar propriedades do documento de esquema de API. schemaDocumentProperties (obrigatório)

SchemaDocumentProperties

Nome Descrição Valor
Componentes Definições de tipos. Usado somente para esquemas Swagger/OpenAPI v2/v3, nulo caso contrário. qualquer
Definições Definições de tipos. Usado somente 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. corda

Definição de recurso do Terraform (provedor de AzAPI)

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

  • grupos de recursos

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

Formato de recurso

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

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

Valores de propriedade

Microsoft.ApiManagement/service/apis/schemas

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço/apis
Propriedades Propriedades do esquema de API. schemaContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis/schemas@2023-05-01-preview"

SchemaContractProperties

Nome Descrição Valor
contentType Deve ser um tipo de mídia válido usado em um cabeçalho Content-Type, conforme definido no RFC 2616. Tipo de mídia do documento de esquema (por exemplo, application/json, application/xml).
- Swagger o uso do esquema application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL o uso do esquema application/vnd.ms-azure-apim.xsd+xml
- OpenApi o uso do esquema application/vnd.oai.openapi.components+json
- WADL Schema usar application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema usar application/vnd.ms-azure-apim.odata.schema
- gRPC Schema usar text/protobuf.		 cadeia de caracteres (obrigatório)
documento Criar ou atualizar propriedades do documento de esquema de API. schemaDocumentProperties (obrigatório)

SchemaDocumentProperties

Nome Descrição Valor
Componentes Definições de tipos. Usado somente para esquemas Swagger/OpenAPI v2/v3, nulo caso contrário. qualquer
Definições Definições de tipos. Usado somente 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. corda