az eventgrid namespace topic event-subscription

Note

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

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

eventgrid 名前空間トピック のイベント サブスクリプションを管理します。

コマンド

名前	説明	型	Status
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 event-subscription create

プレビュー

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

名前空間トピックのイベント サブスクリプションを作成します。

az eventgrid namespace topic event-subscription create --event-subscription-name
                                                       --namespace-name
                                                       --resource-group
                                                       --topic-name
                                                       [--delivery-configuration]
                                                       [--event-delivery-schema {CloudEventSchemaV1_0}]
                                                       [--filters-configuration]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

例

イベント サブスクリプションの作成

az eventgrid namespace topic event-subscription create -g rg --topic-name topic -n event-subscription --namespace-name name --delivery-configuration "{deliveryMode:Queue,queue:{receiveLockDurationInSeconds:60,maxDeliveryCount:4,eventTimeToLive:P1D}}"

必須のパラメーター

--event-subscription-name --name -n

作成されるイベント サブスクリプションの名前。 イベント サブスクリプション名の長さは 3 ~ 100 文字で、英数字のみを使用する必要があります。

--namespace-name

名前空間の名前。

--resource-group -g

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

--topic-name

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

省略可能のパラメーター

--delivery-configuration

イベント サブスクリプションの配信構成に関する情報。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--event-delivery-schema

イベント サブスクリプションのイベント配信スキーマ。

承認された値: CloudEventSchemaV1_0

--filters-configuration

イベント サブスクリプションのフィルターに関する情報。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

グローバル パラメーター

--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 event-subscription delete

プレビュー

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

名前空間トピックの既存のイベント サブスクリプションを削除します。

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

例

イベント サブスクリプションの削除

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

省略可能のパラメーター

--event-subscription-name --name -n

作成されるイベント サブスクリプションの名前。 イベント サブスクリプション名の長さは 3 ~ 100 文字で、英数字のみを使用する必要があります。

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

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

--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 event-subscription list

プレビュー

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

特定の名前空間トピックに属するイベント サブスクリプションを一覧表示します。

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

例

イベント サブスクリプションを一覧表示する

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

必須のパラメーター

--namespace-name

名前空間の名前。

--resource-group -g

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

--topic-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 event-subscription show

プレビュー

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

名前空間トピックのイベント サブスクリプションを表示します。

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

例

イベント サブスクリプションを表示する

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

省略可能のパラメーター

--event-subscription-name --name -n

作成されるイベント サブスクリプションの名前。 イベント サブスクリプション名の長さは 3 ~ 100 文字で、英数字のみを使用する必要があります。

--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 event-subscription update

プレビュー

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

名前空間トピックのイベント サブスクリプションを更新します。

az eventgrid namespace topic event-subscription update [--add]
                                                       [--delivery-configuration]
                                                       [--event-delivery-schema {CloudEventSchemaV1_0}]
                                                       [--event-subscription-name]
                                                       [--filters-configuration]
                                                       [--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]
                                                       [--subscription]
                                                       [--topic-name]

例

イベント サブスクリプションを更新する

az eventgrid namespace topic event-subscription create -g rg --topic-name topic -n event-subscription --namespace-name name --filters-configuration "{includedEventTypes:['All']}"

省略可能のパラメーター

--add

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

--delivery-configuration

イベント サブスクリプションの配信構成に関する情報。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--event-delivery-schema

イベント サブスクリプションのイベント配信スキーマ。

承認された値: CloudEventSchemaV1_0

--event-subscription-name --name -n

作成されるイベント サブスクリプションの名前。 イベント サブスクリプション名の長さは 3 ~ 100 文字で、英数字のみを使用する必要があります。

--filters-configuration

イベント サブスクリプションのフィルターに関する情報。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--force-string

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--namespace-name

名前空間の名前。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--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 を使用して、既定のサブスクリプションを構成できます。

--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 event-subscription wait

プレビュー

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

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

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

省略可能のパラメーター

--created

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

既定値: False

--custom

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

--deleted

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

既定値: False

--event-subscription-name --name -n

作成されるイベント サブスクリプションの名前。 イベント サブスクリプション名の長さは 3 ~ 100 文字で、英数字のみを使用する必要があります。

--exists

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

既定値: False

--ids

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

--interval

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

既定値: 30

--namespace-name

名前空間の名前。

--resource-group -g

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

--subscription

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

--timeout

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

既定値: 3600

--topic-name

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

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