通过

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

Microsoft.Network trafficmanagerprofiles 2018-04-01

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.Network/trafficmanagerprofiles@2018-04-01' = {
  location: 'string'
  name: 'string'
  properties: {
    dnsConfig: {
      relativeName: 'string'
      ttl: int
    }
    endpoints: [
      {
        id: 'string'
        name: 'string'
        properties: {
          customHeaders: [
            {
              name: 'string'
              value: 'string'
            }
          ]
          endpointLocation: 'string'
          endpointMonitorStatus: 'string'
          endpointStatus: 'string'
          geoMapping: [
            'string'
          ]
          minChildEndpoints: int
          priority: int
          subnets: [
            {
              first: 'string'
              last: 'string'
              scope: int
            }
          ]
          target: 'string'
          targetResourceId: 'string'
          weight: int
        }
        type: 'string'
      }
    ]
    maxReturn: int
    monitorConfig: {
      customHeaders: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      expectedStatusCodeRanges: [
        {
          max: int
          min: int
        }
      ]
      intervalInSeconds: int
      path: 'string'
      port: int
      profileMonitorStatus: 'string'
      protocol: 'string'
      timeoutInSeconds: int
      toleratedNumberOfFailures: int
    }
    profileStatus: 'string'
    trafficRoutingMethod: 'string'
    trafficViewEnrollmentStatus: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

DnsConfig

名字 描述 价值
relativeName 此流量管理器配置文件提供的相对 DNS 名称。 此值与 Azure 流量管理器用于形成配置文件的完全限定域名（FQDN）的 DNS 域名相结合。 字符串
ttl DNS 时间To-Live （TTL），以秒为单位。 这会通知本地 DNS 解析程序和 DNS 客户端缓存此流量管理器配置文件提供的 DNS 响应的时间。 int

端点

名字 描述 价值
id 资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} 字符串
名字 资源的名称 字符串
性能 流量管理器终结点的属性。 EndpointProperties
类型 资源的类型。 Ex- Microsoft.Network/trafficManagerProfiles。 字符串

EndpointProperties

名字 描述 价值
customHeaders 自定义标头列表。 EndpointPropertiesCustomHeadersItem[]
endpointLocation 使用“性能”流量路由方法时，指定外部或嵌套终结点的位置。 字符串
endpointMonitorStatus 终结点的监视状态。 “CheckingEndpoint”
“已降级”
“Disabled”
“非活动”
“Online”
“Stopped”
endpointStatus 终结点的状态。 如果终结点已启用，则会探测终结点运行状况，并将其包含在流量路由方法中。 “Disabled”
“Enabled”
geoMapping 使用“地理”流量路由方法时映射到此终结点的国家/地区列表。 有关接受值的完整列表，请参阅流量管理器地理文档。 string[]
minChildEndpoints 子配置文件中必须可用的最小终结点数，以便将父配置文件视为可用。 仅适用于“NestedEndpoints”类型的终结点。 int
优先权 使用“优先级”流量路由方法时，此终结点的优先级。 可能的值为 1 到 1000，较低的值表示更高的优先级。 这是一个可选参数。 如果指定，则必须在所有终结点上指定它，并且两个终结点不能共享相同的优先级值。 int
subnets 使用“子网”流量路由方法时映射到此终结点的子网、IP 地址和/或地址范围的列表。 空列表将匹配其他终结点未涵盖的所有范围。 EndpointPropertiesSubnetsItem[]
目标 终结点的完全限定 DNS 名称或 IP 地址。 流量管理器在 DNS 响应中返回此值，以将流量定向到此终结点。 字符串
targetResourceId 终结点的 Azure 资源 URI。 不适用于“ExternalEndpoints”类型的终结点。 字符串
重量 使用“加权”流量路由方法时此终结点的权重。 可能的值为 1 到 1000。 int

EndpointPropertiesCustomHeadersItem

名字 描述 价值
名字 标头名称。 字符串
价值 标头值。 字符串

EndpointPropertiesSubnetsItem

名字 描述 价值
第一 子网中的第一个地址。 字符串
最后 子网中的最后一个地址。 字符串
范围 块大小（子网掩码中的前导位数）。 int

Microsoft.Network/trafficmanagerprofiles

名字 描述 价值
位置 资源所在的 Azure 区域 字符串
名字 资源名称 string （必需）
性能 流量管理器配置文件的属性。 ProfileProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

MonitorConfig

名字 描述 价值
customHeaders 自定义标头列表。 MonitorConfigCustomHeadersItem[]
expectedStatusCodeRanges 预期状态代码范围的列表。 MonitorConfigExpectedStatusCodeRangesItem[]
intervalInSeconds 此配置文件中终结点的监视间隔。 这是流量管理器将检查此配置文件中每个终结点的运行状况的间隔。 int
路径 相对于用于探测终结点运行状况的终结点域名的路径。 字符串
港口 用于探测终结点运行状况的 TCP 端口。 int
profileMonitorStatus 流量管理器配置文件的配置文件级监视状态。 “CheckingEndpoints”
“已降级”
“Disabled”
“非活动”
“Online”
协议 用于探测终结点运行状况的协议（HTTP、HTTPS 或 TCP）。 “HTTP”
“HTTPS”
“TCP”
timeoutInSeconds 此配置文件中终结点的监视器超时。 这是流量管理器允许此配置文件中的终结点响应运行状况检查的时间。 int
toleratedNumberOfFailures 流量管理器在声明此配置文件中的终结点之前所容忍的连续失败运行状况检查的数量在下次失败的运行状况检查后已降级。 int

MonitorConfigCustomHeadersItem

名字 描述 价值
名字 标头名称。 字符串
价值 标头值。 字符串

MonitorConfigExpectedStatusCodeRangesItem

名字 描述 价值
麦克斯 最大状态代码。 int
min 最小状态代码。 int

ProfileProperties

名字 描述 价值
dnsConfig 流量管理器配置文件的 DNS 设置。 DnsConfig
端点 流量管理器配置文件中的终结点列表。 终结点[]
maxReturn 要为 MultiValue 路由类型返回的最大终结点数。 int
monitorConfig 流量管理器配置文件的终结点监视设置。 MonitorConfig
profileStatus 流量管理器配置文件的状态。 “Disabled”
“Enabled”
trafficRoutingMethod 流量管理器配置文件的流量路由方法。 “地理”
“MultiValue”
“性能”
“Priority”
“Subnet”
“Weighted”
trafficViewEnrollmentStatus 指示流量管理器配置文件的流量视图是“已启用”还是“已禁用”。 Null，指示“Disabled”。 启用此功能会增加流量管理配置文件的成本。 “Disabled”
“Enabled”

TrackedResourceTags

名字 描述 价值

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
Azure 流量管理器外部终结点示例 此模板演示如何使用外部终结点创建 Azure 流量管理器配置文件。
Azure 流量管理器 VM 示例 此模板演示如何跨多个虚拟机创建 Azure 流量管理器配置文件负载均衡。
Azure 流量管理器 Web 应用示例 此模板演示如何为应用服务创建 Azure 流量管理器配置文件。

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.Network/trafficmanagerprofiles",
  "apiVersion": "2018-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "dnsConfig": {
      "relativeName": "string",
      "ttl": "int"
    },
    "endpoints": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "customHeaders": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "endpointLocation": "string",
          "endpointMonitorStatus": "string",
          "endpointStatus": "string",
          "geoMapping": [ "string" ],
          "minChildEndpoints": "int",
          "priority": "int",
          "subnets": [
            {
              "first": "string",
              "last": "string",
              "scope": "int"
            }
          ],
          "target": "string",
          "targetResourceId": "string",
          "weight": "int"
        },
        "type": "string"
      }
    ],
    "maxReturn": "int",
    "monitorConfig": {
      "customHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "expectedStatusCodeRanges": [
        {
          "max": "int",
          "min": "int"
        }
      ],
      "intervalInSeconds": "int",
      "path": "string",
      "port": "int",
      "profileMonitorStatus": "string",
      "protocol": "string",
      "timeoutInSeconds": "int",
      "toleratedNumberOfFailures": "int"
    },
    "profileStatus": "string",
    "trafficRoutingMethod": "string",
    "trafficViewEnrollmentStatus": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

DnsConfig

名字 描述 价值
relativeName 此流量管理器配置文件提供的相对 DNS 名称。 此值与 Azure 流量管理器用于形成配置文件的完全限定域名（FQDN）的 DNS 域名相结合。 字符串
ttl DNS 时间To-Live （TTL），以秒为单位。 这会通知本地 DNS 解析程序和 DNS 客户端缓存此流量管理器配置文件提供的 DNS 响应的时间。 int

端点

名字 描述 价值
id 资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} 字符串
名字 资源的名称 字符串
性能 流量管理器终结点的属性。 EndpointProperties
类型 资源的类型。 Ex- Microsoft.Network/trafficManagerProfiles。 字符串

EndpointProperties

名字 描述 价值
customHeaders 自定义标头列表。 EndpointPropertiesCustomHeadersItem[]
endpointLocation 使用“性能”流量路由方法时，指定外部或嵌套终结点的位置。 字符串
endpointMonitorStatus 终结点的监视状态。 “CheckingEndpoint”
“已降级”
“Disabled”
“非活动”
“Online”
“Stopped”
endpointStatus 终结点的状态。 如果终结点已启用，则会探测终结点运行状况，并将其包含在流量路由方法中。 “Disabled”
“Enabled”
geoMapping 使用“地理”流量路由方法时映射到此终结点的国家/地区列表。 有关接受值的完整列表，请参阅流量管理器地理文档。 string[]
minChildEndpoints 子配置文件中必须可用的最小终结点数，以便将父配置文件视为可用。 仅适用于“NestedEndpoints”类型的终结点。 int
优先权 使用“优先级”流量路由方法时，此终结点的优先级。 可能的值为 1 到 1000，较低的值表示更高的优先级。 这是一个可选参数。 如果指定，则必须在所有终结点上指定它，并且两个终结点不能共享相同的优先级值。 int
subnets 使用“子网”流量路由方法时映射到此终结点的子网、IP 地址和/或地址范围的列表。 空列表将匹配其他终结点未涵盖的所有范围。 EndpointPropertiesSubnetsItem[]
目标 终结点的完全限定 DNS 名称或 IP 地址。 流量管理器在 DNS 响应中返回此值，以将流量定向到此终结点。 字符串
targetResourceId 终结点的 Azure 资源 URI。 不适用于“ExternalEndpoints”类型的终结点。 字符串
重量 使用“加权”流量路由方法时此终结点的权重。 可能的值为 1 到 1000。 int

EndpointPropertiesCustomHeadersItem

名字 描述 价值
名字 标头名称。 字符串
价值 标头值。 字符串

EndpointPropertiesSubnetsItem

名字 描述 价值
第一 子网中的第一个地址。 字符串
最后 子网中的最后一个地址。 字符串
范围 块大小（子网掩码中的前导位数）。 int

Microsoft.Network/trafficmanagerprofiles

名字 描述 价值
apiVersion API 版本 '2018-04-01'
位置 资源所在的 Azure 区域 字符串
名字 资源名称 string （必需）
性能 流量管理器配置文件的属性。 ProfileProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Network/trafficmanagerprofiles”

MonitorConfig

名字 描述 价值
customHeaders 自定义标头列表。 MonitorConfigCustomHeadersItem[]
expectedStatusCodeRanges 预期状态代码范围的列表。 MonitorConfigExpectedStatusCodeRangesItem[]
intervalInSeconds 此配置文件中终结点的监视间隔。 这是流量管理器将检查此配置文件中每个终结点的运行状况的间隔。 int
路径 相对于用于探测终结点运行状况的终结点域名的路径。 字符串
港口 用于探测终结点运行状况的 TCP 端口。 int
profileMonitorStatus 流量管理器配置文件的配置文件级监视状态。 “CheckingEndpoints”
“已降级”
“Disabled”
“非活动”
“Online”
协议 用于探测终结点运行状况的协议（HTTP、HTTPS 或 TCP）。 “HTTP”
“HTTPS”
“TCP”
timeoutInSeconds 此配置文件中终结点的监视器超时。 这是流量管理器允许此配置文件中的终结点响应运行状况检查的时间。 int
toleratedNumberOfFailures 流量管理器在声明此配置文件中的终结点之前所容忍的连续失败运行状况检查的数量在下次失败的运行状况检查后已降级。 int

MonitorConfigCustomHeadersItem

名字 描述 价值
名字 标头名称。 字符串
价值 标头值。 字符串

MonitorConfigExpectedStatusCodeRangesItem

名字 描述 价值
麦克斯 最大状态代码。 int
min 最小状态代码。 int

ProfileProperties

名字 描述 价值
dnsConfig 流量管理器配置文件的 DNS 设置。 DnsConfig
端点 流量管理器配置文件中的终结点列表。 终结点[]
maxReturn 要为 MultiValue 路由类型返回的最大终结点数。 int
monitorConfig 流量管理器配置文件的终结点监视设置。 MonitorConfig
profileStatus 流量管理器配置文件的状态。 “Disabled”
“Enabled”
trafficRoutingMethod 流量管理器配置文件的流量路由方法。 “地理”
“MultiValue”
“性能”
“Priority”
“Subnet”
“Weighted”
trafficViewEnrollmentStatus 指示流量管理器配置文件的流量视图是“已启用”还是“已禁用”。 Null，指示“Disabled”。 启用此功能会增加流量管理配置文件的成本。 “Disabled”
“Enabled”

TrackedResourceTags

名字 描述 价值

快速入门模板

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

模板 描述
Azure 流量管理器 + 应用程序网关演示设置

部署到 Azure 		通过此模板，可以在应用程序网关演示的基础上快速部署 Azure 流量管理器，以测试不同区域之间的流量分布。
Azure 流量管理器演示设置

部署到 Azure 		使用此模板可以快速部署 Azure 流量管理器演示，以测试不同区域之间的流量分布。
Azure 流量管理器外部终结点示例

部署到 Azure 		此模板演示如何使用外部终结点创建 Azure 流量管理器配置文件。
Azure 流量管理器多值路由

部署到 Azure 		此模板演示如何使用具有最小子路由和多值路由的嵌套终结点创建 Azure 流量管理器配置文件。
Azure 流量管理器 VM 示例

部署到 Azure 		此模板演示如何跨多个虚拟机创建 Azure 流量管理器配置文件负载均衡。
使用可用性区域 Azure 流量管理器 VM 示例

部署到 Azure 		此模板演示如何跨位于可用性区域中的多个虚拟机创建 Azure 流量管理器配置文件负载均衡。
Azure 流量管理器 Web 应用示例

部署到 Azure 		此模板演示如何为应用服务创建 Azure 流量管理器配置文件。
多层流量管理器、L4 ILB、L7 AppGateway

部署到 Azure 		此模板部署虚拟网络，通过子网隔离网络，部署 VM 并配置负载均衡

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/trafficmanagerprofiles@2018-04-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      dnsConfig = {
        relativeName = "string"
        ttl = int
      }
      endpoints = [
        {
          id = "string"
          name = "string"
          properties = {
            customHeaders = [
              {
                name = "string"
                value = "string"
              }
            ]
            endpointLocation = "string"
            endpointMonitorStatus = "string"
            endpointStatus = "string"
            geoMapping = [
              "string"
            ]
            minChildEndpoints = int
            priority = int
            subnets = [
              {
                first = "string"
                last = "string"
                scope = int
              }
            ]
            target = "string"
            targetResourceId = "string"
            weight = int
          }
          type = "string"
        }
      ]
      maxReturn = int
      monitorConfig = {
        customHeaders = [
          {
            name = "string"
            value = "string"
          }
        ]
        expectedStatusCodeRanges = [
          {
            max = int
            min = int
          }
        ]
        intervalInSeconds = int
        path = "string"
        port = int
        profileMonitorStatus = "string"
        protocol = "string"
        timeoutInSeconds = int
        toleratedNumberOfFailures = int
      }
      profileStatus = "string"
      trafficRoutingMethod = "string"
      trafficViewEnrollmentStatus = "string"
    }
  })
}

属性值

DnsConfig

名字 描述 价值
relativeName 此流量管理器配置文件提供的相对 DNS 名称。 此值与 Azure 流量管理器用于形成配置文件的完全限定域名（FQDN）的 DNS 域名相结合。 字符串
ttl DNS 时间To-Live （TTL），以秒为单位。 这会通知本地 DNS 解析程序和 DNS 客户端缓存此流量管理器配置文件提供的 DNS 响应的时间。 int

端点

名字 描述 价值
id 资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} 字符串
名字 资源的名称 字符串
性能 流量管理器终结点的属性。 EndpointProperties
类型 资源的类型。 Ex- Microsoft.Network/trafficManagerProfiles。 字符串

EndpointProperties

名字 描述 价值
customHeaders 自定义标头列表。 EndpointPropertiesCustomHeadersItem[]
endpointLocation 使用“性能”流量路由方法时，指定外部或嵌套终结点的位置。 字符串
endpointMonitorStatus 终结点的监视状态。 “CheckingEndpoint”
“已降级”
“Disabled”
“非活动”
“Online”
“Stopped”
endpointStatus 终结点的状态。 如果终结点已启用，则会探测终结点运行状况，并将其包含在流量路由方法中。 “Disabled”
“Enabled”
geoMapping 使用“地理”流量路由方法时映射到此终结点的国家/地区列表。 有关接受值的完整列表，请参阅流量管理器地理文档。 string[]
minChildEndpoints 子配置文件中必须可用的最小终结点数，以便将父配置文件视为可用。 仅适用于“NestedEndpoints”类型的终结点。 int
优先权 使用“优先级”流量路由方法时，此终结点的优先级。 可能的值为 1 到 1000，较低的值表示更高的优先级。 这是一个可选参数。 如果指定，则必须在所有终结点上指定它，并且两个终结点不能共享相同的优先级值。 int
subnets 使用“子网”流量路由方法时映射到此终结点的子网、IP 地址和/或地址范围的列表。 空列表将匹配其他终结点未涵盖的所有范围。 EndpointPropertiesSubnetsItem[]
目标 终结点的完全限定 DNS 名称或 IP 地址。 流量管理器在 DNS 响应中返回此值，以将流量定向到此终结点。 字符串
targetResourceId 终结点的 Azure 资源 URI。 不适用于“ExternalEndpoints”类型的终结点。 字符串
重量 使用“加权”流量路由方法时此终结点的权重。 可能的值为 1 到 1000。 int

EndpointPropertiesCustomHeadersItem

名字 描述 价值
名字 标头名称。 字符串
价值 标头值。 字符串

EndpointPropertiesSubnetsItem

名字 描述 价值
第一 子网中的第一个地址。 字符串
最后 子网中的最后一个地址。 字符串
范围 块大小（子网掩码中的前导位数）。 int

Microsoft.Network/trafficmanagerprofiles

名字 描述 价值
位置 资源所在的 Azure 区域 字符串
名字 资源名称 string （必需）
性能 流量管理器配置文件的属性。 ProfileProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Network/trafficmanagerprofiles@2018-04-01”

MonitorConfig

名字 描述 价值
customHeaders 自定义标头列表。 MonitorConfigCustomHeadersItem[]
expectedStatusCodeRanges 预期状态代码范围的列表。 MonitorConfigExpectedStatusCodeRangesItem[]
intervalInSeconds 此配置文件中终结点的监视间隔。 这是流量管理器将检查此配置文件中每个终结点的运行状况的间隔。 int
路径 相对于用于探测终结点运行状况的终结点域名的路径。 字符串
港口 用于探测终结点运行状况的 TCP 端口。 int
profileMonitorStatus 流量管理器配置文件的配置文件级监视状态。 “CheckingEndpoints”
“已降级”
“Disabled”
“非活动”
“Online”
协议 用于探测终结点运行状况的协议（HTTP、HTTPS 或 TCP）。 “HTTP”
“HTTPS”
“TCP”
timeoutInSeconds 此配置文件中终结点的监视器超时。 这是流量管理器允许此配置文件中的终结点响应运行状况检查的时间。 int
toleratedNumberOfFailures 流量管理器在声明此配置文件中的终结点之前所容忍的连续失败运行状况检查的数量在下次失败的运行状况检查后已降级。 int

MonitorConfigCustomHeadersItem

名字 描述 价值
名字 标头名称。 字符串
价值 标头值。 字符串

MonitorConfigExpectedStatusCodeRangesItem

名字 描述 价值
麦克斯 最大状态代码。 int
min 最小状态代码。 int

ProfileProperties

名字 描述 价值
dnsConfig 流量管理器配置文件的 DNS 设置。 DnsConfig
端点 流量管理器配置文件中的终结点列表。 终结点[]
maxReturn 要为 MultiValue 路由类型返回的最大终结点数。 int
monitorConfig 流量管理器配置文件的终结点监视设置。 MonitorConfig
profileStatus 流量管理器配置文件的状态。 “Disabled”
“Enabled”
trafficRoutingMethod 流量管理器配置文件的流量路由方法。 “地理”
“MultiValue”
“性能”
“Priority”
“Subnet”
“Weighted”
trafficViewEnrollmentStatus 指示流量管理器配置文件的流量视图是“已启用”还是“已禁用”。 Null，指示“Disabled”。 启用此功能会增加流量管理配置文件的成本。 “Disabled”
“Enabled”

TrackedResourceTags

名字 描述 价值