Microsoft.TimeSeriesInsights 環境

[アーティクル]
07/01/2023

Bicep リソース定義

環境リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドを参照してください

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

リソース形式

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

resource symbolicname 'Microsoft.TimeSeriesInsights/environments@2021-06-30-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  kind: 'string'
  // For remaining properties, see environments objects
}

environments オブジェクト

kind プロパティを設定して、オブジェクトの種類を指定します。

Gen1 の場合は、次の値を使用します。

  kind: 'Gen1'
  properties: {
    dataRetentionTime: 'string'
    partitionKeyProperties: [
      {
        name: 'string'
        type: 'String'
      }
    ]
    storageLimitExceededBehavior: 'string'
  }

Gen2 の場合は、次の値を使用します。

  kind: 'Gen2'
  properties: {
    storageConfiguration: {
      accountName: 'string'
      managementKey: 'string'
    }
    timeSeriesIdProperties: [
      {
        name: 'string'
        type: 'String'
      }
    ]
    warmStoreConfiguration: {
      dataRetention: 'string'
    }
  }

プロパティ値

環境

Name	説明	値
name	リソース名	string (必須) 文字制限: 1 から 90 有効な文字: 次は使用できません: `'<>%&:\?/#` または制御文字
location	リソースの場所。	string (必須)
tags	リソースの追加プロパティのキーと値のペア。	タグの名前と値のディクショナリ。「テンプレート内のタグ」を参照してください
sku	SKU によって、Gen1 (S1 または S2) または Gen2 (L1) のいずれかの環境の種類が決定されます。 Gen1 環境の場合、SKU によって環境の容量、イングレスレート、課金レートが決定されます。	Sku (必須)
kind	オブジェクトの種類を設定する	Gen1 Gen2 (必須)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Name	説明	値
kind	環境の種類。	'Gen1' (必須)
properties	Gen1 環境の作成に使用されるプロパティ。	Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (必須)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

名前	説明	値
dataRetentionTime	環境のイベントをクエリに使用できる最小日数を指定する ISO8601 timespan。	string (必須)
partitionKeyProperties	環境内のデータをパーティション分割するために使用されるイベントプロパティの一覧。現在、1 つのパーティションキープロパティのみがサポートされています。	TimeSeriesIdProperty[]
storageLimitExceededBehavior	Time Series Insights サービスが環境の容量を超えたときに実行する必要がある動作。 "PauseIngress" を指定した場合、新しいイベントはイベントソースから読み取られません。 "PurgeOldData" を指定した場合、新しいイベントは引き続き読み取られ、古いイベントは環境から削除されます。既定の動作は PurgeOldData です。	'PauseIngress' 'PurgeOldData'

TimeSeriesIdProperty

Name	説明	値
name	プロパティの名前。	string
type	プロパティの型。	'String'

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

名前	説明	値
kind	環境の種類。	'Gen2' (必須)
properties	Gen2 環境の作成に使用されるプロパティ。	Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (必須)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

名前	説明	値
storageConfiguration	ストレージ構成では、Time Series Insights サービスが環境のデータの格納に使用される顧客ストレージアカウントに接続できるようにする接続の詳細が提供されます。	Gen2StorageConfigurationInputOrGen2StorageConfigurat... (必須)
timeSeriesIdProperties	環境の時系列 ID を定義するために使用されるイベントプロパティの一覧。	TimeSeriesIdProperty[] (必須)
warmStoreConfiguration	ウォームストアの構成では、より高速なクエリのために使用できる環境のデータのコピーを保持するウォームストアキャッシュを作成するための詳細が提供されます。	WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Name	説明	値
accountName	環境の Gen2 データを保持するストレージアカウントの名前。	string (必須)
managementKey	Time Series Insights サービスにストレージアカウントへの書き込みアクセスを許可する管理キーの値。このプロパティは、環境の応答には表示されません。	string (必須)

WarmStoreConfigurationProperties

Name	説明	値
dataRetention	環境のイベントがウォームストアからのクエリに使用できる日数を指定する ISO8601 timespan。	string (必須)

Sku

Name	説明	値
capacity	SKU の容量。 Gen1 環境の場合、この値を変更して、環境の作成後のスケールアウトをサポートできます。	int (必須)
name	この SKU の名前。	'L1' 'P1' 'S1' 'S2' (必須)

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

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

Template	説明
IoT Hubを使用して従量課金制 (PAYG) 環境を作成する	このテンプレートを使用すると、IoT Hubからのイベントを使用するように構成された従量課金制 (PAYG) Time Series Insights 環境をデプロイできます。
Event Hub イベントソースを使用して環境を作成する	このテンプレートを使用すると、イベントハブからのイベントを使用するように構成された Time Series Insights 環境をデプロイできます。

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

環境リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドに関するページを参照してください

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

リソース形式

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

{
  "type": "Microsoft.TimeSeriesInsights/environments",
  "apiVersion": "2021-06-30-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "kind": "string",
  // For remaining properties, see environments objects
}

environments オブジェクト

kind プロパティを設定して、オブジェクトの種類を指定します。

Gen1 の場合は、次の値を使用します。

  "kind": "Gen1",
  "properties": {
    "dataRetentionTime": "string",
    "partitionKeyProperties": [
      {
        "name": "string",
        "type": "String"
      }
    ],
    "storageLimitExceededBehavior": "string"
  }

Gen2 の場合は、次の値を使用します。

  "kind": "Gen2",
  "properties": {
    "storageConfiguration": {
      "accountName": "string",
      "managementKey": "string"
    },
    "timeSeriesIdProperties": [
      {
        "name": "string",
        "type": "String"
      }
    ],
    "warmStoreConfiguration": {
      "dataRetention": "string"
    }
  }

プロパティ値

環境

名前	説明	値
type	リソースの種類	'Microsoft.TimeSeriesInsights/environments'
apiVersion	リソース API のバージョン	'2021-06-30-preview'
name	リソース名	string (必須) 文字数制限: 1 から 90 有効な文字: 次は使用できません: `'<>%&:\?/#` または制御文字
location	リソースの場所。	string (必須)
tags	リソースの追加プロパティのキーと値のペア。	タグ名と値のディクショナリ。「テンプレートのタグ」を参照してください
sku	SKU によって、Gen1 (S1 または S2) または Gen2 (L1) のいずれかの環境の種類が決定されます。 Gen1 環境の場合、SKU によって環境の容量、イングレスレート、課金レートが決定されます。	Sku (必須)
kind	オブジェクトの種類を設定する	Gen1 Gen2 (必須)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

名前	説明	値
kind	環境の種類。	'Gen1' (必須)
properties	Gen1 環境の作成に使用されるプロパティ。	Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (必須)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

名前	説明	値
dataRetentionTime	環境のイベントをクエリに使用できる最小日数を指定する ISO8601 timespan。	string (必須)
partitionKeyProperties	環境内のデータをパーティション分割するために使用されるイベントプロパティの一覧。現時点では、1 つのパーティションキープロパティのみがサポートされています。	TimeSeriesIdProperty[]
storageLimitExceededBehavior	環境の容量を超えたときに Time Series Insights サービスが実行する必要がある動作。 "PauseIngress" を指定した場合、新しいイベントはイベントソースから読み取りません。 "PurgeOldData" を指定した場合、新しいイベントは引き続き読み取られ、古いイベントは環境から削除されます。既定の動作は PurgeOldData です。	'PauseIngress' 'PurgeOldData'

TimeSeriesIdProperty

Name	説明	値
name	プロパティの名前。	string
type	プロパティの型。	'String'

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

名前	説明	値
kind	環境の種類。	'Gen2' (必須)
properties	Gen2 環境の作成に使用されるプロパティ。	Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (必須)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

名前	説明	値
storageConfiguration	ストレージ構成では、Time Series Insights サービスが環境のデータの格納に使用される顧客ストレージアカウントに接続できるようにする接続の詳細が提供されます。	Gen2StorageConfigurationInputOrGen2StorageConfigurat... (必須)
timeSeriesIdProperties	環境の時系列 ID を定義するために使用されるイベントプロパティの一覧。	TimeSeriesIdProperty[] (必須)
warmStoreConfiguration	ウォームストアの構成では、より高速なクエリのために使用できる環境のデータのコピーを保持するウォームストアキャッシュを作成するための詳細が提供されます。	WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Name	説明	値
accountName	環境の Gen2 データを保持するストレージアカウントの名前。	string (必須)
managementKey	Time Series Insights サービスにストレージアカウントへの書き込みアクセスを許可する管理キーの値。このプロパティは、環境の応答には表示されません。	string (必須)

WarmStoreConfigurationProperties

Name	説明	値
dataRetention	環境のイベントがウォームストアからのクエリに使用できる日数を指定する ISO8601 timespan。	string (必須)

Sku

Name	説明	値
capacity	SKU の容量。 Gen1 環境の場合、この値を変更して、環境の作成後のスケールアウトをサポートできます。	int (必須)
name	この SKU の名前。	'L1' 'P1' 'S1' 'S2' (必須)

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

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

Template	説明
IoT Hubを使用して従量課金制 (PAYG) 環境を作成する	このテンプレートを使用すると、IoT Hubからのイベントを使用するように構成された従量課金制 (PAYG) Time Series Insights 環境をデプロイできます。
Event Hub イベントソースを使用して環境を作成する	このテンプレートを使用すると、イベントハブからのイベントを使用するように構成された Time Series Insights 環境をデプロイできます。

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

環境リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.TimeSeriesInsights/environments@2021-06-30-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  // For remaining properties, see environments objects
  body = jsonencode({
    sku = {
      capacity = int
      name = "string"
    }
    kind = "string"
  })
}

environments オブジェクト

kind プロパティを設定して、オブジェクトの種類を指定します。

Gen1 の場合は、次の値を使用します。

  kind = "Gen1"
  properties = {
    dataRetentionTime = "string"
    partitionKeyProperties = [
      {
        name = "string"
        type = "String"
      }
    ]
    storageLimitExceededBehavior = "string"
  }

Gen2 の場合は、次の値を使用します。

  kind = "Gen2"
  properties = {
    storageConfiguration = {
      accountName = "string"
      managementKey = "string"
    }
    timeSeriesIdProperties = [
      {
        name = "string"
        type = "String"
      }
    ]
    warmStoreConfiguration = {
      dataRetention = "string"
    }
  }

プロパティ値

環境

Name	説明	値
type	リソースの種類	"Microsoft.TimeSeriesInsights/environments@2021-06-30-preview"
name	リソース名	string (必須) 文字数制限: 1 から 90 有効な文字: 次は使用できません: `<>*%&:\/?` または制御文字
location	リソースの場所。	string (必須)
parent_id	リソースグループにデプロイするには、そのリソースグループの ID を使用します。	string (必須)
tags	リソースの追加プロパティのキーと値のペア。	タグ名と値のディクショナリ。
sku	SKU によって、Gen1 (S1 または S2) または Gen2 (L1) のいずれかの環境の種類が決定されます。 Gen1 環境の場合、SKU によって環境の容量、イングレスレート、課金レートが決定されます。	Sku (必須)
kind	オブジェクトの種類を設定する	Gen1 Gen2 (必須)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

名前	説明	値
kind	環境の種類。	"Gen1" (必須)
properties	Gen1 環境の作成に使用されるプロパティ。	Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (必須)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

名前	説明	値
dataRetentionTime	環境のイベントをクエリに使用できる最小日数を指定する ISO8601 timespan。	string (必須)
partitionKeyProperties	環境内のデータをパーティション分割するために使用されるイベントプロパティの一覧。現時点では、1 つのパーティションキープロパティのみがサポートされています。	TimeSeriesIdProperty[]
storageLimitExceededBehavior	環境の容量を超えたときに Time Series Insights サービスが実行する必要がある動作。 "PauseIngress" を指定した場合、新しいイベントはイベントソースから読み取りません。 "PurgeOldData" を指定した場合、新しいイベントは引き続き読み取られ、古いイベントは環境から削除されます。既定の動作は PurgeOldData です。	"PauseIngress" "PurgeOldData"

TimeSeriesIdProperty

Name	説明	値
name	プロパティの名前。	string
type	プロパティの型。	"String"

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Name	説明	値
kind	環境の種類。	"Gen2" (必須)
properties	Gen2 環境の作成に使用されるプロパティ。	Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (必須)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

名前	説明	値
storageConfiguration	ストレージ構成では、Time Series Insights サービスが環境のデータの格納に使用される顧客ストレージアカウントに接続できるようにする接続の詳細が提供されます。	Gen2StorageConfigurationInputOrGen2StorageConfigurat... (必須)
timeSeriesIdProperties	環境の時系列 ID を定義するために使用されるイベントプロパティの一覧。	TimeSeriesIdProperty[] (必須)
warmStoreConfiguration	ウォームストアの構成では、より高速なクエリのために使用できる環境のデータのコピーを保持するウォームストアキャッシュを作成するための詳細が提供されます。	WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Name	説明	値
accountName	環境の Gen2 データを保持するストレージアカウントの名前。	string (必須)
managementKey	Time Series Insights サービスにストレージアカウントへの書き込みアクセスを許可する管理キーの値。このプロパティは、環境の応答には表示されません。	string (必須)

WarmStoreConfigurationProperties

Name	説明	値
dataRetention	環境のイベントがウォームストアからのクエリに使用できる日数を指定する ISO8601 timespan。	string (必須)

Sku

Name	説明	値
capacity	SKU の容量。 Gen1 環境の場合、この値を変更して、環境の作成後のスケールアウトをサポートできます。	int (必須)
name	この SKU の名前。	"L1" "P1" "S1" "S2" (必須)

次の方法で共有

Microsoft.TimeSeriesInsights 環境

Bicep リソース定義

リソース形式

environments オブジェクト

プロパティ値

環境

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

TimeSeriesIdProperty

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

WarmStoreConfigurationProperties

Sku

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

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

リソース形式

environments オブジェクト

プロパティ値

環境

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

TimeSeriesIdProperty

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

WarmStoreConfigurationProperties

Sku

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

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

リソース形式

environments オブジェクト

プロパティ値

環境

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

TimeSeriesIdProperty

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

WarmStoreConfigurationProperties

Sku

フィードバック

その他のリソース

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

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

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