Microsoft.Web customApis 2016-06-01
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
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 | 字串 (必要) |
| location | 資源位置 | 字串 |
| tags | 資源標籤 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| etag | 資源 ETag | string |
| properties | 自訂 API 屬性 | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| 名稱 | 描述 | 值 |
|---|---|---|
| apiDefinitions | API 定義 | ApiResourceDefinitions |
| apiType | API 類型 | 'NotSpecified' 'Rest' 'Soap' |
| backendService | API 後端服務 | ApiResourceBackendService |
| brandColor | 品牌色彩 | string |
| capabilities | 自訂 API 功能 | string[] |
| connectionParameters | 連線參數 | object |
| 描述 | 自訂 API 描述 | 字串 |
| displayName | 顯示名稱 | 字串 |
| iconUri | 圖示 URI | 字串 |
| runtimeUrls | 執行時間 URL | string[] |
| Swagger | Swagger 的 JSON 標記法 | 針對 Bicep，您可以使用 any () 函式。 |
| wsdlDefinition | WSDL 定義 | WsdlDefinition |
ApiResourceDefinitions
| 名稱 | 描述 | 值 |
|---|---|---|
| modifiedSwaggerUrl | 修改過的 Swagger URL | 字串 |
| originalSwaggerUrl | 原始 Swagger URL | 字串 |
ApiResourceBackendService
| 名稱 | 描述 | 值 |
|---|---|---|
| serviceUrl | 服務 URL | 字串 |
WsdlDefinition
| 名稱 | 描述 | 值 |
|---|---|---|
| 內容 | WSDL 內容 | string |
| importMethod | WSDL 匯入方法 | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | 具有名稱和端點名稱的服務 | WsdlService |
| url | The WSDL URL | string |
| 內容 | WSDL 內容 | 字串 |
| importMethod | WSDL 匯入方法 | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | 具有名稱和端點名稱的服務 | WsdlService |
| url | The WSDL URL | 字串 |
WsdlService
| 名稱 | 描述 | 值 |
|---|---|---|
| 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
| 名稱 | 描述 | 值 |
|---|---|---|
| type | 資源類型 | 'Microsoft.Web/customApis' |
| apiVersion | 資源 API 版本 | '2016-06-01' |
| NAME | 資源名稱 | 字串 (必要) |
| location | 資源位置 | 字串 |
| tags | 資源標籤 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| etag | 資源 ETag | 字串 |
| properties | 自訂 API 屬性 | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| 名稱 | 描述 | 值 |
|---|---|---|
| apiDefinitions | API 定義 | ApiResourceDefinitions |
| apiType | API 類型 | 'NotSpecified' 'Rest' 'Soap' |
| backendService | API 後端服務 | ApiResourceBackendService |
| brandColor | 品牌色彩 | string |
| capabilities | 自訂 API 功能 | string[] |
| connectionParameters | 連線參數 | object |
| 描述 | 自訂 API 描述 | 字串 |
| displayName | 顯示名稱 | string |
| iconUri | 圖示 URI | 字串 |
| runtimeUrls | 執行時間 URL | string[] |
| Swagger | Swagger 的 JSON 標記法 | |
| wsdlDefinition | WSDL 定義 | WsdlDefinition |
ApiResourceDefinitions
| 名稱 | 描述 | 值 |
|---|---|---|
| modifiedSwaggerUrl | 修改過的 Swagger URL | 字串 |
| originalSwaggerUrl | 原始 Swagger URL | string |
ApiResourceBackendService
| 名稱 | 描述 | 值 |
|---|---|---|
| serviceUrl | 服務 URL | 字串 |
WsdlDefinition
| 名稱 | 描述 | 值 |
|---|---|---|
| 內容 | WSDL 內容 | 字串 |
| importMethod | WSDL 匯入方法 | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | 具有名稱和端點名稱的服務 | WsdlService |
| url | The WSDL URL | string |
| 內容 | WSDL 內容 | string |
| importMethod | WSDL 匯入方法 | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | 具有名稱和端點名稱的服務 | WsdlService |
| url | The WSDL URL | string |
WsdlService
| 名稱 | 描述 | 值 |
|---|---|---|
| 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
| 名稱 | 描述 | 值 |
|---|---|---|
| type | 資源類型 | 「Microsoft.Web/customApis@2016-06-01」 |
| NAME | 資源名稱 | 字串 (必要) |
| location | 資源位置 | string |
| parent_id | 若要部署至資源群組，請使用該資源群組的識別碼。 | 字串 (必要) |
| tags | 資源標籤 | 標記名稱和值的字典。 |
| etag | 資源 ETag | 字串 |
| properties | 自訂 API 屬性 | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| 名稱 | 描述 | 值 |
|---|---|---|
| apiDefinitions | API 定義 | ApiResourceDefinitions |
| apiType | API 類型 | 「NotSpecified」 「Rest」 「Soap」 |
| backendService | API 後端服務 | ApiResourceBackendService |
| brandColor | 品牌色彩 | string |
| capabilities | 自訂 API 功能 | string[] |
| connectionParameters | 連線參數 | object |
| 描述 | 自訂 API 描述 | string |
| displayName | 顯示名稱 | string |
| iconUri | 圖示 URI | string |
| runtimeUrls | 執行時間 URL | string[] |
| Swagger | Swagger 的 JSON 標記法 | |
| wsdlDefinition | WSDL 定義 | WsdlDefinition |
ApiResourceDefinitions
| 名稱 | 描述 | 值 |
|---|---|---|
| modifiedSwaggerUrl | 修改過的 Swagger URL | string |
| originalSwaggerUrl | 原始 Swagger URL | 字串 |
ApiResourceBackendService
| 名稱 | 描述 | 值 |
|---|---|---|
| serviceUrl | 服務 URL | 字串 |
WsdlDefinition
| 名稱 | 描述 | 值 |
|---|---|---|
| 內容 | WSDL 內容 | 字串 |
| importMethod | WSDL 匯入方法 | 「NotSpecified」 「SoapPassThrough」 「SoapToRest」 |
| service | 具有名稱和端點名稱的服務 | WsdlService |
| url | The WSDL URL | string |
| 內容 | WSDL 內容 | 字串 |
| importMethod | WSDL 匯入方法 | 「NotSpecified」 「SoapPassThrough」 「SoapToRest」 |
| service | 具有名稱和端點名稱的服務 | WsdlService |
| url | The WSDL URL | string |
WsdlService
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointQualifiedNames | 端點限定名稱的清單 | string[] |
| qualifiedName | 服務的限定名稱 | 字串 (必要) |