Partilhar via

Serviço/apis/operações Microsoft.ApiManagement 2018-01-01

  • Artigo

Definição de recursos do bíceps

O tipo de recurso service/apis/operations 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/operations, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2018-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    method: 'string'
    policies: 'string'
    request: {
      description: 'string'
      headers: [
        {
          defaultValue: 'string'
          description: 'string'
          name: 'string'
          required: bool
          type: 'string'
          values: [
            'string'
          ]
        }
      ]
      queryParameters: [
        {
          defaultValue: 'string'
          description: 'string'
          name: 'string'
          required: bool
          type: 'string'
          values: [
            'string'
          ]
        }
      ]
      representations: [
        {
          contentType: 'string'
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              name: 'string'
              required: bool
              type: 'string'
              values: [
                'string'
              ]
            }
          ]
          sample: 'string'
          schemaId: 'string'
          typeName: 'string'
        }
      ]
    }
    responses: [
      {
        description: 'string'
        headers: [
          {
            defaultValue: 'string'
            description: 'string'
            name: 'string'
            required: bool
            type: 'string'
            values: [
              'string'
            ]
          }
        ]
        representations: [
          {
            contentType: 'string'
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                name: 'string'
                required: bool
                type: 'string'
                values: [
                  'string'
                ]
              }
            ]
            sample: 'string'
            schemaId: 'string'
            typeName: 'string'
          }
        ]
        statusCode: int
      }
    ]
    templateParameters: [
      {
        defaultValue: 'string'
        description: 'string'
        name: 'string'
        required: bool
        type: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

Valores de propriedade

Microsoft.ApiManagement/service/apis/operations

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (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 Imóveis do Contrato de Operação. OperationContractProperties

OperationContractProperties

Designação Descrição Valor
Descrição Descrição da operação. Pode incluir tags de formatação HTML. string

Restrições:
Comprimento máximo =
displayName Nome da operação. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
método Um método de operação HTTP válido. Métodos Http típicos como GET, PUT, POST mas não limitados apenas por eles. string (obrigatório)
Políticas Políticas de Operação string
solicitar Uma entidade que contém detalhes da solicitação. RequestContract
Respostas Matriz de respostas de operação. ResponseContract[]
templateParameters Coleção de parâmetros de modelo de URL. ParameterContract[]
urlTemplate Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date} string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

ParâmetroContrato

Designação Descrição Valor
defaultValue Valor do parâmetro padrão. string
Descrição Descrição do parâmetro. string
Designação Nome do parâmetro. string (obrigatório)
Necessário se o parâmetro é necessário ou não. Bool
tipo Tipo de parâmetro. string (obrigatório)
valores Valores de parâmetros. string[]

RepresentaçãoContrato

Designação Descrição Valor
contentType Especifica um tipo de conteúdo registrado ou personalizado para essa representação, por exemplo, application/xml. string (obrigatório)
formParameters Coleção de parâmetros de formulário. Obrigatório se o valor 'contentType' for 'application/x-www-form-urlencoded' ou 'multipart/form-data'.. ParameterContract[]
amostra Um exemplo da representação. string
schemaId Identificador de esquema. Aplicável somente se o valor 'contentType' não for 'application/x-www-form-urlencoded' nem 'multipart/form-data'. string
typeName Nome do tipo definido pelo esquema. Aplicável somente se o valor 'contentType' não for 'application/x-www-form-urlencoded' nem 'multipart/form-data'. string

PedidoContrato

Designação Descrição Valor
Descrição Descrição do pedido de operação. string
cabeçalhos Coleta de cabeçalhos de solicitação de operação. ParameterContract[]
queryParameters Coleção de parâmetros de consulta de solicitação de operação. ParameterContract[]
Representações Recolha de representações de pedidos de operação. RepresentationContract[]

RespostaContrato

Designação Descrição Valor
Descrição Descrição da resposta da operação. string
cabeçalhos Coleção de cabeçalhos de resposta de operação. ParameterContract[]
Representações Recolha de representações de resposta à operação. RepresentationContract[]
statusCode Código de status HTTP de resposta da operação. int (obrigatório)

Definição de recurso de modelo ARM

O tipo de recurso service/apis/operations 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/operations, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2018-01-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "method": "string",
    "policies": "string",
    "request": {
      "description": "string",
      "headers": [
        {
          "defaultValue": "string",
          "description": "string",
          "name": "string",
          "required": "bool",
          "type": "string",
          "values": [ "string" ]
        }
      ],
      "queryParameters": [
        {
          "defaultValue": "string",
          "description": "string",
          "name": "string",
          "required": "bool",
          "type": "string",
          "values": [ "string" ]
        }
      ],
      "representations": [
        {
          "contentType": "string",
          "formParameters": [
            {
              "defaultValue": "string",
              "description": "string",
              "name": "string",
              "required": "bool",
              "type": "string",
              "values": [ "string" ]
            }
          ],
          "sample": "string",
          "schemaId": "string",
          "typeName": "string"
        }
      ]
    },
    "responses": [
      {
        "description": "string",
        "headers": [
          {
            "defaultValue": "string",
            "description": "string",
            "name": "string",
            "required": "bool",
            "type": "string",
            "values": [ "string" ]
          }
        ],
        "representations": [
          {
            "contentType": "string",
            "formParameters": [
              {
                "defaultValue": "string",
                "description": "string",
                "name": "string",
                "required": "bool",
                "type": "string",
                "values": [ "string" ]
              }
            ],
            "sample": "string",
            "schemaId": "string",
            "typeName": "string"
          }
        ],
        "statusCode": "int"
      }
    ],
    "templateParameters": [
      {
        "defaultValue": "string",
        "description": "string",
        "name": "string",
        "required": "bool",
        "type": "string",
        "values": [ "string" ]
      }
    ],
    "urlTemplate": "string"
  }
}

Valores de propriedade

Microsoft.ApiManagement/service/apis/operations

Designação Descrição Valor
apiVersion A versão api '2018-01-01'
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (obrigatório)
propriedades Imóveis do Contrato de Operação. OperationContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/apis/operations'

OperationContractProperties

Designação Descrição Valor
Descrição Descrição da operação. Pode incluir tags de formatação HTML. string

Restrições:
Comprimento máximo =
displayName Nome da operação. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
método Um método de operação HTTP válido. Métodos Http típicos como GET, PUT, POST mas não limitados apenas por eles. string (obrigatório)
Políticas Políticas de Operação string
solicitar Uma entidade que contém detalhes da solicitação. RequestContract
Respostas Matriz de respostas de operação. ResponseContract[]
templateParameters Coleção de parâmetros de modelo de URL. ParameterContract[]
urlTemplate Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date} string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

ParâmetroContrato

Designação Descrição Valor
defaultValue Valor do parâmetro padrão. string
Descrição Descrição do parâmetro. string
Designação Nome do parâmetro. string (obrigatório)
Necessário se o parâmetro é necessário ou não. Bool
tipo Tipo de parâmetro. string (obrigatório)
valores Valores de parâmetros. string[]

RepresentaçãoContrato

Designação Descrição Valor
contentType Especifica um tipo de conteúdo registrado ou personalizado para essa representação, por exemplo, application/xml. string (obrigatório)
formParameters Coleção de parâmetros de formulário. Obrigatório se o valor 'contentType' for 'application/x-www-form-urlencoded' ou 'multipart/form-data'.. ParameterContract[]
amostra Um exemplo da representação. string
schemaId Identificador de esquema. Aplicável somente se o valor 'contentType' não for 'application/x-www-form-urlencoded' nem 'multipart/form-data'. string
typeName Nome do tipo definido pelo esquema. Aplicável somente se o valor 'contentType' não for 'application/x-www-form-urlencoded' nem 'multipart/form-data'. string

PedidoContrato

Designação Descrição Valor
Descrição Descrição do pedido de operação. string
cabeçalhos Coleta de cabeçalhos de solicitação de operação. ParameterContract[]
queryParameters Coleção de parâmetros de consulta de solicitação de operação. ParameterContract[]
Representações Recolha de representações de pedidos de operação. RepresentationContract[]

RespostaContrato

Designação Descrição Valor
Descrição Descrição da resposta da operação. string
cabeçalhos Coleção de cabeçalhos de resposta de operação. ParameterContract[]
Representações Recolha de representações de resposta à operação. RepresentationContract[]
statusCode Código de status HTTP de resposta da operação. int (obrigatório)

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso service/apis/operations 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/operations, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2018-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      method = "string"
      policies = "string"
      request = {
        description = "string"
        headers = [
          {
            defaultValue = "string"
            description = "string"
            name = "string"
            required = bool
            type = "string"
            values = [
              "string"
            ]
          }
        ]
        queryParameters = [
          {
            defaultValue = "string"
            description = "string"
            name = "string"
            required = bool
            type = "string"
            values = [
              "string"
            ]
          }
        ]
        representations = [
          {
            contentType = "string"
            formParameters = [
              {
                defaultValue = "string"
                description = "string"
                name = "string"
                required = bool
                type = "string"
                values = [
                  "string"
                ]
              }
            ]
            sample = "string"
            schemaId = "string"
            typeName = "string"
          }
        ]
      }
      responses = [
        {
          description = "string"
          headers = [
            {
              defaultValue = "string"
              description = "string"
              name = "string"
              required = bool
              type = "string"
              values = [
                "string"
              ]
            }
          ]
          representations = [
            {
              contentType = "string"
              formParameters = [
                {
                  defaultValue = "string"
                  description = "string"
                  name = "string"
                  required = bool
                  type = "string"
                  values = [
                    "string"
                  ]
                }
              ]
              sample = "string"
              schemaId = "string"
              typeName = "string"
            }
          ]
          statusCode = int
        }
      ]
      templateParameters = [
        {
          defaultValue = "string"
          description = "string"
          name = "string"
          required = bool
          type = "string"
          values = [
            "string"
          ]
        }
      ]
      urlTemplate = "string"
    }
  })
}

Valores de propriedade

Microsoft.ApiManagement/service/apis/operations

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: service/apis
propriedades Imóveis do Contrato de Operação. OperationContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis/operations@2018-01-01"

OperationContractProperties

Designação Descrição Valor
Descrição Descrição da operação. Pode incluir tags de formatação HTML. string

Restrições:
Comprimento máximo =
displayName Nome da operação. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
método Um método de operação HTTP válido. Métodos Http típicos como GET, PUT, POST mas não limitados apenas por eles. string (obrigatório)
Políticas Políticas de Operação string
solicitar Uma entidade que contém detalhes da solicitação. RequestContract
Respostas Matriz de respostas de operação. ResponseContract[]
templateParameters Coleção de parâmetros de modelo de URL. ParameterContract[]
urlTemplate Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date} string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

ParâmetroContrato

Designação Descrição Valor
defaultValue Valor do parâmetro padrão. string
Descrição Descrição do parâmetro. string
Designação Nome do parâmetro. string (obrigatório)
Necessário se o parâmetro é necessário ou não. Bool
tipo Tipo de parâmetro. string (obrigatório)
valores Valores de parâmetros. string[]

RepresentaçãoContrato

Designação Descrição Valor
contentType Especifica um tipo de conteúdo registrado ou personalizado para essa representação, por exemplo, application/xml. string (obrigatório)
formParameters Coleção de parâmetros de formulário. Obrigatório se o valor 'contentType' for 'application/x-www-form-urlencoded' ou 'multipart/form-data'.. ParameterContract[]
amostra Um exemplo da representação. string
schemaId Identificador de esquema. Aplicável somente se o valor 'contentType' não for 'application/x-www-form-urlencoded' nem 'multipart/form-data'. string
typeName Nome do tipo definido pelo esquema. Aplicável somente se o valor 'contentType' não for 'application/x-www-form-urlencoded' nem 'multipart/form-data'. string

PedidoContrato

Designação Descrição Valor
Descrição Descrição do pedido de operação. string
cabeçalhos Coleta de cabeçalhos de solicitação de operação. ParameterContract[]
queryParameters Coleção de parâmetros de consulta de solicitação de operação. ParameterContract[]
Representações Recolha de representações de pedidos de operação. RepresentationContract[]

RespostaContrato

Designação Descrição Valor
Descrição Descrição da resposta da operação. string
cabeçalhos Coleção de cabeçalhos de resposta de operação. ParameterContract[]
Representações Recolha de representações de resposta à operação. RepresentationContract[]
statusCode Código de status HTTP de resposta da operação. int (obrigatório)