Microsoft.Network/trafficmanagerprofiles 2017-05-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep 资源定义

trafficmanagerprofiles 资源类型可以使用面向以下对象的操作进行部署：

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

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

资源格式

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

resource symbolicname 'Microsoft.Network/trafficmanagerprofiles@2017-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    dnsConfig: {
      relativeName: 'string'
      ttl: int
    }
    endpoints: [
      {
        properties: {
          endpointLocation: 'string'
          endpointMonitorStatus: 'string'
          endpointStatus: 'string'
          geoMapping: [
            'string'
          ]
          minChildEndpoints: int
          priority: int
          target: 'string'
          targetResourceId: 'string'
          weight: int
        }
      }
    ]
    monitorConfig: {
      intervalInSeconds: int
      path: 'string'
      port: int
      profileMonitorStatus: 'string'
      protocol: 'string'
      timeoutInSeconds: int
      toleratedNumberOfFailures: int
    }
    profileStatus: 'string'
    trafficRoutingMethod: 'string'
  }
}

属性值

trafficmanagerprofiles

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：1-63 有效字符：字母数字、连字符和句点。以字母数字开头和结尾。资源名称在 Azure 中必须是唯一的。
location	资源所在的 Azure 区域	字符串
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
properties	流量管理器配置文件的属性。	ProfileProperties

ProfileProperties

名称	说明	值
dnsConfig	流量管理器配置文件的 DNS 设置。	DnsConfig
端点	流量管理器配置文件中的终结点列表。	Endpoint[]
monitorConfig	流量管理器配置文件的终结点监视设置。	MonitorConfig
profileStatus	流量管理器配置文件的状态。	'Disabled' 'Enabled'
trafficRoutingMethod	流量管理器配置文件的流量路由方法。	“地理” “Performance” 'Priority' “Weighted”

DnsConfig

名称	说明	值
relativeName	此流量管理器配置文件提供的相对 DNS 名称。将此值与 Azure 流量管理器使用的 DNS 域名相结合，可以构成配置文件的完全限定域名 (FQDN)。	string
ttl	DNS 生存时间 (TTL) （以秒为单位）。这会通知本地 DNS 解析器和 DNS 客户端缓存此流量管理器配置文件提供的 DNS 响应的时间。	int

终结点

名称	说明	值
properties	流量管理器终结点的属性。	EndpointProperties

EndpointProperties

名称	说明	值
endpointLocation	指定使用“性能”流量路由方法时外部或嵌套终结点的位置。	字符串
endpointMonitorStatus	终结点的监视状态。	“CheckingEndpoint” “已降级” 'Disabled' “非活动” 'Online' 'Stopped'
endpointStatus	终结点的状态。如果终结点已启用，则会探测它的运行状况，并将它包含在流量路由方法中。	“Disabled” “已启用”
geoMapping	使用“地理”流量路由方法时映射到此终结点的国家/地区列表。有关接受值的完整列表，请参阅流量管理器地理文档。	string[]
minChildEndpoints	子配置文件中必须可用的最小终结点数，才能使父配置文件被视为可用。仅适用于类型为“NestedEndpoints”的终结点。	int
priority	使用“优先级”流量路由方法时此终结点的优先级。可能的值为 1 到 1000，值越小表示优先级越高。这是一个可选参数。如果指定，则必须在所有终结点上指定，并且不能有两个终结点共用同一个优先级值。	int
目标	终结点的完全限定 DNS 名称。流量管理器将在针对直接发往此终结点的流量所做的 DNS 响应中返回此值。	字符串
targetResourceId	终结点的 Azure 资源 URI。不适用于类型为“ExternalEndpoints”的终结点。	字符串
重量	使用“加权”流量路由方法时此终结点的权重。可能的值为 1 到 1000。	int

MonitorConfig

名称	说明	值
intervalInSeconds	此配置文件中终结点的监视间隔。这是流量管理器检查此配置文件中每个终结点的运行状况的时间间隔。	int
路径	相对于用于探测终结点运行状况的终结点域名的路径。	string
port	用于探测终结点运行状况的 TCP 端口。	int
profileMonitorStatus	流量管理器配置文件的配置文件级监视状态。	“CheckingEndpoints” “已降级” “Disabled” “非活动” “Online”
protocol	用于探测终结点运行状况的协议 (HTTP、HTTPS 或 TCP) 。	“HTTP” “HTTPS” “TCP”
timeoutInSeconds	此配置文件中终结点的监视器超时。这是流量管理器允许此配置文件中的终结点响应运行状况检查的时间。	int
toleratedNumberOfFailures	流量管理器在声明此配置文件中的终结点在下次失败的运行状况检查后降级之前，检查连续失败的运行状况数。	int

快速入门模板

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

模板	说明
多层流量管理器、L4 ILB、L7 AppGateway	此模板部署虚拟网络、通过子网隔离网络、部署 VM 和配置负载均衡
Azure 流量管理器 + 应用程序网关演示设置	通过此模板，可以在应用程序网关演示的基础上快速部署 Azure 流量管理器，以测试不同区域之间的流量分布。
Azure 流量管理器演示设置	使用此模板可以快速部署 Azure 流量管理器演示，以测试不同区域之间的流量分布。
Azure 流量管理器外部终结点示例	此模板演示如何使用外部终结点创建 Azure 流量管理器配置文件。
Azure 流量管理器多值路由	此模板演示如何使用具有最小子级和多值路由的嵌套终结点创建 Azure 流量管理器配置文件。
Azure 流量管理器 VM 示例	此模板演示如何跨多个虚拟机创建 Azure 流量管理器配置文件负载均衡。
包含可用性区域的 Azure 流量管理器 VM 示例	此模板演示如何在放置在可用性区域中的多个虚拟机之间创建 Azure 流量管理器配置文件负载均衡。
Azure 流量管理器 Web 应用示例	此模板演示如何为App 服务创建 Azure 流量管理器配置文件。

ARM 模板资源定义

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

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

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

资源格式

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

{
  "type": "Microsoft.Network/trafficmanagerprofiles",
  "apiVersion": "2017-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "dnsConfig": {
      "relativeName": "string",
      "ttl": "int"
    },
    "endpoints": [
      {
        "properties": {
          "endpointLocation": "string",
          "endpointMonitorStatus": "string",
          "endpointStatus": "string",
          "geoMapping": [ "string" ],
          "minChildEndpoints": "int",
          "priority": "int",
          "target": "string",
          "targetResourceId": "string",
          "weight": "int"
        }
      }
    ],
    "monitorConfig": {
      "intervalInSeconds": "int",
      "path": "string",
      "port": "int",
      "profileMonitorStatus": "string",
      "protocol": "string",
      "timeoutInSeconds": "int",
      "toleratedNumberOfFailures": "int"
    },
    "profileStatus": "string",
    "trafficRoutingMethod": "string"
  }
}

属性值

trafficmanagerprofiles

名称	说明	Value
type	资源类型	'Microsoft.Network/trafficmanagerprofiles'
apiVersion	资源 API 版本	'2017-05-01'
name	资源名称	字符串 (必需) 字符限制：1-63 有效字符：字母数字、连字符和句点。以字母数字开头和结尾。资源名称在 Azure 中必须是唯一的。
location	资源所在的 Azure 区域	字符串
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
properties	流量管理器配置文件的属性。	ProfileProperties

ProfileProperties

名称	说明	值
dnsConfig	流量管理器配置文件的 DNS 设置。	DnsConfig
端点	流量管理器配置文件中的终结点列表。	Endpoint[]
monitorConfig	流量管理器配置文件的终结点监视设置。	MonitorConfig
profileStatus	流量管理器配置文件的状态。	'Disabled' 'Enabled'
trafficRoutingMethod	流量管理器配置文件的流量路由方法。	“地理” “Performance” 'Priority' “Weighted”

DnsConfig

名称	说明	值
relativeName	此流量管理器配置文件提供的相对 DNS 名称。将此值与 Azure 流量管理器使用的 DNS 域名相结合，可以构成配置文件的完全限定域名 (FQDN)。	string
ttl	DNS 生存时间 (TTL) （以秒为单位）。这会通知本地 DNS 解析器和 DNS 客户端缓存此流量管理器配置文件提供的 DNS 响应的时间。	int

终结点

名称	说明	值
properties	流量管理器终结点的属性。	EndpointProperties

EndpointProperties

名称	说明	值
endpointLocation	指定使用“性能”流量路由方法时外部或嵌套终结点的位置。	string
endpointMonitorStatus	终结点的监视状态。	“CheckingEndpoint” “已降级” 'Disabled' “非活动” 'Online' 'Stopped'
endpointStatus	终结点的状态。如果终结点已启用，则会探测它的运行状况，并将它包含在流量路由方法中。	'Disabled' 'Enabled'
geoMapping	使用“地理”流量路由方法时映射到此终结点的国家/地区列表。有关接受值的完整列表，请参阅流量管理器地理文档。	string[]
minChildEndpoints	子配置文件中必须可用的最小终结点数，以便将父配置文件视为可用。仅适用于“NestedEndpoints”类型的终结点。	int
priority	使用“优先级”流量路由方法时此终结点的优先级。可能的值为 1 到 1000，值越小表示优先级越高。这是一个可选参数。如果指定，则必须在所有终结点上指定，并且不能有两个终结点共用同一个优先级值。	int
目标	终结点的完全限定 DNS 名称。流量管理器将在针对直接发往此终结点的流量所做的 DNS 响应中返回此值。	字符串
targetResourceId	终结点的的 Azure 资源 URI。不适用于“ExternalEndpoints”类型的终结点。	string
重量	使用“加权”流量路由方法时此终结点的权重。可能的值为 1 到 1000。	int

MonitorConfig

名称	说明	值
intervalInSeconds	此配置文件中终结点的监视间隔。这是流量管理器检查此配置文件中每个终结点的运行状况的时间间隔。	int
路径	相对于用于探测终结点运行状况的终结点域名的路径。	string
port	用于探测终结点运行状况的 TCP 端口。	int
profileMonitorStatus	流量管理器配置文件的配置文件级监视状态。	“CheckingEndpoints” “已降级” 'Disabled' “非活动” 'Online'
protocol	协议 (HTTP、HTTPS 或 TCP) ，用于探测终结点运行状况。	'HTTP' 'HTTPS' 'TCP'
timeoutInSeconds	此配置文件中终结点的监视器超时。这是流量管理器允许此配置文件中的终结点响应运行状况检查的时间。	int
toleratedNumberOfFailures	在下一个失败的运行状况检查后，在此配置文件中声明终结点已降级之前，流量管理器容忍的连续失败运行状况检查数。	int

快速入门模板

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

模板	说明
多层流量管理器、L4 ILB、L7 AppGateway	此模板部署虚拟网络，通过子网隔离网络，部署 VM 并配置负载均衡
Azure 流量管理器 + 应用程序网关演示设置	通过此模板，可以在应用程序网关演示的基础上快速部署 Azure 流量管理器，以测试不同区域之间的流量分布。
Azure 流量管理器演示设置	使用此模板可以快速部署 Azure 流量管理器演示，以测试不同区域之间的流量分布。
Azure 流量管理器外部终结点示例	此模板演示如何使用外部终结点创建 Azure 流量管理器配置文件。
Azure 流量管理器多值路由	此模板演示如何使用具有最小子级和多值路由的嵌套终结点创建 Azure 流量管理器配置文件。
Azure 流量管理器 VM 示例	此模板演示如何跨多个虚拟机创建 Azure 流量管理器配置文件负载均衡。
使用可用性区域的 Azure 流量管理器 VM 示例	此模板演示如何在放置在可用性区域中的多个虚拟机之间创建 Azure 流量管理器配置文件负载均衡。
Azure 流量管理器 Web 应用示例	此模板演示如何为App 服务创建 Azure 流量管理器配置文件。

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

trafficmanagerprofiles 资源类型可以使用面向以下对象的操作进行部署：

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/trafficmanagerprofiles@2017-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      dnsConfig = {
        relativeName = "string"
        ttl = int
      }
      endpoints = [
        {
          properties = {
            endpointLocation = "string"
            endpointMonitorStatus = "string"
            endpointStatus = "string"
            geoMapping = [
              "string"
            ]
            minChildEndpoints = int
            priority = int
            target = "string"
            targetResourceId = "string"
            weight = int
          }
        }
      ]
      monitorConfig = {
        intervalInSeconds = int
        path = "string"
        port = int
        profileMonitorStatus = "string"
        protocol = "string"
        timeoutInSeconds = int
        toleratedNumberOfFailures = int
      }
      profileStatus = "string"
      trafficRoutingMethod = "string"
    }
  })
}

属性值

trafficmanagerprofiles

名称	说明	Value
type	资源类型	“Microsoft.Network/trafficmanagerprofiles@2017-05-01”
name	资源名称	字符串 (必需) 字符限制：1-63 有效字符：字母数字、连字符和句点。以字母数字开头和结尾。资源名称在 Azure 中必须是唯一的。
location	资源所在的 Azure 区域	字符串
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。
properties	流量管理器配置文件的属性。	ProfileProperties

ProfileProperties

名称	说明	值
dnsConfig	流量管理器配置文件的 DNS 设置。	DnsConfig
端点	流量管理器配置文件中的终结点列表。	Endpoint[]
monitorConfig	流量管理器配置文件的终结点监视设置。	MonitorConfig
profileStatus	流量管理器配置文件的状态。	“Disabled” “Enabled”
trafficRoutingMethod	流量管理器配置文件的流量路由方法。	“地理” “性能” “优先级” “Weighted”

DnsConfig

名称	说明	值
relativeName	此流量管理器配置文件提供的相对 DNS 名称。将此值与 Azure 流量管理器使用的 DNS 域名相结合，可以构成配置文件的完全限定域名 (FQDN)。	string
ttl	DNS 生存时间 (TTL) （以秒为单位）。这会通知本地 DNS 解析器和 DNS 客户端缓存此流量管理器配置文件提供的 DNS 响应的时间。	int

终结点

名称	说明	值
properties	流量管理器终结点的属性。	EndpointProperties

EndpointProperties

名称	说明	值
endpointLocation	指定使用“性能”流量路由方法时外部或嵌套终结点的位置。	string
endpointMonitorStatus	终结点的监视状态。	“CheckingEndpoint” “已降级” “Disabled” “非活动” “Online” “Stopped”
endpointStatus	终结点的状态。如果终结点已启用，则会探测它的运行状况，并将它包含在流量路由方法中。	“Disabled” “Enabled”
geoMapping	使用“地理”流量路由方法时映射到此终结点的国家/地区列表。有关接受值的完整列表，请参阅流量管理器地理文档。	string[]
minChildEndpoints	子配置文件中必须可用的最小终结点数，以便将父配置文件视为可用。仅适用于“NestedEndpoints”类型的终结点。	int
priority	使用“优先级”流量路由方法时此终结点的优先级。可能的值为 1 到 1000，值越小表示优先级越高。这是一个可选参数。如果指定，则必须在所有终结点上指定，并且不能有两个终结点共用同一个优先级值。	int
目标	终结点的完全限定 DNS 名称。流量管理器将在针对直接发往此终结点的流量所做的 DNS 响应中返回此值。	字符串
targetResourceId	终结点的的 Azure 资源 URI。不适用于“ExternalEndpoints”类型的终结点。	string
重量	使用“加权”流量路由方法时此终结点的权重。可能的值为 1 到 1000。	int

MonitorConfig

名称	说明	值
intervalInSeconds	此配置文件中终结点的监视间隔。这是流量管理器检查此配置文件中每个终结点的运行状况的时间间隔。	int
路径	相对于用于探测终结点运行状况的终结点域名的路径。	string
port	用于探测终结点运行状况的 TCP 端口。	int
profileMonitorStatus	流量管理器配置文件的配置文件级监视状态。	“CheckingEndpoints” “已降级” “Disabled” “非活动” “Online”
protocol	协议 (HTTP、HTTPS 或 TCP) ，用于探测终结点运行状况。	"HTTP" “HTTPS” “TCP”
timeoutInSeconds	此配置文件中终结点的监视器超时。这是流量管理器允许此配置文件中的终结点响应运行状况检查的时间。	int
toleratedNumberOfFailures	在下一个失败的运行状况检查后，在此配置文件中声明终结点已降级之前，流量管理器容忍的连续失败运行状况检查数。	int

通过

Microsoft.Network trafficmanagerprofiles 2017-05-01

Bicep 资源定义

资源格式

属性值

trafficmanagerprofiles

ProfileProperties

DnsConfig

终结点

EndpointProperties

MonitorConfig

快速入门模板

ARM 模板资源定义

资源格式

属性值

trafficmanagerprofiles

ProfileProperties

DnsConfig

终结点

EndpointProperties

MonitorConfig

快速入门模板

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

资源格式

属性值

trafficmanagerprofiles

ProfileProperties

DnsConfig

终结点

EndpointProperties

MonitorConfig

反馈

其他资源