次の方法で共有

az eventgrid system-topic event-subscription

  • リファレンス

Note

このコマンド グループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細をご覧ください。

システム トピックのイベント サブスクリプションを管理します。

コマンド

名前 説明 型 状態
az eventgrid system-topic event-subscription create

システム トピックの新しいイベント サブスクリプションを作成します。

 コア GA
az eventgrid system-topic event-subscription create (eventgrid 拡張機能)

システム トピックの新しいイベント サブスクリプションを作成します。

 拡張機能 プレビュー
az eventgrid system-topic event-subscription delete

システム トピックのイベント サブスクリプションを削除します。

 コア GA
az eventgrid system-topic event-subscription delete (eventgrid 拡張機能)

システム トピックのイベント サブスクリプションを削除します。

 拡張機能 プレビュー
az eventgrid system-topic event-subscription list

特定のシステム トピックのイベント サブスクリプションを一覧表示します。

 コア GA
az eventgrid system-topic event-subscription list (eventgrid 拡張機能)

特定のシステム トピックのイベント サブスクリプションを一覧表示します。

 拡張機能 プレビュー
az eventgrid system-topic event-subscription show

システム トピックのイベント サブスクリプションの詳細を取得します。

 コア GA
az eventgrid system-topic event-subscription show (eventgrid 拡張機能)

システム トピックのイベント サブスクリプションの詳細を取得します。

 拡張機能 プレビュー
az eventgrid system-topic event-subscription update

システム トピックのイベント サブスクリプションを更新します。

 コア GA
az eventgrid system-topic event-subscription update (eventgrid 拡張機能)

システム トピックのイベント サブスクリプションを更新します。

 拡張機能 プレビュー

az eventgrid system-topic event-subscription create

編集

システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--aad-tenant-id]
                                                    [--advanced-filter]
                                                    [--azure-active-directory-application-id-or-uri]
                                                    [--deadletter-endpoint]
                                                    [--delivery-attribute-mapping]
                                                    [--enable-advanced-filtering-on-arrays {false, true}]
                                                    [--endpoint]
                                                    [--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
                                                    [--event-delivery-schema {cloudeventschemav1_0, custominputschema, eventgridschema}]
                                                    [--event-ttl]
                                                    [--expiration-date]
                                                    [--included-event-types]
                                                    [--labels]
                                                    [--max-delivery-attempts]
                                                    [--max-events-per-batch]
                                                    [--preferred-batch-size-in-kilobytes]
                                                    [--qttl]
                                                    [--subject-begins-with]
                                                    [--subject-case-sensitive {false, true}]
                                                    [--subject-ends-with]

例

既定のフィルターを使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create --name es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code

件名プレフィックスを指定するフィルターを使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create --name es4 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --subject-begins-with mysubject_prefix

既定のフィルターと CloudEvent V 1.0 を配信スキーマとして使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create -n es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --event-delivery-schema cloudeventschemav1_0

配信不能な宛先とカスタム再試行ポリシーが最大 10 回、イベント TTL が 2 時間 (どちらか早い方) と有効期限が設定された、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/s2/blobServices/default/containers/blobcontainer1 \
    --max-delivery-attempts 10 --event-ttl 120 --expiration-date "2022-10-31"

Azure Active Directory 対応 Webhook を宛先として使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create --name es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --azure-active-directory-tenant-id azureactivedirectorytenantid
    --azure-active-directory-application-id-or-uri azureactivedirectoryapplicationidoruri

Azure 関数を宛先として使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction

5 分の ttl で宛先としてストレージ キューを使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成する

az eventgrid system-topic event-subscription create -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint-type storagequeue \
    --endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
    --storage-queue-msg-ttl 300

Event Grid システム トピックの新しいイベント サブスクリプションを作成し、配列の高度なフィルター処理を有効にする

az eventgrid system-topic event-subscription create -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction \
    --enable-advanced-filtering-on-arrays true

必須のパラメーター

--name -n

イベント サブスクリプションの名前。

--resource-group -g

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

--system-topic-name

システム トピックの名前。

省略可能のパラメーター

--aad-tenant-id --azure-active-directory-tenant-id

配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory テナント ID。 宛先として Webhook にのみ適用されます。

--advanced-filter

高度なフィルターを使用すると、特定のイベント プロパティに基づいてイベントをフィルター処理できます。

使用法: --advanced-filter KEY[.INNERKEY] FILTEROPERATOR 値 [値 ...]StringIn: --advanced-filter データ。Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter データ。Color StringNotIn Blue Red Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringNotContains: --advanced-filter subject StringNotContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringNotBeginsWith: --advanced-filter subject StringNotBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png jpg NumberIn: --advanced-filterdata.property1 NumberIn 5 10 20 NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberNotInRange: --advanced-filter data.property2 NumberNotNotInInInRange 100,110 200,210 300,310 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --advanced-filter data.property3NumberGreaterThan 100 NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true IsNullOrUndefined: --advanced-filter data.property3 IsNullOrUndefined IsNotNull: --advanced-filter data.property3 IsNotNull 複数の高度なフィルターは、複数の --advanced-filter 引数を使用して指定できます。

--azure-active-directory-application-id-or-uri

配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory アプリケーション ID または URI。 宛先として Webhook にのみ適用されます。

--deadletter-endpoint

EventGrid がこのイベント サブスクリプションの配信不能イベントを配信不能にする必要がある Azure Storage BLOB コンテナーの宛先の Azure リソース ID。

例: --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/containerName。

--delivery-attribute-mapping

配信属性マッピングを追加して、イベントを配信するときに HTTP ヘッダー経由で追加情報を送信します。 この属性は、StorageQueue を除くすべての宛先の種類に対して有効です。 複数の引数を使用して、複数の属性を --delivery-attribute-mapping 指定できます。

使用法: --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret] 静的属性マッピング: --delivery-attribute-mapping somename static somevalue static somevalue false Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue Static と Dynamic: --delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.

--enable-advanced-filtering-on-arrays --enable-af-arr

特異な値を期待するのではなく、値の配列に対して高度なフィルターを評価できるようにします。

指定可能な値: false, true
--endpoint

EventGrid がこのイベント サブスクリプションに一致するイベントを配信するエンドポイント。 webhook エンドポイントの種類の場合、これは対応する webhook URL である必要があります。 その他の種類のエンドポイントの場合、これはエンドポイントの Azure リソース識別子である必要があります。 Event Grid コマンドを実行する前に、宛先エンドポイントが既に作成され、使用できる必要があります。

--endpoint-type

宛先エンドポイントの種類。

指定可能な値: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
規定値: webhook
--event-delivery-schema

このイベント サブスクリプションに対してイベントを配信するスキーマ。 既定では、イベントは(対応するトピックの入力スキーマに基づいて) 発行されるのと同じスキーマで配信されます。

指定可能な値: cloudeventschemav1_0, custominputschema, eventgridschema
--event-ttl

イベントの有効期間 (分単位)。 1 ~ 1440 の数値を指定する必要があります。

規定値: 1440
--expiration-date

イベント サブスクリプションの有効期限が切れる日付または日時 (UTC、例: '2018-11-30T11:59:59+00:00' または '2018-11-30')。 既定では、イベント サブスクリプションの有効期限はありません。

--included-event-types

イベントの種類 (Microsoft.Storage.BlobCreated や Microsoft.Storage.BlobDeleted など) のスペース区切りのリスト。 すべての既定のイベントの種類をサブスクライブするには、この引数に値を指定しないでください。 イベント グリッド トピックの場合、イベントの種類は顧客定義です。 Azure イベント (ストレージ アカウント、IoT Hub など) の場合は、この CLI コマンド 'az eventgrid topic-type list-event-types' を使用して、イベントの種類に対してクエリを実行できます。

--labels

このイベント サブスクリプションに関連付けるラベルのスペース区切りの一覧。

--max-delivery-attempts

配信試行の最大数。 1 ~ 30 の数値を指定する必要があります。

規定値: 30
--max-events-per-batch

バッチ内のイベントの最大数。 1 から 5000 までの数値を指定する必要があります。

--preferred-batch-size-in-kilobytes

推奨されるバッチ サイズ (KB 単位)。 1 から 1024 までの数値を指定する必要があります。

--qttl --storage-queue-msg-ttl

ストレージ キュー メッセージの有効期間 (秒単位)。

--subject-begins-with

プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字はサポートされていません。

--subject-case-sensitive

件名フィールドを大文字と小文字を区別して比較するかどうかを指定します。 True の場合フラグが存在します。

指定可能な値: false, true
規定値: False
--subject-ends-with

サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字はサポートされていません。

グローバル パラメーター
--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 system-topic event-subscription create (eventgrid 拡張機能)

プレビュー

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

システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--advanced-filter]
                                                    [--azure-active-directory-application-id-or-uri]
                                                    [--azure-active-directory-tenant-id]
                                                    [--deadletter-endpoint]
                                                    [--endpoint]
                                                    [--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
                                                    [--event-delivery-schema {cloudeventschemav1_0, custominputschema, eventgridschema}]
                                                    [--event-ttl]
                                                    [--expiration-date]
                                                    [--included-event-types]
                                                    [--labels]
                                                    [--max-delivery-attempts]
                                                    [--max-events-per-batch]
                                                    [--preferred-batch-size-in-kilobytes]
                                                    [--subject-begins-with]
                                                    [--subject-case-sensitive {false, true}]
                                                    [--subject-ends-with]

例

既定のフィルターを使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create --name es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code

件名プレフィックスを指定するフィルターを使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create --name es4 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --subject-begins-with mysubject_prefix

既定のフィルターと CloudEvent V 1.0 を配信スキーマとして使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create -n es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --event-delivery-schema cloudeventschemav1_0

配信不能な宛先とカスタム再試行ポリシーが最大 10 回、イベント TTL が 2 時間 (どちらか早い方) と有効期限が設定された、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/s2/blobServices/default/containers/blobcontainer1 \
    --max-delivery-attempts 10 --event-ttl 120 --expiration-date "2022-10-31"

Azure Active Directory 対応 Webhook を宛先として使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create --name es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --azure-active-directory-tenant-id azureactivedirectorytenantid
    --azure-active-directory-application-id-or-uri azureactivedirectoryapplicationidoruri

Azure 関数を宛先として使用して、Event Grid システム トピックの新しいイベント サブスクリプションを作成します。

az eventgrid system-topic event-subscription create -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction

必須のパラメーター

--name -n

イベント サブスクリプションの名前。

--resource-group -g

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

--system-topic-name

システム トピックの名前。

省略可能のパラメーター

--advanced-filter

高度なフィルターを使用すると、特定のイベント プロパティに基づいてイベントをフィルター処理できます。

使用法: --advanced-filter KEY[.INNERKEY] FILTEROPERATOR 値 [値 ...]StringIn: --advanced-filter データ。Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter データ。Color StringNotIn Blue Red Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg NumberIn: --advanced-filter data.property 1 NumberIn 5 10 20 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filterdata.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --advanced-filter data.property3 NumberGreaterThan 100 NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true Multiple advanced filters は、複数の --advanced-filter 引数を使用して指定できます。

--azure-active-directory-application-id-or-uri

配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory アプリケーション ID または URI。 宛先として Webhook にのみ適用されます。

--azure-active-directory-tenant-id

配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory テナント ID。 宛先として Webhook にのみ適用されます。

--deadletter-endpoint

EventGrid がこのイベント サブスクリプションの配信不能イベントを配信不能にする必要がある Azure Storage BLOB コンテナーの宛先の Azure リソース ID。

例: --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/containerName。

--endpoint

EventGrid がこのイベント サブスクリプションに一致するイベントを配信するエンドポイント。 webhook エンドポイントの種類の場合、これは対応する webhook URL である必要があります。 その他の種類のエンドポイントの場合、これはエンドポイントの Azure リソース識別子である必要があります。

--endpoint-type

宛先エンドポイントの種類。

指定可能な値: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
規定値: webhook
--event-delivery-schema

このイベント サブスクリプションに対してイベントを配信するスキーマ。 既定では、イベントは(対応するトピックの入力スキーマに基づいて) 発行されるのと同じスキーマで配信されます。

指定可能な値: cloudeventschemav1_0, custominputschema, eventgridschema
--event-ttl

イベントの有効期間 (分単位)。 1 ~ 1440 の数値を指定する必要があります。

規定値: 1440
--expiration-date

イベント サブスクリプションの有効期限が切れる日付または日時 (UTC、例: '2018-11-30T11:59:59+00:00' または '2018-11-30')。 既定では、イベント サブスクリプションの有効期限はありません。

--included-event-types

イベントの種類のスペース区切りのリスト。 例: Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted。 すべての既定のイベントの種類をサブスクライブするには、この引数に値を指定しないでください。

--labels

このイベント サブスクリプションに関連付けるラベルのスペース区切りの一覧。

--max-delivery-attempts

配信試行の最大数。 1 ~ 30 の数値を指定する必要があります。

規定値: 30
--max-events-per-batch

バッチ内のイベントの最大数。 1 から 5000 までの数値を指定する必要があります。

--preferred-batch-size-in-kilobytes

推奨されるバッチ サイズ (KB 単位)。 1 から 1024 までの数値を指定する必要があります。

--subject-begins-with

プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字はサポートされていません。

--subject-case-sensitive

件名フィールドを大文字と小文字を区別して比較するかどうかを指定します。 True の場合フラグが存在します。

指定可能な値: false, true
規定値: False
--subject-ends-with

サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字はサポートされていません。

グローバル パラメーター
--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 system-topic event-subscription delete

編集

システム トピックのイベント サブスクリプションを削除します。

az eventgrid system-topic event-subscription delete --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--yes]

例

Event Grid システム トピックのイベント サブスクリプションを削除します。

az eventgrid system-topic event-subscription delete --name es1 \
    -g rg1 --system-topic-name systemtopic1 \

必須のパラメーター

--name -n

イベント サブスクリプションの名前。

--resource-group -g

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

--system-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 system-topic event-subscription delete (eventgrid 拡張機能)

プレビュー

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

システム トピックのイベント サブスクリプションを削除します。

az eventgrid system-topic event-subscription delete --name
                                                    --resource-group
                                                    --system-topic-name

例

Event Grid システム トピックのイベント サブスクリプションを削除します。

az eventgrid system-topic event-subscription delete --name es1 \
    -g rg1 --system-topic-name systemtopic1 \

必須のパラメーター

--name -n

イベント サブスクリプションの名前。

--resource-group -g

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

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

編集

特定のシステム トピックのイベント サブスクリプションを一覧表示します。

az eventgrid system-topic event-subscription list --resource-group
                                                  --system-topic-name
                                                  [--odata-query]

例

Event Grid システム トピック用に作成されたすべてのイベント サブスクリプションを一覧表示します。

az eventgrid system-topic event-subscription list -g rg1 --system-topic-name systemtopic1

必須のパラメーター

--resource-group -g

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

--system-topic-name

システム トピックの名前。

省略可能のパラメーター

--odata-query

リストの結果をフィルター処理するために使用される OData クエリ。 現在、フィルター処理は Name プロパティでのみ許可されています。 サポートされる操作には、CONTAINS、eq (等しい)、ne (等しくない場合)、AND、OR、NOT が含まれます。

グローバル パラメーター
--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 system-topic event-subscription list (eventgrid 拡張機能)

プレビュー

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

特定のシステム トピックのイベント サブスクリプションを一覧表示します。

az eventgrid system-topic event-subscription list --resource-group
                                                  --system-topic-name
                                                  [--odata-query]

例

Event Grid システム トピック用に作成されたすべてのイベント サブスクリプションを一覧表示します。

az eventgrid system-topic event-subscription list -g rg1 --system-topic-name systemtopic1

必須のパラメーター

--resource-group -g

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

--system-topic-name

システム トピックの名前。

省略可能のパラメーター

--odata-query

OData 構文を使用して結果をフィルター処理するために使用されるクエリ。

グローバル パラメーター
--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 system-topic event-subscription show

編集

システム トピックのイベント サブスクリプションの詳細を取得します。

az eventgrid system-topic event-subscription show --name
                                                  --resource-group
                                                  --system-topic-name
                                                  [--include-attrib-secret {false, true}]
                                                  [--include-full-endpoint-url {false, true}]

例

Event Grid システム トピックのイベント サブスクリプションの詳細を表示します。

az eventgrid system-topic event-subscription show --name es1 \
     -g rg1 --system-topic-name systemtopic1

Event Grid システム トピックのイベント サブスクリプションの詳細を表示するには、静的配信属性シークレットが含まれます。

az eventgrid system-topic event-subscription show --name es1 \
     -g rg1 --system-topic-name systemtopic1 --include-attrib-secret

必須のパラメーター

--name -n

イベント サブスクリプションの名前。

--resource-group -g

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

--system-topic-name

システム トピックの名前。

省略可能のパラメーター

--include-attrib-secret --include-static-delivery-attribute-secret

静的配信属性シークレットを返す必要があるかどうかを示します。 True の場合フラグが存在します。

指定可能な値: false, true
規定値: False
--include-full-endpoint-url

完全なエンドポイント URL を返す必要があるかどうかを指定します。 True の場合フラグが存在します。

指定可能な値: false, true
規定値: 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 system-topic event-subscription show (eventgrid 拡張機能)

プレビュー

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

システム トピックのイベント サブスクリプションの詳細を取得します。

az eventgrid system-topic event-subscription show --name
                                                  --resource-group
                                                  --system-topic-name
                                                  [--include-full-endpoint-url {false, true}]

例

Event Grid システム トピックのイベント サブスクリプションの詳細を表示します。

az eventgrid system-topic event-subscription show --name es1 \
     -g rg1 --system-topic-name systemtopic1

必須のパラメーター

--name -n

イベント サブスクリプションの名前。

--resource-group -g

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

--system-topic-name

システム トピックの名前。

省略可能のパラメーター

--include-full-endpoint-url

完全なエンドポイント URL を返す必要があるかどうかを指定します。 True の場合フラグが存在します。

指定可能な値: false, true
規定値: 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 system-topic event-subscription update

編集

システム トピックのイベント サブスクリプションを更新します。

az eventgrid system-topic event-subscription update --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--advanced-filter]
                                                    [--deadletter-endpoint]
                                                    [--delivery-attribute-mapping]
                                                    [--enable-advanced-filtering-on-arrays {false, true}]
                                                    [--endpoint]
                                                    [--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
                                                    [--included-event-types]
                                                    [--labels]
                                                    [--qttl]
                                                    [--subject-begins-with]
                                                    [--subject-ends-with]

例

Event Grid システム トピックのイベント サブスクリプションを更新して、新しいエンドポイントを指定します。

az eventgrid system-topic event-subscription update --name es1 \
    -g rg1 --system-topic-name systemtopic1 --endpoint https://contoso.azurewebsites.net/api/f1?code=code

Event Grid システム トピックのイベント サブスクリプションを更新して、新しい subject-ends-with フィルターを指定します。

az eventgrid system-topic event-subscription update --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --subject-ends-with .jpg

Event Grid システム トピックのイベント サブスクリプションを更新して、新しいエンドポイントと新しい subject-ends-with フィルターを使用して、含まれるイベントの種類の新しいリストを指定します。

az eventgrid system-topic event-subscription update --name es3 \
    -g rg1 --system-topic-name systemtopic1 \
    --subject-ends-with .png \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --included-event-types Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted

配信不能な宛先を含むように、Azure Event Grid システム トピックのイベント サブスクリプションを更新します。

az eventgrid system-topic event-subscription update --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/blobcontainer1

高度なフィルターを使用して、Azure Event Grid システム トピックのイベント サブスクリプションを更新します。

az eventgrid system-topic event-subscription update --name es3 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --advanced-filter data.blobType StringIn BlockBlob
    --advanced-filter data.url StringBeginsWith https://myaccount.blob.core.windows.net

Event Grid システム トピックのイベント サブスクリプションを、5 分の ttl でストレージ キューを宛先として更新する

az eventgrid system-topic event-subscription update -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --storage-queue-msg-ttl 300

配列の高度なフィルター処理が有効になっている Event Grid システム トピックのイベント サブスクリプションを更新する

az eventgrid system-topic event-subscription update -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --enable-advanced-filtering-on-arrays true

必須のパラメーター

--name -n

イベント サブスクリプションの名前。

--resource-group -g

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

--system-topic-name

システム トピックの名前。

省略可能のパラメーター

--advanced-filter

高度なフィルターを使用すると、特定のイベント プロパティに基づいてイベントをフィルター処理できます。

使用法: --advanced-filter KEY[.INNERKEY] FILTEROPERATOR 値 [値 ...]StringIn: --advanced-filter データ。Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter データ。Color StringNotIn Blue Red Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringNotContains: --advanced-filter subject StringNotContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringNotBeginsWith: --advanced-filter subject StringNotBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png jpg NumberIn: --advanced-filterdata.property1 NumberIn 5 10 20 NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberNotInRange: --advanced-filter data.property2 NumberNotNotInInInRange 100,110 200,210 300,310 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --advanced-filter data.property3NumberGreaterThan 100 NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true IsNullOrUndefined: --advanced-filter data.property3 IsNullOrUndefined IsNotNull: --advanced-filter data.property3 IsNotNull 複数の高度なフィルターは、複数の --advanced-filter 引数を使用して指定できます。

--deadletter-endpoint

EventGrid がこのイベント サブスクリプションの配信不能イベントを配信不能にする必要がある Azure Storage BLOB コンテナーの宛先の Azure リソース ID。

--delivery-attribute-mapping

配信属性マッピングを追加して、イベントを配信するときに HTTP ヘッダー経由で追加情報を送信します。 この属性は、StorageQueue を除くすべての宛先の種類に対して有効です。 複数の引数を使用して、複数の属性を --delivery-attribute-mapping 指定できます。

使用法: --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret] 静的属性マッピング: --delivery-attribute-mapping somename static somevalue static somevalue false Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue Static と Dynamic: --delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.

--enable-advanced-filtering-on-arrays --enable-af-arr

特異な値を期待するのではなく、値の配列に対して高度なフィルターを評価できるようにします。

指定可能な値: false, true
--endpoint

EventGrid がこのイベント サブスクリプションに一致するイベントを配信するエンドポイント。 webhook エンドポイントの種類の場合、これは対応する webhook URL である必要があります。 その他の種類のエンドポイントの場合、これはエンドポイントの Azure リソース識別子である必要があります。 Event Grid コマンドを実行する前に、宛先エンドポイントが既に作成され、使用できる必要があります。

--endpoint-type

宛先エンドポイントの種類。

指定可能な値: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
規定値: webhook
--included-event-types

イベントの種類 (Microsoft.Storage.BlobCreated や Microsoft.Storage.BlobDeleted など) のスペース区切りのリスト。 すべての既定のイベントの種類をサブスクライブするには、この引数に値を指定しないでください。 イベント グリッド トピックの場合、イベントの種類は顧客定義です。 Azure イベント (ストレージ アカウント、IoT Hub など) の場合は、この CLI コマンド 'az eventgrid topic-type list-event-types' を使用して、イベントの種類に対してクエリを実行できます。

--labels

このイベント サブスクリプションに関連付けるラベルのスペース区切りの一覧。

--qttl --storage-queue-msg-ttl

ストレージ キュー メッセージの有効期間 (秒単位)。

--subject-begins-with

プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字はサポートされていません。

--subject-ends-with

サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字はサポートされていません。

グローバル パラメーター
--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 system-topic event-subscription update (eventgrid 拡張機能)

プレビュー

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

システム トピックのイベント サブスクリプションを更新します。

az eventgrid system-topic event-subscription update --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--advanced-filter]
                                                    [--deadletter-endpoint]
                                                    [--endpoint]
                                                    [--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
                                                    [--included-event-types]
                                                    [--labels]
                                                    [--subject-begins-with]
                                                    [--subject-ends-with]

例

Event Grid システム トピックのイベント サブスクリプションを更新して、新しいエンドポイントを指定します。

az eventgrid system-topic event-subscription update --name es1 \
    -g rg1 --system-topic-name systemtopic1 --endpoint https://contoso.azurewebsites.net/api/f1?code=code

Event Grid システム トピックのイベント サブスクリプションを更新して、新しい subject-ends-with フィルターを指定します。

az eventgrid system-topic event-subscription update --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --subject-ends-with .jpg

Event Grid システム トピックのイベント サブスクリプションを更新して、新しいエンドポイントと新しい subject-ends-with フィルターを使用して、含まれるイベントの種類の新しいリストを指定します。

az eventgrid system-topic event-subscription update --name es3 \
    -g rg1 --system-topic-name systemtopic1 \
    --subject-ends-with .png \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --included-event-types Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted

配信不能な宛先を含むように、Azure Event Grid システム トピックのイベント サブスクリプションを更新します。

az eventgrid system-topic event-subscription update --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/blobcontainer1

高度なフィルターを使用して、Azure Event Grid システム トピックのイベント サブスクリプションを更新します。

az eventgrid system-topic event-subscription update --name es3 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --advanced-filter data.blobType StringIn BlockBlob
    --advanced-filter data.url StringBeginsWith https://myaccount.blob.core.windows.net

必須のパラメーター

--name -n

イベント サブスクリプションの名前。

--resource-group -g

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

--system-topic-name

システム トピックの名前。

省略可能のパラメーター

--advanced-filter

高度なフィルターを使用すると、特定のイベント プロパティに基づいてイベントをフィルター処理できます。

使用法: --advanced-filter KEY[.INNERKEY] FILTEROPERATOR 値 [値 ...]StringIn: --advanced-filter データ。Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter データ。Color StringNotIn Blue Red Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg NumberIn: --advanced-filter data.property 1 NumberIn 5 10 20 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filterdata.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --advanced-filter data.property3 NumberGreaterThan 100 NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true Multiple advanced filters は、複数の --advanced-filter 引数を使用して指定できます。

--deadletter-endpoint

EventGrid がこのイベント サブスクリプションの配信不能イベントを配信不能にする必要がある Azure Storage BLOB コンテナーの宛先の Azure リソース ID。

--endpoint

EventGrid がこのイベント サブスクリプションに一致するイベントを配信するエンドポイント。 webhook エンドポイントの種類の場合、これは対応する webhook URL である必要があります。 その他の種類のエンドポイントの場合、これはエンドポイントの Azure リソース識別子である必要があります。

--endpoint-type

宛先エンドポイントの種類。

指定可能な値: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
規定値: webhook
--included-event-types

イベントの種類のスペース区切りのリスト。 例: Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted。 すべての既定のイベントの種類をサブスクライブするには、この引数に値を指定しないでください。

--labels

このイベント サブスクリプションに関連付けるラベルのスペース区切りの一覧。

--subject-begins-with

プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字はサポートされていません。

--subject-ends-with

サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字はサポートされていません。

グローバル パラメーター
--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 を使います。