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

Microsoft.Web 连接

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.Web/connections@2016-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  etag: 'string'
  properties: {
    api: {
      brandColor: 'string'
      description: 'string'
      displayName: 'string'
      iconUri: 'string'
      id: 'string'
      name: 'string'
      swagger: any()
      type: 'string'
    }
    changedTime: 'string'
    createdTime: 'string'
    customParameterValues: {}
    displayName: 'string'
    nonSecretParameterValues: {}
    parameterValues: {}
    statuses: [
      {
        error: {
          etag: 'string'
          location: 'string'
          properties: {
            code: 'string'
            message: 'string'
          }
          tags: {}
        }
        status: 'string'
        target: 'string'
      }
    ]
    testLinks: [
      {
        method: 'string'
        requestUri: 'string'
      }
    ]
  }
}

属性值

connections

名称 说明 值
name 资源名称 字符串 (必需)
location 资源位置 字符串
标记 资源标记 标记名称和值的字典。 请参阅 模板中的标记
etag 资源 ETag string
properties ApiConnectionDefinitionProperties

ApiConnectionDefinitionProperties

名称 说明 值
api ApiReference
changedTime 上次连接更改的时间戳 字符串
createdTime 连接创建的时间戳 字符串
customParameterValues 自定义参数值的字典 对象 (object)
displayName 显示名称 字符串
nonSecretParameterValues 非secret 参数值的字典 对象 (object)
parameterValues 参数值的字典 对象 (object)
statuses 连接状态 ConnectionStatusDefinition[]
testLinks 用于测试 API 连接的链接 ApiConnectionTestLink[]

ApiReference

名称 说明 值
brandColor 品牌颜色 字符串
description 自定义 API 说明 字符串
displayName 显示名称 字符串
iconUri 图标 URI string
id 资源引用 ID 字符串
name API 的名称 字符串
swagger swagger 的 JSON 表示形式 对于 Bicep，可以使用 任何 () 函数。
类型 资源引用类型 字符串

ConnectionStatusDefinition

名称 说明 值
error 连接错误 ConnectionError
status 网关状态 string
目标 错误的目标 字符串

ConnectionError

名称 说明 值
etag 资源 ETag 字符串
location 资源位置 string
properties ConnectionErrorProperties
标记 资源标记 对象 (object)

ConnectionErrorProperties

名称 说明 值
code 状态代码 字符串
message 状态说明 字符串
名称 说明 值
method HTTP 方法 字符串
requestUri 测试链接请求 URI 字符串

快速入门模板

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

模板 说明
使用逻辑应用发出队列警报

部署到 Azure		 此模板允许创建具有 Webhook 的逻辑应用。 触发逻辑应用时，它会将你传递的有效负载添加到指定的 Azure 存储队列。 可以将此 Webhook 添加到 Azure 警报，然后每当警报触发时，都会在队列中获取该项。
使用逻辑应用发出 Slack 警报

部署到 Azure		 使用此模板可以创建一个逻辑应用，该应用具有要从 Azure 警报使用的 Webhook。 触发警报时，它会将消息发布到指定的 Slack 通道。 需要有一个 Slack 帐户才能使用此模板。
使用逻辑应用对短信发出警报

部署到 Azure		 使用此模板可以创建一个逻辑应用，该应用具有要从 Azure 警报使用的 Webhook。 触发警报时，它会向你发送一条包含警报详细信息的短信。 它使用 go.gl URL 缩短服务来包含指向门户的链接以查看资源。
在 ARM 模板中检索 Azure 存储访问密钥

部署到 Azure		 此模板将创建一个存储帐户，之后它将通过动态检索存储帐户的主密钥来创建 API 连接。 然后，API 连接在逻辑应用中用作 Blob 更改的触发器轮询。 可以在 /samples/azure/azure-quickstart-templates/arm-template-retrieve-azure-storage-access-keys/ 上找到完整的方案。
用于通过电子邮件发送详细备份报表的逻辑应用

部署到 Azure		 创建逻辑应用，通过电子邮件发送有关备份实例、使用情况、作业、策略、策略遵从性和优化机会的报告。
逻辑应用通过电子邮件发送有关备份实例的报告

部署到 Azure		 创建逻辑应用，通过电子邮件发送有关使用 Azure 备份 保护的备份实例的报告
逻辑应用以电子邮件发送有关备份和还原作业的报告

部署到 Azure		 创建逻辑应用以通过电子邮件发送有关备份和还原作业的报告
逻辑应用通过电子邮件发送有关备份成本优化的报告

部署到 Azure		 此模板部署一个逻辑应用，该应用将关于非活动备份资源、可能的备份计划优化和可能的备份保留优化定期报告发送到一组指定的电子邮件地址。
逻辑应用以电子邮件发送有关备份策略的报告

部署到 Azure		 创建逻辑应用以通过电子邮件发送有关备份策略的报告
逻辑应用通过电子邮件发送有关备份策略符合性的报告

部署到 Azure		 创建逻辑应用，通过电子邮件发送有关备份实例的备份策略符合性的报告
逻辑应用以电子邮件发送有关备份的摘要报告

部署到 Azure		 创建逻辑应用以通过电子邮件发送有关备份的摘要报告。
逻辑应用通过电子邮件发送有关Azure 备份计费的报告

部署到 Azure		 此模板部署一个逻辑应用，该应用将有关密钥备份计费参数 (受保护实例的定期报告，并将在计费实体级别) 使用的云存储备份到一组指定的电子邮件地址。
Azure 逻辑应用 - AS2 发送接收

部署到 Azure		 为两个合作伙伴 Contoso 和 Fabrikam 创建集成帐户，包括合作伙伴的项目和协议。 该模板还在 Fabrikam Sales 和 Contoso 之间创建逻辑应用，以演示同步 AS2 发送接收。 该模板还在 Fabrikam Finance 和 Contoso 之间创建逻辑应用，这些应用演示了异步 AS2 发送接收。
Azure 逻辑应用 - B2B 灾难恢复复制

部署到 Azure		 为生成和接收的 X12 控制编号的 AS2 MIC 创建复制逻辑应用。 每个逻辑应用的触发器都指向一个主站点集成帐户。 每个逻辑应用的操作都指向一个辅助站点集成帐户。
使用服务总线通过逻辑应用关联消息

部署到 Azure		 其中显示了如何使用 Azure 服务总线
将 FTP 文件复制到 Azure Blob 逻辑应用

部署到 Azure		 此模板允许对 FTP 服务器中的文件创建逻辑应用触发器，并将其复制到 Azure Blob 容器。 可以添加其他触发器或操作，以根据需要对其进行自定义。
使用逻辑应用发送电子邮件

部署到 Azure		 此模板允许创建发送电子邮件的逻辑应用。 可以添加其他触发器或操作，以根据需要对其进行自定义。
通过逻辑应用按计划运行 SQL 存储过程

部署到 Azure		 使用此模板可以创建一个按计划运行 SQL 存储过程的逻辑应用。 可将该过程的所有参数放入该模板的正文部分。

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.Web/connections",
  "apiVersion": "2016-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "etag": "string",
  "properties": {
    "api": {
      "brandColor": "string",
      "description": "string",
      "displayName": "string",
      "iconUri": "string",
      "id": "string",
      "name": "string",
      "swagger": {},
      "type": "string"
    },
    "changedTime": "string",
    "createdTime": "string",
    "customParameterValues": {},
    "displayName": "string",
    "nonSecretParameterValues": {},
    "parameterValues": {},
    "statuses": [
      {
        "error": {
          "etag": "string",
          "location": "string",
          "properties": {
            "code": "string",
            "message": "string"
          },
          "tags": {}
        },
        "status": "string",
        "target": "string"
      }
    ],
    "testLinks": [
      {
        "method": "string",
        "requestUri": "string"
      }
    ]
  }
}

属性值

connections

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

ApiConnectionDefinitionProperties

名称 说明 值
api ApiReference
changedTime 上次连接更改的时间戳 字符串
createdTime 连接创建的时间戳 字符串
customParameterValues 自定义参数值的字典 对象 (object)
displayName 显示名称 字符串
nonSecretParameterValues 非secret 参数值的字典 对象 (object)
parameterValues 参数值的字典 对象 (object)
statuses 连接状态 ConnectionStatusDefinition[]
testLinks 用于测试 API 连接的链接 ApiConnectionTestLink[]

ApiReference

名称 说明 值
brandColor 品牌颜色 字符串
description 自定义 API 说明 字符串
displayName 显示名称 字符串
iconUri 图标 URI string
id 资源引用 ID 字符串
name API 的名称 字符串
swagger swagger 的 JSON 表示形式
类型 资源引用类型 字符串

ConnectionStatusDefinition

名称 说明 值
error 连接错误 ConnectionError
status 网关状态 string
目标 错误的目标 字符串

ConnectionError

名称 说明 值
etag 资源 ETag 字符串
location 资源位置 string
properties ConnectionErrorProperties
标记 资源标记 对象 (object)

ConnectionErrorProperties

名称 说明 值
code 状态代码 字符串
message 状态说明 字符串
名称 说明 值
method HTTP 方法 字符串
requestUri 测试链接请求 URI 字符串

快速入门模板

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

模板 说明
使用逻辑应用发出队列警报

部署到 Azure		 使用此模板可以创建具有 Webhook 的逻辑应用。 触发逻辑应用时，它会将传递的有效负载添加到指定的 Azure 存储队列。 可以将此 Webhook 添加到 Azure 警报，然后每当警报触发时，都会在队列中获取该项。
使用逻辑应用发出 Slack 警报

部署到 Azure		 通过此模板，可以创建一个逻辑应用，该应用具有要从 Azure 警报使用的 Webhook。 触发警报时，它会将消息发布到指定的 Slack 通道。 需要有一个 Slack 帐户才能使用此模板。
使用逻辑应用对短信发出警报

部署到 Azure		 通过此模板，可以创建一个逻辑应用，该应用具有要从 Azure 警报使用的 Webhook。 触发警报时，它会向你发送一条包含警报详细信息的短信。 它使用 go.gl URL 缩短服务来包含指向门户的链接以查看资源。
在 ARM 模板中检索 Azure 存储访问密钥

部署到 Azure		 此模板将创建一个存储帐户，之后它将通过动态检索存储帐户的主密钥来创建 API 连接。 然后，API 连接在逻辑应用中用作 Blob 更改的触发器轮询。 完整的方案可以在 /samples/azure/azure-quickstart-templates/arm-template-retrieve-azure-storage-access-keys/ 上找到。
用于通过电子邮件发送详细备份报表的逻辑应用

部署到 Azure		 创建逻辑应用，通过电子邮件发送有关备份实例、使用情况、作业、策略、策略遵守和优化机会的报告。
逻辑应用以电子邮件发送有关备份实例的报告

部署到 Azure		 创建逻辑应用，以通过电子邮件发送有关使用 Azure 备份 保护的备份实例的报告
用于通过电子邮件发送有关备份和还原作业的报告的逻辑应用

部署到 Azure		 创建逻辑应用以通过电子邮件发送有关备份和还原作业的报告
逻辑应用以电子邮件发送有关备份成本优化的报告

部署到 Azure		 此模板部署一个逻辑应用，用于将有关非活动备份资源、可能的备份计划优化和可能的备份保留优化的报告定期发送到一组指定的电子邮件地址。
逻辑应用以电子邮件发送有关备份策略的报告

部署到 Azure		 创建逻辑应用以通过电子邮件发送有关备份策略的报告
逻辑应用通过电子邮件发送有关备份策略遵守情况的报告

部署到 Azure		 创建逻辑应用，通过电子邮件发送有关备份实例的备份策略遵守情况的报告
逻辑应用以电子邮件发送有关备份的摘要报告

部署到 Azure		 创建逻辑应用以通过电子邮件发送有关备份的摘要报告。
逻辑应用，用于通过电子邮件发送有关Azure 备份计费的报告

部署到 Azure		 此模板部署一个逻辑应用，该逻辑应用将有关密钥备份计费参数 (受保护实例的定期报告，并将在计费实体级别) 使用的云存储备份到一组指定的电子邮件地址。
Azure 逻辑应用 - AS2 发送接收

部署到 Azure		 为两个合作伙伴（Contoso 和 Fabrikam）创建集成帐户，包括合作伙伴和协议的项目。 该模板还在 Fabrikam Sales 和 Contoso 之间创建逻辑应用，以演示同步 AS2 发送接收。 该模板还在 Fabrikam Finance 和 Contoso 之间创建逻辑应用，这些应用演示异步 AS2 发送接收。
Azure 逻辑应用 - B2B 灾难恢复复制

部署到 Azure		 为 AS2 MIC 创建复制逻辑应用，生成和接收的 X12 控制编号。 每个逻辑应用的触发器都指向一个主站点集成帐户。 每个逻辑应用的操作都指向一个辅助站点集成帐户。
使用服务总线通过逻辑应用关联消息

部署到 Azure		 其中显示了如何使用 Azure 服务总线
将 FTP 文件复制到 Azure Blob 逻辑应用

部署到 Azure		 此模板允许对 FTP 服务器中的文件创建逻辑应用触发器，并将其复制到 Azure Blob 容器。 可以添加其他触发器或操作，以根据需要对其进行自定义。
使用逻辑应用发送电子邮件

部署到 Azure		 使用此模板可以创建发送电子邮件的逻辑应用。 可以添加其他触发器或操作，以根据需要对其进行自定义。
通过逻辑应用按计划运行 SQL 存储过程

部署到 Azure		 使用此模板可以创建一个按计划运行 SQL 存储过程的逻辑应用。 可将该过程的所有参数放入该模板的正文部分。

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/connections@2016-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      api = {
        brandColor = "string"
        description = "string"
        displayName = "string"
        iconUri = "string"
        id = "string"
        name = "string"
        type = "string"
      }
      changedTime = "string"
      createdTime = "string"
      customParameterValues = {}
      displayName = "string"
      nonSecretParameterValues = {}
      parameterValues = {}
      statuses = [
        {
          error = {
            etag = "string"
            location = "string"
            properties = {
              code = "string"
              message = "string"
            }
            tags = {}
          }
          status = "string"
          target = "string"
        }
      ]
      testLinks = [
        {
          method = "string"
          requestUri = "string"
        }
      ]
    }
    etag = "string"
  })
}

属性值

connections

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

ApiConnectionDefinitionProperties

名称 说明 值
api ApiReference
changedTime 上次连接更改的时间戳 字符串
createdTime 连接创建的时间戳 字符串
customParameterValues 自定义参数值的字典 对象 (object)
displayName 显示名称 字符串
nonSecretParameterValues 非secret 参数值的字典 对象 (object)
parameterValues 参数值的字典 对象 (object)
statuses 连接状态 ConnectionStatusDefinition[]
testLinks 用于测试 API 连接的链接 ApiConnectionTestLink[]

ApiReference

名称 说明 值
brandColor 品牌颜色 字符串
description 自定义 API 说明 字符串
displayName 显示名称 字符串
iconUri 图标 URI string
id 资源引用 ID 字符串
name API 的名称 字符串
swagger swagger 的 JSON 表示形式
类型 资源引用类型 字符串

ConnectionStatusDefinition

名称 说明 值
error 连接错误 ConnectionError
status 网关状态 string
目标 错误的目标 字符串

ConnectionError

名称 说明 值
etag 资源 ETag 字符串
location 资源位置 string
properties ConnectionErrorProperties
标记 资源标记 对象 (object)

ConnectionErrorProperties

名称 说明 值
code 状态代码 字符串
message 状态说明 字符串
名称 说明 值
method HTTP 方法 字符串
requestUri 测试链接请求 URI 字符串