次の方法で共有


az eventgrid namespace client

Note

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

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

eventgrid 名前空間クライアントを管理します。

コマンド

名前 説明 状態
az eventgrid namespace client create

クライアントを作成します。

Extension Preview
az eventgrid namespace client delete

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

Extension Preview
az eventgrid namespace client list

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

Extension Preview
az eventgrid namespace client show

クライアントを表示します。

Extension Preview
az eventgrid namespace client update

クライアントを更新します。

Extension Preview
az eventgrid namespace client wait

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

Extension Preview

az eventgrid namespace client create

プレビュー

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

クライアントを作成します。

az eventgrid namespace client create --client-name --name
                                     --namespace-name
                                     --resource-group
                                     [--attributes]
                                     [--authentication]
                                     [--authentication-name]
                                     [--client-certificate-authentication]
                                     [--description]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--state {Disabled, Enabled}]

クライアントの作成

az eventgrid namespace client create -g rg --namespace-name name -n client-name  --attributes "{'room':'345','floor':5}" --client-certificate-authentication "{validationScheme:SubjectMatchesAuthenticationName}"

必須のパラメーター

--client-name --name -n

クライアント名。

--namespace-name

名前空間の名前。

--resource-group -g

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

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

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

--attributes

クライアントの属性。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

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

クライアントの認証情報。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ
パラメーター グループ: Properties Arguments
--authentication-name

認証のためにクライアントによって提示される名前。 既定値はリソースの名前です。

プロパティ
パラメーター グループ: Properties Arguments
--client-certificate-authentication

クライアント証明書の認証情報。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

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

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

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

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

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

クライアントが有効かどうかを示します。 既定値は [有効] です。

プロパティ
パラメーター グループ: Properties Arguments
規定値: Enabled
指定可能な値: Disabled, Enabled
グローバル パラメーター
--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 delete

プレビュー

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

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

az eventgrid namespace client delete [--client-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 delete -g rg --namespace-name name -n client-name

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

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

--client-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 list

プレビュー

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

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

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

クライアントの一覧表示

az eventgrid namespace client 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 show

プレビュー

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

クライアントを表示します。

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

クライアントの表示

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

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

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

--client-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 update

プレビュー

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

クライアントを更新します。

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

クライアントの更新

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

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

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

--add

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

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

クライアントの属性。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

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

クライアントの認証情報。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ
パラメーター グループ: Properties Arguments
--client-certificate-authentication

クライアント証明書の認証情報。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ
パラメーター グループ: Properties Arguments
--client-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
--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
--state

クライアントが有効かどうかを示します。 既定値は [有効] です。

プロパティ
パラメーター グループ: Properties Arguments
指定可能な値: Disabled, Enabled
--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 wait

プレビュー

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

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

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

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

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

--client-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