Azure Resource Manager テンプレートを使用して Azure Time Series Insights Gen 1 リソースを作成する

[アーティクル]
09/30/2020

手記

Time Series Insights サービスは、2024 年 7 月 7 日に廃止されます。既存の環境をできるだけ早く別のソリューションに移行することを検討してください。非推奨と移行の詳細については、ドキュメントを参照してください。

注意

これは Gen1 の記事です。

この記事では、Azure Resource Manager テンプレート、PowerShell、Azure Time Series Insights リソースプロバイダー使用して、Azure Time Series Insights リソースを作成してデプロイする方法について説明します。

Azure Time Series Insights では、次のリソースがサポートされています。

資源	説明
環境	Azure Time Series Insights 環境は、イベントブローカーから読み取られ、格納され、クエリで使用できるイベントの論理的なグループです。詳細については、「Azure Time Series Insights 環境の計画を参照してください。
イベント元	イベントソースは、Azure Time Series Insights がイベントを読み取って環境に取り込むイベントブローカーへの接続です。現在サポートされているイベントソースは、IoT Hub とイベントハブです。
参照データセット	参照データセットは、環境内のイベントに関するメタデータを提供します。参照データセット内のメタデータは、イングレス中にイベントと結合されます。参照データ・セットは、イベント・キー・プロパティーによってリソースとして定義されます。参照データセットを構成する実際のメタデータは、データプレーン API を介してアップロードまたは変更されます。
アクセスポリシー	アクセスポリシーは、データクエリの発行、環境内の参照データの操作、環境に関連付けられている保存されたクエリとパースペクティブの共有を行うアクセス許可を付与します。詳細については、「Azure portal を使用して Azure Time Series Insights 環境へのデータアクセスを許可する」を参照してください。

Resource Manager テンプレートは、リソースグループ内のリソースのインフラストラクチャと構成を定義する JSON ファイルです。次のドキュメントでは、テンプレートファイルについて詳しく説明します。

Azure Resource Manager テンプレートのデプロイ
Resource Manager テンプレートと Azure PowerShell を使用してリソースをデプロイする
Microsoft.TimeSeriesInsights リソースの種類

timeseriesinsights-environment-with-eventhub クイックスタートテンプレートが GitHub に公開されています。このテンプレートは、Azure Time Series Insights 環境、イベントハブからのイベントを使用するように構成された子イベントソース、環境のデータへのアクセスを許可するアクセスポリシーを作成します。既存のイベントハブが指定されていない場合は、デプロイで作成されます。

手記

Azure Az PowerShell モジュールを使用して Azure と対話することをお勧めします。作業を開始するには、「Azure PowerShellのインストール」を参照してください。 Az PowerShell モジュールに移行する方法については、「Azure PowerShell を AzureRM から Azに移行する」を参照してください。

デプロイテンプレートとパラメーターを指定する

次の手順では、PowerShell を使用して、Azure Time Series Insights 環境を作成する Azure Resource Manager テンプレート、イベントハブからのイベントを使用するように構成された子イベントソース、環境のデータへのアクセスを許可するアクセスポリシーをデプロイする方法について説明します。既存のイベントハブが指定されていない場合は、デプロイで作成されます。

Azure PowerShellの概要に関するの手順に従って、Azure PowerShell をインストールします。

gitHub から timeseriesinsights-environment-with-eventhub テンプレートを複製またはコピーします。

パラメーターファイルを作成する

パラメーターファイルを作成するには、timeseriesinsights-environment-with-eventhub ファイルをコピーします。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
      "eventHubNamespaceName": {
          "value": "GEN-UNIQUE"
      },
      "eventHubName": {
          "value": "GEN-UNIQUE"
      },
      "consumerGroupName": {
          "value": "GEN-UNIQUE"
      },
      "environmentName": {
        "value": "GEN-UNIQUE"
      },
      "eventSourceName": {
        "value": "GEN-UNIQUE"
      }
  }
}

必須パラメーター

パラメーター	説明
eventHubNamespaceName	ソースイベントハブの名前空間。
eventHubName	ソースイベントハブの名前。
消費者グループ名	Azure Time Series Insights サービスがイベントハブからデータを読み取るために使用するコンシューマーグループの名前。注: リソースの競合を回避するには、このコンシューマーグループを Azure Time Series Insights サービス専用にし、他のリーダーと共有しないようにする必要があります。
環境名	環境の名前。名前には、`<`、`>`、`%`、`&`、`:`、`\\`、`?`、`/`、およびコントロール文字を含めることはできません。その他の文字はすべて使用できます。
イベントソース名	イベントソースの子リソースの名前。名前には、`<`、`>`、`%`、`&`、`:`、`\\`、`?`、`/`、およびコントロール文字を含めることはできません。その他の文字はすべて使用できます。

省略可能なパラメーター

パラメーター	説明
existingEventHubResourceId	イベントソースを介して Azure Time Series Insights 環境に接続される既存のイベントハブのオプションのリソース ID。注意: テンプレートをデプロイするユーザーは、Event Hub で listkeys 操作を実行する権限を持っている必要があります。値が渡されない場合は、テンプレートによって新しいイベントハブが作成されます。
環境表示名	環境名の代わりにツールまたはユーザーインターフェイスに表示するオプションのフレンドリ名。
environmentSkuName	SKU の名前。詳細については、「Azure Time Series Insights の価格」ページを参照してください。
環境SKU容量	SKU のユニット容量。詳細については、「Azure Time Series Insights の価格」ページを参照してください。
環境データ保持時間	環境のイベントの最小期間は、クエリに使用できます。値は ISO 8601 形式で指定する必要があります。たとえば、30 日間の保持ポリシーの `P30D`。
イベントソース表示名	イベントソース名の代わりにツールまたはユーザーインターフェイスに表示するオプションのフレンドリ名。
イベントソースタイムスタンププロパティ名	イベントソースのタイムスタンプとして使用されるイベントプロパティ。 timestampPropertyName に値が指定されていない場合、または null または空の文字列が指定されている場合は、イベントの作成時間が使用されます。
eventSourceKeyName	Azure Time Series Insights サービスがイベントハブへの接続に使用する共有アクセスキーの名前。
アクセスポリシーリーダーオブジェクトID	環境への閲覧者アクセス権を持つ必要がある Microsoft Entra ID のユーザーまたはアプリケーションのオブジェクト ID の一覧。サービスプリンシパル objectId は、Get-AzADUser または Get-AzADServicePrincipal コマンドレットを呼び出すことによって取得できます。 Microsoft Entra グループのアクセスポリシーの作成はまだサポートされていません。
アクセスポリシー寄与者オブジェクトID	環境への共同作成者アクセス権を持つ必要がある Microsoft Entra ID 内のユーザーまたはアプリケーションのオブジェクト ID の一覧。サービスプリンシパル objectId は、Get-AzADUser または Get-AzADServicePrincipal コマンドレットを呼び出すことによって取得できます。 Microsoft Entra グループのアクセスポリシーの作成はまだサポートされていません。

たとえば、次のパラメーターファイルを使用して、既存のイベントハブからイベントを読み取る環境とイベントソースを作成します。また、共同作成者に環境へのアクセスを許可する 2 つのアクセスポリシーも作成します。

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "eventHubNamespaceName": {
            "value": "tsiTemplateTestNamespace"
        },
        "eventHubName": {
            "value": "tsiTemplateTestEventHub"
        },
        "consumerGroupName": {
            "value": "tsiTemplateTestConsumerGroup"
        },
        "environmentName": {
            "value": "tsiTemplateTestEnvironment"
        },
        "eventSourceName": {
            "value": "tsiTemplateTestEventSource"
        },
        "existingEventHubResourceId": {
            "value": "/subscriptions/{yourSubscription}/resourceGroups/MyDemoRG/providers/Microsoft.EventHub/namespaces/tsiTemplateTestNamespace/eventhubs/tsiTemplateTestEventHub"
        },
        "accessPolicyContributorObjectIds": {
            "value": [
                "AGUID001-0000-0000-0000-000000000000",
                "AGUID002-0000-0000-0000-000000000000"
            ]
        }
    }
}

詳細については、「パラメーター」記事を参照してください。

PowerShell を使用してクイックスタートテンプレートをローカルにデプロイする

重要

次に示すコマンドライン操作では、Az PowerShell モジュールについて説明します。

PowerShell で、Azure アカウントにログインします。
- PowerShell プロンプトから、次のコマンドを実行します。
```
Connect-AzAccount
```
- Azure アカウントにログオンするように求められます。ログオンした後、次のコマンドを実行して、使用可能なサブスクリプションを表示します。
```
Get-AzSubscription
```
- このコマンドは、使用可能な Azure サブスクリプションの一覧を返します。次のコマンドを実行して、現在のセッションのサブスクリプションを選択します。 <YourSubscriptionId> を、使用する Azure サブスクリプションの GUID に置き換えます。
```
Set-AzContext -SubscriptionID <YourSubscriptionId>
```
新しいリソースグループが存在しない場合は作成します。
- 既存のリソースグループがない場合は、New-AzResourceGroup コマンドを使用して新しいリソースグループを作成します。使用するリソースグループの名前と場所を指定します。例えば：
```
New-AzResourceGroup -Name MyDemoRG -Location "West US"
```
- 成功した場合は、新しいリソースグループの概要が表示されます。
```
ResourceGroupName : MyDemoRG
Location          : westus
ProvisioningState : Succeeded
Tags              :
ResourceId        : /subscriptions/<GUID>/resourceGroups/MyDemoRG
```
デプロイをテストします。
- Test-AzResourceGroupDeployment コマンドレットを実行して、デプロイを検証します。デプロイをテストするときは、デプロイの実行時とまったく同じようにパラメーターを指定します。
```
Test-AzResourceGroupDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json -TemplateParameterFile <path to parameters file>\azuredeploy.parameters.json
```
展開を構築する
- 新しいデプロイを作成するには、New-AzResourceGroupDeployment コマンドレットを実行し、プロンプトが表示されたら必要なパラメーターを指定します。パラメーターには、デプロイの名前、リソースグループの名前、テンプレートファイルのパスまたは URL が含まれます。 Mode パラメーターが指定されていない場合は、増分の既定値が使用されます。詳細については、増分デプロイと完全デプロイを参照してください。
- 次のコマンドを実行すると、PowerShell ウィンドウで 5 つの必須パラメーターを入力するように求められます。
```
New-AzResourceGroupDeployment -Name MyDemoDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json
```
- 代わりにパラメーターファイルを指定するには、次のコマンドを使用します。
```
New-AzResourceGroupDeployment -Name MyDemoDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json -TemplateParameterFile <path to parameters file>\azuredeploy.parameters.json
```
- デプロイコマンドレットを実行するときにインラインパラメーターを使用することもできます。コマンドは次のとおりです。
```
New-AzResourceGroupDeployment -Name MyDemoDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json -parameterName "parameterValue"
```
- 完全なデプロイを実行するには、Mode パラメーターを Completeに設定します。
```
New-AzResourceGroupDeployment -Name MyDemoDeployment -Mode Complete -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json
```

デプロイを確認する

リソースが正常にデプロイされると、デプロイの概要が PowerShell ウィンドウに表示されます。

 DeploymentName          : MyDemoDeployment
 ResourceGroupName       : MyDemoRG
 ProvisioningState       : Succeeded
 Timestamp               : 10/11/2019 3:20:37 AM
 Mode                    : Incremental
 TemplateLink            :
 Parameters              :
                           Name                                Type                       Value
                           ==================================  =========================  ==========
                           eventHubNewOrExisting               String                     new
                           eventHubResourceGroup               String                     MyDemoRG
                           eventHubNamespaceName               String                     tsiquickstartns
                           eventHubName                        String                     tsiquickstarteh
                           consumerGroupName                   String                     tsiquickstart
                           environmentName                     String                     tsiquickstart
                           environmentDisplayName              String                     tsiquickstart
                           environmentSkuName                  String                     S1
                           environmentSkuCapacity              Int                        1
                           environmentDataRetentionTime        String                     P30D
                           eventSourceName                     String                     tsiquickstart
                           eventSourceDisplayName              String                     tsiquickstart
                           eventSourceTimestampPropertyName    String
                           eventSourceKeyName                  String                     manage
                           accessPolicyReaderObjectIds         Array                      []
                           accessPolicyContributorObjectIds    Array                      []
                           location                            String                     westus

 Outputs                 :
                            Name              Type                       Value
                            ================  =========================  ==========
                            dataAccessFQDN    String
                            11aa1aa1-a1aa-1a1a-a11a-aa111a111a11.env.timeseries.azure.com

 DeploymentDebugLogLevel :

Azure portal を使用してクイックスタートテンプレートをデプロイする
- GitHub のクイックスタートテンプレートのホームページには、[Azure へのデプロイ] ボタンも含まれています。クリックすると、Azure portal で [カスタムデプロイ] ページが開きます。このページからは、必要なパラメーターのテーブルと省略可能なパラメーターのテーブルで、それぞれのパラメーターの値を入力または選択できます。設定に入力した後、[購入] ボタンをクリックすると、テンプレートのデプロイが開始されます。

次の手順

REST API を使用して Azure Time Series Insights リソースをプログラムで管理する方法については、「Azure Time Series Insights Management参照してください。

次の方法で共有

Azure Resource Manager テンプレートを使用して Azure Time Series Insights Gen 1 リソースを作成する

デプロイテンプレートとパラメーターを指定する

PowerShell を使用してクイックスタートテンプレートをローカルにデプロイする

次の手順

その他のリソース

次の方法で共有

Azure Resource Manager テンプレートを使用して Azure Time Series Insights Gen 1 リソースを作成する

デプロイ テンプレートとパラメーターを指定する

PowerShell を使用してクイックスタート テンプレートをローカルにデプロイする

次の手順

その他のリソース

デプロイテンプレートとパラメーターを指定する

PowerShell を使用してクイックスタートテンプレートをローカルにデプロイする