ARMClient を使用して接続モニターを作成する

[アーティクル]
04/13/2023

重要

2021 年 7 月 1 日以降、既存のワークスペースに新しいテストを追加したり、Network Performance Monitor で新しいワークスペースを有効にしたりできなくなります。接続モニター (クラシック) に新しい接続モニターを追加することもできなくなります。 2021 年 7 月 1 日より前に作成されたテストおよび接続モニターは引き続き使用することができます。現在のワークロードに対するサービスの中断を最小限に抑えるには、2024 年 2 月 29 日より前に、Network Performance Monitor からテストを移行するか、接続モニター (クラシック) から Azure Network Watcher の新しい接続モニターに移行します。

ARMClient を使用して接続モニターを作成し、リソース間の通信を監視する方法について説明します。これにより、ハイブリッドデプロイおよび Azure クラウドデプロイがサポートされます。

開始する前に

接続モニター (プレビュー) で作成できる接続モニターでは、オンプレミスのマシンと Azure VM の両方をソースとして追加できます。これらの接続モニターでは、エンドポイントへの接続も監視できます。エンドポイントは、Azure または他の任意の URL や IP 上のどこにあってもかまいません。

接続モニターには、次のエンティティが含まれています。

接続モニターリソース – リージョン固有の Azure リソース。以下のすべてのエンティティが、接続モニターリソースのプロパティです。
エンドポイント –接続チェックに含まれるソースまたはターゲット。エンドポイントの例としては、Azure VM、オンプレミスのエージェント、URL、IP などがあります。
テスト構成 – テスト用のプロトコル固有の構成。選択したプロトコルに基づいて、ポート、しきい値、テストの頻度、その他のパラメーターを定義できます。
テストグループ – ソースエンドポイント、ターゲットエンドポイント、テスト構成が含まれるグループ。接続モニターには、複数のテストグループを含めることができます。
テスト – ソースエンドポイント、ターゲットエンドポイント、テスト構成の組み合わせ。テストは、監視データを入手できる最も小さいレベルです。監視データには、失敗したチェックの割合と、ラウンドトリップ時間 (RTT) が含まれます。

ARMClient を使用して接続モニターを作成するための手順

ARMClient を使用して接続モニターを作成するには、次のコードを使用します。

$connectionMonitorName = "sampleConnectionMonitor"

$ARM = "https://management.azure.com"

$SUB = "subscriptions/<subscription id 1>;"

$NW = "resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher\_<region>"

$body =

"{

location: '<region>',

properties: {

endpoints: [{

name: 'endpoint_workspace_machine',

type: 'MMAWorkspaceMachine',

resourceId: '/subscriptions/<subscription id>/resourcegroups/<resource group>/providers/Microsoft.OperationalInsights/workspaces/sampleWorkspace',

//Example 1: Choose a machine

address : '<non-Azure machine FQDN>'
}

//Example 2: Select IP from chosen machines

address : '<non-Azure machine FQDN>

"scope": {
      "include": [
            {
                  "address": "<IP belonging to machine chosen above>"  
	    }
       ]
      }
   }    
   
name: 'endpoint_workspace_network',

type: 'MMAWorkspaceNetwork',

resourceId: '/subscriptions/<subscription id>/resourcegroups/<resource group>/providers/Microsoft.OperationalInsights/workspaces/sampleWorkspace',

 coverage level : 'high', //Optional
 
 //Include subnets. You can also exclude IPs from subnet to exclude from monitoring
 
 scope: {
      "include": [
            {
                  "address": "<subnet 1 mask>" // Eg: 10.10.1.0/28
            },
            {
                  "address": "<subnet 2 mask>" 
            }
      ],
      "exclude": [
      		{ 
      		"address" : "<ip-from-included-subnets-that-should-be-excluded>"
		}
      ]
     }
},

//Use a Azure VM as an endpoint
{

name: 'endpoint_virtualmachine',

resourceId: '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Compute/virtualMachines/<vm-name>'

},

//Use an Azure VNET or Subnet as an endpoint

 {

name: 'endpoint_vnet_subnet',

resourceId: '<resource id of VNET or subnet'
coverage level: 'high' //Optional

//Scope is optional.

  "scope": {
      "include": [
            {
                  "address": "<subnet 1 mask>" // Eg: 10.10.1.0/28 .This subnet should match with any existing subnet in vnet
            }
      ],
    "exclude": [
            {
                  "address": "<ip-from-included-subnets-that-should-be-excluded>" // If used with include, IP should be part of the subnet defined above. Without include, this could be any address within vnet range or any specific subnet range as a whole.
            }
      ]
  }
   },

//Endpoint as a URL
{

name: 'azure portal'

address: '<URL>'

   },

//Endpoint as an IP 
 {

    name: 'ip',

     address: '<IP>'

 }

  ],

  testGroups: [{

    name: 'Connectivity to Azure Portal and Public IP',

    testConfigurations: ['http', 'https', 'tcpEnabled', 'icmpEnabled'],

    sources: ['vm1', 'workspace'],

    destinations: ['azure portal', 'ip']

   },

{

    name: 'Connectivty from Azure VM 1 to Azure VM 2',

   // Choose your protocol
   
    testConfigurations: ['http', 'https', 'tcpDisabled', 'icmpDisabled'],

    sources: ['vm1'],

    destinations: ['vm2'],

    disable: true

   }

  ],

  testConfigurations: [{

    name: 'http',

    testFrequencySec: <frequency>,

    protocol: 'HTTP',

    successThreshold: {

     checksFailedPercent: <threshold for checks failed %>,

     roundTripTimeMs: <threshold for RTT>

    }

   }, {

    name: 'https',

    testFrequencySec: <frequency>,

    protocol: 'HTTP',

    httpConfiguration: {
    
     port: '<port of choice>'
  
    preferHTTPS: true // If port chosen isn't 80 or 443
    
    method: 'GET', //Choose GET or POST
    
    path: '/', //Specify path for request
         
    requestHeaders: [
            {
              "name": "Content-Type",
              "value": "appication/json"
            }
          ],
          
    validStatusCodeRanges: [ "102", "200-202", "3xx" ], //Samples
          
    },

    successThreshold: {

     checksFailedPercent: <choose your checks failed threshold>,

     roundTripTimeMs: <choose your RTT threshold>

    }

   }, 
   {

    name: 'tcpEnabled',

    testFrequencySec: <frequency>,

    protocol: 'TCP',

    tcpConfiguration: {

     port: 80

    },

    successThreshold: {

     checksFailedPercent: <choose your checks failed threshold>,

     roundTripTimeMs: <choose your RTT threshold>

    }

   }, {

    name: 'icmpEnabled',

    testFrequencySec: <frequency>,

    protocol: 'ICMP',

    successThreshold: {

     checksFailedPercent: <choose your checks failed threshold>,

     roundTripTimeMs: <choose your RTT threshold>

    }

   }, {

    name: 'icmpDisabled',

    testFrequencySec: <frequency>,

    protocol: 'ICMP',

    icmpConfiguration: {

     disableTraceRoute: true

    },

    successThreshold: {

     checksFailedPercent: <choose your checks failed threshold>,

     roundTripTimeMs: <choose your RTT threshold>

    }

   }, {

    name: 'tcpDisabled',

    testFrequencySec: <frequency>,

    protocol: 'TCP',

    tcpConfiguration: {

     port: 80,

     disableTraceRoute: true

    },

    successThreshold: {

     checksFailedPercent: <choose your checks failed threshold>,

     roundTripTimeMs: <choose your RTT threshold>

    }

   }

  ]

 }

} "

デプロイコマンドを次に示します。

armclient PUT $ARM/$SUB/$NW/connectionMonitors/$connectionMonitorName/?api-version=2019-07-01 $body -verbose

プロパティの説明

connectionMonitorName - 接続モニターリソースの名前
SUB - 接続モニターを作成したいサブスクリプションのサブサブスクリプション ID
NW - CM が作成される Network Watcher リソース ID
location - 接続モニターが作成されるリージョン
エンドポイント
- name – 各エンドポイントの一意の名前
- resourceId – Azure エンドポイントの場合、リソース ID は仮想マシンの Azure Resource Manager リソース ID を示します。 Azure 以外のエンドポイントの場合、リソース ID は、Azure 以外のエージェントにリンクされている Log Analytics ワークスペースの Azure Resource Manager リソース ID を示します。
- address – リソース ID が指定されていない場合、またはリソース ID が Log Analytics ワークスペースである場合にのみ適用されます。 Log Analytics リソース ID と共に使用される場合、これは監視に使用できるエージェントの FQDN を示します。リソース ID なしで使用される場合、これは、任意のパブリックエンドポイントの URL または IP とすることができます。
- filter – Azure 以外のエンドポイントの場合は、フィルターを使用して、接続モニターリソース内で監視に使用される Log Analytics ワークスペースからエージェントを選択します。フィルターが設定されていない場合、Log Analytics ワークスペースに属するすべてのエージェントを監視に使用できます
  - type – type は "エージェントアドレス" として設定します。
  - address – オンプレミスのエージェントの FQDN としてアドレスを設定します。
テストグループ
- name – テストグループの名前を指定します。
- testConfigurations - テスト構成であり、これに基づいてソースエンドポイントはターゲットエンドポイントに接続されます。
- sources - 上記で作成したエンドポイントから選択します。 Azure ベースのソースエンドポイントには Azure Network Watcher 拡張機能がインストールされている必要があり、Azure ベースでないソースエンドポイントには Azure Log Analytics エージェントがインストールされている必要があります。ソース用のエージェントをインストールするには、「監視エージェントをインストールする」を参照してください。
- destinations - 前述で作成したエンドポイントから選びます。 Azure VM または任意のエンドポイント (パブリック IP、URL、FQDN) をターゲットとして指定すると、それらへの接続を監視できます。 1 つのテストグループに、Azure VM、Office 365 URL、Dynamics 365 URL、カスタムエンドポイントを追加できます。
- disable - このフィールドを使用すると、テストグループで指定されているすべてのソースとターゲットに対する監視を無効にできます。
テスト構成
- name - テスト構成の名前です。
- testFrequencySec - 指定したプロトコルとポートでソースがターゲットに ping を実行する頻度を指定します。 30 秒、1 分、5 分、15 分、30 分のいずれかを選択できます。ソースでは、選択した値に基づいて、ターゲットへの接続がテストされます。たとえば、30 秒を選択すると、ソースにより、少なくとも 30 秒に 1 回、ターゲットへの接続が確認されます。
- protocol - TCP、ICMP、HTTP、または HTTPS を選択できます。プロトコルによっては、いくつかのプロトコル固有の構成を行うことができます。
  - preferHTTPS - 使用されるポートが 80 でも 443 でもないとき、HTTP 経由で HTTPS を使用するかどうかを指定します
  - port - 任意の宛先ポートを指定します。
  - disableTraceRoute - これは、プロトコルが TCP または ICMP であるテスト構成に適用されます。これによって、ソースでのトポロジとホップバイホップ RTT の検出が停止します。
  - method - これは、プロトコルが HTTP であるテスト構成に適用されます。 HTTP 要求メソッド (GET または POST) を選択します
  - path - URL に追加するパスパラメーターを指定します
  - validStatusCodes - 該当するステータスコードを選択します。応答コードがこの一覧と一致しない場合は、診断メッセージが表示されます
  - requestHeaders - 宛先に渡されるカスタム要求ヘッダー文字列を指定します
- successThreshold - 以下のネットワークパラメーターにしきい値を設定できます。
  - checksFailedPercent - 指定した条件で行われるソースによるターゲットへの接続の確認で、失敗してもかまわないチェックの割合を設定します。 TCP または ICMP プロトコルでは、失敗したチェックの割合はパケット損失の割合と同等と考えられます。 HTTP プロトコルでは、このフィールドは、応答を受け取らなかった HTTP 要求の割合を表します。
  - roundTripTimeMs - テスト構成でソースがターゲットに接続するのにかかるラウンドトリップ時間をミリ秒で設定します。

スケールの上限

接続モニターには、次のようなスケール制限があります。

1 つのリージョンの 1 つのサブスクリプションあたりの接続モニターの最大数: 100
接続モニターあたりのテストグループの最大数: 20
接続モニターあたりのソースとターゲットの最大数: 100
接続モニターあたりのテスト構成の最大数: 20 (ARMClient を使用した場合)

次の手順

監視データを分析してアラートを設定する方法を確認する
ネットワークの問題を診断する方法を確認する