az stream-analytics cluster

  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の stream-analytics 拡張機能の一部です。 拡張機能は、az stream-analytics クラスター コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

ストリーム分析を使用してクラスターを管理します。

コマンド

名前 説明 型 Status
az stream-analytics cluster create

Stream Analytics クラスターを作成するか、既存のクラスターを置き換えます。

 拡張 GA
az stream-analytics cluster delete

指定したクラスターを削除します。

 拡張 GA
az stream-analytics cluster list

特定のリソース グループ内のすべてのクラスターを一覧表示します。 また、特定のサブスクリプション内のすべてのクラスターを一覧表示します。

 拡張 GA
az stream-analytics cluster list-streaming-job

特定のクラスター内のすべてのストリーミング ジョブを一覧表示します。

 拡張 GA
az stream-analytics cluster show

指定したクラスターに関する情報を取得します。

 拡張 GA
az stream-analytics cluster update

既存のクラスターを更新します。 これを使用すると、クラスター定義の残りの部分に影響を与えることなく、クラスターを部分的に更新 (つまり、1 つまたは 2 つのプロパティを更新) できます。

 拡張 GA
az stream-analytics cluster wait

ストリーム分析クラスターの条件が満たされるまで、CLI を待機状態にします。

 拡張 GA

az stream-analytics cluster create

Stream Analytics クラスターを作成するか、既存のクラスターを置き換えます。

az stream-analytics cluster create --cluster-name
                                   --resource-group
                                   [--if-match]
                                   [--if-none-match]
                                   [--location]
                                   [--no-wait]
                                   [--sku]
                                   [--tags]

例

新しいクラスターを作成する

az stream-analytics cluster create --location "North US" --sku name="Default" capacity=36 --tags key="value" --name "An Example Cluster" --resource-group "sjrg"

必須のパラメーター

--cluster-name --name -n

クラスターの名前です。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--if-match

リソースの ETag。 現在のレコード セットを常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

--if-none-match

新しいリソースの作成を許可するが、既存のレコード セットを更新できないようにするには、'*' に設定します。 その他の値は、412 の事前条件失敗応答になります。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--sku

クラスターの SKU。 これにより、クラスターのサイズ/容量が決まります。 PUT (CreateOrUpdate) 要求で必要です。

使用法: --sku name=XX capacity=XX

name: クラスターの SKU 名を指定します。 PUT (CreateOrUpdate) 要求で必要です。 capacity: クラスターがサポートできるストリーミング ユニットの数を示します。 このプロパティの有効な値は 36 の倍数で、最小値は 36、最大値は 216 です。 PUT (CreateOrUpdate) 要求で必要です。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics cluster delete

指定したクラスターを削除します。

az stream-analytics cluster delete [--cluster-name]
                                   [--ids]
                                   [--no-wait]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

例

クラスターの削除

az stream-analytics cluster delete --name "testcluster" --resource-group "sjrg"

省略可能のパラメーター

--cluster-name --name -n

クラスターの名前です。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--yes -y

確認のダイアログを表示しません。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics cluster list

特定のリソース グループ内のすべてのクラスターを一覧表示します。 また、特定のサブスクリプション内のすべてのクラスターを一覧表示します。

az stream-analytics cluster list [--resource-group]

例

リソース グループ内のクラスターを一覧表示する

az stream-analytics cluster list --resource-group "sjrg"

サブスクリプション内のクラスターを一覧表示する

az stream-analytics cluster list

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics cluster list-streaming-job

特定のクラスター内のすべてのストリーミング ジョブを一覧表示します。

az stream-analytics cluster list-streaming-job --cluster-name
                                               --resource-group

例

クラスター内のすべてのストリーミング ジョブを一覧表示する

az stream-analytics cluster list-streaming-job --name "testcluster" --resource-group "sjrg"

必須のパラメーター

--cluster-name --name -n

クラスターの名前です。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics cluster show

指定したクラスターに関する情報を取得します。

az stream-analytics cluster show [--cluster-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

例

クラスターを取得する

az stream-analytics cluster show --name "testcluster" --resource-group "sjrg"

省略可能のパラメーター

--cluster-name --name -n

クラスターの名前です。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics cluster update

既存のクラスターを更新します。 これを使用すると、クラスター定義の残りの部分に影響を与えることなく、クラスターを部分的に更新 (つまり、1 つまたは 2 つのプロパティを更新) できます。

az stream-analytics cluster update [--cluster-name]
                                   [--ids]
                                   [--if-match]
                                   [--location]
                                   [--no-wait]
                                   [--resource-group]
                                   [--sku]
                                   [--subscription]
                                   [--tags]

例

クラスターを更新する

az stream-analytics cluster update --location "Central US" --sku capacity=72 --name "testcluster" --resource-group "sjrg"

省略可能のパラメーター

--cluster-name --name -n

クラスターの名前です。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--if-match

リソースの ETag。 現在のレコード セットを常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--sku

クラスターの SKU。 これにより、クラスターのサイズ/容量が決まります。 PUT (CreateOrUpdate) 要求で必要です。

使用法: --sku name=XX capacity=XX

name: クラスターの SKU 名を指定します。 PUT (CreateOrUpdate) 要求で必要です。 capacity: クラスターがサポートできるストリーミング ユニットの数を示します。 このプロパティの有効な値は 36 の倍数で、最小値は 36、最大値は 216 です。 PUT (CreateOrUpdate) 要求で必要です。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics cluster wait

ストリーム分析クラスターの条件が満たされるまで、CLI を待機状態にします。

az stream-analytics cluster wait [--cluster-name]
                                 [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--ids]
                                 [--interval]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

例

stream-analytics クラスターが正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。

az stream-analytics cluster wait --name "testcluster" --resource-group "sjrg" --created

stream-analytics クラスターが正常に更新されるまで、CLI スクリプトの次の行の実行を一時停止します。

az stream-analytics cluster wait --name "testcluster" --resource-group "sjrg" --updated

stream-analytics クラスターが正常に削除されるまで、CLI スクリプトの次の行の実行を一時停止します。

az stream-analytics cluster wait --name "testcluster" --resource-group "sjrg" --deleted

省略可能のパラメーター

--cluster-name --name -n

クラスターの名前です。

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False
--exists

リソースが存在するまで待ちます。

既定値: False
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

既定値: 30
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--timeout

最大待機時間 (秒単位)。

既定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。