Compartilhar via


Microsoft.ApiManagement service/apis/operations

Definição de recurso do Bicep

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

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

Formato de recurso

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    method: 'string'
    policies: 'string'
    request: {
      description: 'string'
      headers: [
        {
          defaultValue: 'string'
          description: 'string'
          examples: {
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
          }
          name: 'string'
          required: bool
          schemaId: 'string'
          type: 'string'
          typeName: 'string'
          values: [
            'string'
          ]
        }
      ]
      queryParameters: [
        {
          defaultValue: 'string'
          description: 'string'
          examples: {
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
          }
          name: 'string'
          required: bool
          schemaId: 'string'
          type: 'string'
          typeName: 'string'
          values: [
            'string'
          ]
        }
      ]
      representations: [
        {
          contentType: 'string'
          examples: {
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
          }
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              examples: {
                {customized property}: {
                  description: 'string'
                  externalValue: 'string'
                  summary: 'string'
                  value: any()
                }
                {customized property}: {
                  description: 'string'
                  externalValue: 'string'
                  summary: 'string'
                  value: any()
                }
              }
              name: 'string'
              required: bool
              schemaId: 'string'
              type: 'string'
              typeName: 'string'
              values: [
                'string'
              ]
            }
          ]
          schemaId: 'string'
          typeName: 'string'
        }
      ]
    }
    responses: [
      {
        description: 'string'
        headers: [
          {
            defaultValue: 'string'
            description: 'string'
            examples: {
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any()
              }
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any()
              }
            }
            name: 'string'
            required: bool
            schemaId: 'string'
            type: 'string'
            typeName: 'string'
            values: [
              'string'
            ]
          }
        ]
        representations: [
          {
            contentType: 'string'
            examples: {
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any()
              }
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any()
              }
            }
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                examples: {
                  {customized property}: {
                    description: 'string'
                    externalValue: 'string'
                    summary: 'string'
                    value: any()
                  }
                  {customized property}: {
                    description: 'string'
                    externalValue: 'string'
                    summary: 'string'
                    value: any()
                  }
                }
                name: 'string'
                required: bool
                schemaId: 'string'
                type: 'string'
                typeName: 'string'
                values: [
                  'string'
                ]
              }
            ]
            schemaId: 'string'
            typeName: 'string'
          }
        ]
        statusCode: int
      }
    ]
    templateParameters: [
      {
        defaultValue: 'string'
        description: 'string'
        examples: {
          {customized property}: {
            description: 'string'
            externalValue: 'string'
            summary: 'string'
            value: any()
          }
          {customized property}: {
            description: 'string'
            externalValue: 'string'
            summary: 'string'
            value: any()
          }
        }
        name: 'string'
        required: bool
        schemaId: 'string'
        type: 'string'
        typeName: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

Valores de propriedade

service/apis/operations

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.
cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
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: apis
properties Propriedades do Contrato de Operação. OperationContractProperties

OperationContractProperties

Nome Descrição Valor
descrição Descrição da operação. Pode incluir marcas de formatação HTML. string
displayName Nome da operação. cadeia de caracteres (obrigatório)
method 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. cadeia de caracteres (obrigatório)
políticas Políticas de operação string
solicitação Uma entidade que contém detalhes da solicitação. RequestContract
responses Matriz de respostas de operação. ResponseContract[]
templateParameters Coleção de parâmetros de modelo de URL. ParameterContract[]
urlTemplate Modelo de URL relativa identificando o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date} cadeia de caracteres (obrigatório)

RequestContract

Nome Descrição Valor
descrição Descrição da solicitação de operação. string
headers Coleção 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[]
representations Coleção de representações de solicitação da operação. RepresentationContract[]

ParameterContract

Nome Descrição Valor
defaultValue Valor de parâmetro padrão. string
descrição Descrição do parâmetro. string
exemplos Exemplo definido para o parâmetro . ParameterExamplesContract
name Nome do parâmetro. cadeia de caracteres (obrigatório)
exigido Especifica se o parâmetro é necessário ou não. bool
schemaId Identificador de esquema. string
type Tipo de parâmetro. cadeia de caracteres (obrigatório)
typeName Nome do tipo definido pelo esquema. string
valores Valores do parâmetro. string[]

ParameterExamplesContract

Nome Descrição Valor
{propriedade personalizada} ParameterExampleContract
{propriedade personalizada} ParameterExampleContract

ParameterExampleContract

Nome Descrição Valor
descrição Descrição longa para o exemplo string
externalValue Uma URL que aponta para o exemplo literal string
resumo Descrição curta para o exemplo string
value Valor de exemplo. Pode ser um valor primitivo ou um objeto . Para o Bicep, você pode usar a função any().

RepresentationContract

Nome Descrição Valor
contentType Especifica um tipo de conteúdo registrado ou personalizado para essa representação, por exemplo, application/xml. cadeia de caracteres (obrigatório)
exemplos Exemplo definido para a representação. ParameterExamplesContract
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[]
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

ResponseContract

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

Definição de recurso de modelo do ARM

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

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

Formato de recurso

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

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "method": "string",
    "policies": "string",
    "request": {
      "description": "string",
      "headers": [
        {
          "defaultValue": "string",
          "description": "string",
          "examples": {
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            },
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            }
          },
          "name": "string",
          "required": "bool",
          "schemaId": "string",
          "type": "string",
          "typeName": "string",
          "values": [ "string" ]
        }
      ],
      "queryParameters": [
        {
          "defaultValue": "string",
          "description": "string",
          "examples": {
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            },
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            }
          },
          "name": "string",
          "required": "bool",
          "schemaId": "string",
          "type": "string",
          "typeName": "string",
          "values": [ "string" ]
        }
      ],
      "representations": [
        {
          "contentType": "string",
          "examples": {
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            },
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            }
          },
          "formParameters": [
            {
              "defaultValue": "string",
              "description": "string",
              "examples": {
                "{customized property}": {
                  "description": "string",
                  "externalValue": "string",
                  "summary": "string",
                  "value": {}
                },
                "{customized property}": {
                  "description": "string",
                  "externalValue": "string",
                  "summary": "string",
                  "value": {}
                }
              },
              "name": "string",
              "required": "bool",
              "schemaId": "string",
              "type": "string",
              "typeName": "string",
              "values": [ "string" ]
            }
          ],
          "schemaId": "string",
          "typeName": "string"
        }
      ]
    },
    "responses": [
      {
        "description": "string",
        "headers": [
          {
            "defaultValue": "string",
            "description": "string",
            "examples": {
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              },
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              }
            },
            "name": "string",
            "required": "bool",
            "schemaId": "string",
            "type": "string",
            "typeName": "string",
            "values": [ "string" ]
          }
        ],
        "representations": [
          {
            "contentType": "string",
            "examples": {
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              },
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              }
            },
            "formParameters": [
              {
                "defaultValue": "string",
                "description": "string",
                "examples": {
                  "{customized property}": {
                    "description": "string",
                    "externalValue": "string",
                    "summary": "string",
                    "value": {}
                  },
                  "{customized property}": {
                    "description": "string",
                    "externalValue": "string",
                    "summary": "string",
                    "value": {}
                  }
                },
                "name": "string",
                "required": "bool",
                "schemaId": "string",
                "type": "string",
                "typeName": "string",
                "values": [ "string" ]
              }
            ],
            "schemaId": "string",
            "typeName": "string"
          }
        ],
        "statusCode": "int"
      }
    ],
    "templateParameters": [
      {
        "defaultValue": "string",
        "description": "string",
        "examples": {
          "{customized property}": {
            "description": "string",
            "externalValue": "string",
            "summary": "string",
            "value": {}
          },
          "{customized property}": {
            "description": "string",
            "externalValue": "string",
            "summary": "string",
            "value": {}
          }
        },
        "name": "string",
        "required": "bool",
        "schemaId": "string",
        "type": "string",
        "typeName": "string",
        "values": [ "string" ]
      }
    ],
    "urlTemplate": "string"
  }
}

Valores de propriedade

service/apis/operations

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.ApiManagement/service/apis/operations'
apiVersion A versão da API do recurso '2023-05-01-preview'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.
cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
properties Propriedades do Contrato de Operação. OperationContractProperties

OperationContractProperties

Nome Descrição Valor
descrição Descrição da operação. Pode incluir marcas de formatação HTML. string
displayName Nome da Operação. cadeia de caracteres (obrigatório)
method 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. cadeia de caracteres (obrigatório)
políticas Políticas de operação string
solicitação Uma entidade que contém detalhes da solicitação. RequestContract
responses Matriz de respostas de operação. ResponseContract[]
templateParameters Coleção de parâmetros de modelo de URL. ParameterContract[]
urlTemplate Modelo de URL relativa identificando o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date} cadeia de caracteres (obrigatório)

RequestContract

Nome Descrição Valor
descrição Descrição da solicitação de operação. string
headers Coleção 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[]
representations Coleção de representações de solicitação da operação. RepresentationContract[]

ParameterContract

Nome Descrição Valor
defaultValue Valor de parâmetro padrão. string
descrição Descrição do parâmetro. string
exemplos Exemplo definido para o parâmetro . ParameterExamplesContract
name Nome do parâmetro. cadeia de caracteres (obrigatório)
exigido Especifica se o parâmetro é necessário ou não. bool
schemaId Identificador de esquema. string
type Tipo de parâmetro. cadeia de caracteres (obrigatório)
typeName Nome do tipo definido pelo esquema. string
valores Valores do parâmetro. string[]

ParameterExamplesContract

Nome Descrição Valor
{propriedade personalizada} ParameterExampleContract
{propriedade personalizada} ParameterExampleContract

ParameterExampleContract

Nome Descrição Valor
descrição Descrição longa para o exemplo string
externalValue Uma URL que aponta para o exemplo literal string
resumo Descrição curta para o exemplo string
value Valor de exemplo. Pode ser um valor primitivo ou um objeto .

RepresentationContract

Nome Descrição Valor
contentType Especifica um tipo de conteúdo registrado ou personalizado para essa representação, por exemplo, application/xml. cadeia de caracteres (obrigatório)
exemplos Exemplo definido para a representação. ParameterExamplesContract
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[]
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

ResponseContract

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

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

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

  • Grupos de recursos

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

Formato de recurso

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

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

Valores de propriedade

service/apis/operations

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: apis
properties Propriedades do Contrato de Operação. OperationContractProperties

OperationContractProperties

Nome Descrição Valor
descrição Descrição da operação. Pode incluir marcas de formatação HTML. string
displayName Nome da operação. cadeia de caracteres (obrigatório)
method 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. cadeia de caracteres (obrigatório)
políticas Políticas de operação string
solicitação Uma entidade que contém detalhes da solicitação. RequestContract
responses Matriz de respostas de operação. ResponseContract[]
templateParameters Coleção de parâmetros de modelo de URL. ParameterContract[]
urlTemplate Modelo de URL relativa identificando o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date} cadeia de caracteres (obrigatório)

RequestContract

Nome Descrição Valor
descrição Descrição da solicitação de operação. string
headers Coleção 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[]
representations Coleção de representações de solicitação da operação. RepresentationContract[]

ParameterContract

Nome Descrição Valor
defaultValue Valor de parâmetro padrão. string
descrição Descrição do parâmetro. string
exemplos Exemplo definido para o parâmetro . ParameterExamplesContract
name Nome do parâmetro. cadeia de caracteres (obrigatório)
exigido Especifica se o parâmetro é necessário ou não. bool
schemaId Identificador de esquema. string
type Tipo de parâmetro. cadeia de caracteres (obrigatório)
typeName Nome do tipo definido pelo esquema. string
valores Valores do parâmetro. string[]

ParameterExamplesContract

Nome Descrição Valor
{propriedade personalizada} ParameterExampleContract
{propriedade personalizada} ParameterExampleContract

ParameterExampleContract

Nome Descrição Valor
descrição Descrição longa para o exemplo string
externalValue Uma URL que aponta para o exemplo literal string
resumo Descrição curta para o exemplo string
value Valor de exemplo. Pode ser um valor primitivo ou um objeto .

RepresentationContract

Nome Descrição Valor
contentType Especifica um tipo de conteúdo registrado ou personalizado para essa representação, por exemplo, application/xml. cadeia de caracteres (obrigatório)
exemplos Exemplo definido para a representação. ParameterExamplesContract
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[]
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

ResponseContract

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