Microsoft.Network trafficmanagerprofiles 2017-03-01

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.Network/trafficmanagerprofiles@2017-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    dnsConfig: {
      fqdn: 'string'
      relativeName: 'string'
      ttl: int
    }
    endpoints: [
      {
        id: 'string'
        name: 'string'
        properties: {
          endpointLocation: 'string'
          endpointMonitorStatus: 'string'
          endpointStatus: 'string'
          geoMapping: [
            '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'
  }
}

プロパティ値

trafficmanagerprofiles

名前 説明
name リソース名 string (必須)

文字数制限: 1 から 63

有効な文字:
英数字、ハイフン、およびピリオド。

先頭と末尾には英数字を使用します。

リソース名は、Azure 全体で一意である必要があります。
location リソースの場所 string
tags リソース タグ タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
properties Traffic Manager プロファイルのプロパティを表すクラス。 ProfileProperties

ProfileProperties

名前 説明
dnsConfig Traffic Manager プロファイルの DNS 設定を取得または設定します。 DnsConfig
エンドポイント Traffic Manager プロファイル内のエンドポイントの一覧を取得または設定します。 Endpoint[]
monitorConfig Traffic Manager プロファイルのエンドポイント監視設定を取得または設定します。 MonitorConfig
profileStatus Traffic Manager プロファイルの状態を取得または設定します。 使用可能な値は、'Enabled' と 'Disabled' です。 string
trafficRoutingMethod Traffic Manager プロファイルのトラフィック ルーティング方法を取得または設定します。 指定できる値は、"パフォーマンス"、"重み付け"、"優先度"、または "地理的" です。 string

DnsConfig

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

エンドポイント

Name 説明
id Traffic Manager エンドポイントの ID を取得または設定します。 string
name Traffic Manager エンドポイントの名前を取得または設定します。 string
properties Traffic Manager エンドポイントのプロパティを表すクラス。 EndpointProperties
Traffic Manager エンドポイントのエンドポイントの種類を取得または設定します。 string

EndpointProperties

名前 説明
endpointLocation "パフォーマンス" トラフィック ルーティング方法を使用する場合の外部エンドポイントまたは入れ子になったエンドポイントの場所を指定します。 string
endpointMonitorStatus エンドポイントの監視状態を取得または設定します。 string
endpointStatus エンドポイントの状態を取得または設定します。 エンドポイントが有効な場合、これはエンドポイントの正常性をプローブし、トラフィックのルーティング方法に含まれます。 使用可能な値は、'Enabled' と 'Disabled' です。 string
geoMapping "地理的" トラフィック ルーティング方法を使用する場合に、このエンドポイントにマップされる国/地域の一覧を取得または設定します。 受け入れられる値の完全な一覧については、Traffic Manager の地理的なドキュメントを参照してください。 string[]
minChildEndpoints 親プロファイルを使用可能と見なすために、子プロファイルで使用できる必要があるエンドポイントの最小数を取得または設定します。 型 'NestedEndpoints' のエンドポイントにのみ適用されます。 INT
priority "Priority" トラフィック ルーティング方法を使用する場合の、このエンドポイントの優先度を取得または設定します。 使用できる値は 1 から 1000 で、低い値は優先度が高いことを表します。 これは省略可能なパラメーターです。 指定した場合、すべてのエンドポイントに指定する必要があります。2 つのエンドポイントが同じ優先度の値を共有することはできません。 INT
ターゲット (target) エンドポイントの完全修飾 DNS 名を取得または設定します。 トラフィック マネージャーは、このエンドポイントにトラフィックをダイレクトする DNS 応答にこの値を返します。 string
targetResourceId エンドポイントの の Azure リソース URI を取得または設定します。 "ExternalEndpoints" 型のエンドポイントには適用されません。 string
weight "重み付け" トラフィック ルーティング方法を使用する場合の、このエンドポイントの重みを取得または設定します。 使用できる値は 1 から 1000 です。 INT

MonitorConfig

Name 説明
path エンドポイントの正常性のプローブに使用されるエンドポイント ドメイン名に対する相対パスを取得または設定します。 string
port エンドポイントの正常性のプローブに使用される TCP ポートを取得または設定します。 INT
profileMonitorStatus Traffic Manager プロファイルのプロファイル レベルの監視状態を取得または設定します。 string
protocol エンドポイントの正常性のプローブに使用されるプロトコル (HTTP または HTTPS) を取得または設定します。 string

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

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
多層トラフィック マネージャー、L4 ILB、L7 AppGateway

Azure にデプロイする
このテンプレートは、Virtual Networkをデプロイし、サブネットを介してネットワークを分離し、VM をデプロイして負荷分散を構成します
Azure Traffic Manager + Application Gateways デモセットアップ

Azure にデプロイする
このテンプレートを使用すると、Application Gateways デモの上に Azure Traffic Manager をすばやくデプロイして、異なるリージョン間のトラフィック分散をテストできます。
Azure Traffic Manager デモのセットアップ

Azure にデプロイする
このテンプレートを使用すると、Azure Traffic Manager デモをすばやくデプロイして、異なるリージョン間のトラフィック分散をテストできます。
Azure Traffic Manager 外部エンドポイントの例

Azure にデプロイする
このテンプレートでは、外部エンドポイントを使用して Azure Traffic Manager プロファイルを作成する方法を示します。
Azure Traffic Manager の複数値ルーティング

Azure にデプロイする
このテンプレートでは、最小子ルーティングと複数値ルーティングを使用して、入れ子になったエンドポイントを使用して Azure Traffic Manager プロファイルを作成する方法を示します。
Azure Traffic Manager VM の例

Azure にデプロイする
このテンプレートでは、複数の仮想マシン間で Azure Traffic Manager プロファイルの負荷分散を作成する方法を示します。
Availability Zonesを使用した Azure Traffic Manager VM の例

Azure にデプロイする
このテンプレートでは、Availability Zonesに配置された複数の仮想マシン間で Azure Traffic Manager プロファイルの負荷分散を作成する方法を示します。
Azure Traffic Manager Web アプリの例

Azure にデプロイする
このテンプレートは、App Serviceの Azure Traffic Manager プロファイルを作成する方法を示しています。

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

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

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

リソース形式

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

{
  "type": "Microsoft.Network/trafficmanagerprofiles",
  "apiVersion": "2017-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "dnsConfig": {
      "fqdn": "string",
      "relativeName": "string",
      "ttl": "int"
    },
    "endpoints": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "endpointLocation": "string",
          "endpointMonitorStatus": "string",
          "endpointStatus": "string",
          "geoMapping": [ "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"
  }
}

プロパティ値

trafficmanagerprofiles

名前 説明
type リソースの種類 'Microsoft.Network/trafficmanagerprofiles'
apiVersion リソース API のバージョン '2017-03-01'
name リソース名 string (必須)

文字制限: 1 から 63

有効な文字:
英数字、ハイフン、およびピリオド。

先頭と末尾には英数字を使用します。

リソース名は、Azure 全体で一意である必要があります。
location リソースの場所 string
tags リソース タグ タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
properties Traffic Manager プロファイルのプロパティを表すクラス。 ProfileProperties

ProfileProperties

名前 説明
dnsConfig Traffic Manager プロファイルの DNS 設定を取得または設定します。 DnsConfig
エンドポイント Traffic Manager プロファイル内のエンドポイントの一覧を取得または設定します。 Endpoint[]
monitorConfig Traffic Manager プロファイルのエンドポイント監視設定を取得または設定します。 MonitorConfig
profileStatus Traffic Manager プロファイルの状態を取得または設定します。 使用可能な値は、'Enabled' と 'Disabled' です。 string
trafficRoutingMethod Traffic Manager プロファイルのトラフィック ルーティング方法を取得または設定します。 使用できる値は、"パフォーマンス"、"重み付け"、"優先度"、または "地理的" です。 string

DnsConfig

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

エンドポイント

Name 説明
id Traffic Manager エンドポイントの ID を取得または設定します。 string
name Traffic Manager エンドポイントの名前を取得または設定します。 string
properties Traffic Manager エンドポイントのプロパティを表すクラス。 EndpointProperties
Traffic Manager エンドポイントのエンドポイントの種類を取得または設定します。 string

EndpointProperties

Name 説明
endpointLocation "パフォーマンス" トラフィック ルーティング方法を使用する場合の外部エンドポイントまたは入れ子になったエンドポイントの場所を指定します。 string
endpointMonitorStatus エンドポイントの監視状態を取得または設定します。 string
endpointStatus エンドポイントの状態を取得または設定します。 エンドポイントが有効な場合、これはエンドポイントの正常性をプローブし、トラフィックのルーティング方法に含まれます。 使用可能な値は、'Enabled' と 'Disabled' です。 string
geoMapping "地理的" トラフィック ルーティング方法を使用する場合に、このエンドポイントにマップされる国/地域の一覧を取得または設定します。 受け入れられる値の完全な一覧については、Traffic Manager の地理的なドキュメントを参照してください。 string[]
minChildEndpoints 親プロファイルを使用可能と見なすために、子プロファイルで使用できる必要があるエンドポイントの最小数を取得または設定します。 型 'NestedEndpoints' のエンドポイントにのみ適用されます。 INT
priority "Priority" トラフィック ルーティング方法を使用する場合の、このエンドポイントの優先度を取得または設定します。 使用できる値は 1 から 1000 で、低い値は優先度が高いことを表します。 これは省略可能なパラメーターです。 指定した場合、すべてのエンドポイントに指定する必要があります。2 つのエンドポイントが同じ優先度の値を共有することはできません。 INT
ターゲット (target) エンドポイントの完全修飾 DNS 名を取得または設定します。 トラフィック マネージャーは、このエンドポイントにトラフィックをダイレクトする DNS 応答にこの値を返します。 string
targetResourceId エンドポイントの の Azure リソース URI を取得または設定します。 型 'ExternalEndpoints' のエンドポイントには適用されません。 string
weight "重み付け" トラフィック ルーティング方法を使用する場合の、このエンドポイントの重みを取得または設定します。 指定できる値は 1 ~ 1000 です。 INT

MonitorConfig

名前 説明
path エンドポイントの正常性のプローブに使用されるエンドポイント ドメイン名に対する相対パスを取得または設定します。 string
port エンドポイントの正常性のプローブに使用される TCP ポートを取得または設定します。 INT
profileMonitorStatus Traffic Manager プロファイルのプロファイル レベルの監視状態を取得または設定します。 string
protocol エンドポイントの正常性のプローブに使用されるプロトコル (HTTP または HTTPS) を取得または設定します。 string

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

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
多層トラフィック マネージャー、L4 ILB、L7 AppGateway

Azure にデプロイする
このテンプレートは、Virtual Networkをデプロイし、サブネットを介してネットワークを分離し、VM をデプロイし、負荷分散を構成します
Azure Traffic Manager + Application Gateways デモのセットアップ

Azure にデプロイする
このテンプレートを使用すると、Application Gateways デモの上に Azure Traffic Manager をすばやくデプロイして、異なるリージョン間のトラフィック分散をテストできます。
Azure Traffic Manager デモのセットアップ

Azure にデプロイする
このテンプレートを使用すると、Azure Traffic Manager デモをすばやくデプロイして、異なるリージョン間のトラフィック分散をテストできます。
Azure Traffic Manager 外部エンドポイントの例

Azure にデプロイする
このテンプレートでは、外部エンドポイントを使用して Azure Traffic Manager プロファイルを作成する方法を示します。
Azure Traffic Manager の複数値ルーティング

Azure にデプロイする
このテンプレートでは、最小子ルーティングと複数値ルーティングを使用して、入れ子になったエンドポイントを使用して Azure Traffic Manager プロファイルを作成する方法を示します。
Azure Traffic Manager VM の例

Azure にデプロイする
このテンプレートでは、複数の仮想マシン間で Azure Traffic Manager プロファイルの負荷分散を作成する方法を示します。
Availability Zonesを使用した Azure Traffic Manager VM の例

Azure にデプロイする
このテンプレートでは、Availability Zonesに配置された複数の仮想マシン間で Azure Traffic Manager プロファイルの負荷分散を作成する方法を示します。
Azure Traffic Manager Web アプリの例

Azure にデプロイする
このテンプレートは、App Serviceの Azure Traffic Manager プロファイルを作成する方法を示しています。

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/trafficmanagerprofiles@2017-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      dnsConfig = {
        fqdn = "string"
        relativeName = "string"
        ttl = int
      }
      endpoints = [
        {
          id = "string"
          name = "string"
          properties = {
            endpointLocation = "string"
            endpointMonitorStatus = "string"
            endpointStatus = "string"
            geoMapping = [
              "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"
    }
  })
}

プロパティ値

trafficmanagerprofiles

名前 説明
type リソースの種類 "Microsoft.Network/trafficmanagerprofiles@2017-03-01"
name リソース名 string (必須)

文字数制限: 1 から 63

有効な文字:
英数字、ハイフン、およびピリオド。

先頭と末尾には英数字を使用します。

リソース名は、Azure 全体で一意である必要があります。
location リソースの場所 string
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ タグ名と値のディクショナリ。
properties Traffic Manager プロファイルのプロパティを表すクラス。 ProfileProperties

ProfileProperties

名前 説明
dnsConfig Traffic Manager プロファイルの DNS 設定を取得または設定します。 DnsConfig
エンドポイント Traffic Manager プロファイル内のエンドポイントの一覧を取得または設定します。 Endpoint[]
monitorConfig Traffic Manager プロファイルのエンドポイント監視設定を取得または設定します。 MonitorConfig
profileStatus Traffic Manager プロファイルの状態を取得または設定します。 使用可能な値は、'Enabled' と 'Disabled' です。 string
trafficRoutingMethod Traffic Manager プロファイルのトラフィック ルーティング方法を取得または設定します。 指定できる値は、"パフォーマンス"、"重み付け"、"優先度"、または "地理的" です。 string

DnsConfig

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

エンドポイント

Name 説明
id Traffic Manager エンドポイントの ID を取得または設定します。 string
name Traffic Manager エンドポイントの名前を取得または設定します。 string
properties Traffic Manager エンドポイントのプロパティを表すクラス。 EndpointProperties
Traffic Manager エンドポイントのエンドポイントの種類を取得または設定します。 string

EndpointProperties

Name 説明
endpointLocation "パフォーマンス" トラフィック ルーティング方法を使用する場合の外部エンドポイントまたは入れ子になったエンドポイントの場所を指定します。 string
endpointMonitorStatus エンドポイントの監視状態を取得または設定します。 string
endpointStatus エンドポイントの状態を取得または設定します。 エンドポイントが有効な場合、これはエンドポイントの正常性をプローブし、トラフィックのルーティング方法に含まれます。 使用可能な値は、'Enabled' と 'Disabled' です。 string
geoMapping "地理的" トラフィック ルーティング方法を使用するときに、このエンドポイントにマップされる国/地域の一覧を取得または設定します。 許容される値の完全な一覧については、Traffic Manager の地理的なドキュメントを参照してください。 string[]
minChildEndpoints 親プロファイルを使用可能と見なすために子プロファイルで使用できる必要があるエンドポイントの最小数を取得または設定します。 型 'NestedEndpoints' のエンドポイントにのみ適用されます。 INT
priority "Priority" トラフィック ルーティング方法を使用する場合に、このエンドポイントの優先度を取得または設定します。 指定できる値は 1 から 1000 で、値が小さい方が優先度が高いことを表します。 これは省略可能なパラメーターです。 指定した場合、すべてのエンドポイントに指定する必要があります。2 つのエンドポイントが同じ優先度の値を共有することはできません。 INT
ターゲット (target) エンドポイントの完全修飾 DNS 名を取得または設定します。 トラフィック マネージャーは、このエンドポイントにトラフィックをダイレクトする DNS 応答にこの値を返します。 string
targetResourceId エンドポイントの の Azure リソース URI を取得または設定します。 型 'ExternalEndpoints' のエンドポイントには適用されません。 string
weight "重み付け" トラフィック ルーティング方法を使用する場合の、このエンドポイントの重みを取得または設定します。 指定できる値は 1 ~ 1000 です。 INT

MonitorConfig

名前 説明
path エンドポイントの正常性のプローブに使用されるエンドポイント ドメイン名に対する相対パスを取得または設定します。 string
port エンドポイントの正常性のプローブに使用される TCP ポートを取得または設定します。 INT
profileMonitorStatus Traffic Manager プロファイルのプロファイル レベルの監視状態を取得または設定します。 string
protocol エンドポイントの正常性のプローブに使用されるプロトコル (HTTP または HTTPS) を取得または設定します。 string