Microsoft.ApiManagement service/apis/operations 2021-08-01

• última
• 2023-09-01-preview
• 2022-08-01
• 2021-08-01

Definição de recurso do Bicep

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

• Grupos de recursos - Consulte comandos de implantação do grupo 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/operations, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2021-08-01' = {
  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()
            }
          }
          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()
            }
          }
          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()
            }
          }
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              examples: {
                {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()
              }
            }
            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()
              }
            }
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                examples: {
                  {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()
          }
        }
        name: 'string'
        required: bool
        schemaId: 'string'
        type: 'string'
        typeName: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

Valores de propriedade

service/apis/operations

Nome	Descrição	Valor
nome	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: Alfanuméricos e hifens. Comece com letra e termine com 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
Propriedades	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.	corda Restrições: Comprimento máximo = 1000
displayName	Nome da operação.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
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.	cadeia de caracteres (obrigatório)
Políticas	Políticas de operação	corda
pedir	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}	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1000

RequestContract

Nome	Descrição	Valor
descrição	Descrição da solicitação de operação.	corda
Cabeçalhos	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 []
Representações	Coleção de representações de solicitação de operação.	RepresentationContract []

ParameterContract

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

ParameterExamplesContract

Nome	Descrição	Valor
{propriedade personalizada}		ParameterExampleContract

ParameterExampleContract

Nome	Descrição	Valor
descrição	Descrição longa para o exemplo	corda
externalValue	Uma URL que aponta para o exemplo literal	corda
resumo	Descrição curta para o exemplo	corda
valor	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. Necessá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'.	corda
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'.	corda

ResponseContract

Nome	Descrição	Valor
descrição	Descrição da resposta da operação.	corda
Cabeçalhos	Coleção de cabeçalhos de resposta de operação.	ParameterContract []
Representações	Coleção de representações de resposta de 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 de serviço/apis/operações pode ser implantado com operações direcionadas:

• Grupos de recursos - Consulte comandos de implantação do grupo 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/operations, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2021-08-01",
  "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": {}
            }
          },
          "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": {}
            }
          },
          "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": {}
            }
          },
          "formParameters": [
            {
              "defaultValue": "string",
              "description": "string",
              "examples": {
                "{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": {}
              }
            },
            "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": {}
              }
            },
            "formParameters": [
              {
                "defaultValue": "string",
                "description": "string",
                "examples": {
                  "{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": {}
          }
        },
        "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	'2021-08-01'
nome	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: Alfanuméricos e hifens. Comece com letra e termine com alfanumérico.
Propriedades	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.	corda Restrições: Comprimento máximo = 1000
displayName	Nome da operação.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
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.	cadeia de caracteres (obrigatório)
Políticas	Políticas de operação	corda
pedir	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}	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1000

RequestContract

Nome	Descrição	Valor
descrição	Descrição da solicitação de operação.	corda
Cabeçalhos	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 []
Representações	Coleção de representações de solicitação de operação.	RepresentationContract []

ParameterContract

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

ParameterExamplesContract

Nome	Descrição	Valor
{propriedade personalizada}		ParameterExampleContract

ParameterExampleContract

Nome	Descrição	Valor
descrição	Descrição longa para o exemplo	corda
externalValue	Uma URL que aponta para o exemplo literal	corda
resumo	Descrição curta para o exemplo	corda
valor	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. Necessá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'.	corda
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'.	corda

ResponseContract

Nome	Descrição	Valor
descrição	Descrição da resposta da operação.	corda
Cabeçalhos	Coleção de cabeçalhos de resposta de operação.	ParameterContract []
Representações	Coleção de representações de resposta de 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 de serviço/apis/operações pode ser implantado com operações direcionadas:

• 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/operations, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2021-08-01"
  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"
              }
            }
            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"
              }
            }
            name = "string"
            required = bool
            schemaId = "string"
            type = "string"
            typeName = "string"
            values = [
              "string"
            ]
          }
        ]
        representations = [
          {
            contentType = "string"
            examples = {
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
            }
            formParameters = [
              {
                defaultValue = "string"
                description = "string"
                examples = {
                  {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"
                }
              }
              name = "string"
              required = bool
              schemaId = "string"
              type = "string"
              typeName = "string"
              values = [
                "string"
              ]
            }
          ]
          representations = [
            {
              contentType = "string"
              examples = {
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                }
              }
              formParameters = [
                {
                  defaultValue = "string"
                  description = "string"
                  examples = {
                    {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"
            }
          }
          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@2021-08-01"
nome	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Alfanuméricos e hifens. Comece com letra e termine com alfanumérico.
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: apis
Propriedades	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.	corda Restrições: Comprimento máximo = 1000
displayName	Nome da operação.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
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.	cadeia de caracteres (obrigatório)
Políticas	Políticas de operação	corda
pedir	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}	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1000

RequestContract

Nome	Descrição	Valor
descrição	Descrição da solicitação de operação.	corda
Cabeçalhos	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 []
Representações	Coleção de representações de solicitação de operação.	RepresentationContract []

ParameterContract

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

ParameterExamplesContract

Nome	Descrição	Valor
{propriedade personalizada}		ParameterExampleContract

ParameterExampleContract

Nome	Descrição	Valor
descrição	Descrição longa para o exemplo	corda
externalValue	Uma URL que aponta para o exemplo literal	corda
resumo	Descrição curta para o exemplo	corda
valor	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. Necessá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'.	corda
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'.	corda

ResponseContract

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