Microsoft.Web customApis 2016-06-01
Definição de recurso do Bicep
O tipo de recurso customApis pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Web/customApis, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
etag: 'string'
properties: {
apiDefinitions: {
modifiedSwaggerUrl: 'string'
originalSwaggerUrl: 'string'
}
apiType: 'string'
backendService: {
serviceUrl: 'string'
}
brandColor: 'string'
capabilities: [
'string'
]
connectionParameters: {}
description: 'string'
displayName: 'string'
iconUri: 'string'
runtimeUrls: [
'string'
]
swagger: any()
wsdlDefinition: {
content: 'string'
importMethod: 'string'
service: {
endpointQualifiedNames: [
'string'
]
qualifiedName: 'string'
}
url: 'string'
content: 'string'
importMethod: 'string'
service: {
endpointQualifiedNames: [
'string'
]
qualifiedName: 'string'
}
url: 'string'
}
}
}
Valores de propriedade
customApis
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia (obrigatório) |
| localização | Localização do recurso | string |
| etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| etag | ETag de Recurso | string |
| propriedades | Propriedades personalizadas da API | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| Nome | Descrição | Valor |
|---|---|---|
| apiDefinitions | Definições de API | ApiResourceDefinitions |
| apiType | O tipo de API | "NotSpecified" 'Rest' 'Soap' |
| backendService | O serviço de back-end da API | ApiResourceBackendService |
| brandColor | Cor da marca | string |
| capacidades | As capacidades personalizadas da API | cadeia[] |
| connectionParameters | Parâmetros da ligação | objeto |
| descrição | A descrição da API personalizada | string |
| displayName | O nome a apresentar | string |
| iconUri | O URI do ícone | string |
| runtimeUrls | Runtime URLs | cadeia[] |
| swagger | A representação JSON do swagger | Para o Bicep, pode utilizar a função any( ). |
| wsdlDefinition | A definição WSDL | WsdlDefinition |
ApiResourceDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| modifiedSwaggerUrl | O URL swagger modificado | string |
| originalSwaggerUrl | O URL swagger original | string |
ApiResourceBackendService
| Nome | Descrição | Valor |
|---|---|---|
| serviceUrl | O URL do serviço | string |
WsdlDefinition
| Nome | Descrição | Valor |
|---|---|---|
| conteúdo | O conteúdo WSDL | string |
| importMethod | O método de importação WSDL | "Não Indicado" "SoapPassThrough" "SoapToRest" |
| serviço | O serviço com nomes e nomes de pontos finais | WsdlService |
| url | O URL do WSDL | string |
| conteúdo | O conteúdo WSDL | string |
| importMethod | O método de importação WSDL | "Não Indicado" "SoapPassThrough" "SoapToRest" |
| serviço | O serviço com nomes e nomes de pontos finais | WsdlService |
| url | O URL do WSDL | string |
WsdlService
| Nome | Descrição | Valor |
|---|---|---|
| endpointQualifiedNames | Lista dos nomes qualificados dos pontos finais | string[] |
| qualifiedName | O nome qualificado do serviço | cadeia (obrigatório) |
Definição de recurso do modelo arm
O tipo de recurso customApis pode ser implementado com operações que visam:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Web/customApis, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Web/customApis",
"apiVersion": "2016-06-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"etag": "string",
"properties": {
"apiDefinitions": {
"modifiedSwaggerUrl": "string",
"originalSwaggerUrl": "string"
},
"apiType": "string",
"backendService": {
"serviceUrl": "string"
},
"brandColor": "string",
"capabilities": [ "string" ],
"connectionParameters": {},
"description": "string",
"displayName": "string",
"iconUri": "string",
"runtimeUrls": [ "string" ],
"swagger": {},
"wsdlDefinition": {
"content": "string",
"importMethod": "string",
"service": {
"endpointQualifiedNames": [ "string" ],
"qualifiedName": "string"
},
"url": "string",
"content": "string",
"importMethod": "string",
"service": {
"endpointQualifiedNames": [ "string" ],
"qualifiedName": "string"
},
"url": "string"
}
}
}
Valores de propriedade
customApis
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Web/customApis" |
| apiVersion | A versão da API de recursos | '2016-06-01' |
| name | O nome do recurso | cadeia (obrigatório) |
| localização | Localização do recurso | string |
| etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| etag | ETag de Recurso | string |
| propriedades | Propriedades personalizadas da API | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| Nome | Descrição | Valor |
|---|---|---|
| apiDefinitions | Definições de API | ApiResourceDefinitions |
| apiType | O tipo de API | "Não Indicado" 'Rest' 'Soap' |
| backendService | O serviço de back-end da API | ApiResourceBackendService |
| brandColor | Cor da marca | string |
| capacidades | As capacidades personalizadas da API | string[] |
| connectionParameters | Parâmetros da ligação | objeto |
| descrição | A descrição da API personalizada | string |
| displayName | O nome a apresentar | string |
| iconUri | O URI do ícone | string |
| runtimeUrls | Runtime URLs | cadeia[] |
| swagger | A representação JSON do swagger | |
| wsdlDefinition | A definição WSDL | WsdlDefinition |
ApiResourceDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| modifiedSwaggerUrl | O URL swagger modificado | string |
| originalSwaggerUrl | O URL swagger original | string |
ApiResourceBackendService
| Nome | Descrição | Valor |
|---|---|---|
| serviceUrl | O URL do serviço | string |
WsdlDefinition
| Nome | Descrição | Valor |
|---|---|---|
| conteúdo | O conteúdo WSDL | string |
| importMethod | O método de importação WSDL | "NotSpecified" 'SoapPassThrough' 'SoapToRest' |
| serviço | O serviço com nomes de nomes e pontos finais | WsdlService |
| url | O URL do WSDL | string |
| conteúdo | O conteúdo WSDL | string |
| importMethod | O método de importação WSDL | "NotSpecified" 'SoapPassThrough' 'SoapToRest' |
| serviço | O serviço com nomes de nomes e pontos finais | WsdlService |
| url | O URL do WSDL | string |
WsdlService
| Nome | Descrição | Valor |
|---|---|---|
| endpointQualifiedNames | Lista dos nomes qualificados dos pontos finais | cadeia[] |
| qualifiedName | O nome qualificado do serviço | cadeia (obrigatório) |
Definição de recurso do Terraform (fornecedor AzAPI)
O tipo de recurso customApis pode ser implementado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Web/customApis, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/customApis@2016-06-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
apiDefinitions = {
modifiedSwaggerUrl = "string"
originalSwaggerUrl = "string"
}
apiType = "string"
backendService = {
serviceUrl = "string"
}
brandColor = "string"
capabilities = [
"string"
]
connectionParameters = {}
description = "string"
displayName = "string"
iconUri = "string"
runtimeUrls = [
"string"
]
wsdlDefinition = {
content = "string"
importMethod = "string"
service = {
endpointQualifiedNames = [
"string"
]
qualifiedName = "string"
}
url = "string"
content = "string"
importMethod = "string"
service = {
endpointQualifiedNames = [
"string"
]
qualifiedName = "string"
}
url = "string"
}
}
etag = "string"
})
}
Valores de propriedade
customApis
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Web/customApis@2016-06-01" |
| name | O nome do recurso | cadeia (obrigatório) |
| localização | Localização do recurso | string |
| parent_id | Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de etiquetas. |
| etag | ETag de Recurso | string |
| propriedades | Propriedades personalizadas da API | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| Nome | Descrição | Valor |
|---|---|---|
| apiDefinitions | Definições de API | ApiResourceDefinitions |
| apiType | O tipo de API | "NotSpecified" "Rest" "Soap" |
| backendService | O serviço de back-end da API | ApiResourceBackendService |
| brandColor | Cor da marca | string |
| capacidades | As capacidades personalizadas da API | string[] |
| connectionParameters | Parâmetros da ligação | objeto |
| descrição | A descrição da API personalizada | string |
| displayName | O nome a apresentar | string |
| iconUri | O URI do ícone | string |
| runtimeUrls | Runtime URLs | string[] |
| swagger | A representação JSON do swagger | |
| wsdlDefinition | A definição WSDL | WsdlDefinition |
ApiResourceDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| modifiedSwaggerUrl | O URL do swagger modificado | string |
| originalSwaggerUrl | O URL do swagger original | string |
ApiResourceBackendService
| Nome | Descrição | Valor |
|---|---|---|
| serviceUrl | O URL do serviço | string |
WsdlDefinition
| Nome | Descrição | Valor |
|---|---|---|
| conteúdo | O conteúdo WSDL | string |
| importMethod | O método de importação WSDL | "NotSpecified" "SoapPassThrough" "SoapToRest" |
| serviço | O serviço com nomes e nomes de pontos finais | WsdlService |
| url | O URL do WSDL | string |
| conteúdo | O conteúdo WSDL | string |
| importMethod | O método de importação WSDL | "NotSpecified" "SoapPassThrough" "SoapToRest" |
| serviço | O serviço com nomes e nomes de pontos finais | WsdlService |
| url | O URL do WSDL | string |
WsdlService
| Nome | Descrição | Valor |
|---|---|---|
| endpointQualifiedNames | Lista dos nomes qualificados dos pontos finais | string[] |
| qualifiedName | O nome qualificado do serviço | cadeia (obrigatório) |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários