Microsoft.ApiManagement service/apis/operations 2016-10-10

• última
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

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@2016-10-10' = {
  parent: resourceSymbolicName
  description: 'string'
  method: 'string'
  name: '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'
        sample: 'string'
      }
    ]
  }
  responses: [
    {
      description: 'string'
      representations: [
        {
          contentType: 'string'
          sample: '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

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
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)
nome	O nome do recurso	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (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
pedir	Uma entidade que contém detalhes da solicitação.	RequestContract
Respostas	Matriz de respostas de operação.	resultcontract[]
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}	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 1000 (obrigatório)

ParameterContract

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

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)
amostra	Um exemplo da representação.	corda

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 []

ResultContract

Nome	Descrição	Valor
descrição	Descrição da resposta da operação.	corda
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 Restrições: Valor mínimo = 100 Valor máximo = 599 (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": "2016-10-10",
  "name": "string",
  "description": "string",
  "method": "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",
        "sample": "string"
      }
    ]
  },
  "responses": [
    {
      "description": "string",
      "representations": [
        {
          "contentType": "string",
          "sample": "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

Nome	Descrição	Valor
apiVersion	A versão da API	'2016-10-10'
descrição	Descrição da operação. Pode incluir marcas de formatação HTML.	corda Restrições: Comprimento máximo = 1000
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)
nome	O nome do recurso	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (obrigatório)
pedir	Uma entidade que contém detalhes da solicitação.	RequestContract
Respostas	Matriz de respostas de operação.	resultcontract[]
templateParameters	Coleção de parâmetros de modelo de URL.	ParameterContract []
tipo	O tipo de recurso	'Microsoft.ApiManagement/service/apis/operations'
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}	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 1000 (obrigatório)

ParameterContract

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

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)
amostra	Um exemplo da representação.	corda

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 []

ResultContract

Nome	Descrição	Valor
descrição	Descrição da resposta da operação.	corda
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 Restrições: Valor mínimo = 100 Valor máximo = 599 (obrigatório)

Exemplos de uso

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@2016-10-10"
  name = "string"
  description = "string"
  method = "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"
        sample = "string"
      }
    ]
  }
  responses = [
    {
      description = "string"
      representations = [
        {
          contentType = "string"
          sample = "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

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
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)
nome	O nome do recurso	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: serviço/apis
pedir	Uma entidade que contém detalhes da solicitação.	RequestContract
Respostas	Matriz de respostas de operação.	resultcontract[]
templateParameters	Coleção de parâmetros de modelo de URL.	ParameterContract []
tipo	O tipo de recurso	"Microsoft.ApiManagement/service/apis/operations@2016-10-10"
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}	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 1000 (obrigatório)

ParameterContract

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

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)
amostra	Um exemplo da representação.	corda

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 []

ResultContract

Nome	Descrição	Valor
descrição	Descrição da resposta da operação.	corda
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 Restrições: Valor mínimo = 100 Valor máximo = 599 (obrigatório)