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

Microsoft.Web 连接 2015-08-01-preview

• 最新
• 2016-06-01
• 2015-08-01-preview

Bicep 资源定义

可以使用目标操作部署连接资源类型：

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

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

资源格式

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

resource symbolicname 'Microsoft.Web/connections@2015-08-01-preview' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    api: {
      id: 'string'
      kind: 'string'
      location: 'string'
      name: 'string'
      properties: {
        entity: {
          id: 'string'
          location: 'string'
          name: 'string'
          plan: {
            name: 'string'
            product: 'string'
            promotionCode: 'string'
            publisher: 'string'
            version: 'string'
          }
          properties: {
            id: 'string'
            kind: 'string'
            location: 'string'
            name: 'string'
            properties: {
              apiDefinitionUrl: 'string'
              backendService: {
                id: 'string'
                kind: 'string'
                location: 'string'
                name: 'string'
                properties: {
                  hostingEnvironmentServiceUrls: [
                    {
                      hostId: 'string'
                      hostingEnvironmentId: 'string'
                      serviceUrl: 'string'
                      useInternalRouting: bool
                    }
                  ]
                  serviceUrl: 'string'
                }
                tags: {
                  {customized property}: 'string'
                }
                type: 'string'
              }
              capabilities: [
                'string'
              ]
              changedTime: 'string'
              connectionParameters: {
                {customized property}: {
                  defaultValue: any(...)
                  oAuthSettings: {
                    clientId: 'string'
                    clientSecret: 'string'
                    customParameters: {
                      {customized property}: {
                        options: any(...)
                        uiDefinition: any(...)
                        value: 'string'
                      }
                    }
                    identityProvider: 'string'
                    properties: any(...)
                    redirectUrl: 'string'
                    scopes: [
                      'string'
                    ]
                  }
                  type: 'string'
                  uiDefinition: any(...)
                }
              }
              createdTime: 'string'
              generalInformation: {
                id: 'string'
                kind: 'string'
                location: 'string'
                name: 'string'
                properties: {
                  connectionDisplayName: 'string'
                  connectionPortalUrl: any(...)
                  description: 'string'
                  displayName: 'string'
                  iconUrl: 'string'
                  termsOfUseUrl: 'string'
                }
                tags: {
                  {customized property}: 'string'
                }
                type: 'string'
              }
              metadata: any(...)
              name: 'string'
              path: 'string'
              policies: {
                id: 'string'
                kind: 'string'
                location: 'string'
                name: 'string'
                properties: {
                  content: 'string'
                }
                tags: {
                  {customized property}: 'string'
                }
                type: 'string'
              }
              protocols: [
                'string'
              ]
              runtimeUrls: [
                'string'
              ]
            }
            tags: {
              {customized property}: 'string'
            }
            type: 'string'
          }
          sku: {
            capacity: int
            family: 'string'
            name: 'string'
            size: 'string'
            tier: 'string'
          }
          tags: {
            {customized property}: 'string'
          }
          type: 'string'
        }
        id: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
      type: 'string'
    }
    changedTime: 'string'
    createdTime: 'string'
    customParameterValues: {
      {customized property}: {
        id: 'string'
        kind: 'string'
        location: 'string'
        name: 'string'
        properties: {
          customParameters: {
            {customized property}: {
              id: 'string'
              kind: 'string'
              location: 'string'
              name: 'string'
              properties: {
                option: 'string'
              }
              tags: {
                {customized property}: 'string'
              }
              type: 'string'
            }
          }
        }
        tags: {
          {customized property}: 'string'
        }
        type: 'string'
      }
    }
    displayName: 'string'
    firstExpirationTime: 'string'
    keywords: [
      'string'
    ]
    metadata: any(...)
    name: 'string'
    nonSecretParameterValues: {
      {customized property}: any(...)
    }
    parameterValues: {
      {customized property}: any(...)
    }
    statuses: [
      {
        id: 'string'
        kind: 'string'
        location: 'string'
        name: 'string'
        properties: {
          error: {
            id: 'string'
            kind: 'string'
            location: 'string'
            name: 'string'
            properties: {
              code: 'string'
              message: 'string'
            }
            tags: {
              {customized property}: 'string'
            }
            type: 'string'
          }
          status: 'string'
          target: 'string'
        }
        tags: {
          {customized property}: 'string'
        }
        type: 'string'
      }
    ]
    tenantId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

ApiEntity

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ApiEntityProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ApiEntityProperties

名字	说明	价值
apiDefinitionUrl	API 定义 URL - 可从中下载 swagger 的 URL	字符串
backendService	后端服务定义	BackendServiceDefinition
能力	能力	string[]
changedTime	上次连接更改的时间戳。	字符串
connectionParameters	连接参数	ApiEntityPropertiesConnectionParameters
createdTime	连接创建的时间戳	字符串
generalInformation	通过 APIM 公开时此 API 的 URL 路径	GeneralApiInformation
元数据	数据调用方想要存储的自由窗体对象	任何
姓名	API 的名称 通过 APIM 公开时此 API 的 URL 路径	字符串
路径	通过 APIM 公开时此 API 的 URL 路径	字符串
政策	API 策略	ApiPolicies
协议	前端支持的协议 - http/https	string[]
runtimeUrls	返回可以调用 API 的运行时终结点的只读属性	string[]

ApiEntityPropertiesConnectionParameters

名字	说明	价值

ApiOAuthSettings

名字	说明	价值
clientId	资源提供程序客户端 ID	字符串
客户端密钥	OAuth 所需的客户端密码	字符串
customParameters	OAuth 参数密钥是参数的名称	ApiOAuthSettingsCustomParameters
identityProvider	标识提供程序	字符串
性能	此 oauth 设置的只读属性。	任何
redirectUrl	URL	字符串
范围	OAuth 范围	string[]

ApiOAuthSettingsCustomParameters

名字	说明	价值

ApiOAuthSettingsParameter

名字	说明	价值
选项	只读：可用于此参数的选项	任何
uiDefinition	每个区域性的 UI 定义，因为调用方可以指定区域性	任何
价值	价值	字符串

ApiPolicies

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ApiPoliciesProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ApiPoliciesProperties

名字	说明	价值
内容	xml 策略的内容	字符串

ArmPlan

名字	说明	价值
姓名	名称	字符串
产品	产品	字符串
promotionCode	促销代码	字符串
出版商	发布者	字符串
版本	产品版本	字符串

BackendServiceDefinition

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		BackendServiceDefinitionProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

BackendServiceDefinitionProperties

名字	说明	价值
hostingEnvironmentServiceUrls	每个托管环境的服务 URL	HostingEnvironmentServiceDescriptions[]
serviceUrl	将从中提取 swagger 有效负载的 URL	字符串

ConnectionError

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ConnectionErrorProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ConnectionErrorProperties

名字	说明	价值
代码	状态代码	字符串
消息	状态说明	字符串

ConnectionParameter

名字	说明	价值
defaultValue	默认参数值	任何
oAuthSettings	为后端提供程序定义 OAuth 流的设置	ApiOAuthSettings
类型	参数的类型	“array” “bool” “connection” “int” “oauthSetting” 'object' “secureobject” “securestring” “string”
uiDefinition	UI 定义	任何

ConnectionProperties

名字	说明	价值
API（应用程序编程接口）	扩展的连接提供程序名称	ExpandedParentApiEntity
changedTime	上次连接更改的时间戳。	字符串
createdTime	连接创建的时间戳	字符串
customParameterValues	自定义登录设置值。	ConnectionPropertiesCustomParameterValues
displayName	显示名称	字符串
firstExpirationTime	OAuth 令牌首次过期时的 UTC 时间	字符串
关键字	标记 acl 的关键字列表	string[]
元数据	任何对象	任何
姓名	连接名称	字符串
nonSecretParameterValues	令牌/声明	ConnectionPropertiesNonSecretParameterValues
parameterValues	令牌/声明	ConnectionPropertiesParameterValues
状态	连接状态	ConnectionStatus[]
租户ID		字符串

ConnectionPropertiesCustomParameterValues

名字	说明	价值

ConnectionPropertiesNonSecretParameterValues

名字	说明	价值

ConnectionPropertiesParameterValues

名字	说明	价值

ConnectionStatus

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ConnectionStatusProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ConnectionStatusProperties

名字	说明	价值
错误	错误详细信息	ConnectionError
地位	状态	字符串
目标	错误目标	字符串

CustomLoginSettingValue

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		CustomLoginSettingValueProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

CustomLoginSettingValueProperties

名字	说明	价值
选项	为此自定义登录设置值选择的选项	字符串

ExpandedParentApiEntity

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ExpandedParentApiEntityProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ExpandedParentApiEntityProperties

名字	说明	价值
实体	连接提供程序的 ID	ResponseMessageEnvelopeApiEntity
id	连接提供程序的 ID	字符串

GeneralApiInformation

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		GeneralApiInformationProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

GeneralApiInformationProperties

名字	说明	价值
connectionDisplayName	DefaultConnectionNameTemplate	字符串
connectionPortalUrl	ConnectionPortalUrl	任何
描述	说明	字符串
displayName	显示名称	字符串
iconUrl	图标 URL	字符串
termsOfUseUrl	此 API 的使用条款 URL 的公共可访问 URL	字符串

HostingEnvironmentServiceDescriptions

名字	说明	价值
hostId	主机 ID	字符串
hostingEnvironmentId	托管环境 ID	字符串
serviceUrl	要使用的服务 URL	字符串
useInternalRouting	当后端 URL 位于同一 ASE 中时，出于性能原因，可以将此标志设置为 true 如果还设置了 WebApp.DisableHostNames，则通过仅允许后端访问来提高安全性 通过 API 调用 注意：如果使用此选项，但后端不在同一 ASE 上，则调用将失败	布尔

Microsoft.Web/connections

名字	说明	价值
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	string （必需）
性能		ConnectionProperties
tags	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

ParameterCustomLoginSettingValues

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ParameterCustomLoginSettingValuesProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ParameterCustomLoginSettingValuesProperties

名字	说明	价值
customParameters	自定义参数。	ParameterCustomLoginSettingValuesPropertiesCustomParameters

ParameterCustomLoginSettingValuesPropertiesCustomParameters

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResponseMessageEnvelopeApiEntity

名字	说明	价值
id	资源 ID。通常仅为对 GET 请求的响应填充 ID。 调用方负责传入此项 仅 GET 请求的值。 例如：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}	字符串
位置	地理区域资源属于南CentralUS、SouthEastAsia	字符串
姓名	资源名称	字符串
计划	Azure 资源管理器计划	ArmPlan
性能	特定于资源的属性	ApiEntity
sku	资源的 SKU 说明	SkuDescription
tags	与资源关联的标记	ResponseMessageEnvelopeApiEntityTags
类型	资源类型，例如 Microsoft.Web/sites	字符串

ResponseMessageEnvelopeApiEntityTags

名字	说明	价值

SkuDescription

名字	说明	价值
容量	分配给资源的当前实例数	整数 (int)
家庭	资源 SKU 的家庭代码	字符串
姓名	资源 SKU 的名称	字符串
size	资源 SKU 的大小说明符	字符串
层	资源 SKU 的服务层	字符串

用法示例

Azure 快速入门示例

以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。

Bicep 文件	说明
Azure 逻辑应用 - AS2 发送接收	为两个合作伙伴 Contoso 和 Fabrikam 创建集成帐户，包括合作伙伴和协议的项目。 该模板还会在 Fabrikam Sales 和 Contoso 之间创建逻辑应用，以演示同步 AS2 发送接收。 该模板还会在 Fabrikam Finance 和 Contoso 之间创建逻辑应用，该应用演示异步 AS2 发送接收。
将 FTP 文件复制到 Azure Blob 逻辑应用	使用此模板可以在 FTP 服务器中的文件上创建逻辑应用触发器，并将其复制到 Azure Blob 容器。 可以添加其他触发器或操作以根据需要对其进行自定义。
检索 ARM 模板 中的 Azure 存储访问密钥	此模板将创建一个存储帐户，之后它将通过动态检索存储帐户的主密钥来创建 API 连接。 然后，在逻辑应用中使用 API 连接作为 Blob 更改的触发器轮询。

ARM 模板资源定义

可以使用目标操作部署连接资源类型：

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

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

资源格式

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

{
  "type": "Microsoft.Web/connections",
  "apiVersion": "2015-08-01-preview",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "api": {
      "id": "string",
      "kind": "string",
      "location": "string",
      "name": "string",
      "properties": {
        "entity": {
          "id": "string",
          "location": "string",
          "name": "string",
          "plan": {
            "name": "string",
            "product": "string",
            "promotionCode": "string",
            "publisher": "string",
            "version": "string"
          },
          "properties": {
            "id": "string",
            "kind": "string",
            "location": "string",
            "name": "string",
            "properties": {
              "apiDefinitionUrl": "string",
              "backendService": {
                "id": "string",
                "kind": "string",
                "location": "string",
                "name": "string",
                "properties": {
                  "hostingEnvironmentServiceUrls": [
                    {
                      "hostId": "string",
                      "hostingEnvironmentId": "string",
                      "serviceUrl": "string",
                      "useInternalRouting": "bool"
                    }
                  ],
                  "serviceUrl": "string"
                },
                "tags": {
                  "{customized property}": "string"
                },
                "type": "string"
              },
              "capabilities": [ "string" ],
              "changedTime": "string",
              "connectionParameters": {
                "{customized property}": {
                  "defaultValue": {},
                  "oAuthSettings": {
                    "clientId": "string",
                    "clientSecret": "string",
                    "customParameters": {
                      "{customized property}": {
                        "options": {},
                        "uiDefinition": {},
                        "value": "string"
                      }
                    },
                    "identityProvider": "string",
                    "properties": {},
                    "redirectUrl": "string",
                    "scopes": [ "string" ]
                  },
                  "type": "string",
                  "uiDefinition": {}
                }
              },
              "createdTime": "string",
              "generalInformation": {
                "id": "string",
                "kind": "string",
                "location": "string",
                "name": "string",
                "properties": {
                  "connectionDisplayName": "string",
                  "connectionPortalUrl": {},
                  "description": "string",
                  "displayName": "string",
                  "iconUrl": "string",
                  "termsOfUseUrl": "string"
                },
                "tags": {
                  "{customized property}": "string"
                },
                "type": "string"
              },
              "metadata": {},
              "name": "string",
              "path": "string",
              "policies": {
                "id": "string",
                "kind": "string",
                "location": "string",
                "name": "string",
                "properties": {
                  "content": "string"
                },
                "tags": {
                  "{customized property}": "string"
                },
                "type": "string"
              },
              "protocols": [ "string" ],
              "runtimeUrls": [ "string" ]
            },
            "tags": {
              "{customized property}": "string"
            },
            "type": "string"
          },
          "sku": {
            "capacity": "int",
            "family": "string",
            "name": "string",
            "size": "string",
            "tier": "string"
          },
          "tags": {
            "{customized property}": "string"
          },
          "type": "string"
        },
        "id": "string"
      },
      "tags": {
        "{customized property}": "string"
      },
      "type": "string"
    },
    "changedTime": "string",
    "createdTime": "string",
    "customParameterValues": {
      "{customized property}": {
        "id": "string",
        "kind": "string",
        "location": "string",
        "name": "string",
        "properties": {
          "customParameters": {
            "{customized property}": {
              "id": "string",
              "kind": "string",
              "location": "string",
              "name": "string",
              "properties": {
                "option": "string"
              },
              "tags": {
                "{customized property}": "string"
              },
              "type": "string"
            }
          }
        },
        "tags": {
          "{customized property}": "string"
        },
        "type": "string"
      }
    },
    "displayName": "string",
    "firstExpirationTime": "string",
    "keywords": [ "string" ],
    "metadata": {},
    "name": "string",
    "nonSecretParameterValues": {
      "{customized property}": {}
    },
    "parameterValues": {
      "{customized property}": {}
    },
    "statuses": [
      {
        "id": "string",
        "kind": "string",
        "location": "string",
        "name": "string",
        "properties": {
          "error": {
            "id": "string",
            "kind": "string",
            "location": "string",
            "name": "string",
            "properties": {
              "code": "string",
              "message": "string"
            },
            "tags": {
              "{customized property}": "string"
            },
            "type": "string"
          },
          "status": "string",
          "target": "string"
        },
        "tags": {
          "{customized property}": "string"
        },
        "type": "string"
      }
    ],
    "tenantId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

ApiEntity

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ApiEntityProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ApiEntityProperties

名字	说明	价值
apiDefinitionUrl	API 定义 URL - 可从中下载 swagger 的 URL	字符串
backendService	后端服务定义	BackendServiceDefinition
能力	能力	string[]
changedTime	上次连接更改的时间戳。	字符串
connectionParameters	连接参数	ApiEntityPropertiesConnectionParameters
createdTime	连接创建的时间戳	字符串
generalInformation	通过 APIM 公开时此 API 的 URL 路径	GeneralApiInformation
元数据	数据调用方想要存储的自由窗体对象	任何
姓名	API 的名称 通过 APIM 公开时此 API 的 URL 路径	字符串
路径	通过 APIM 公开时此 API 的 URL 路径	字符串
政策	API 策略	ApiPolicies
协议	前端支持的协议 - http/https	string[]
runtimeUrls	返回可以调用 API 的运行时终结点的只读属性	string[]

ApiEntityPropertiesConnectionParameters

名字	说明	价值

ApiOAuthSettings

名字	说明	价值
clientId	资源提供程序客户端 ID	字符串
客户端密钥	OAuth 所需的客户端密码	字符串
customParameters	OAuth 参数密钥是参数的名称	ApiOAuthSettingsCustomParameters
identityProvider	标识提供程序	字符串
性能	此 oauth 设置的只读属性。	任何
redirectUrl	URL	字符串
范围	OAuth 范围	string[]

ApiOAuthSettingsCustomParameters

名字	说明	价值

ApiOAuthSettingsParameter

名字	说明	价值
选项	只读：可用于此参数的选项	任何
uiDefinition	每个区域性的 UI 定义，因为调用方可以指定区域性	任何
价值	价值	字符串

ApiPolicies

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ApiPoliciesProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ApiPoliciesProperties

名字	说明	价值
内容	xml 策略的内容	字符串

ArmPlan

名字	说明	价值
姓名	名称	字符串
产品	产品	字符串
promotionCode	促销代码	字符串
出版商	发布者	字符串
版本	产品版本	字符串

BackendServiceDefinition

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		BackendServiceDefinitionProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

BackendServiceDefinitionProperties

名字	说明	价值
hostingEnvironmentServiceUrls	每个托管环境的服务 URL	HostingEnvironmentServiceDescriptions[]
serviceUrl	将从中提取 swagger 有效负载的 URL	字符串

ConnectionError

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ConnectionErrorProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ConnectionErrorProperties

名字	说明	价值
代码	状态代码	字符串
消息	状态说明	字符串

ConnectionParameter

名字	说明	价值
defaultValue	默认参数值	任何
oAuthSettings	为后端提供程序定义 OAuth 流的设置	ApiOAuthSettings
类型	参数的类型	“array” “bool” “connection” “int” “oauthSetting” 'object' “secureobject” “securestring” “string”
uiDefinition	UI 定义	任何

ConnectionProperties

名字	说明	价值
API（应用程序编程接口）	扩展的连接提供程序名称	ExpandedParentApiEntity
changedTime	上次连接更改的时间戳。	字符串
createdTime	连接创建的时间戳	字符串
customParameterValues	自定义登录设置值。	ConnectionPropertiesCustomParameterValues
displayName	显示名称	字符串
firstExpirationTime	OAuth 令牌首次过期时的 UTC 时间	字符串
关键字	标记 acl 的关键字列表	string[]
元数据	任何对象	任何
姓名	连接名称	字符串
nonSecretParameterValues	令牌/声明	ConnectionPropertiesNonSecretParameterValues
parameterValues	令牌/声明	ConnectionPropertiesParameterValues
状态	连接状态	ConnectionStatus[]
租户ID		字符串

ConnectionPropertiesCustomParameterValues

名字	说明	价值

ConnectionPropertiesNonSecretParameterValues

名字	说明	价值

ConnectionPropertiesParameterValues

名字	说明	价值

ConnectionStatus

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ConnectionStatusProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ConnectionStatusProperties

名字	说明	价值
错误	错误详细信息	ConnectionError
地位	状态	字符串
目标	错误目标	字符串

CustomLoginSettingValue

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		CustomLoginSettingValueProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

CustomLoginSettingValueProperties

名字	说明	价值
选项	为此自定义登录设置值选择的选项	字符串

ExpandedParentApiEntity

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ExpandedParentApiEntityProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ExpandedParentApiEntityProperties

名字	说明	价值
实体	连接提供程序的 ID	ResponseMessageEnvelopeApiEntity
id	连接提供程序的 ID	字符串

GeneralApiInformation

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		GeneralApiInformationProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

GeneralApiInformationProperties

名字	说明	价值
connectionDisplayName	DefaultConnectionNameTemplate	字符串
connectionPortalUrl	ConnectionPortalUrl	任何
描述	说明	字符串
displayName	显示名称	字符串
iconUrl	图标 URL	字符串
termsOfUseUrl	此 API 的使用条款 URL 的公共可访问 URL	字符串

HostingEnvironmentServiceDescriptions

名字	说明	价值
hostId	主机 ID	字符串
hostingEnvironmentId	托管环境 ID	字符串
serviceUrl	要使用的服务 URL	字符串
useInternalRouting	当后端 URL 位于同一 ASE 中时，出于性能原因，可以将此标志设置为 true 如果还设置了 WebApp.DisableHostNames，则通过仅允许后端访问来提高安全性 通过 API 调用 注意：如果使用此选项，但后端不在同一 ASE 上，则调用将失败	布尔

Microsoft.Web/connections

名字	说明	价值
apiVersion	API 版本	'2015-08-01-preview'
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	string （必需）
性能		ConnectionProperties
tags	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.Web/connections”

ParameterCustomLoginSettingValues

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ParameterCustomLoginSettingValuesProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ParameterCustomLoginSettingValuesProperties

名字	说明	价值
customParameters	自定义参数。	ParameterCustomLoginSettingValuesPropertiesCustomParameters

ParameterCustomLoginSettingValuesPropertiesCustomParameters

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResponseMessageEnvelopeApiEntity

名字	说明	价值
id	资源 ID。通常仅为对 GET 请求的响应填充 ID。 调用方负责传入此项 仅 GET 请求的值。 例如：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}	字符串
位置	地理区域资源属于南CentralUS、SouthEastAsia	字符串
姓名	资源名称	字符串
计划	Azure 资源管理器计划	ArmPlan
性能	特定于资源的属性	ApiEntity
sku	资源的 SKU 说明	SkuDescription
tags	与资源关联的标记	ResponseMessageEnvelopeApiEntityTags
类型	资源类型，例如 Microsoft.Web/sites	字符串

ResponseMessageEnvelopeApiEntityTags

名字	说明	价值

SkuDescription

名字	说明	价值
容量	分配给资源的当前实例数	整数 (int)
家庭	资源 SKU 的家庭代码	字符串
姓名	资源 SKU 的名称	字符串
size	资源 SKU 的大小说明符	字符串
层	资源 SKU 的服务层	字符串

用法示例

Azure 快速入门模板

以下 Azure 快速入门模板 部署此资源类型。

模板	说明
使用逻辑应用 警报到队列	使用此模板可以创建具有 Webhook 的逻辑应用。 触发逻辑应用时，它将添加传递给指定的 Azure 存储队列的有效负载。 可以将此 Webhook 添加到 Azure 警报，然后每当警报触发时，就会在队列中获取该项。
使用逻辑应用 Slack 警报	使用此模板可以创建一个逻辑应用，该应用包含要从 Azure 警报使用的 Webhook。 触发警报时，它会将消息发布到指定的 slack 通道。 需要有一个 Slack 帐户才能使用此模板。
使用逻辑应用 短信警报	使用此模板可以创建一个逻辑应用，该应用包含要从 Azure 警报使用的 Webhook。 触发警报时，它会向你发送一条包含警报详细信息的短信。 它使用 go.gl URL 缩短服务来包含指向门户的链接以查看资源。
Azure 逻辑应用 - AS2 发送接收	为两个合作伙伴 Contoso 和 Fabrikam 创建集成帐户，包括合作伙伴和协议的项目。 该模板还会在 Fabrikam Sales 和 Contoso 之间创建逻辑应用，以演示同步 AS2 发送接收。 该模板还会在 Fabrikam Finance 和 Contoso 之间创建逻辑应用，该应用演示异步 AS2 发送接收。
Azure 逻辑应用 - B2B 灾难恢复复制	为 AS2 MIC 创建复制逻辑应用，并生成并接收 X12 控制编号。 每个逻辑应用的触发器都指向主站点集成帐户。 每个逻辑应用的操作都指向辅助站点集成帐户。
将 FTP 文件复制到 Azure Blob 逻辑应用	使用此模板可以在 FTP 服务器中的文件上创建逻辑应用触发器，并将其复制到 Azure Blob 容器。 可以添加其他触发器或操作以根据需要对其进行自定义。
使用服务总线 关联逻辑应用的消息	其中显示了如何使用 Azure 服务总线将消息与逻辑应用相关联
部署示例逻辑应用，以用作权利管理自定义扩展	此模板创建一个简单的逻辑应用，其中包含所有授权策略设置，服务现在连接，以创建票证和架构到权利管理自定义扩展 API 所需的 http 触发器。
逻辑应用通过电子邮件发送详细的备份报告	创建逻辑应用以通过电子邮件发送有关备份实例、使用情况、作业、策略、策略遵循和优化机会的报告。
逻辑应用， 通过电子邮件发送有关备份和还原作业的报告	创建逻辑应用，通过电子邮件发送有关备份和还原作业的报告
逻辑应用通过电子邮件发送有关备份成本优化 的报告	此模板将逻辑应用部署到指定的电子邮件地址集，用于将有关非活动备份资源的定期报告、可能的备份计划优化和可能的备份保留优化。
逻辑应用以通过电子邮件发送有关备份实例的报告	创建逻辑应用以通过电子邮件发送有关使用 Azure 备份保护的备份实例的报告
逻辑应用，以通过电子邮件发送有关备份策略的报告	创建逻辑应用以通过电子邮件发送有关备份策略的报告
逻辑应用以电子邮件报告备份策略符合性	创建逻辑应用，通过电子邮件发送有关备份实例的备份策略符合性的报告
逻辑应用以通过电子邮件发送 Azure 备份计费	此模板部署一个逻辑应用，用于在计费实体级别将有关密钥备份计费参数（受保护的实例和备份云存储）的定期报告发送到一组指定的电子邮件地址。
逻辑应用，以通过电子邮件发送有关备份的摘要报告	创建逻辑应用，通过电子邮件发送备份摘要报告。
检索 ARM 模板 中的 Azure 存储访问密钥	此模板将创建一个存储帐户，之后它将通过动态检索存储帐户的主密钥来创建 API 连接。 然后，在逻辑应用中使用 API 连接作为 Blob 更改的触发器轮询。
通过逻辑应用按计划运行 SQL 存储过程	使用此模板可以创建一个逻辑应用，该逻辑应用将按计划运行 SQL 存储过程。 该过程的任何参数都可以放入模板的正文部分。
使用逻辑应用 发送电子邮件	使用此模板可以创建发送电子邮件的逻辑应用。 可以添加其他触发器或操作以根据需要对其进行自定义。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署连接资源类型：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/connections@2015-08-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      api = {
        id = "string"
        kind = "string"
        location = "string"
        name = "string"
        properties = {
          entity = {
            id = "string"
            location = "string"
            name = "string"
            plan = {
              name = "string"
              product = "string"
              promotionCode = "string"
              publisher = "string"
              version = "string"
            }
            properties = {
              id = "string"
              kind = "string"
              location = "string"
              name = "string"
              properties = {
                apiDefinitionUrl = "string"
                backendService = {
                  id = "string"
                  kind = "string"
                  location = "string"
                  name = "string"
                  properties = {
                    hostingEnvironmentServiceUrls = [
                      {
                        hostId = "string"
                        hostingEnvironmentId = "string"
                        serviceUrl = "string"
                        useInternalRouting = bool
                      }
                    ]
                    serviceUrl = "string"
                  }
                  tags = {
                    {customized property} = "string"
                  }
                  type = "string"
                }
                capabilities = [
                  "string"
                ]
                changedTime = "string"
                connectionParameters = {
                  {customized property} = {
                    defaultValue = ?
                    oAuthSettings = {
                      clientId = "string"
                      clientSecret = "string"
                      customParameters = {
                        {customized property} = {
                          options = ?
                          uiDefinition = ?
                          value = "string"
                        }
                      }
                      identityProvider = "string"
                      properties = ?
                      redirectUrl = "string"
                      scopes = [
                        "string"
                      ]
                    }
                    type = "string"
                    uiDefinition = ?
                  }
                }
                createdTime = "string"
                generalInformation = {
                  id = "string"
                  kind = "string"
                  location = "string"
                  name = "string"
                  properties = {
                    connectionDisplayName = "string"
                    connectionPortalUrl = ?
                    description = "string"
                    displayName = "string"
                    iconUrl = "string"
                    termsOfUseUrl = "string"
                  }
                  tags = {
                    {customized property} = "string"
                  }
                  type = "string"
                }
                metadata = ?
                name = "string"
                path = "string"
                policies = {
                  id = "string"
                  kind = "string"
                  location = "string"
                  name = "string"
                  properties = {
                    content = "string"
                  }
                  tags = {
                    {customized property} = "string"
                  }
                  type = "string"
                }
                protocols = [
                  "string"
                ]
                runtimeUrls = [
                  "string"
                ]
              }
              tags = {
                {customized property} = "string"
              }
              type = "string"
            }
            sku = {
              capacity = int
              family = "string"
              name = "string"
              size = "string"
              tier = "string"
            }
            tags = {
              {customized property} = "string"
            }
            type = "string"
          }
          id = "string"
        }
        tags = {
          {customized property} = "string"
        }
        type = "string"
      }
      changedTime = "string"
      createdTime = "string"
      customParameterValues = {
        {customized property} = {
          id = "string"
          kind = "string"
          location = "string"
          name = "string"
          properties = {
            customParameters = {
              {customized property} = {
                id = "string"
                kind = "string"
                location = "string"
                name = "string"
                properties = {
                  option = "string"
                }
                tags = {
                  {customized property} = "string"
                }
                type = "string"
              }
            }
          }
          tags = {
            {customized property} = "string"
          }
          type = "string"
        }
      }
      displayName = "string"
      firstExpirationTime = "string"
      keywords = [
        "string"
      ]
      metadata = ?
      name = "string"
      nonSecretParameterValues = {
        {customized property} = ?
      }
      parameterValues = {
        {customized property} = ?
      }
      statuses = [
        {
          id = "string"
          kind = "string"
          location = "string"
          name = "string"
          properties = {
            error = {
              id = "string"
              kind = "string"
              location = "string"
              name = "string"
              properties = {
                code = "string"
                message = "string"
              }
              tags = {
                {customized property} = "string"
              }
              type = "string"
            }
            status = "string"
            target = "string"
          }
          tags = {
            {customized property} = "string"
          }
          type = "string"
        }
      ]
      tenantId = "string"
    }
  }
}

属性值

ApiEntity

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ApiEntityProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ApiEntityProperties

名字	说明	价值
apiDefinitionUrl	API 定义 URL - 可从中下载 swagger 的 URL	字符串
backendService	后端服务定义	BackendServiceDefinition
能力	能力	string[]
changedTime	上次连接更改的时间戳。	字符串
connectionParameters	连接参数	ApiEntityPropertiesConnectionParameters
createdTime	连接创建的时间戳	字符串
generalInformation	通过 APIM 公开时此 API 的 URL 路径	GeneralApiInformation
元数据	数据调用方想要存储的自由窗体对象	任何
姓名	API 的名称 通过 APIM 公开时此 API 的 URL 路径	字符串
路径	通过 APIM 公开时此 API 的 URL 路径	字符串
政策	API 策略	ApiPolicies
协议	前端支持的协议 - http/https	string[]
runtimeUrls	返回可以调用 API 的运行时终结点的只读属性	string[]

ApiEntityPropertiesConnectionParameters

名字	说明	价值

ApiOAuthSettings

名字	说明	价值
clientId	资源提供程序客户端 ID	字符串
客户端密钥	OAuth 所需的客户端密码	字符串
customParameters	OAuth 参数密钥是参数的名称	ApiOAuthSettingsCustomParameters
identityProvider	标识提供程序	字符串
性能	此 oauth 设置的只读属性。	任何
redirectUrl	URL	字符串
范围	OAuth 范围	string[]

ApiOAuthSettingsCustomParameters

名字	说明	价值

ApiOAuthSettingsParameter

名字	说明	价值
选项	只读：可用于此参数的选项	任何
uiDefinition	每个区域性的 UI 定义，因为调用方可以指定区域性	任何
价值	价值	字符串

ApiPolicies

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ApiPoliciesProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ApiPoliciesProperties

名字	说明	价值
内容	xml 策略的内容	字符串

ArmPlan

名字	说明	价值
姓名	名称	字符串
产品	产品	字符串
promotionCode	促销代码	字符串
出版商	发布者	字符串
版本	产品版本	字符串

BackendServiceDefinition

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		BackendServiceDefinitionProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

BackendServiceDefinitionProperties

名字	说明	价值
hostingEnvironmentServiceUrls	每个托管环境的服务 URL	HostingEnvironmentServiceDescriptions[]
serviceUrl	将从中提取 swagger 有效负载的 URL	字符串

ConnectionError

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ConnectionErrorProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ConnectionErrorProperties

名字	说明	价值
代码	状态代码	字符串
消息	状态说明	字符串

ConnectionParameter

名字	说明	价值
defaultValue	默认参数值	任何
oAuthSettings	为后端提供程序定义 OAuth 流的设置	ApiOAuthSettings
类型	参数的类型	“array” “bool” “connection” “int” “oauthSetting” 'object' “secureobject” “securestring” “string”
uiDefinition	UI 定义	任何

ConnectionProperties

名字	说明	价值
API（应用程序编程接口）	扩展的连接提供程序名称	ExpandedParentApiEntity
changedTime	上次连接更改的时间戳。	字符串
createdTime	连接创建的时间戳	字符串
customParameterValues	自定义登录设置值。	ConnectionPropertiesCustomParameterValues
displayName	显示名称	字符串
firstExpirationTime	OAuth 令牌首次过期时的 UTC 时间	字符串
关键字	标记 acl 的关键字列表	string[]
元数据	任何对象	任何
姓名	连接名称	字符串
nonSecretParameterValues	令牌/声明	ConnectionPropertiesNonSecretParameterValues
parameterValues	令牌/声明	ConnectionPropertiesParameterValues
状态	连接状态	ConnectionStatus[]
租户ID		字符串

ConnectionPropertiesCustomParameterValues

名字	说明	价值

ConnectionPropertiesNonSecretParameterValues

名字	说明	价值

ConnectionPropertiesParameterValues

名字	说明	价值

ConnectionStatus

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ConnectionStatusProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ConnectionStatusProperties

名字	说明	价值
错误	错误详细信息	ConnectionError
地位	状态	字符串
目标	错误目标	字符串

CustomLoginSettingValue

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		CustomLoginSettingValueProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

CustomLoginSettingValueProperties

名字	说明	价值
选项	为此自定义登录设置值选择的选项	字符串

ExpandedParentApiEntity

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ExpandedParentApiEntityProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ExpandedParentApiEntityProperties

名字	说明	价值
实体	连接提供程序的 ID	ResponseMessageEnvelopeApiEntity
id	连接提供程序的 ID	字符串

GeneralApiInformation

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		GeneralApiInformationProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

GeneralApiInformationProperties

名字	说明	价值
connectionDisplayName	DefaultConnectionNameTemplate	字符串
connectionPortalUrl	ConnectionPortalUrl	任何
描述	说明	字符串
displayName	显示名称	字符串
iconUrl	图标 URL	字符串
termsOfUseUrl	此 API 的使用条款 URL 的公共可访问 URL	字符串

HostingEnvironmentServiceDescriptions

名字	说明	价值
hostId	主机 ID	字符串
hostingEnvironmentId	托管环境 ID	字符串
serviceUrl	要使用的服务 URL	字符串
useInternalRouting	当后端 URL 位于同一 ASE 中时，出于性能原因，可以将此标志设置为 true 如果还设置了 WebApp.DisableHostNames，则通过仅允许后端访问来提高安全性 通过 API 调用 注意：如果使用此选项，但后端不在同一 ASE 上，则调用将失败	布尔

Microsoft.Web/connections

名字	说明	价值
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	string （必需）
性能		ConnectionProperties
tags	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Web/connections@2015-08-01-preview”

ParameterCustomLoginSettingValues

名字	说明	价值
id	资源 ID	字符串
类	资源类型	字符串
位置	资源位置	string （必需）
姓名	资源名称	字符串
性能		ParameterCustomLoginSettingValuesProperties
tags	资源标记	ResourceTags
类型	资源类型	字符串

ParameterCustomLoginSettingValuesProperties

名字	说明	价值
customParameters	自定义参数。	ParameterCustomLoginSettingValuesPropertiesCustomParameters

ParameterCustomLoginSettingValuesPropertiesCustomParameters

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResourceTags

名字	说明	价值

ResponseMessageEnvelopeApiEntity

名字	说明	价值
id	资源 ID。通常仅为对 GET 请求的响应填充 ID。 调用方负责传入此项 仅 GET 请求的值。 例如：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}	字符串
位置	地理区域资源属于南CentralUS、SouthEastAsia	字符串
姓名	资源名称	字符串
计划	Azure 资源管理器计划	ArmPlan
性能	特定于资源的属性	ApiEntity
sku	资源的 SKU 说明	SkuDescription
tags	与资源关联的标记	ResponseMessageEnvelopeApiEntityTags
类型	资源类型，例如 Microsoft.Web/sites	字符串

ResponseMessageEnvelopeApiEntityTags

名字	说明	价值

SkuDescription

名字	说明	价值
容量	分配给资源的当前实例数	整数 (int)
家庭	资源 SKU 的家庭代码	字符串
姓名	资源 SKU 的名称	字符串
size	资源 SKU 的大小说明符	字符串
层	资源 SKU 的服务层	字符串