az eventgrid namespace topic

Note

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

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

eventgrid 名前空間トピックを管理します。

コマンド

名前	説明	型	状態
az eventgrid namespace topic create	新しい名前空間トピックを作成します。	拡張機能	プレビュー
az eventgrid namespace topic delete	既存の名前空間トピックを削除します。	拡張機能	プレビュー
az eventgrid namespace topic event-subscription	eventgrid 名前空間トピック のイベント サブスクリプションを管理します。	拡張機能	プレビュー
az eventgrid namespace topic event-subscription create	名前空間トピックのイベント サブスクリプションを作成します。	拡張機能	プレビュー
az eventgrid namespace topic event-subscription delete	名前空間トピックの既存のイベント サブスクリプションを削除します。	拡張機能	プレビュー
az eventgrid namespace topic event-subscription list	特定の名前空間トピックに属するイベント サブスクリプションを一覧表示します。	拡張機能	プレビュー
az eventgrid namespace topic event-subscription show	名前空間トピックのイベント サブスクリプションを表示します。	拡張機能	プレビュー
az eventgrid namespace topic event-subscription update	名前空間トピックのイベント サブスクリプションを更新します。	拡張機能	プレビュー
az eventgrid namespace topic event-subscription wait	条件が満たされるまで CLI を待機状態にします。	拡張機能	プレビュー
az eventgrid namespace topic list	名前空間の下にあるすべての名前空間トピックを一覧表示します。	拡張機能	プレビュー
az eventgrid namespace topic list-key	名前空間トピックに発行するために使用する 2 つのキーを一覧表示します。	拡張機能	プレビュー
az eventgrid namespace topic regenerate-key	名前空間トピックの共有アクセス キーを再生成します。	拡張機能	プレビュー
az eventgrid namespace topic show	名前空間トピックを表示します。	拡張機能	プレビュー
az eventgrid namespace topic update	名前空間トピックを更新します。	拡張機能	プレビュー
az eventgrid namespace topic wait	条件が満たされるまで CLI を待機状態にします。	拡張機能	プレビュー

az eventgrid namespace topic create

プレビュー

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

新しい名前空間トピックを作成します。

az eventgrid namespace topic create --name
                                    --namespace-name
                                    --resource-group
                                    [--event-retention-in-days]
                                    [--input-schema {CloudEventSchemaV1_0}]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--publisher-type {Custom}]

例

トピックの作成

az eventgrid namespace topic create -g rg -n topic --namespace-name name --event-retention-in-days 1 --publisher-type custom

必須のパラメーター

--name --topic-name -n

名前空間トピックの名前。

--namespace-name

名前空間の名前。

--resource-group -g

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

省略可能のパラメーター

--event-retention-in-days

名前空間トピックのイベントリテンション期間 (日数)。

--input-schema

これにより、トピックに発行される受信イベントに必要な形式が決まります。

指定可能な値: CloudEventSchemaV1_0

規定値: CloudEventSchemaV1_0

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--publisher-type

名前空間トピックの発行元の種類。

指定可能な値: Custom

グローバル パラメーター

--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 eventgrid namespace topic delete

プレビュー

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

既存の名前空間トピックを削除します。

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

例

トピックの削除

az eventgrid namespace topic delete -g rg -n topic --namespace-name name

省略可能のパラメーター

--ids

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

--name --topic-name -n

トピックの名前。

--namespace-name

名前空間の名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--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 eventgrid namespace topic list

プレビュー

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

名前空間の下にあるすべての名前空間トピックを一覧表示します。

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

例

リスト トピック

az eventgrid namespace topic list -g rg --namespace-name name

必須のパラメーター

--namespace-name

名前空間の名前。

--resource-group -g

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

省略可能のパラメーター

--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 トークン値を指定します。

--next-token

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

--top

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

グローバル パラメーター

--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 eventgrid namespace topic list-key

プレビュー

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

名前空間トピックに発行するために使用する 2 つのキーを一覧表示します。

az eventgrid namespace topic list-key [--ids]
                                      [--namespace-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--topic-name]

例

キーの一覧表示

az eventgrid namespace topic list-key -g rg --topic-name topic --namespace-name name

省略可能のパラメーター

--ids

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

--namespace-name

名前空間の名前。

--resource-group -g

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

--subscription

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

--topic-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 eventgrid namespace topic regenerate-key

プレビュー

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

名前空間トピックの共有アクセス キーを再生成します。

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

例

キーを再生成します

az eventgrid namespace topic regenerate-key -g rg --topic-name topic --namespace-name name --key-name key1

必須のパラメーター

--key-name

key1 または key2 を再生成するキー名。

省略可能のパラメーター

--ids

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

--namespace-name

名前空間の名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--subscription

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

--topic-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 eventgrid namespace topic show

プレビュー

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

名前空間トピックを表示します。

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

例

トピックの表示

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

省略可能のパラメーター

--ids

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

--name --topic-name -n

名前空間トピックの名前。

--namespace-name

名前空間の名前。

--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 eventgrid namespace topic update

プレビュー

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

名前空間トピックを更新します。

az eventgrid namespace topic update [--add]
                                    [--event-retention-in-days]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--ids]
                                    [--input-schema {CloudEventSchemaV1_0}]
                                    [--name]
                                    [--namespace-name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--publisher-type {Custom}]
                                    [--remove]
                                    [--resource-group]
                                    [--set]
                                    [--subscription]

例

トピックの更新

az eventgrid namespace topic create -g rg -n topic --namespace-name name --input-schema CloudEventSchemaV1_0

省略可能のパラメーター

--add

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

--event-retention-in-days

名前空間トピックのイベントリテンション期間 (日数)。

--force-string

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--input-schema

これにより、トピックに発行される受信イベントに必要な形式が決まります。

指定可能な値: CloudEventSchemaV1_0

--name --topic-name -n

名前空間トピックの名前。

--namespace-name

名前空間の名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--publisher-type

名前空間トピックの発行元の種類。

指定可能な値: Custom

--remove

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

--resource-group -g

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

--set

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

--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 eventgrid namespace topic wait

プレビュー

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

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

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

省略可能のパラメーター

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

--name --topic-name -n

名前空間トピックの名前。

--namespace-name

名前空間の名前。

--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 を使います。