Serviço/apis/operações Microsoft.ApiManagement 2016-10-10

• Últimas
• 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 recursos do bíceps

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

• Grupos de recursos - Consulte comandos de implantação de grupo 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 Bicep 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

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 =
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)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 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 recurso do tipo: service/apis
solicitar	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}	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)
amostra	Um exemplo da representação.	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[]

ResultadoContrato

Designação	Descrição	Valor
Descrição	Descrição da resposta da operação.	string
Representações	Recolha de representações de resposta à 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 ARM

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

• Grupos de recursos - Consulte comandos de implantação de grupo 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 JSON ao seu 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

Designação	Descrição	Valor
apiVersion	A versão api	'2016-10-10'
Descrição	Descrição da operação. Pode incluir tags de formatação HTML.	string Restrições: Comprimento máximo =
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)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 Padrão = ^[^*#&+:<>?]+$ (obrigatório)
solicitar	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}	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)
amostra	Um exemplo da representação.	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[]

ResultadoContrato

Designação	Descrição	Valor
Descrição	Descrição da resposta da operação.	string
Representações	Recolha de representações de resposta à 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 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@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

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 =
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)
Designação	O nome do recurso	string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id	A ID do recurso que é o pai para este recurso.	ID do recurso do tipo: service/apis
solicitar	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}	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)
amostra	Um exemplo da representação.	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[]

ResultadoContrato

Designação	Descrição	Valor
Descrição	Descrição da resposta da operação.	string
Representações	Recolha de representações de resposta à 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)