Microsoft.Web customApis 2016-06-01
Definição de recurso do Bicep
O tipo de recurso customApis pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Web/customApis, adicione o Bicep a seguir ao 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 de caracteres (obrigatório) |
local | Localização do recurso | string |
marcas | Marcações de recursos | Dicionário de nomes e valores de marcas. Confira Marcas em modelos |
etag | ETag de Recurso | string |
properties | Propriedades da API personalizada | 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 |
funcionalidades | Os recursos de API personalizados | string[] |
connectionParameters | Parâmetros de conexão | objeto |
descrição | A descrição da API personalizada | string |
displayName | O nome de exibição | string |
iconUri | O URI do ícone | string |
runtimeUrls | Runtime URLs | string[] |
swagger | A representação JSON do swagger | Para o Bicep, você pode usar a função any(). |
wsdlDefinition | A definição do WSDL | WsdlDefinition |
ApiResourceDefinitions
Nome | Descrição | Valor |
---|---|---|
modifiedSwaggerUrl | A URL do Swagger modificada | string |
originalSwaggerUrl | A URL original do Swagger | string |
ApiResourceBackendService
Nome | Descrição | Valor |
---|---|---|
serviceUrl | A URL do serviço | string |
WsdlDefinition
Nome | Descrição | Valor |
---|---|---|
conteúdo | O conteúdo do WSDL | string |
Importmethod | O método de importação WSDL | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
serviço | O serviço com nomes de nome e ponto de extremidade | WsdlService |
url | A URL do WSDL | string |
conteúdo | O conteúdo do WSDL | string |
Importmethod | O método de importação WSDL | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
serviço | O serviço com nomes de nome e ponto de extremidade | WsdlService |
url | A URL do WSDL | string |
WsdlService
Nome | Descrição | Valor |
---|---|---|
endpointQualifiedNames | Lista de nomes qualificados dos pontos de extremidade | string[] |
qualifiedName | O nome qualificado do serviço | cadeia de caracteres (obrigatório) |
Definição de recurso de modelo do ARM
O tipo de recurso customApis 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 log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Web/customApis, adicione o JSON a seguir ao 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 de caracteres (obrigatório) |
local | Localização do recurso | string |
marcas | Marcações de recursos | Dicionário de nomes e valores de marcas. Consulte Marcas em modelos |
etag | ETag de Recurso | string |
properties | Propriedades da API personalizada | 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 |
funcionalidades | Os recursos de API personalizados | string[] |
connectionParameters | Parâmetros de conexão | objeto |
descrição | A descrição da API personalizada | string |
displayName | O nome de exibição | string |
iconUri | O URI do ícone | string |
runtimeUrls | Runtime URLs | string[] |
swagger | A representação JSON do swagger | |
wsdlDefinition | A definição do WSDL | WsdlDefinition |
ApiResourceDefinitions
Nome | Descrição | Valor |
---|---|---|
modifiedSwaggerUrl | A URL do swagger modificada | string |
originalSwaggerUrl | A URL do swagger original | string |
ApiResourceBackendService
Nome | Descrição | Valor |
---|---|---|
serviceUrl | A URL do serviço | string |
WsdlDefinition
Nome | Descrição | Valor |
---|---|---|
conteúdo | O conteúdo do WSDL | string |
Importmethod | O método de importação WSDL | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
serviço | O serviço com nomes de nome e ponto de extremidade | WsdlService |
url | A URL do WSDL | string |
conteúdo | O conteúdo do WSDL | string |
Importmethod | O método de importação WSDL | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
serviço | O serviço com nomes de nome e ponto de extremidade | WsdlService |
url | A URL do WSDL | string |
WsdlService
Nome | Descrição | Valor |
---|---|---|
endpointQualifiedNames | Lista de nomes qualificados dos pontos de extremidade | string[] |
qualifiedName | O nome qualificado do serviço | cadeia de caracteres (obrigatório) |
Definição de recurso do Terraform (provedor AzAPI)
O tipo de recurso customApis pode ser implantado com operações direcionadas:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Web/customApis, adicione o Terraform a seguir ao 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 de caracteres (obrigatório) |
local | Localização do recurso | string |
parent_id | Para implantar em um grupo de recursos, use a ID desse grupo de recursos. | cadeia de caracteres (obrigatório) |
marcas | Marcações de recursos | Dicionário de nomes e valores de marcas. |
etag | ETag de Recurso | string |
properties | Propriedades da API personalizada | 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 |
funcionalidades | Os recursos de API personalizados | string[] |
connectionParameters | Parâmetros de conexão | objeto |
descrição | A descrição da API personalizada | string |
displayName | O nome de exibição | string |
iconUri | O URI do ícone | string |
runtimeUrls | Runtime URLs | string[] |
swagger | A representação JSON do swagger | |
wsdlDefinition | A definição do WSDL | WsdlDefinition |
ApiResourceDefinitions
Nome | Descrição | Valor |
---|---|---|
modifiedSwaggerUrl | A URL do swagger modificada | string |
originalSwaggerUrl | A URL do swagger original | string |
ApiResourceBackendService
Nome | Descrição | Valor |
---|---|---|
serviceUrl | A URL do serviço | string |
WsdlDefinition
Nome | Descrição | Valor |
---|---|---|
conteúdo | O conteúdo do WSDL | string |
Importmethod | O método de importação WSDL | "NotSpecified" "SoapPassThrough" "SoapToRest" |
serviço | O serviço com nomes de nome e ponto de extremidade | WsdlService |
url | A URL do WSDL | string |
conteúdo | O conteúdo do WSDL | string |
Importmethod | O método de importação WSDL | "NotSpecified" "SoapPassThrough" "SoapToRest" |
serviço | O serviço com nomes de nome e ponto de extremidade | WsdlService |
url | A URL do WSDL | string |
WsdlService
Nome | Descrição | Valor |
---|---|---|
endpointQualifiedNames | Lista de nomes qualificados dos pontos de extremidade | string[] |
qualifiedName | O nome qualificado do serviço | cadeia de caracteres (obrigatório) |
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de