Microsoft.Web customApis 2016-06-01
Definición de recursos de Bicep
El tipo de recurso customApis se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.Web/customApis, agregue el siguiente bicep a la plantilla.
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 propiedad
customApis
| Nombre | Descripción | Value |
|---|---|---|
| name | El nombre del recurso | string (obligatorio) |
| ubicación | Ubicación de los recursos | string |
| etiquetas | Etiquetas del recurso | Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas. |
| ETag | ETag de recursos | string |
| properties | Propiedades de la API personalizada | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| Nombre | Descripción | Value |
|---|---|---|
| apiDefinitions | Definiciones de API | ApiResourceDefinitions |
| apiType | El tipo de API | 'NotSpecified' 'Rest' 'Soap' |
| backendService | El servicio back-end de API | ApiResourceBackendService |
| brandColor | Color de marca | string |
| capabilities | Funcionalidades de API personalizadas | string[] |
| connectionParameters | Parámetros de conexión | object |
| description | Descripción de la API personalizada | string |
| DisplayName | Nombre para mostrar | string |
| iconUri | El URI del icono | string |
| runtimeUrls | Direcciones URL en tiempo de ejecución | string[] |
| swagger | Representación JSON de swagger | Para Bicep, puede usar la función any(). |
| wsdlDefinition | Definición de WSDL | WsdlDefinition |
ApiResourceDefinitions
| Nombre | Descripción | Valor |
|---|---|---|
| modifiedSwaggerUrl | Dirección URL de Swagger modificada | string |
| originalSwaggerUrl | Dirección URL original de Swagger | string |
ApiResourceBackendService
| Nombre | Descripción | Valor |
|---|---|---|
| serviceUrl | Dirección URL del servicio | string |
WsdlDefinition
| Nombre | Descripción | Value |
|---|---|---|
| content | Contenido de WSDL | string |
| importMethod | Método de importación de WSDL | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | El servicio con nombres y nombres de punto de conexión | WsdlService |
| url | Dirección URL de WSDL | string |
| contenido | Contenido de WSDL | string |
| importMethod | Método de importación de WSDL | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | El servicio con nombres y nombres de punto de conexión | WsdlService |
| url | Dirección URL de WSDL | string |
WsdlService
| Nombre | Descripción | Value |
|---|---|---|
| endpointQualifiedNames | Lista de los nombres calificados de los puntos de conexión | string[] |
| qualifiedName | Nombre completo del servicio | string (obligatorio) |
Definición de recursos de plantilla de ARM
El tipo de recurso customApis se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.Web/customApis, agregue el siguiente json a la plantilla.
{
"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 propiedad
customApis
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | 'Microsoft.Web/customApis' |
| apiVersion | La versión de la API de recursos | '2016-06-01' |
| name | El nombre del recurso | string (obligatorio) |
| ubicación | Ubicación de los recursos | string |
| etiquetas | Etiquetas del recurso | Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas. |
| ETag | ETag de recursos | string |
| properties | Propiedades de la API personalizada | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| Nombre | Descripción | Valor |
|---|---|---|
| apiDefinitions | Definiciones de API | ApiResourceDefinitions |
| apiType | El tipo de API | 'NotSpecified' 'Rest' 'Soap' |
| backendService | El servicio back-end de API | ApiResourceBackendService |
| brandColor | Color de marca | string |
| capabilities | Funcionalidades de API personalizadas | string[] |
| connectionParameters | Parámetros de conexión | object |
| description | Descripción de la API personalizada | string |
| DisplayName | Nombre para mostrar | string |
| iconUri | El URI del icono | string |
| runtimeUrls | Direcciones URL en tiempo de ejecución | string[] |
| swagger | Representación JSON de swagger | |
| wsdlDefinition | Definición de WSDL | WsdlDefinition |
ApiResourceDefinitions
| Nombre | Descripción | Valor |
|---|---|---|
| modifiedSwaggerUrl | Dirección URL de Swagger modificada | string |
| originalSwaggerUrl | La dirección URL original de Swagger | string |
ApiResourceBackendService
| Nombre | Descripción | Valor |
|---|---|---|
| serviceUrl | Dirección URL del servicio | string |
WsdlDefinition
| Nombre | Descripción | Value |
|---|---|---|
| content | Contenido de WSDL | string |
| importMethod | Método de importación de WSDL | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | El servicio con nombres y nombres de punto de conexión | WsdlService |
| url | Dirección URL de WSDL | string |
| contenido | Contenido de WSDL | string |
| importMethod | Método de importación de WSDL | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | El servicio con nombres y nombres de punto de conexión | WsdlService |
| url | Dirección URL de WSDL | string |
WsdlService
| Nombre | Descripción | Valor |
|---|---|---|
| endpointQualifiedNames | Lista de los nombres completos de los puntos de conexión | string[] |
| qualifiedName | Nombre completo del servicio | string (obligatorio) |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso customApis se puede implementar con operaciones destinadas a:
- Grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.Web/customApis, agregue el siguiente terraform a la plantilla.
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 propiedad
customApis
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.Web/customApis@2016-06-01" |
| name | El nombre del recurso | string (obligatorio) |
| ubicación | Ubicación de los recursos | string |
| parent_id | Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos. | string (obligatorio) |
| etiquetas | Etiquetas del recurso | Diccionario de nombres y valores de etiqueta. |
| ETag | ETag de recursos | string |
| properties | Propiedades de la API personalizada | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| Nombre | Descripción | Valor |
|---|---|---|
| apiDefinitions | Definiciones de API | ApiResourceDefinitions |
| apiType | El tipo de API | "NotSpecified" "Resto" "Soap" |
| backendService | El servicio back-end de API | ApiResourceBackendService |
| brandColor | Color de marca | string |
| capabilities | Funcionalidades de API personalizadas | string[] |
| connectionParameters | Parámetros de conexión | object |
| description | Descripción de la API personalizada | string |
| DisplayName | Nombre para mostrar | string |
| iconUri | El URI del icono | string |
| runtimeUrls | Direcciones URL en tiempo de ejecución | string[] |
| swagger | Representación JSON de swagger | |
| wsdlDefinition | Definición de WSDL | WsdlDefinition |
ApiResourceDefinitions
| Nombre | Descripción | Valor |
|---|---|---|
| modifiedSwaggerUrl | Dirección URL de Swagger modificada | string |
| originalSwaggerUrl | Dirección URL original de Swagger | string |
ApiResourceBackendService
| Nombre | Descripción | Value |
|---|---|---|
| serviceUrl | Dirección URL del servicio | string |
WsdlDefinition
| Nombre | Descripción | Value |
|---|---|---|
| content | Contenido de WSDL | string |
| importMethod | Método de importación de WSDL | "NotSpecified" "SoapPassThrough" "SoapToRest" |
| service | El servicio con nombres y nombres de punto de conexión | WsdlService |
| url | Dirección URL de WSDL | string |
| contenido | Contenido de WSDL | string |
| importMethod | Método de importación de WSDL | "NotSpecified" "SoapPassThrough" "SoapToRest" |
| service | El servicio con nombres y nombres de punto de conexión | WsdlService |
| url | Dirección URL de WSDL | string |
WsdlService
| Nombre | Descripción | Valor |
|---|---|---|
| endpointQualifiedNames | Lista de los nombres calificados de los puntos de conexión | string[] |
| qualifiedName | Nombre completo del servicio | string (obligatorio) |
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de