Serviço/apis/operações Microsoft.ApiManagement
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@2023-09-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()
}
}
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
Serviço/APIs/Operações
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep. |
string (obrigatório) Limite de caracteres: 1-80 Caracteres válidos: Alfanuméricos e hífenes. 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 recurso do tipo: 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 = 1000 |
| displayName | Nome da operação. | string (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. | 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 (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1000 |
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[] |
ParâmetroContrato
| Designação | Descrição | Valor |
|---|---|---|
| defaultValue | Valor do parâmetro padrão. | string |
| Descrição | Descrição do parâmetro. | string |
| Exemplos | Exemplo definido para o parâmetro. | ParameterExamplesContract |
| Designação | Nome do parâmetro. | string (obrigatório) |
| Necessário | Especifica se o parâmetro é necessário ou não. | Bool |
| schemaId | Identificador de esquema. | string |
| tipo | Tipo de parâmetro. | string (obrigatório) |
| typeName | Nome do tipo definido pelo esquema. | string |
| valores | Valores de parâmetros. | string[] |
ParameterExamplesContract
| Designação | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ParameterExampleContract |
ParameterExampleContract
| Designação | Descrição | Valor |
|---|---|---|
| Descrição | Descrição longa para o exemplo | string |
| valor externo | Um URL que aponta para o exemplo literal | string |
| Resumo | Breve descrição do exemplo | string |
| valor | Valor de exemplo. Pode ser um valor primitivo ou um objeto. | Para o Bicep, você pode usar a função any(). |
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) |
| 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 |
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:
- 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": "2023-09-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": {}
}
},
"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
Serviço/APIs/Operações
| Designação | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/apis/operations' |
| apiVersion | A versão da api de recursos | '2023-09-01-pré-visualização' |
| Designação | O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos JSON ARM. |
string (obrigatório) Limite de caracteres: 1-80 Caracteres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
| 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 = 1000 |
| displayName | Nome da operação. | string (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. | 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 (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1000 |
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[] |
ParâmetroContrato
| Designação | Descrição | Valor |
|---|---|---|
| defaultValue | Valor do parâmetro padrão. | string |
| Descrição | Descrição do parâmetro. | string |
| Exemplos | Exemplo definido para o parâmetro. | ParameterExamplesContract |
| Designação | Nome do parâmetro. | string (obrigatório) |
| Necessário | Especifica se o parâmetro é necessário ou não. | Bool |
| schemaId | Identificador de esquema. | string |
| tipo | Tipo de parâmetro. | string (obrigatório) |
| typeName | Nome do tipo definido pelo esquema. | string |
| valores | Valores de parâmetros. | string[] |
ParameterExamplesContract
| Designação | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ParameterExampleContract |
ParameterExampleContract
| Designação | Descrição | Valor |
|---|---|---|
| Descrição | Descrição longa para o exemplo | string |
| valor externo | Um URL que aponta para o exemplo literal | string |
| Resumo | Breve descrição do exemplo | string |
| valor | Valor de exemplo. Pode ser um valor primitivo ou um objeto. |
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) |
| 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 |
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@2023-09-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"
}
}
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
Serviço/APIs/Operações
| Designação | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/apis/operations@2023-09-01-preview" |
| Designação | O nome do recurso | string (obrigatório) Limite de caracteres: 1-80 Caracteres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
| parent_id | A ID do recurso que é o pai para este recurso. | ID para recurso do tipo: 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 = 1000 |
| displayName | Nome da operação. | string (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. | 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 (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 1000 |
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[] |
ParâmetroContrato
| Designação | Descrição | Valor |
|---|---|---|
| defaultValue | Valor do parâmetro padrão. | string |
| Descrição | Descrição do parâmetro. | string |
| Exemplos | Exemplo definido para o parâmetro. | ParameterExamplesContract |
| Designação | Nome do parâmetro. | string (obrigatório) |
| Necessário | Especifica se o parâmetro é necessário ou não. | Bool |
| schemaId | Identificador de esquema. | string |
| tipo | Tipo de parâmetro. | string (obrigatório) |
| typeName | Nome do tipo definido pelo esquema. | string |
| valores | Valores de parâmetros. | string[] |
ParameterExamplesContract
| Designação | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | ParameterExampleContract |
ParameterExampleContract
| Designação | Descrição | Valor |
|---|---|---|
| Descrição | Descrição longa para o exemplo | string |
| valor externo | Um URL que aponta para o exemplo literal | string |
| Resumo | Breve descrição do exemplo | string |
| valor | Valor de exemplo. Pode ser um valor primitivo ou um objeto. |
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) |
| 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 |
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) |