Microsoft.Network trafficmanagerprofiles 2018-03-01
Bicep 資源定義
trafficmanagerprofiles 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Network/trafficmanagerprofiles 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Network/trafficmanagerprofiles@2018-03-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
target: 'string'
targetResourceId: 'string'
weight: int
}
type: 'string'
}
]
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 流量管理員所使用的 DNS 功能變數名稱結合，以形成配置檔的完整功能變數名稱 （FQDN）。 | 字串 |
| ttl | DNS 時間To-Live （TTL），以秒為單位。 這會通知本機 DNS 解析程式和 DNS 用戶端快取此流量管理員配置檔所提供的 DNS 回應多久。 | int |
端點
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} | 字串 |
| 名字 | 資源的名稱 | 字串 |
| 性能 | 流量管理員端點的屬性。 | EndpointProperties |
| 類型 | 資源的型別。 Ex- Microsoft.Network/trafficManagerProfiles。 | 字串 |
EndpointProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| customHeaders | 自定義標頭的清單。 | EndpointPropertiesCustomHeadersItem[] |
| endpointLocation | 使用「效能」流量路由方法時，指定外部或巢狀端點的位置。 | 字串 |
| endpointMonitorStatus | 端點的監視狀態。 | 'CheckingEndpoint' 「已降級」 'Disabled' 'Inactive' 'Online' 'Stopped' |
| endpointStatus | 端點的狀態。 如果端點為 Enabled，則會針對端點健康情況進行探查，並包含在流量路由方法中。 | 'Disabled' 'Enabled' |
| geoMapping | 使用「地理」流量路由方法時，對應至此端點的國家/地區清單。 如需已接受值的完整清單，請參閱流量管理員地理檔。 | string[] |
| minChildEndpoints | 子配置檔中必須可用的端點數目下限，才能將父配置檔視為可用。 僅適用於類型為 『NestedEndpoints』 的端點。 | int |
| 優先權 | 使用「優先順序」流量路由方法時，此端點的優先順序。 可能的值為 1 到 1000，較低的值代表較高的優先順序。 這是選擇性參數。 如果指定，則必須在所有端點上指定它，而且沒有任何兩個端點可以共用相同的優先順序值。 | int |
| 目標 | 端點的完整 DNS 名稱或 IP 位址。 流量管理員會在 DNS 回應中傳回此值，以將流量導向此端點。 | 字串 |
| targetResourceId | 端點的 Azure 資源 URI。 不適用於類型為 『ExternalEndpoints』 的端點。 | 字串 |
| 重量 | 使用「加權」流量路由方法時，此端點的權數。 可能的值為 1 到 1000。 | int |
EndpointPropertiesCustomHeadersItem
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 標頭名稱。 | 字串 |
| 價值 | 標頭值。 | 字串 |
Microsoft.Network/trafficmanagerprofiles
| 名字 | 描述 | 價值 |
|---|---|---|
| 位置 | 資源所在的 Azure 區域 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 流量管理員配置檔的屬性。 | ProfileProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
MonitorConfig
| 名字 | 描述 | 價值 |
|---|---|---|
| customHeaders | 自定義標頭的清單。 | MonitorConfigCustomHeadersItem[] |
| expectedStatusCodeRanges | 預期的狀態代碼範圍清單。 | MonitorConfigExpectedStatusCodeRangesItem[] |
| intervalInSeconds | 此配置檔中端點的監視間隔。 這是流量管理員會檢查此配置檔中每個端點健康情況的間隔。 | int |
| 路徑 | 相對於用來探查端點健康情況之端點功能變數名稱的路徑。 | 字串 |
| 港口 | 用來探查端點健康情況的 TCP 埠。 | int |
| profileMonitorStatus | 流量管理員配置檔的配置檔層級監視狀態。 | 'CheckingEndpoints' 「已降級」 'Disabled' 'Inactive' 'Online' |
| 協定 | 用來探查端點健康情況的通訊協定（HTTP、HTTPS 或 TCP）。 | 'HTTP' 'HTTPS' 'TCP' |
| timeoutInSeconds | 此設定檔中端點的監視逾時。 這是流量管理員允許此配置檔中的端點回應健康狀態檢查的時間。 | int |
| toleratedNumberOfFailures | 流量管理員在宣告此配置檔中的端點在下次失敗健康狀態檢查之後降級之前，所容許的連續失敗健康情況檢查數目。 | int |
MonitorConfigCustomHeadersItem
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 標頭名稱。 | 字串 |
| 價值 | 標頭值。 | 字串 |
MonitorConfigExpectedStatusCodeRangesItem
| 名字 | 描述 | 價值 |
|---|---|---|
| 麥克斯 | 狀態代碼上限。 | int |
| min | 最小狀態代碼。 | int |
ProfileProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| dnsConfig | 流量管理員配置檔的 DNS 設定。 | DnsConfig |
| 端點 | 流量管理員配置檔中的端點清單。 | 端點[] |
| monitorConfig | 流量管理員配置檔的端點監視設定。 | MonitorConfig |
| profileStatus | 流量管理員配置檔的狀態。 | 'Disabled' 'Enabled' |
| trafficRoutingMethod | 流量管理員配置檔的流量路由方法。 | '地理' 'Performance' 'Priority' 「加權」 |
| trafficViewEnrollmentStatus | 指出流量管理員配置檔的流量檢視為「已啟用」或「已停用」。 Null，表示 'Disabled'。 啟用此功能會增加流量管理配置檔的成本。 | 'Disabled' 'Enabled' |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
快速入門範例
下列快速入門範例會部署此資源類型。
| Bicep 檔案 | 描述 |
|---|---|
| Azure 流量管理員外部端點範例 | 此範本示範如何使用外部端點建立 Azure 流量管理員配置檔。 |
| Azure 流量管理員 VM 範例 | 此範本示範如何建立跨多部虛擬機的 Azure 流量管理員配置檔負載平衡。 |
| Azure 流量管理員 Web 應用程式範例 | 此範本示範如何建立 App Service 的 Azure 流量管理員配置檔。 |
ARM 樣本資源定義
trafficmanagerprofiles 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Network/trafficmanagerprofiles 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Network/trafficmanagerprofiles",
"apiVersion": "2018-03-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",
"target": "string",
"targetResourceId": "string",
"weight": "int"
},
"type": "string"
}
],
"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 流量管理員所使用的 DNS 功能變數名稱結合，以形成配置檔的完整功能變數名稱 （FQDN）。 | 字串 |
| ttl | DNS 時間To-Live （TTL），以秒為單位。 這會通知本機 DNS 解析程式和 DNS 用戶端快取此流量管理員配置檔所提供的 DNS 回應多久。 | int |
端點
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} | 字串 |
| 名字 | 資源的名稱 | 字串 |
| 性能 | 流量管理員端點的屬性。 | EndpointProperties |
| 類型 | 資源的型別。 Ex- Microsoft.Network/trafficManagerProfiles。 | 字串 |
EndpointProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| customHeaders | 自定義標頭的清單。 | EndpointPropertiesCustomHeadersItem[] |
| endpointLocation | 使用「效能」流量路由方法時，指定外部或巢狀端點的位置。 | 字串 |
| endpointMonitorStatus | 端點的監視狀態。 | 'CheckingEndpoint' 「已降級」 'Disabled' 'Inactive' 'Online' 'Stopped' |
| endpointStatus | 端點的狀態。 如果端點為 Enabled，則會針對端點健康情況進行探查，並包含在流量路由方法中。 | 'Disabled' 'Enabled' |
| geoMapping | 使用「地理」流量路由方法時，對應至此端點的國家/地區清單。 如需已接受值的完整清單，請參閱流量管理員地理檔。 | string[] |
| minChildEndpoints | 子配置檔中必須可用的端點數目下限，才能將父配置檔視為可用。 僅適用於類型為 『NestedEndpoints』 的端點。 | int |
| 優先權 | 使用「優先順序」流量路由方法時，此端點的優先順序。 可能的值為 1 到 1000，較低的值代表較高的優先順序。 這是選擇性參數。 如果指定，則必須在所有端點上指定它，而且沒有任何兩個端點可以共用相同的優先順序值。 | int |
| 目標 | 端點的完整 DNS 名稱或 IP 位址。 流量管理員會在 DNS 回應中傳回此值，以將流量導向此端點。 | 字串 |
| targetResourceId | 端點的 Azure 資源 URI。 不適用於類型為 『ExternalEndpoints』 的端點。 | 字串 |
| 重量 | 使用「加權」流量路由方法時，此端點的權數。 可能的值為 1 到 1000。 | int |
EndpointPropertiesCustomHeadersItem
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 標頭名稱。 | 字串 |
| 價值 | 標頭值。 | 字串 |
Microsoft.Network/trafficmanagerprofiles
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2018-03-01' |
| 位置 | 資源所在的 Azure 區域 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 流量管理員配置檔的屬性。 | ProfileProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 類型 | 資源類型 | 'Microsoft.Network/trafficmanagerprofiles' |
MonitorConfig
| 名字 | 描述 | 價值 |
|---|---|---|
| customHeaders | 自定義標頭的清單。 | MonitorConfigCustomHeadersItem[] |
| expectedStatusCodeRanges | 預期的狀態代碼範圍清單。 | MonitorConfigExpectedStatusCodeRangesItem[] |
| intervalInSeconds | 此配置檔中端點的監視間隔。 這是流量管理員會檢查此配置檔中每個端點健康情況的間隔。 | int |
| 路徑 | 相對於用來探查端點健康情況之端點功能變數名稱的路徑。 | 字串 |
| 港口 | 用來探查端點健康情況的 TCP 埠。 | int |
| profileMonitorStatus | 流量管理員配置檔的配置檔層級監視狀態。 | 'CheckingEndpoints' 「已降級」 'Disabled' 'Inactive' 'Online' |
| 協定 | 用來探查端點健康情況的通訊協定（HTTP、HTTPS 或 TCP）。 | 'HTTP' 'HTTPS' 'TCP' |
| timeoutInSeconds | 此設定檔中端點的監視逾時。 這是流量管理員允許此配置檔中的端點回應健康狀態檢查的時間。 | int |
| toleratedNumberOfFailures | 流量管理員在宣告此配置檔中的端點在下次失敗健康狀態檢查之後降級之前，所容許的連續失敗健康情況檢查數目。 | int |
MonitorConfigCustomHeadersItem
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 標頭名稱。 | 字串 |
| 價值 | 標頭值。 | 字串 |
MonitorConfigExpectedStatusCodeRangesItem
| 名字 | 描述 | 價值 |
|---|---|---|
| 麥克斯 | 狀態代碼上限。 | int |
| min | 最小狀態代碼。 | int |
ProfileProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| dnsConfig | 流量管理員配置檔的 DNS 設定。 | DnsConfig |
| 端點 | 流量管理員配置檔中的端點清單。 | 端點[] |
| monitorConfig | 流量管理員配置檔的端點監視設定。 | MonitorConfig |
| profileStatus | 流量管理員配置檔的狀態。 | 'Disabled' 'Enabled' |
| trafficRoutingMethod | 流量管理員配置檔的流量路由方法。 | '地理' 'Performance' 'Priority' 「加權」 |
| trafficViewEnrollmentStatus | 指出流量管理員配置檔的流量檢視為「已啟用」或「已停用」。 Null，表示 'Disabled'。 啟用此功能會增加流量管理配置檔的成本。 | 'Disabled' 'Enabled' |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
Azure 流量管理員 + 應用程式閘道示範設定
|
此範本可讓您在應用程式閘道示範之上快速部署 Azure 流量管理員，以測試不同區域之間的流量分佈。 |
|
Azure 流量管理員示範設定
|
此範本可讓您快速部署 Azure 流量管理員示範，以測試不同區域之間的流量分佈。 |
|
Azure 流量管理員外部端點範例
|
此範本示範如何使用外部端點建立 Azure 流量管理員配置檔。 |
|
Azure 流量管理員多重值路由
|
此範本示範如何使用巢狀端點搭配最小子系和多重值路由來建立 Azure 流量管理員配置檔。 |
|
Azure 流量管理員 VM 範例
|
此範本示範如何建立跨多部虛擬機的 Azure 流量管理員配置檔負載平衡。 |
|
可用性區域 的 Azure 流量管理員 VM 範例
|
此範本示範如何跨放置於可用性區域的多個虛擬機建立 Azure 流量管理員配置檔負載平衡。 |
|
Azure 流量管理員 Web 應用程式範例
|
此範本示範如何建立 App Service 的 Azure 流量管理員配置檔。 |
|
多層式流量管理員、L4 ILB、L7 AppGateway
|
此範本會部署虛擬網路、透過子網隔離網路、部署 VM 並設定負載平衡 |
Terraform （AzAPI 提供者） 資源定義
trafficmanagerprofiles 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Network/trafficmanagerprofiles 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/trafficmanagerprofiles@2018-03-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
target = "string"
targetResourceId = "string"
weight = int
}
type = "string"
}
]
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 流量管理員所使用的 DNS 功能變數名稱結合，以形成配置檔的完整功能變數名稱 （FQDN）。 | 字串 |
| ttl | DNS 時間To-Live （TTL），以秒為單位。 這會通知本機 DNS 解析程式和 DNS 用戶端快取此流量管理員配置檔所提供的 DNS 回應多久。 | int |
端點
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} | 字串 |
| 名字 | 資源的名稱 | 字串 |
| 性能 | 流量管理員端點的屬性。 | EndpointProperties |
| 類型 | 資源的型別。 Ex- Microsoft.Network/trafficManagerProfiles。 | 字串 |
EndpointProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| customHeaders | 自定義標頭的清單。 | EndpointPropertiesCustomHeadersItem[] |
| endpointLocation | 使用「效能」流量路由方法時，指定外部或巢狀端點的位置。 | 字串 |
| endpointMonitorStatus | 端點的監視狀態。 | 'CheckingEndpoint' 「已降級」 'Disabled' 'Inactive' 'Online' 'Stopped' |
| endpointStatus | 端點的狀態。 如果端點為 Enabled，則會針對端點健康情況進行探查，並包含在流量路由方法中。 | 'Disabled' 'Enabled' |
| geoMapping | 使用「地理」流量路由方法時，對應至此端點的國家/地區清單。 如需已接受值的完整清單，請參閱流量管理員地理檔。 | string[] |
| minChildEndpoints | 子配置檔中必須可用的端點數目下限，才能將父配置檔視為可用。 僅適用於類型為 『NestedEndpoints』 的端點。 | int |
| 優先權 | 使用「優先順序」流量路由方法時，此端點的優先順序。 可能的值為 1 到 1000，較低的值代表較高的優先順序。 這是選擇性參數。 如果指定，則必須在所有端點上指定它，而且沒有任何兩個端點可以共用相同的優先順序值。 | int |
| 目標 | 端點的完整 DNS 名稱或 IP 位址。 流量管理員會在 DNS 回應中傳回此值，以將流量導向此端點。 | 字串 |
| targetResourceId | 端點的 Azure 資源 URI。 不適用於類型為 『ExternalEndpoints』 的端點。 | 字串 |
| 重量 | 使用「加權」流量路由方法時，此端點的權數。 可能的值為 1 到 1000。 | int |
EndpointPropertiesCustomHeadersItem
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 標頭名稱。 | 字串 |
| 價值 | 標頭值。 | 字串 |
Microsoft.Network/trafficmanagerprofiles
| 名字 | 描述 | 價值 |
|---|---|---|
| 位置 | 資源所在的 Azure 區域 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 流量管理員配置檔的屬性。 | ProfileProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 類型 | 資源類型 | “Microsoft.Network/trafficmanagerprofiles@2018-03-01” |
MonitorConfig
| 名字 | 描述 | 價值 |
|---|---|---|
| customHeaders | 自定義標頭的清單。 | MonitorConfigCustomHeadersItem[] |
| expectedStatusCodeRanges | 預期的狀態代碼範圍清單。 | MonitorConfigExpectedStatusCodeRangesItem[] |
| intervalInSeconds | 此配置檔中端點的監視間隔。 這是流量管理員會檢查此配置檔中每個端點健康情況的間隔。 | int |
| 路徑 | 相對於用來探查端點健康情況之端點功能變數名稱的路徑。 | 字串 |
| 港口 | 用來探查端點健康情況的 TCP 埠。 | int |
| profileMonitorStatus | 流量管理員配置檔的配置檔層級監視狀態。 | 'CheckingEndpoints' 「已降級」 'Disabled' 'Inactive' 'Online' |
| 協定 | 用來探查端點健康情況的通訊協定（HTTP、HTTPS 或 TCP）。 | 'HTTP' 'HTTPS' 'TCP' |
| timeoutInSeconds | 此設定檔中端點的監視逾時。 這是流量管理員允許此配置檔中的端點回應健康狀態檢查的時間。 | int |
| toleratedNumberOfFailures | 流量管理員在宣告此配置檔中的端點在下次失敗健康狀態檢查之後降級之前，所容許的連續失敗健康情況檢查數目。 | int |
MonitorConfigCustomHeadersItem
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 標頭名稱。 | 字串 |
| 價值 | 標頭值。 | 字串 |
MonitorConfigExpectedStatusCodeRangesItem
| 名字 | 描述 | 價值 |
|---|---|---|
| 麥克斯 | 狀態代碼上限。 | int |
| min | 最小狀態代碼。 | int |
ProfileProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| dnsConfig | 流量管理員配置檔的 DNS 設定。 | DnsConfig |
| 端點 | 流量管理員配置檔中的端點清單。 | 端點[] |
| monitorConfig | 流量管理員配置檔的端點監視設定。 | MonitorConfig |
| profileStatus | 流量管理員配置檔的狀態。 | 'Disabled' 'Enabled' |
| trafficRoutingMethod | 流量管理員配置檔的流量路由方法。 | '地理' 'Performance' 'Priority' 「加權」 |
| trafficViewEnrollmentStatus | 指出流量管理員配置檔的流量檢視為「已啟用」或「已停用」。 Null，表示 'Disabled'。 啟用此功能會增加流量管理配置檔的成本。 | 'Disabled' 'Enabled' |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|