Microsoft.Web customApis
Bicep 資源定義
customApis 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Web/customApis 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
apiDefinitions: {
modifiedSwaggerUrl: 'string'
originalSwaggerUrl: 'string'
}
apiType: 'string'
backendService: {
serviceUrl: 'string'
}
brandColor: 'string'
capabilities: [
'string'
]
connectionParameters: {
{customized property}: {
oAuthSettings: {
clientId: 'string'
clientSecret: 'string'
customParameters: {
{customized property}: {
options: any(Azure.Bicep.Types.Concrete.AnyType)
uiDefinition: any(Azure.Bicep.Types.Concrete.AnyType)
value: 'string'
}
}
identityProvider: 'string'
properties: any(Azure.Bicep.Types.Concrete.AnyType)
redirectUrl: 'string'
scopes: [
'string'
]
}
type: 'string'
}
}
description: 'string'
displayName: 'string'
iconUri: 'string'
runtimeUrls: [
'string'
]
swagger: any(Azure.Bicep.Types.Concrete.AnyType)
wsdlDefinition: {
content: 'string'
importMethod: 'string'
service: {
endpointQualifiedNames: [
'string'
]
qualifiedName: 'string'
}
url: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
屬性值
ApiOAuthSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| clientId | 資源提供者用戶端標識碼 | 字串 |
| clientSecret | OAuth 所需的客戶端密碼 | 字串 |
| customParameters | OAuth 參數金鑰是參數的名稱 | ApiOAuthSettingsCustomParameters |
| identityProvider | 識別提供者 | 字串 |
| 性能 | 此 oauth 設定的唯讀屬性。 | 任何 |
| redirectUrl | URL | 字串 |
| 範圍 | OAuth 範圍 | string[] |
ApiOAuthSettingsCustomParameters
| 名字 | 描述 | 價值 |
|---|
ApiOAuthSettingsParameter
| 名字 | 描述 | 價值 |
|---|---|---|
| 選項 | 此參數可用的選項 | 任何 |
| uiDefinition | 每個文化特性的UI定義，因為呼叫端可以指定文化特性 | 任何 |
| 價值 | 設定的值 | 字串 |
ApiResourceBackendService
| 名字 | 描述 | 價值 |
|---|---|---|
| serviceUrl | 服務 URL | 字串 |
ApiResourceDefinitions
| 名字 | 描述 | 價值 |
|---|---|---|
| modifiedSwaggerUrl | 修改過的 Swagger URL | 字串 |
| originalSwaggerUrl | 原始 Swagger URL | 字串 |
ConnectionParameter
| 名字 | 描述 | 價值 |
|---|---|---|
| oAuthSettings | 線上提供者的 OAuth 設定 | ApiOAuthSettings |
| 類型 | 參數的類型 | 'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string' |
CustomApiPropertiesDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| apiDefinitions | API 定義 | ApiResourceDefinitions |
| apiType | API 類型 | 'NotSpecified' 'Rest' 'Soap' |
| backendService | API 後端服務 | ApiResourceBackendService |
| brandColor | 品牌色彩 | 字串 |
| 能力 | 自定義 API 功能 | string[] |
| connectionParameters | 聯機參數 | CustomApiPropertiesDefinitionConnectionParameters |
| 描述 | 自定義 API 描述 | 字串 |
| displayName | 顯示名稱 | 字串 |
| iconUri | 圖示 URI | 字串 |
| runtimeUrls | 運行時間 URL | string[] |
| 斯瓦格 | Swagger 的 JSON 表示法 | 任何 |
| wsdlDefinition | WSDL 定義 | WsdlDefinition |
CustomApiPropertiesDefinitionConnectionParameters
| 名字 | 描述 | 價值 |
|---|
Microsoft.Web/customApis
| 名字 | 描述 | 價值 |
|---|---|---|
| etag | 資源 ETag | 字串 |
| 位置 | 資源位置 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 自定義 API 屬性 | CustomApiPropertiesDefinition |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
TagsDictionary
| 名字 | 描述 | 價值 |
|---|
WsdlDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| 內容 | WSDL 內容 | 字串 |
| importMethod | WSDL 匯入方法 | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| 服務 | 具有名稱和端點名稱的服務 | 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",
"etag": "string",
"location": "string",
"properties": {
"apiDefinitions": {
"modifiedSwaggerUrl": "string",
"originalSwaggerUrl": "string"
},
"apiType": "string",
"backendService": {
"serviceUrl": "string"
},
"brandColor": "string",
"capabilities": [ "string" ],
"connectionParameters": {
"{customized property}": {
"oAuthSettings": {
"clientId": "string",
"clientSecret": "string",
"customParameters": {
"{customized property}": {
"options": {},
"uiDefinition": {},
"value": "string"
}
},
"identityProvider": "string",
"properties": {},
"redirectUrl": "string",
"scopes": [ "string" ]
},
"type": "string"
}
},
"description": "string",
"displayName": "string",
"iconUri": "string",
"runtimeUrls": [ "string" ],
"swagger": {},
"wsdlDefinition": {
"content": "string",
"importMethod": "string",
"service": {
"endpointQualifiedNames": [ "string" ],
"qualifiedName": "string"
},
"url": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
屬性值
ApiOAuthSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| clientId | 資源提供者用戶端標識碼 | 字串 |
| clientSecret | OAuth 所需的客戶端密碼 | 字串 |
| customParameters | OAuth 參數金鑰是參數的名稱 | ApiOAuthSettingsCustomParameters |
| identityProvider | 識別提供者 | 字串 |
| 性能 | 此 oauth 設定的唯讀屬性。 | 任何 |
| redirectUrl | URL | 字串 |
| 範圍 | OAuth 範圍 | string[] |
ApiOAuthSettingsCustomParameters
| 名字 | 描述 | 價值 |
|---|
ApiOAuthSettingsParameter
| 名字 | 描述 | 價值 |
|---|---|---|
| 選項 | 此參數可用的選項 | 任何 |
| uiDefinition | 每個文化特性的UI定義，因為呼叫端可以指定文化特性 | 任何 |
| 價值 | 設定的值 | 字串 |
ApiResourceBackendService
| 名字 | 描述 | 價值 |
|---|---|---|
| serviceUrl | 服務 URL | 字串 |
ApiResourceDefinitions
| 名字 | 描述 | 價值 |
|---|---|---|
| modifiedSwaggerUrl | 修改過的 Swagger URL | 字串 |
| originalSwaggerUrl | 原始 Swagger URL | 字串 |
ConnectionParameter
| 名字 | 描述 | 價值 |
|---|---|---|
| oAuthSettings | 線上提供者的 OAuth 設定 | ApiOAuthSettings |
| 類型 | 參數的類型 | 'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string' |
CustomApiPropertiesDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| apiDefinitions | API 定義 | ApiResourceDefinitions |
| apiType | API 類型 | 'NotSpecified' 'Rest' 'Soap' |
| backendService | API 後端服務 | ApiResourceBackendService |
| brandColor | 品牌色彩 | 字串 |
| 能力 | 自定義 API 功能 | string[] |
| connectionParameters | 聯機參數 | CustomApiPropertiesDefinitionConnectionParameters |
| 描述 | 自定義 API 描述 | 字串 |
| displayName | 顯示名稱 | 字串 |
| iconUri | 圖示 URI | 字串 |
| runtimeUrls | 運行時間 URL | string[] |
| 斯瓦格 | Swagger 的 JSON 表示法 | 任何 |
| wsdlDefinition | WSDL 定義 | WsdlDefinition |
CustomApiPropertiesDefinitionConnectionParameters
| 名字 | 描述 | 價值 |
|---|
Microsoft.Web/customApis
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2016-06-01' |
| etag | 資源 ETag | 字串 |
| 位置 | 資源位置 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 自定義 API 屬性 | CustomApiPropertiesDefinition |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 類型 | 資源類型 | 'Microsoft.Web/customApis' |
TagsDictionary
| 名字 | 描述 | 價值 |
|---|
WsdlDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| 內容 | WSDL 內容 | 字串 |
| importMethod | WSDL 匯入方法 | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| 服務 | 具有名稱和端點名稱的服務 | WsdlService |
| url | The WSDL URL | 字串 |
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"
etag = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
apiDefinitions = {
modifiedSwaggerUrl = "string"
originalSwaggerUrl = "string"
}
apiType = "string"
backendService = {
serviceUrl = "string"
}
brandColor = "string"
capabilities = [
"string"
]
connectionParameters = {
{customized property} = {
oAuthSettings = {
clientId = "string"
clientSecret = "string"
customParameters = {
{customized property} = {
options = ?
uiDefinition = ?
value = "string"
}
}
identityProvider = "string"
properties = ?
redirectUrl = "string"
scopes = [
"string"
]
}
type = "string"
}
}
description = "string"
displayName = "string"
iconUri = "string"
runtimeUrls = [
"string"
]
swagger = ?
wsdlDefinition = {
content = "string"
importMethod = "string"
service = {
endpointQualifiedNames = [
"string"
]
qualifiedName = "string"
}
url = "string"
}
}
})
}
屬性值
ApiOAuthSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| clientId | 資源提供者用戶端標識碼 | 字串 |
| clientSecret | OAuth 所需的客戶端密碼 | 字串 |
| customParameters | OAuth 參數金鑰是參數的名稱 | ApiOAuthSettingsCustomParameters |
| identityProvider | 識別提供者 | 字串 |
| 性能 | 此 oauth 設定的唯讀屬性。 | 任何 |
| redirectUrl | URL | 字串 |
| 範圍 | OAuth 範圍 | string[] |
ApiOAuthSettingsCustomParameters
| 名字 | 描述 | 價值 |
|---|
ApiOAuthSettingsParameter
| 名字 | 描述 | 價值 |
|---|---|---|
| 選項 | 此參數可用的選項 | 任何 |
| uiDefinition | 每個文化特性的UI定義，因為呼叫端可以指定文化特性 | 任何 |
| 價值 | 設定的值 | 字串 |
ApiResourceBackendService
| 名字 | 描述 | 價值 |
|---|---|---|
| serviceUrl | 服務 URL | 字串 |
ApiResourceDefinitions
| 名字 | 描述 | 價值 |
|---|---|---|
| modifiedSwaggerUrl | 修改過的 Swagger URL | 字串 |
| originalSwaggerUrl | 原始 Swagger URL | 字串 |
ConnectionParameter
| 名字 | 描述 | 價值 |
|---|---|---|
| oAuthSettings | 線上提供者的 OAuth 設定 | ApiOAuthSettings |
| 類型 | 參數的類型 | 'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string' |
CustomApiPropertiesDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| apiDefinitions | API 定義 | ApiResourceDefinitions |
| apiType | API 類型 | 'NotSpecified' 'Rest' 'Soap' |
| backendService | API 後端服務 | ApiResourceBackendService |
| brandColor | 品牌色彩 | 字串 |
| 能力 | 自定義 API 功能 | string[] |
| connectionParameters | 聯機參數 | CustomApiPropertiesDefinitionConnectionParameters |
| 描述 | 自定義 API 描述 | 字串 |
| displayName | 顯示名稱 | 字串 |
| iconUri | 圖示 URI | 字串 |
| runtimeUrls | 運行時間 URL | string[] |
| 斯瓦格 | Swagger 的 JSON 表示法 | 任何 |
| wsdlDefinition | WSDL 定義 | WsdlDefinition |
CustomApiPropertiesDefinitionConnectionParameters
| 名字 | 描述 | 價值 |
|---|
Microsoft.Web/customApis
| 名字 | 描述 | 價值 |
|---|---|---|
| etag | 資源 ETag | 字串 |
| 位置 | 資源位置 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 自定義 API 屬性 | CustomApiPropertiesDefinition |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 類型 | 資源類型 | “Microsoft.Web/customApis@2016-06-01” |
TagsDictionary
| 名字 | 描述 | 價值 |
|---|
WsdlDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| 內容 | WSDL 內容 | 字串 |
| importMethod | WSDL 匯入方法 | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| 服務 | 具有名稱和端點名稱的服務 | WsdlService |
| url | The WSDL URL | 字串 |
WsdlService
| 名字 | 描述 | 價值 |
|---|---|---|
| endpointQualifiedNames | 端點限定名稱的清單 | string[] |
| qualifiedName | 服務的限定名稱 | 字串 （必要） |