Microsoft.TimeSeriesInsights 環境/eventSources 2018-08-15-preview

• 最新
• 2021-06-30-preview
• 2021-03-31-preview
• 2020-05-15
• 2018-08-15-preview
• 2017-11-15
• 2017-02-28-preview

Bicep リソース定義

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

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

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

リソース形式

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

resource symbolicname 'Microsoft.TimeSeriesInsights/environments/eventSources@2018-08-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  parent: resourceSymbolicName
  localTimestamp: {
    format: 'Embedded'
    timeZoneOffset: {
      propertyName: 'string'
    }
  }
  // For remaining properties, see environments/eventSources objects
}

environments/eventSources オブジェクト

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

Microsoft.EventHub の場合は、次を使用します。

  kind: 'Microsoft.EventHub'
  properties: {
    consumerGroupName: 'string'
    eventHubName: 'string'
    eventSourceResourceId: 'string'
    keyName: 'string'
    serviceBusNamespace: 'string'
    sharedAccessKey: 'string'
    timestampPropertyName: 'string'
  }

Microsoft.IoTHub の場合は、次を使用します。

  kind: 'Microsoft.IoTHub'
  properties: {
    consumerGroupName: 'string'
    eventSourceResourceId: 'string'
    iotHubName: 'string'
    keyName: 'string'
    sharedAccessKey: 'string'
    timestampPropertyName: 'string'
  }

プロパティ値

environments/eventSources

名前	説明	値
name	リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。	string (必須) 文字数制限: 1 から 90 有効な文字: 次は使用できません: `<>*%&:;\/?` または制御文字
location	リソースの場所。	string (必須)
tags	リソースの追加プロパティのキーと値のペア。	タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
kind	オブジェクトの種類を設定する	Microsoft.EventHub Microsoft.IoTHub (必須)
parent	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。	種類のリソースのシンボル名: 環境
localTimestamp	ローカル タイムスタンプ プロパティを表す オブジェクト。 これには、使用する必要があるローカル タイムスタンプの形式と、対応するタイムゾーン オフセット情報が含まれています。 localTimestamp に値が指定されていない場合、または null の場合、ローカル タイムスタンプはイベントと共にイングレスされません。	LocalTimestamp

EventHubEventSourceCreateOrUpdateParametersOrEventHu...

名前	説明	値
kind	イベント ソースの種類。	'Microsoft.EventHub' (必須)
properties	作成要求または更新要求に必要な EventHub イベント ソースのプロパティ。	EventHubEventSourceCreationPropertiesOrEventHubEvent... (必須)

EventHubEventSourceCreationPropertiesOrEventHubEvent...

名前	説明	値
consumerGroupName	イベントの読み取り元となるパーティションを保持するイベント ハブのコンシューマー グループの名前。	string (必須)
eventHubName	イベント ハブの名前。	string (必須)
eventSourceResourceId	Azure Resource Managerのイベント ソースのリソース ID。	string (必須)
keyName	Time Series Insights サービスにイベント ハブへのアクセスを許可する SAS キーの名前。 このキーの共有アクセス ポリシーは、イベント ハブに "リッスン" アクセス許可を付与する必要があります。	string (必須)
serviceBusNamespace	イベント ハブを含むサービス バスの名前。	string (必須)
sharedAccessKey	Time Series Insights サービスにイベント ハブへの読み取りアクセスを許可する共有アクセス キーの値。 このプロパティは、イベント ソースの応答には表示されません。	string (必須)
timestampPropertyName	イベント ソースのタイムスタンプとして使用されるイベント プロパティ。 TimestampPropertyName に値が指定されていない場合や、null または空の文字列が指定されている場合は、イベントの作成時刻が使用されます。	string

IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEve...

名前	説明	値
kind	イベント ソースの種類。	'Microsoft.IoTHub' (必須)
properties	作成要求または更新要求に必要な IoTHub イベント ソースのプロパティ。	IoTHubEventSourceCreationPropertiesOrIoTHubEventSour... (必須)

IoTHubEventSourceCreationPropertiesOrIoTHubEventSour...

Name	説明	値
consumerGroupName	イベントの読み取り元となるパーティションを保持する IoT ハブのコンシューマー グループの名前。	string (必須)
eventSourceResourceId	Azure Resource Managerのイベント ソースのリソース ID。	string (必須)
iotHubName	IoT ハブの名前。	string (必須)
keyName	Time Series Insights サービスに iot ハブへのアクセスを許可する Shared Access Policy キーの名前。 この共有アクセス ポリシー キーは、iot ハブに "サービス接続" アクセス許可を付与する必要があります。	string (必須)
sharedAccessKey	Time Series Insights サービスに iot ハブへの読み取りアクセスを許可する Shared Access Policy キーの値。 このプロパティは、イベント ソースの応答には表示されません。	string (必須)
timestampPropertyName	イベント ソースのタイムスタンプとして使用されるイベント プロパティ。 TimestampPropertyName に値が指定されていない場合や、null または空の文字列が指定されている場合は、イベントの作成時刻が使用されます。	string

LocalTimestamp

Name	説明	値
format	設定する必要があるローカル タイムスタンプ プロパティの形式を表す列挙型。	'Embedded'
timeZoneOffset	指定されたローカル タイムスタンプ形式のオフセット情報を表す オブジェクト。 LocalTimestampFormat - Embedded には指定しないでください。	LocalTimestampTimeZoneOffset

LocalTimestampTimeZoneOffset

Name	説明	値
propertyName	ローカル タイムスタンプを計算するためのオフセット情報を格納するイベント プロパティ。 LocalTimestampFormat が Iana の場合、プロパティ名には、IANA タイムゾーン名 (例: Americas/Los Angeles) を含む列の名前が含まれます。 LocalTimestampFormat が Timespan の場合、オフセットを表す値を含むプロパティの名前が含まれます (例: P1D または 1.00:00:00)	string

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

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

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

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

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

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

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

リソース形式

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

{
  "type": "Microsoft.TimeSeriesInsights/environments/eventSources",
  "apiVersion": "2018-08-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "localTimestamp": {
    "format": "Embedded",
    "timeZoneOffset": {
      "propertyName": "string"
    }
  },
  // For remaining properties, see environments/eventSources objects
}

environments/eventSources オブジェクト

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

Microsoft.EventHub の場合は、次を使用します。

  "kind": "Microsoft.EventHub",
  "properties": {
    "consumerGroupName": "string",
    "eventHubName": "string",
    "eventSourceResourceId": "string",
    "keyName": "string",
    "serviceBusNamespace": "string",
    "sharedAccessKey": "string",
    "timestampPropertyName": "string"
  }

Microsoft.IoTHub の場合は、次を使用します。

  "kind": "Microsoft.IoTHub",
  "properties": {
    "consumerGroupName": "string",
    "eventSourceResourceId": "string",
    "iotHubName": "string",
    "keyName": "string",
    "sharedAccessKey": "string",
    "timestampPropertyName": "string"
  }

プロパティ値

environments/eventSources

名前	説明	値
type	リソースの種類	'Microsoft.TimeSeriesInsights/environments/eventSources'
apiVersion	リソース API のバージョン	'2018-08-15-preview'
name	リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。	string (必須) 文字制限: 1 から 90 有効な文字: 次は使用できません: `<>*%&:;\/?` または制御文字
location	リソースの場所。	string (必須)
tags	リソースの追加プロパティのキーと値のペア。	タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
kind	オブジェクトの種類を設定する	Microsoft.EventHub Microsoft.IoTHub (必須)
localTimestamp	ローカル タイムスタンプ プロパティを表す オブジェクト。 これには、使用する必要があるローカル タイムスタンプの形式と、対応するタイムゾーン オフセット情報が含まれています。 localTimestamp に値が指定されていない場合、または null の場合、ローカル タイムスタンプはイベントと共にイングレスされません。	LocalTimestamp

EventHubEventSourceCreateOrUpdateParametersOrEventHu...

Name	説明	値
kind	イベント ソースの種類。	'Microsoft.EventHub' (必須)
properties	作成要求または更新要求に必要な EventHub イベント ソースのプロパティ。	EventHubEventSourceCreationPropertiesOrEventHubEvent... (必須)

EventHubEventSourceCreationPropertiesOrEventHubEvent...

Name	説明	値
consumerGroupName	イベントの読み取り元となるパーティションを保持するイベント ハブのコンシューマー グループの名前。	string (必須)
eventHubName	イベント ハブの名前。	string (必須)
eventSourceResourceId	Azure Resource Managerのイベント ソースのリソース ID。	string (必須)
keyName	Time Series Insights サービスにイベント ハブへのアクセスを許可する SAS キーの名前。 このキーの共有アクセス ポリシーは、イベント ハブに "リッスン" アクセス許可を付与する必要があります。	string (必須)
serviceBusNamespace	イベント ハブを含むサービス バスの名前。	string (必須)
sharedAccessKey	Time Series Insights サービスにイベント ハブへの読み取りアクセスを許可する共有アクセス キーの値。 このプロパティは、イベント ソースの応答には表示されません。	string (必須)
timestampPropertyName	イベント ソースのタイムスタンプとして使用されるイベント プロパティ。 TimestampPropertyName に値が指定されていない場合や、null または空の文字列が指定されている場合は、イベントの作成時刻が使用されます。	string

IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEve...

名前	説明	値
kind	イベント ソースの種類。	'Microsoft.IoTHub' (必須)
properties	作成要求または更新要求に必要な IoTHub イベント ソースのプロパティ。	IoTHubEventSourceCreationPropertiesOrIoTHubEventSour... (必須)

IoTHubEventSourceCreationPropertiesOrIoTHubEventSour...

Name	説明	値
consumerGroupName	イベントの読み取り元となるパーティションを保持する iot ハブのコンシューマー グループの名前。	string (必須)
eventSourceResourceId	Azure Resource Managerのイベント ソースのリソース ID。	string (必須)
iotHubName	IoT ハブの名前。	string (必須)
keyName	Time Series Insights サービスに IoT ハブへのアクセスを許可する Shared Access Policy キーの名前。 この共有アクセス ポリシー キーは、iot ハブに "サービス接続" アクセス許可を付与する必要があります。	string (必須)
sharedAccessKey	Time Series Insights サービスに IoT ハブへの読み取りアクセスを許可する Shared Access Policy キーの値。 このプロパティは、イベント ソースの応答には表示されません。	string (必須)
timestampPropertyName	イベント ソースのタイムスタンプとして使用されるイベント プロパティ。 TimestampPropertyName に値が指定されていない場合や、null または空の文字列が指定されている場合は、イベントの作成時刻が使用されます。	string

LocalTimestamp

Name	説明	値
format	設定する必要があるローカル タイムスタンプ プロパティの形式を表す列挙型。	'Embedded'
timeZoneOffset	指定されたローカル タイムスタンプ形式のオフセット情報を表す オブジェクト。 LocalTimestampFormat - Embedded には指定しないでください。	LocalTimestampTimeZoneOffset

LocalTimestampTimeZoneOffset

Name	説明	値
propertyName	ローカル タイムスタンプを計算するためのオフセット情報を格納するイベント プロパティ。 LocalTimestampFormat が Iana の場合、プロパティ名には IANA タイムゾーン名 (例: アメリカ/ロサンゼルス) を含む列の名前が含まれます。 LocalTimestampFormat が Timespan の場合、オフセットを表す値を含むプロパティの名前が含まれます (例: P1D または 1.00:00:00)	string

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

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

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

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

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

• リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.TimeSeriesInsights/environments/eventSources@2018-08-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  // For remaining properties, see environments/eventSources objects
  body = jsonencode({
    kind = "string"
    localTimestamp = {
      format = "Embedded"
      timeZoneOffset = {
        propertyName = "string"
      }
    }
  })
}

environments/eventSources オブジェクト

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

Microsoft.EventHub の場合は、次を使用します。

  kind = "Microsoft.EventHub"
  properties = {
    consumerGroupName = "string"
    eventHubName = "string"
    eventSourceResourceId = "string"
    keyName = "string"
    serviceBusNamespace = "string"
    sharedAccessKey = "string"
    timestampPropertyName = "string"
  }

Microsoft.IoTHub の場合は、次を使用します。

  kind = "Microsoft.IoTHub"
  properties = {
    consumerGroupName = "string"
    eventSourceResourceId = "string"
    iotHubName = "string"
    keyName = "string"
    sharedAccessKey = "string"
    timestampPropertyName = "string"
  }

プロパティ値

environments/eventSources

Name	説明	値
type	リソースの種類	"Microsoft.TimeSeriesInsights/environments/eventSources@2018-08-15-preview"
name	リソース名	string (必須) 文字数制限: 1 から 90 有効な文字: 次は使用できません: `'<>%&:\?/#` または制御文字
location	リソースの場所。	string (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: 環境
tags	リソースの追加プロパティのキーと値のペア。	タグ名と値のディクショナリ。
kind	オブジェクトの種類を設定する	Microsoft.EventHub Microsoft.IoTHub (必須)
localTimestamp	ローカル タイムスタンプ プロパティを表す オブジェクト。 これには、使用する必要があるローカル タイムスタンプの形式と、対応するタイムゾーン オフセット情報が含まれています。 localTimestamp に値が指定されていない場合、または null の場合、ローカル タイムスタンプはイベントと共にイングレスされません。	LocalTimestamp

EventHubEventSourceCreateOrUpdateParametersOrEventHu...

Name	説明	値
kind	イベント ソースの種類。	"Microsoft.EventHub" (必須)
properties	作成要求または更新要求に必要な EventHub イベント ソースのプロパティ。	EventHubEventSourceCreationPropertiesOrEventHubEvent... (必須)

EventHubEventSourceCreationPropertiesOrEventHubEvent...

名前	説明	値
consumerGroupName	イベントの読み取り元となるパーティションを保持するイベント ハブのコンシューマー グループの名前。	string (必須)
eventHubName	イベント ハブの名前。	string (必須)
eventSourceResourceId	Azure Resource Managerのイベント ソースのリソース ID。	string (必須)
keyName	Time Series Insights サービスにイベント ハブへのアクセスを許可する SAS キーの名前。 このキーの共有アクセス ポリシーは、イベント ハブに "リッスン" アクセス許可を付与する必要があります。	string (必須)
serviceBusNamespace	イベント ハブを含むサービス バスの名前。	string (必須)
sharedAccessKey	Time Series Insights サービスにイベント ハブへの読み取りアクセスを許可する共有アクセス キーの値。 このプロパティは、イベント ソースの応答には表示されません。	string (必須)
timestampPropertyName	イベント ソースのタイムスタンプとして使用されるイベント プロパティ。 TimestampPropertyName に値が指定されていない場合や、null または空の文字列が指定されている場合は、イベントの作成時刻が使用されます。	string

IoTHubEventSourceCreateOrUpdateParametersOrIoTHubEve...

Name	説明	値
kind	イベント ソースの種類。	"Microsoft.IoTHub" (必須)
properties	作成要求または更新要求に必要な IoTHub イベント ソースのプロパティ。	IoTHubEventSourceCreationPropertiesOrIoTHubEventSour... (必須)

IoTHubEventSourceCreationPropertiesOrIoTHubEventSour...

名前	説明	値
consumerGroupName	イベントの読み取り元となるパーティションを保持する IoT ハブのコンシューマー グループの名前。	string (必須)
eventSourceResourceId	Azure Resource Managerのイベント ソースのリソース ID。	string (必須)
iotHubName	IoT ハブの名前。	string (必須)
keyName	Time Series Insights サービスに iot ハブへのアクセスを許可する Shared Access Policy キーの名前。 この共有アクセス ポリシー キーは、iot ハブに "サービス接続" アクセス許可を付与する必要があります。	string (必須)
sharedAccessKey	Time Series Insights サービスに iot ハブへの読み取りアクセスを許可する Shared Access Policy キーの値。 このプロパティは、イベント ソースの応答には表示されません。	string (必須)
timestampPropertyName	イベント ソースのタイムスタンプとして使用されるイベント プロパティ。 TimestampPropertyName に値が指定されていない場合や、null または空の文字列が指定されている場合は、イベントの作成時刻が使用されます。	string

LocalTimestamp

Name	説明	値
format	設定する必要があるローカル タイムスタンプ プロパティの形式を表す列挙型。	"Embedded"
timeZoneOffset	指定されたローカル タイムスタンプ形式のオフセット情報を表す オブジェクト。 LocalTimestampFormat - Embedded には指定しないでください。	LocalTimestampTimeZoneOffset

LocalTimestampTimeZoneOffset

Name	説明	値
propertyName	ローカル タイムスタンプを計算するためのオフセット情報を格納するイベント プロパティ。 LocalTimestampFormat が Iana の場合、プロパティ名には、IANA タイムゾーン名 (例: Americas/Los Angeles) を含む列の名前が含まれます。 LocalTimestampFormat が Timespan の場合、オフセットを表す値を含むプロパティの名前が含まれます (例: P1D または 1.00:00:00)	string