你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Web customApis 2016-06-01

项目
09/03/2023

Bicep 资源定义

可以使用面向以下操作部署 customApis 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Web/customApis 资源，请将以下 Bicep 添加到模板。

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'
    }
  }
}

属性值

customApis

名称	说明	Value
name	资源名称	字符串 (必需)
location	资源位置	字符串
标记	资源标记	标记名称和值的字典。请参阅模板中的标记
etag	资源 ETag	string
properties	自定义 API 属性	CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

名称	说明	Value
apiDefinitions	API 定义	ApiResourceDefinitions
apiType	API 类型	“NotSpecified” 'Rest' “Soap”
backendService	API 后端服务	ApiResourceBackendService
brandColor	品牌颜色	字符串
capabilities	自定义 API 功能	string[]
connectionParameters	连接参数	对象 (object)
description	自定义 API 说明	字符串
displayName	显示名称	string
iconUri	图标 URI	字符串
runtimeUrls	运行时 URL	string[]
swagger	swagger 的 JSON 表示形式	对于 Bicep，可以使用 any () 函数。
wsdlDefinition	WSDL 定义	WsdlDefinition

ApiResourceDefinitions

名称	说明	Value
modifiedSwaggerUrl	修改后的 swagger URL	字符串
originalSwaggerUrl	原始 swagger URL	string

ApiResourceBackendService

名称	说明	Value
serviceUrl	服务 URL	字符串

WsdlDefinition

名称	说明	Value
content	WSDL 内容	string
importMethod	WSDL 导入方法	“NotSpecified” “SoapPassThrough” “SoapToRest”
服务	具有名称和终结点名称的服务	WsdlService
url	The WSDL URL	string
内容	WSDL 内容	字符串
importMethod	WSDL 导入方法	“NotSpecified” “SoapPassThrough” “SoapToRest”
服务	具有名称和终结点名称的服务	WsdlService
url	The WSDL URL	字符串

WsdlService

名称	说明	Value
endpointQualifiedNames	终结点的限定名称列表	string[]
qualifiedName	服务的限定名称	字符串 (必需)

ARM 模板资源定义

customApis 资源类型可以通过针对以下操作进行部署：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Web/customApis 资源，请将以下 JSON 添加到模板。

{
  "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"
    }
  }
}

属性值

customApis

名称	说明	Value
type	资源类型	“Microsoft.Web/customApis”
apiVersion	资源 API 版本	'2016-06-01'
name	资源名称	字符串 (必需)
location	资源位置	字符串
标记	资源标记	标记名称和值的字典。请参阅模板中的标记
etag	资源 ETag	string
properties	自定义 API 属性	CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

名称	说明	Value
apiDefinitions	API 定义	ApiResourceDefinitions
apiType	API 类型	“NotSpecified” “Rest” “Soap”
backendService	API 后端服务	ApiResourceBackendService
brandColor	品牌颜色	字符串
capabilities	自定义 API 功能	string[]
connectionParameters	连接参数	对象 (object)
description	自定义 API 说明	字符串
displayName	显示名称	string
iconUri	图标 URI	字符串
runtimeUrls	运行时 URL	string[]
swagger	swagger 的 JSON 表示形式
wsdlDefinition	WSDL 定义	WsdlDefinition

ApiResourceDefinitions

名称	说明	Value
modifiedSwaggerUrl	修改后的 swagger URL	string
originalSwaggerUrl	原始 swagger URL	字符串

ApiResourceBackendService

名称	说明	Value
serviceUrl	服务 URL	string

WsdlDefinition

名称	说明	Value
content	WSDL 内容	string
importMethod	WSDL 导入方法	“NotSpecified” “SoapPassThrough” “SoapToRest”
服务	具有名称和终结点名称的服务	WsdlService
url	The WSDL URL	string
内容	WSDL 内容	string
importMethod	WSDL 导入方法	“NotSpecified” “SoapPassThrough” “SoapToRest”
服务	具有名称和终结点名称的服务	WsdlService
url	The WSDL URL	string

WsdlService

名称	说明	Value
endpointQualifiedNames	终结点的限定名称列表	string[]
qualifiedName	服务的限定名称	字符串 (必需)

Terraform (AzAPI 提供程序) 资源定义

customApis 资源类型可以通过针对以下操作进行部署：

资源组

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Web/customApis 资源，请将以下 Terraform 添加到模板。

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"
  })
}

属性值

customApis

名称	说明	Value
type	资源类型	“Microsoft.Web/customApis@2016-06-01”
name	资源名称	字符串 (必需)
location	资源位置	字符串
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记	标记名称和值的字典。
etag	资源 ETag	string
properties	自定义 API 属性	CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

名称	说明	Value
apiDefinitions	API 定义	ApiResourceDefinitions
apiType	API 类型	“NotSpecified” “Rest” “Soap”
backendService	API 后端服务	ApiResourceBackendService
brandColor	品牌颜色	字符串
capabilities	自定义 API 功能	string[]
connectionParameters	连接参数	对象 (object)
description	自定义 API 说明	string
displayName	显示名称	string
iconUri	图标 URI	字符串
runtimeUrls	运行时 URL	string[]
swagger	swagger 的 JSON 表示形式
wsdlDefinition	WSDL 定义	WsdlDefinition

ApiResourceDefinitions

名称	说明	Value
modifiedSwaggerUrl	修改后的 swagger URL	字符串
originalSwaggerUrl	原始 swagger URL	字符串

ApiResourceBackendService

名称	说明	Value
serviceUrl	服务 URL	string

WsdlDefinition

名称	说明	Value
content	WSDL 内容	string
importMethod	WSDL 导入方法	“NotSpecified” “SoapPassThrough” “SoapToRest”
服务	具有名称和终结点名称的服务	WsdlService
url	The WSDL URL	字符串
内容	WSDL 内容	string
importMethod	WSDL 导入方法	“NotSpecified” “SoapPassThrough” “SoapToRest”
服务	具有名称和终结点名称的服务	WsdlService
url	The WSDL URL	字符串

WsdlService

名称	说明	Value
endpointQualifiedNames	终结点的限定名称列表	string[]
qualifiedName	服务的限定名称	字符串 (必需)

Share via

Microsoft.Web customApis 2016-06-01

Bicep 资源定义

资源格式

属性值

customApis

CustomApiPropertiesDefinition

ApiResourceDefinitions

ApiResourceBackendService

WsdlDefinition

WsdlService

ARM 模板资源定义

资源格式

属性值

customApis

CustomApiPropertiesDefinition

ApiResourceDefinitions

ApiResourceBackendService

WsdlDefinition

WsdlService

Terraform (AzAPI 提供程序) 资源定义

资源格式

属性值

customApis

CustomApiPropertiesDefinition

ApiResourceDefinitions

ApiResourceBackendService

WsdlDefinition

WsdlService

反馈

反馈

其他资源