az tsi event-source iothub
注
このリファレンスは、Azure CLI (バージョン 2.50.0 以降) の timeseriesinsights 拡張機能の一部です。 az tsi event-source iothub コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
timeseriesinsights サブ グループ iot-hub を使用してイベント ソースを管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az tsi event-source iothub create |
指定した環境にイベント ソースを作成します。 |
拡張 | GA |
az tsi event-source iothub update |
指定した環境でイベント ソースを更新します。 |
拡張 | GA |
az tsi event-source iothub create
指定した環境にイベント ソースを作成します。
az tsi event-source iothub create --consumer-group-name
--environment-name
--event-source-name
--event-source-resource-id
--iot-hub-name
--key-name
--location
--resource-group
--shared-access-key
[--local-timestamp]
[--tags]
[--timestamp-property-name]
例
CreateIotHubEventSource
az tsi event-source iothub create -g "rg" --environment-name "env1" --name "eventsource" --consumer-group-name "consumer-group" --iot-hub-name "iothub" --location westus --key-name "key-name" --shared-access-key "someSecretvalue" --event-source-resource-id "resource-id"
必須のパラメーター
イベントの読み取り元となるパーティションを保持する IoT ハブのコンシューマー グループの名前。
指定したリソース グループに関連付けられている Time Series Insights 環境の名前。
指定した環境に関連付けられている Time Series Insights イベント ソースの名前。
Azure Resource Manager のイベント ソースのリソース ID。
IoT ハブの名前。
Time Series Insights サービスに IoT ハブへのアクセスを許可する Shared Access Policy キーの名前。 この共有アクセス ポリシー キーは、IoT ハブへの "サービス接続" アクセス許可を付与する必要があります。
場所。 値のソース: az account list-locations
az configure --defaults location=<location>
を使用して、既定の場所を構成できます。
環境のリソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Time Series Insights サービスに IoT ハブへの読み取りアクセスを許可する Shared Access Policy キーの値。 このプロパティは、イベント ソースの応答には表示されません。
省略可能のパラメーター
ローカル タイムスタンプ プロパティを表すオブジェクト。 これには、使用する必要があるローカル タイムスタンプの形式と、対応するタイムゾーン オフセット情報が含まれています。 localTimestamp に値が指定されていない場合、または null の場合、ローカル タイムスタンプはイベントと共に受信されません。 予期される値: json-string/@json-file。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
イベント ソースのタイムスタンプとして使用されるイベント プロパティ。 timestampPropertyName に値が指定されていない場合、または null または空の文字列が指定されている場合は、イベントの作成時間が使用されます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力フォーマット。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az tsi event-source iothub update
指定した環境でイベント ソースを更新します。
az tsi event-source iothub update [--environment-name]
[--event-source-name]
[--ids]
[--local-timestamp]
[--resource-group]
[--shared-access-key]
[--subscription]
[--tags]
[--timestamp-property-name]
例
UpdateIotHubEventSource
az tsi event-source iothub update -g "rg" --environment-name "env1" --name "eventsource" --timestamp-property-name timestampProp --shared-access-key "someSecretvalue" --tags test=tag
省略可能のパラメーター
指定したリソース グループに関連付けられている Time Series Insights 環境の名前。
指定した環境に関連付けられている Time Series Insights イベント ソースの名前。
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
ローカル タイムスタンプ プロパティを表すオブジェクト。 これには、使用する必要があるローカル タイムスタンプの形式と、対応するタイムゾーン オフセット情報が含まれています。 localTimestamp に値が指定されていない場合、または null の場合、ローカル タイムスタンプはイベントと共に受信されません。 予期される値: json-string/@json-file。
環境のリソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Time Series Insights サービスに IoT ハブへの読み取りアクセスを許可する Shared Access Policy キーの値。 このプロパティは、イベント ソースの応答には表示されません。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
イベント ソースのタイムスタンプとして使用されるイベント プロパティ。 timestampPropertyName に値が指定されていない場合、または null または空の文字列が指定されている場合は、イベントの作成時間が使用されます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力フォーマット。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
Azure CLI