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

Microsoft.Network trafficmanagerprofiles/ExternalEndpoints 2022-04-01-preview

Bicep 资源定义

可以使用目标操作部署 trafficmanagerprofiles/ExternalEndpoints 资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.Network/trafficmanagerprofiles/ExternalEndpoints@2022-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alwaysServe: 'string'
    customHeaders: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    endpointLocation: 'string'
    endpointMonitorStatus: 'string'
    endpointStatus: 'string'
    geoMapping: [
      'string'
    ]
    minChildEndpoints: int
    minChildEndpointsIPv4: int
    minChildEndpointsIPv6: int
    priority: int
    subnets: [
      {
        first: 'string'
        last: 'string'
        scope: int
      }
    ]
    target: 'string'
    targetResourceId: 'string'
    weight: int
  }
}

属性值

EndpointProperties

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

EndpointPropertiesCustomHeadersItem

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

EndpointPropertiesSubnetsItem

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

Microsoft.Network/trafficmanagerprofiles/ExternalEndpoints

名字 描述 价值
名字 资源名称 string (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:trafficmanagerprofiles
性能 流量管理器终结点的属性。 EndpointProperties

ARM 模板资源定义

可以使用目标操作部署 trafficmanagerprofiles/ExternalEndpoints 资源类型:

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

资源格式

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

{
  "type": "Microsoft.Network/trafficmanagerprofiles/ExternalEndpoints",
  "apiVersion": "2022-04-01-preview",
  "name": "string",
  "properties": {
    "alwaysServe": "string",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "endpointLocation": "string",
    "endpointMonitorStatus": "string",
    "endpointStatus": "string",
    "geoMapping": [ "string" ],
    "minChildEndpoints": "int",
    "minChildEndpointsIPv4": "int",
    "minChildEndpointsIPv6": "int",
    "priority": "int",
    "subnets": [
      {
        "first": "string",
        "last": "string",
        "scope": "int"
      }
    ],
    "target": "string",
    "targetResourceId": "string",
    "weight": "int"
  }
}

属性值

EndpointProperties

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

EndpointPropertiesCustomHeadersItem

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

EndpointPropertiesSubnetsItem

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

Microsoft.Network/trafficmanagerprofiles/ExternalEndpoints

名字 描述 价值
apiVersion API 版本 '2022-04-01-preview'
名字 资源名称 string (必需)
性能 流量管理器终结点的属性。 EndpointProperties
类型 资源类型 “Microsoft.Network/trafficmanagerprofiles/ExternalEndpoints”

快速入门模板

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

模板 描述
将终结点添加到现有流量管理器配置文件

部署到 Azure
将外部终结点添加到现有 Azure 流量管理器配置文件的示例模板

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

可以使用目标操作部署 trafficmanagerprofiles/ExternalEndpoints 资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/trafficmanagerprofiles/ExternalEndpoints@2022-04-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      alwaysServe = "string"
      customHeaders = [
        {
          name = "string"
          value = "string"
        }
      ]
      endpointLocation = "string"
      endpointMonitorStatus = "string"
      endpointStatus = "string"
      geoMapping = [
        "string"
      ]
      minChildEndpoints = int
      minChildEndpointsIPv4 = int
      minChildEndpointsIPv6 = int
      priority = int
      subnets = [
        {
          first = "string"
          last = "string"
          scope = int
        }
      ]
      target = "string"
      targetResourceId = "string"
      weight = int
    }
  })
}

属性值

EndpointProperties

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

EndpointPropertiesCustomHeadersItem

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

EndpointPropertiesSubnetsItem

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

Microsoft.Network/trafficmanagerprofiles/ExternalEndpoints

名字 描述 价值
名字 资源名称 string (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:trafficmanagerprofiles
性能 流量管理器终结点的属性。 EndpointProperties
类型 资源类型 “Microsoft.Network/trafficmanagerprofiles/ExternalEndpoints@2022-04-01-preview”