使用 Azure Resource Manager 範本建立第 1 代 Azure 時間序列深入解析資源

發行項
04/05/2024

注意

時間序列深入解析服務將於 2024 年 7 月 7 日淘汰。請考慮儘快將現有的環境移轉至替代解決方案。如需淘汰和移轉的詳細資訊，請造訪我們的文件。

警告

這是 Gen1 文章。

本文說明如何使用 Azure Resource Manager 範本、PowerShell 和 Azure 時間序列深入解析資源提供者來建立和部署 Azure 時間序列深入解析資源。

Azure 時間序列深入解析支援下列資源：

資源	描述
Environment	Azure 時間序列深入解析環境是從事件代理程式讀取、儲存及可供查詢的事件邏輯群組。如需詳細資訊，請參閱規劃您的 Azure 時間序列深入解析環境
事件來源	事件來源是事件代理程序的連接，其中 Azure 時間序列深入解析讀取和內嵌事件到環境中。目前支援的事件來源 IoT 中樞和事件中樞。
參考數據集	參考數據集提供環境中事件的相關元數據。參考數據集中的元數據會在輸入期間與事件聯結。參考數據集會依其事件索引鍵屬性來定義為資源。組成參考數據集的實際元數據會透過數據平面 API 上傳或修改。
存取原則	存取原則會授與發出數據查詢的許可權、操作環境中的參考數據，以及共用與環境相關聯的已儲存查詢和檢視方塊。如需詳細資訊，請參閱使用 Azure 入口網站授與 Azure 時間序列深入解析環境的數據存取權

Resource Manager 範本是 JSON 檔案，可定義資源群組中的資源基礎結構和組態。下列檔更詳細地描述範本檔案：

timeseriesinsights-environment-with-eventhub 快速入門範本發佈在 GitHub 上。此範本會建立 Azure 時間序列深入解析環境、設定為從事件中樞取用事件的子事件來源，以及授與環境數據存取權的存取原則。如果未指定現有的事件中樞，則會使用部署建立一個事件中樞。

注意

建議您使用 Azure Az PowerShell 模組來與 Azure 互動。若要開始使用，請參閱安裝 Azure PowerShell。若要了解如何移轉至 Az PowerShell 模組，請參閱將 Azure PowerShell 從 AzureRM 移轉至 Az。

指定部署範本和參數

下列程序說明如何使用PowerShell來部署 Azure Resource Manager 樣本，以建立 Azure 時間序列深入解析環境、設定為取用事件中樞的事件子事件來源，以及授與環境數據存取權的存取原則。如果未指定現有的事件中樞，則會使用部署建立一個事件中樞。

依照下列指示安裝 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	來源事件中樞的名稱。
consumerGroupName	Azure 時間序列深入解析服務將用來從事件中樞讀取數據的取用者群組名稱。注意：若要避免資源爭用，此取用者群組必須專用於 Azure 時間序列深入解析服務，而不會與其他讀取者共用。
environmentName	環境的名稱。名稱不能包含：`<`、、`>\\&%:`、 `?/`和任何控制字元。允許所有其他字元。
eventSourceName	事件來源子資源的名稱。名稱不能包含：`<`、、`>\\&%:`、 `?/`和任何控制字元。允許所有其他字元。

選擇性參數

參數	描述
existingEventHubResourceId	現有事件中樞的選擇性資源標識符，會透過事件來源連線到 Azure 時間序列深入解析環境。注意：部署範本的用戶必須具有許可權，才能在事件中樞上執行 listkeys 作業。如果未傳遞任何值，範本將會建立新的事件中樞。
environmentDisplayName	在工具或使用者介面中顯示而非環境名稱的選擇性易記名稱。
environmentSkuName	SKU 的名稱。如需詳細資訊，請參閱 Azure 時間序列深入解析定價頁面。
environmentSkuCapacity	Sku 的單位容量。如需詳細資訊，請參閱 Azure 時間序列深入解析定價頁面。
environmentDataRetentionTime	環境事件的最小時間範圍將可供查詢。此值必須以 ISO 8601 格式指定，例如 `P30D` 30 天的保留原則。
eventSourceDisplayName	選擇性易記名稱，用於工具或使用者介面中顯示，而不是事件來源名稱。
eventSourceTimestampPropertyName	將做為事件來源時間戳的事件屬性。如果未為 timestampPropertyName 指定值，或指定 null 或空字串，則會使用事件建立時間。
eventSourceKeyName	Azure 時間序列深入解析服務將用來連線到事件中樞的共用存取密鑰名稱。
accessPolicyReaderObjectIds	Microsoft Entra ID 中使用者或應用程式的物件標識符清單，該標識符應該具有環境的讀取者存取權。呼叫 Get-AzADUser 或 Get-AzADServicePrincipal Cmdlet，即可取得服務主體 objectId。尚不支援建立Microsoft Entra 群組的存取原則。
accessPolicyContributorObjectIds	Microsoft Entra 識別碼中使用者或應用程式的物件標識符清單，該標識符應該具有環境的參與者存取權。呼叫 Get-AzADUser 或 Get-AzADServicePrincipal Cmdlet，即可取得服務主體 objectId。尚不支援建立Microsoft Entra 群組的存取原則。

例如，下列參數檔案會用來建立環境和事件來源，以從現有的事件中樞讀取事件。它也會建立兩個存取原則，將參與者存取權授與環境。

{
    "$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 訂用帳戶清單。執行下列命令為目前的工作階段選擇訂用帳戶。以您要使用的 Azure 訂用帳戶 GUID 取代 <YourSubscriptionId>：
```
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 Cmdlet 驗證部署。測試部署時，請提供與執行部署時完全一致的參數。

Test-AzResourceGroupDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json -TemplateParameterFile <path to parameters file>\azuredeploy.parameters.json

建立部署

若要建立新的部署，請執行 New-AzResourceGroupDeployment Cmdlet，並於提示出現時提供必要的參數。參數會包含部署的名稱、資源群組的名稱，以及範本檔案的路徑或 URL。如未指定 Mode 參數，即會使用預設值 Incremental。如需詳細資訊，請參閱累加式和完成部署。

下列命令會在 PowerShell 視窗中提示您輸入五個必要參數：

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

執行部署 Cmdlet 時，您也可以使用內嵌參數。命令如下所示：

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 入口網站部署快速入門範本
- GitHub 上的快速入門範本首頁也包含 [ 部署至 Azure ] 按鈕。按兩下會在 Azure 入口網站開啟 [自訂部署] 頁面。您可以從此頁面輸入或選取必要參數或選擇性參數數據表中每個參數的值。填寫設定之後，按兩下 [ 購買] 按鈕將會起始範本部署。

下一步

如需使用 REST API 以程式設計方式管理 Azure 時間序列深入解析資源的資訊，請參閱 Azure 時間序列深入解析管理。

共用方式為

使用 Azure Resource Manager 範本建立第 1 代 Azure 時間序列深入解析資源

指定部署範本和參數

使用 PowerShell 在本機部署快速入門範本

下一步

意見反應

其他資源

共用方式為

使用 Azure Resource Manager 範本建立第 1 代 Azure 時間序列深入解析 資源

指定部署範本和參數

使用 PowerShell 在本機部署快速入門範本

下一步

意見反應

其他資源

使用 Azure Resource Manager 範本建立第 1 代 Azure 時間序列深入解析資源