Microsoft.Network トラフィックマネージャープロファイル 2015-11-01

• 最新の を する
• 2024-04-01-プレビュー
• 2022-04-01
• 2022-04-01-プレビュー
• 2018-08-01
• 2018-04-01
• 2018-03-01
• 2018-02-01
• 2017-05-01
• 2017-03-01
• 2015-11-01

Bicep リソース定義

trafficmanagerprofiles リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンで変更されたプロパティの一覧については、変更ログの 参照してください。

リソースの形式

Microsoft.Network/trafficmanagerprofiles リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Network/trafficmanagerprofiles@2015-11-01' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    dnsConfig: {
      fqdn: 'string'
      relativeName: 'string'
      ttl: int
    }
    endpoints: [
      {
        id: 'string'
        name: 'string'
        properties: {
          endpointLocation: 'string'
          endpointMonitorStatus: 'string'
          endpointStatus: 'string'
          minChildEndpoints: int
          priority: int
          target: 'string'
          targetResourceId: 'string'
          weight: int
        }
        type: 'string'
      }
    ]
    monitorConfig: {
      path: 'string'
      port: int
      profileMonitorStatus: 'string'
      protocol: 'string'
    }
    profileStatus: 'string'
    trafficRoutingMethod: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.Network/trafficmanagerprofiles

名前	形容	価値
位置	リソースの場所	文字列
名前	リソース名	string (必須)
プロパティ	Traffic Manager プロファイルのプロパティを表すクラス。	プロファイルプロパティ
スコープ	デプロイ スコープとは異なるスコープでリソースを作成するときに使用します。	このプロパティをリソースのシンボリック名に設定して、拡張リソースを適用します。
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください

DnsConfigの

名前	形容	価値
FQDNの	Traffic Manager プロファイルの完全修飾ドメイン名 (FQDN) を取得または設定します。 これは、RelativeName と Azure Traffic Manager で使用される DNS ドメインの連結から形成されます。	文字列
relativeName (親子名)	この Traffic Manager プロファイルによって提供される相対 DNS 名を取得または設定します。 この値は、Azure Traffic Manager で使用される DNS ドメイン名と組み合わせて、プロファイルの完全修飾ドメイン名 (FQDN) を形成します。	文字列
TTLの	DNS 時間To-Live (TTL) を秒単位で取得または設定します。 これにより、ローカル DNS リゾルバーと DNS クライアントに、この Traffic Manager プロファイルによって提供される DNS 応答をキャッシュする期間が通知されます。	整数 (int)

エンドポイント

名前	形容	価値
身分証明書	Traffic Manager エンドポイントの ID を取得または設定します。	文字列
名前	Traffic Manager エンドポイントの名前を取得または設定します。	文字列
プロパティ	Traffic Manager エンドポイントのプロパティを表すクラス。	エンドポイントプロパティ
型	Traffic Manager エンドポイントのエンドポイントの種類を取得または設定します。	文字列

エンドポイントプロパティ

名前	形容	価値
エンドポイントロケーション	"パフォーマンス" トラフィック ルーティング方法を使用する場合の外部エンドポイントまたは入れ子になったエンドポイントの場所を指定します。	文字列
エンドポイントモニターステータス	エンドポイントの監視状態を取得または設定します。	文字列
エンドポイントステータス	エンドポイントの状態を取得または設定します。. エンドポイントが有効の場合、エンドポイントの正常性がプローブされ、トラフィック ルーティング方法に含まれます。 有効な値は 、'Enabled' と 'Disabled' です。	文字列
minChildエンドポイント	親プロファイルを使用可能と見なすために子プロファイルで使用できる必要があるエンドポイントの最小数を取得または設定します。 型 'NestedEndpoints' のエンドポイントにのみ適用されます。	整数 (int)
優先権	"Priority" トラフィック ルーティング方法を使用する場合の、このエンドポイントの優先順位を取得または設定します。 指定できる値は 1 から 1000 で、値が小さい方が優先度が高いことを表します。 これは省略可能なパラメーターです。 指定する場合は、すべてのエンドポイントで指定する必要があり、同じ優先順位の値を共有できるエンドポイントは 2 つありません。	整数 (int)
ターゲット	エンドポイントの完全修飾 DNS 名を取得または設定します。 Traffic Manager は、このエンドポイントにトラフィックを誘導するために DNS 応答でこの値を返します。	文字列
ターゲットリソースID	エンドポイントの Azure リソース URI を取得または設定します。 "ExternalEndpoints" 型のエンドポイントには適用されません。	文字列
重量	"重み付け" トラフィック ルーティング方法を使用する場合の、このエンドポイントの重みを取得または設定します。 指定できる値は 1 から 1000 です。	整数 (int)

モニター設定

名前	形容	価値
パス	エンドポイントの正常性のプローブに使用されるエンドポイント ドメイン名に対する相対パスを取得または設定します。	文字列
ポート	エンドポイントの正常性のプローブに使用される TCP ポートを取得または設定します。	整数 (int)
プロファイルモニターステータス	Traffic Manager プロファイルのプロファイル レベルの監視状態を取得または設定します。	文字列
プロトコル	エンドポイントの正常性のプローブに使用されるプロトコル (HTTP または HTTPS) を取得または設定します。	文字列

プロファイルプロパティ

名前	形容	価値
dnsConfigの	Traffic Manager プロファイルの DNS 設定を取得または設定します。	DnsConfigの
エンドポイント	Traffic Manager プロファイル内のエンドポイントの一覧を取得または設定します。	エンドポイント[]
モニターコンフィグ	Traffic Manager プロファイルのエンドポイント監視設定を取得または設定します。	モニターコンフィグ
profileステータス	Traffic Manager プロファイルの状態を取得または設定します。 有効な値は 、'Enabled' と 'Disabled' です。	文字列
トラフィックルーティングメソッド	Traffic Manager プロファイルのトラフィック ルーティング方法を取得または設定します。 指定できる値は、'Performance'、'Weighted'、または 'Priority' です。	文字列

リソースタグ

名前	形容	価値

使用例

Azure 検証済みモジュール

次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

モジュール	形容
Traffic Manager プロファイルの	Traffic Manager プロファイル用 AVM リソース モジュール

Azure クイック スタートのサンプル

次 Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル	形容
Azure Traffic Manager の外部エンドポイントの例	このテンプレートでは、外部エンドポイントを使用して Azure Traffic Manager プロファイルを作成する方法を示します。
Azure Traffic Manager VM の例	このテンプレートでは、複数の仮想マシン間で Azure Traffic Manager プロファイルの負荷分散を作成する方法を示します。
Azure Traffic Manager Web アプリの例	このテンプレートでは、App Service の Azure Traffic Manager プロファイルを作成する方法を示します。

ARM テンプレート リソース定義

trafficmanagerprofiles リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンで変更されたプロパティの一覧については、変更ログの 参照してください。

リソースの形式

Microsoft.Network/trafficmanagerprofiles リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Network/trafficmanagerprofiles",
  "apiVersion": "2015-11-01",
  "name": "string",
  "location": "string",
  "properties": {
    "dnsConfig": {
      "fqdn": "string",
      "relativeName": "string",
      "ttl": "int"
    },
    "endpoints": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "endpointLocation": "string",
          "endpointMonitorStatus": "string",
          "endpointStatus": "string",
          "minChildEndpoints": "int",
          "priority": "int",
          "target": "string",
          "targetResourceId": "string",
          "weight": "int"
        },
        "type": "string"
      }
    ],
    "monitorConfig": {
      "path": "string",
      "port": "int",
      "profileMonitorStatus": "string",
      "protocol": "string"
    },
    "profileStatus": "string",
    "trafficRoutingMethod": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.Network/trafficmanagerprofiles

名前	形容	価値
apiVersion (英語)	API のバージョン	'2015-11-01'
位置	リソースの場所	文字列
名前	リソース名	string (必須)
プロパティ	Traffic Manager プロファイルのプロパティを表すクラス。	プロファイルプロパティ
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください
型	リソースの種類	'Microsoft.Network/trafficmanagerprofiles'

DnsConfigの

名前	形容	価値
FQDNの	Traffic Manager プロファイルの完全修飾ドメイン名 (FQDN) を取得または設定します。 これは、RelativeName と Azure Traffic Manager で使用される DNS ドメインの連結から形成されます。	文字列
relativeName (親子名)	この Traffic Manager プロファイルによって提供される相対 DNS 名を取得または設定します。 この値は、Azure Traffic Manager で使用される DNS ドメイン名と組み合わせて、プロファイルの完全修飾ドメイン名 (FQDN) を形成します。	文字列
TTLの	DNS 時間To-Live (TTL) を秒単位で取得または設定します。 これにより、ローカル DNS リゾルバーと DNS クライアントに、この Traffic Manager プロファイルによって提供される DNS 応答をキャッシュする期間が通知されます。	整数 (int)

エンドポイント

名前	形容	価値
身分証明書	Traffic Manager エンドポイントの ID を取得または設定します。	文字列
名前	Traffic Manager エンドポイントの名前を取得または設定します。	文字列
プロパティ	Traffic Manager エンドポイントのプロパティを表すクラス。	エンドポイントプロパティ
型	Traffic Manager エンドポイントのエンドポイントの種類を取得または設定します。	文字列

エンドポイントプロパティ

名前	形容	価値
エンドポイントロケーション	"パフォーマンス" トラフィック ルーティング方法を使用する場合の外部エンドポイントまたは入れ子になったエンドポイントの場所を指定します。	文字列
エンドポイントモニターステータス	エンドポイントの監視状態を取得または設定します。	文字列
エンドポイントステータス	エンドポイントの状態を取得または設定します。. エンドポイントが有効の場合、エンドポイントの正常性がプローブされ、トラフィック ルーティング方法に含まれます。 有効な値は 、'Enabled' と 'Disabled' です。	文字列
minChildエンドポイント	親プロファイルを使用可能と見なすために子プロファイルで使用できる必要があるエンドポイントの最小数を取得または設定します。 型 'NestedEndpoints' のエンドポイントにのみ適用されます。	整数 (int)
優先権	"Priority" トラフィック ルーティング方法を使用する場合の、このエンドポイントの優先順位を取得または設定します。 指定できる値は 1 から 1000 で、値が小さい方が優先度が高いことを表します。 これは省略可能なパラメーターです。 指定する場合は、すべてのエンドポイントで指定する必要があり、同じ優先順位の値を共有できるエンドポイントは 2 つありません。	整数 (int)
ターゲット	エンドポイントの完全修飾 DNS 名を取得または設定します。 Traffic Manager は、このエンドポイントにトラフィックを誘導するために DNS 応答でこの値を返します。	文字列
ターゲットリソースID	エンドポイントの Azure リソース URI を取得または設定します。 "ExternalEndpoints" 型のエンドポイントには適用されません。	文字列
重量	"重み付け" トラフィック ルーティング方法を使用する場合の、このエンドポイントの重みを取得または設定します。 指定できる値は 1 から 1000 です。	整数 (int)

モニター設定

名前	形容	価値
パス	エンドポイントの正常性のプローブに使用されるエンドポイント ドメイン名に対する相対パスを取得または設定します。	文字列
ポート	エンドポイントの正常性のプローブに使用される TCP ポートを取得または設定します。	整数 (int)
プロファイルモニターステータス	Traffic Manager プロファイルのプロファイル レベルの監視状態を取得または設定します。	文字列
プロトコル	エンドポイントの正常性のプローブに使用されるプロトコル (HTTP または HTTPS) を取得または設定します。	文字列

プロファイルプロパティ

名前	形容	価値
dnsConfigの	Traffic Manager プロファイルの DNS 設定を取得または設定します。	DnsConfigの
エンドポイント	Traffic Manager プロファイル内のエンドポイントの一覧を取得または設定します。	エンドポイント[]
モニターコンフィグ	Traffic Manager プロファイルのエンドポイント監視設定を取得または設定します。	モニターコンフィグ
profileステータス	Traffic Manager プロファイルの状態を取得または設定します。 有効な値は 、'Enabled' と 'Disabled' です。	文字列
トラフィックルーティングメソッド	Traffic Manager プロファイルのトラフィック ルーティング方法を取得または設定します。 指定できる値は、'Performance'、'Weighted'、または 'Priority' です。	文字列

リソースタグ

名前	形容	価値

使用例

Azure クイック スタート テンプレート

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート	形容
Azure Traffic Manager + Application Gateways デモ セットアップ AzureDeploy to AzureDeploy to Azureにデプロイする	このテンプレートを使用すると、Application Gateway のデモに Azure Traffic Manager をすばやくデプロイして、異なるリージョン間のトラフィック分散をテストできます。
Azure Traffic Manager デモ セットアップ AzureDeploy to AzureDeploy to Azureにデプロイする	このテンプレートを使用すると、Azure Traffic Manager デモをすばやくデプロイして、異なるリージョン間のトラフィック分散をテストできます。
Azure Traffic Manager の外部エンドポイントの例 AzureDeploy to AzureDeploy to Azureにデプロイする	このテンプレートでは、外部エンドポイントを使用して Azure Traffic Manager プロファイルを作成する方法を示します。
Azure Traffic Manager の複数値ルーティング を する AzureDeploy to AzureDeploy to Azureにデプロイする	このテンプレートでは、最小子ルーティングと複数値ルーティングを使用して、入れ子になったエンドポイントを使用して Azure Traffic Manager プロファイルを作成する方法を示します。
Azure Traffic Manager VM の例 AzureDeploy to AzureDeploy to Azureにデプロイする	このテンプレートでは、複数の仮想マシン間で Azure Traffic Manager プロファイルの負荷分散を作成する方法を示します。
Availability Zones を使用して Azure Traffic Manager VM の例を する AzureDeploy to AzureDeploy to Azureにデプロイする	このテンプレートでは、Availability Zones に配置された複数の仮想マシン間で Azure Traffic Manager プロファイルの負荷分散を作成する方法を示します。
Azure Traffic Manager Web アプリの例 AzureDeploy to AzureDeploy to Azureにデプロイする	このテンプレートでは、App Service の Azure Traffic Manager プロファイルを作成する方法を示します。
多層トラフィック マネージャー、L4 ILB、L7 AppGateway AzureDeploy to AzureDeploy to Azureにデプロイする	このテンプレートは、仮想ネットワークをデプロイし、サブネットを介してネットワークを分離し、VM をデプロイして負荷分散を構成します

Terraform (AzAPI プロバイダー) リソース定義

trafficmanagerprofiles リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンで変更されたプロパティの一覧については、変更ログの 参照してください。

リソースの形式

Microsoft.Network/trafficmanagerprofiles リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/trafficmanagerprofiles@2015-11-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      dnsConfig = {
        fqdn = "string"
        relativeName = "string"
        ttl = int
      }
      endpoints = [
        {
          id = "string"
          name = "string"
          properties = {
            endpointLocation = "string"
            endpointMonitorStatus = "string"
            endpointStatus = "string"
            minChildEndpoints = int
            priority = int
            target = "string"
            targetResourceId = "string"
            weight = int
          }
          type = "string"
        }
      ]
      monitorConfig = {
        path = "string"
        port = int
        profileMonitorStatus = "string"
        protocol = "string"
      }
      profileStatus = "string"
      trafficRoutingMethod = "string"
    }
  }
}

プロパティ値

Microsoft.Network/trafficmanagerprofiles

名前	形容	価値
位置	リソースの場所	文字列
名前	リソース名	string (必須)
parent_id	この拡張リソースを適用するリソースの ID。	string (必須)
プロパティ	Traffic Manager プロファイルのプロパティを表すクラス。	プロファイルプロパティ
タグ	リソース タグ	タグ名と値のディクショナリ。
型	リソースの種類	「Microsoft.ネットワーク/trafficmanagerprofiles@2015-11-01」

DnsConfigの

名前	形容	価値
FQDNの	Traffic Manager プロファイルの完全修飾ドメイン名 (FQDN) を取得または設定します。 これは、RelativeName と Azure Traffic Manager で使用される DNS ドメインの連結から形成されます。	文字列
relativeName (親子名)	この Traffic Manager プロファイルによって提供される相対 DNS 名を取得または設定します。 この値は、Azure Traffic Manager で使用される DNS ドメイン名と組み合わせて、プロファイルの完全修飾ドメイン名 (FQDN) を形成します。	文字列
TTLの	DNS 時間To-Live (TTL) を秒単位で取得または設定します。 これにより、ローカル DNS リゾルバーと DNS クライアントに、この Traffic Manager プロファイルによって提供される DNS 応答をキャッシュする期間が通知されます。	整数 (int)

エンドポイント

名前	形容	価値
身分証明書	Traffic Manager エンドポイントの ID を取得または設定します。	文字列
名前	Traffic Manager エンドポイントの名前を取得または設定します。	文字列
プロパティ	Traffic Manager エンドポイントのプロパティを表すクラス。	エンドポイントプロパティ
型	Traffic Manager エンドポイントのエンドポイントの種類を取得または設定します。	文字列

エンドポイントプロパティ

名前	形容	価値
エンドポイントロケーション	"パフォーマンス" トラフィック ルーティング方法を使用する場合の外部エンドポイントまたは入れ子になったエンドポイントの場所を指定します。	文字列
エンドポイントモニターステータス	エンドポイントの監視状態を取得または設定します。	文字列
エンドポイントステータス	エンドポイントの状態を取得または設定します。. エンドポイントが有効の場合、エンドポイントの正常性がプローブされ、トラフィック ルーティング方法に含まれます。 有効な値は 、'Enabled' と 'Disabled' です。	文字列
minChildエンドポイント	親プロファイルを使用可能と見なすために子プロファイルで使用できる必要があるエンドポイントの最小数を取得または設定します。 型 'NestedEndpoints' のエンドポイントにのみ適用されます。	整数 (int)
優先権	"Priority" トラフィック ルーティング方法を使用する場合の、このエンドポイントの優先順位を取得または設定します。 指定できる値は 1 から 1000 で、値が小さい方が優先度が高いことを表します。 これは省略可能なパラメーターです。 指定する場合は、すべてのエンドポイントで指定する必要があり、同じ優先順位の値を共有できるエンドポイントは 2 つありません。	整数 (int)
ターゲット	エンドポイントの完全修飾 DNS 名を取得または設定します。 Traffic Manager は、このエンドポイントにトラフィックを誘導するために DNS 応答でこの値を返します。	文字列
ターゲットリソースID	エンドポイントの Azure リソース URI を取得または設定します。 "ExternalEndpoints" 型のエンドポイントには適用されません。	文字列
重量	"重み付け" トラフィック ルーティング方法を使用する場合の、このエンドポイントの重みを取得または設定します。 指定できる値は 1 から 1000 です。	整数 (int)

モニター設定

名前	形容	価値
パス	エンドポイントの正常性のプローブに使用されるエンドポイント ドメイン名に対する相対パスを取得または設定します。	文字列
ポート	エンドポイントの正常性のプローブに使用される TCP ポートを取得または設定します。	整数 (int)
プロファイルモニターステータス	Traffic Manager プロファイルのプロファイル レベルの監視状態を取得または設定します。	文字列
プロトコル	エンドポイントの正常性のプローブに使用されるプロトコル (HTTP または HTTPS) を取得または設定します。	文字列

プロファイルプロパティ

名前	形容	価値
dnsConfigの	Traffic Manager プロファイルの DNS 設定を取得または設定します。	DnsConfigの
エンドポイント	Traffic Manager プロファイル内のエンドポイントの一覧を取得または設定します。	エンドポイント[]
モニターコンフィグ	Traffic Manager プロファイルのエンドポイント監視設定を取得または設定します。	モニターコンフィグ
profileステータス	Traffic Manager プロファイルの状態を取得または設定します。 有効な値は 、'Enabled' と 'Disabled' です。	文字列
トラフィックルーティングメソッド	Traffic Manager プロファイルのトラフィック ルーティング方法を取得または設定します。 指定できる値は、'Performance'、'Weighted'、または 'Priority' です。	文字列

リソースタグ

名前	形容	価値

使用例

Terraformサンプル

Traffic Manager プロファイルのデプロイの基本的な例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "trafficManagerProfile" {
  type      = "Microsoft.Network/trafficManagerProfiles@2018-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = "global"
  body = {
    properties = {
      dnsConfig = {
        relativeName = "acctest-tmp-230630034107605443"
        ttl          = 30
      }
      monitorConfig = {
        expectedStatusCodeRanges = [
        ]
        intervalInSeconds         = 30
        path                      = "/"
        port                      = 443
        protocol                  = "HTTPS"
        timeoutInSeconds          = 10
        toleratedNumberOfFailures = 3
      }
      trafficRoutingMethod = "Weighted"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}