次の方法で共有

az eventgrid namespace client-group

  • プレビュー

Note

このリファレンスは、Azure CLI (バージョン 2.51.0 以降) の eventgrid 拡張機能の一部です。 拡張機能は、az eventgrid namespace client-group コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

コマンド グループ 'az eventgrid' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

eventgrid 名前空間の client-group を管理します。

コマンド

名前 説明 型 状態
az eventgrid namespace client-group create

クライアント グループを作成します。

 Extension Preview
az eventgrid namespace client-group delete

既存のクライアント グループを削除します。

 Extension Preview
az eventgrid namespace client-group list

名前空間の下にあるすべてのクライアント グループを一覧表示します。

 Extension Preview
az eventgrid namespace client-group show

クライアント グループを表示します。

 Extension Preview
az eventgrid namespace client-group update

クライアント グループを更新します。

 Extension Preview
az eventgrid namespace client-group wait

条件が満たされるまで CLI を待機状態にします。

 Extension Preview

az eventgrid namespace client-group create

プレビュー

コマンド グループ 'az eventgrid namespace client-group' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クライアント グループを作成します。

az eventgrid namespace client-group create --client-group-name --name
                                           --namespace-name
                                           --resource-group
                                           [--description]
                                           [--group-query]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

例

クライアント グループを作成する

az eventgrid namespace client-group create -g rg --namespace-name name -n client-group --group-query "attributes.floor=6"

必須のパラメーター

--client-group-name --name -n

クライアント グループ名。

--namespace-name

名前空間の名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--description

クライアント グループ リソースの説明。

プロパティ 値
パラメーター グループ: Properties Arguments
--group-query

クライアントのグループ化クエリ。

プロパティ 値
パラメーター グループ: Properties Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az eventgrid namespace client-group delete

プレビュー

コマンド グループ 'az eventgrid namespace client-group' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

既存のクライアント グループを削除します。

az eventgrid namespace client-group delete [--client-group-name --name]
                                           [--ids]
                                           [--namespace-name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

例

クライアント グループを削除する

az eventgrid namespace client-group delete -g rg --namespace-name name -n client-group

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--client-group-name --name -n

クライアント グループの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--ids

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--namespace-name

名前空間の名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--yes -y

確認を求めないでください。

プロパティ 値
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az eventgrid namespace client-group list

プレビュー

コマンド グループ 'az eventgrid namespace client-group' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

名前空間の下にあるすべてのクライアント グループを一覧表示します。

az eventgrid namespace client-group list --namespace-name
                                         --resource-group
                                         [--filter]
                                         [--max-items]
                                         [--next-token]
                                         [--top]

例

クライアント グループを一覧表示する

az eventgrid namespace client-group list -g rg --namespace-name name

必須のパラメーター

--namespace-name

名前空間の名前。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--filter

OData 構文を使用して検索結果をフィルター処理するために使用するクエリ。 フィルター処理は、'name' プロパティでのみ許可され、OData 操作の数は限られています。 これらの操作は、'contains' 関数と、次の論理演算です。not、and、または eq (等しい場合)、ne (等しくない場合) です。 算術演算はサポートされていません。 有効なフィルターの例を次に示します。$filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. 有効なフィルターの例を次に示します。$filter=location eq 'westus'。

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

プロパティ 値
パラメーター グループ: Pagination Arguments
--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

プロパティ 値
パラメーター グループ: Pagination Arguments
--top

リスト操作の 1 ページあたりに返される結果の数。 top パラメーターの有効な範囲は 1 から 100 です。 指定しない場合、返される結果の既定の数は 1 ページあたり 20 アイテムです。

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az eventgrid namespace client-group show

プレビュー

コマンド グループ 'az eventgrid namespace client-group' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クライアント グループを表示します。

az eventgrid namespace client-group show [--client-group-name --name]
                                         [--ids]
                                         [--namespace-name]
                                         [--resource-group]
                                         [--subscription]

例

クライアント グループを表示する

az eventgrid namespace client-group show -g rg --namespace-name name -n client-group

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--client-group-name --name -n

クライアント グループの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--ids

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--namespace-name

名前空間の名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--resource-group -g

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az eventgrid namespace client-group update

プレビュー

コマンド グループ 'az eventgrid namespace client-group' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

クライアント グループを更新します。

az eventgrid namespace client-group update [--add]
                                           [--client-group-name --name]
                                           [--description]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--group-query]
                                           [--ids]
                                           [--namespace-name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subscription]

例

クライアント グループの更新

az eventgrid namespace client-group update -g rg --namespace-name name -n client-group --description test

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ 値
パラメーター グループ: Generic Update Arguments
--client-group-name --name -n

クライアント グループの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--description

クライアント グループ リソースの説明。

プロパティ 値
パラメーター グループ: Properties Arguments
--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ 値
パラメーター グループ: Generic Update Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--group-query

クライアントのグループ化クエリ。

プロパティ 値
パラメーター グループ: Properties Arguments
--ids

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--namespace-name

名前空間の名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ 値
パラメーター グループ: Generic Update Arguments
--resource-group -g

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ 値
パラメーター グループ: Generic Update Arguments
--subscription

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az eventgrid namespace client-group wait

プレビュー

コマンド グループ 'az eventgrid namespace client-group' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

条件が満たされるまで CLI を待機状態にします。

az eventgrid namespace client-group wait [--client-group-name --name]
                                         [--created]
                                         [--custom]
                                         [--deleted]
                                         [--exists]
                                         [--ids]
                                         [--interval]
                                         [--namespace-name]
                                         [--resource-group]
                                         [--subscription]
                                         [--timeout]
                                         [--updated]

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--client-group-name --name -n

クライアント グループの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--created

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--custom

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
--deleted

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--exists

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--ids

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--interval

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 30
--namespace-name

名前空間の名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--resource-group -g

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--timeout

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 3600
--updated

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False