次の方法で共有

az eventgrid topic

  • リファレンス

Azure Event Grid のトピックを管理します。

コマンド

名前 説明 型 状態
az eventgrid topic create

トピックを作成します。

 コア ジョージア 州
az eventgrid topic delete

トピックを削除します。

 コア ジョージア 州
az eventgrid topic event-subscription

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

 コア ジョージア 州
az eventgrid topic event-subscription create

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

 コア ジョージア 州
az eventgrid topic event-subscription delete

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

 コア ジョージア 州
az eventgrid topic event-subscription list

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

 コア ジョージア 州
az eventgrid topic event-subscription show

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

 コア ジョージア 州
az eventgrid topic event-subscription update

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

 コア ジョージア 州
az eventgrid topic key

トピックの共有アクセス キーを管理します。

 コア ジョージア 州
az eventgrid topic key list

トピックの共有アクセス キーを一覧表示します。

 コア ジョージア 州
az eventgrid topic key regenerate

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

 コア ジョージア 州
az eventgrid topic list

使用可能なトピックを一覧表示します。

 コア ジョージア 州
az eventgrid topic show

トピックの詳細を取得します。

 コア ジョージア 州
az eventgrid topic update

トピックを更新します。

 コア ジョージア 州

az eventgrid topic create

編集

トピックを作成します。

az eventgrid topic create --name
                          --resource-group
                          [--extended-location-name]
                          [--extended-location-type {customlocation}]
                          [--identity {noidentity, systemassigned}]
                          [--inbound-ip-rules]
                          [--input-mapping-default-values]
                          [--input-mapping-fields]
                          [--input-schema {cloudeventschemav1_0, customeventschema, eventgridschema}]
                          [--kind {azure, azurearc}]
                          [--location]
                          [--mi-system-assigned]
                          [--mi-user-assigned]
                          [--public-network-access {disabled, enabled}]
                          [--sku {basic, premium}]
                          [--tags]

例

新しいトピックを作成します。

az eventgrid topic create -g rg1 --name topic1 -l westus2

カスタム入力マッピングを使用して新しいトピックを作成します。

az eventgrid topic create -g rg1 --name topic1 -l westus2 --input-schema customeventschema --input-mapping-fields topic=myTopicField eventType=myEventTypeField --input-mapping-default-values subject=DefaultSubject dataVersion=1.0

CloudEvents V1.0 スキーマで発行されたイベントを受け入れる新しいトピックを作成します。

az eventgrid topic create -g rg1 --name topic1 -l westus2 --input-schema cloudeventschemav1_0

Basic SKU とシステム割り当て ID を使用して特定の受信 IP 規則を許可する新しいトピックを作成する

az eventgrid topic create -g rg1 --name topic1 -l westus2 --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --sku Basic --identity systemassigned

Azure で新しいトピックを作成します。

az eventgrid topic create -g rg1 --name topic1 -l westus2

Azure で新しいトピックを作成します。

az eventgrid topic create -g rg1 --name topic1 -l westus2 --kind azure

カスタムの場所をターゲットとする新しいトピックを AzureArc に作成します。

az eventgrid topic create -g rg1 --name topic1 -l eastus2euap --kind azurearc --extended-location-name /subscriptions/<subid>/resourcegroups/<rgname>/providers/microsoft.extendedlocation/customlocations/<cust-loc-name> --extended-location-type customlocation --input-schema CloudEventSchemaV1_0

必須のパラメーター

--name -n

トピックの名前。

--resource-group -g

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

省略可能のパラメーター

--extended-location-name
プレビュー

kind==azurearc の場合の拡張場所名。

--extended-location-type
プレビュー

kind==azurearc の場合の拡張場所の種類。

指定可能な値: customlocation
--identity
プレビュー 非推奨

引数 'identity' は非推奨となり、今後のリリースで削除される予定です。

リソースのマネージド ID の種類。 今後非推奨となり、--mi-system-assigned-identity に置き換えられます。

指定可能な値: noidentity, systemassigned
--inbound-ip-rules

受信 IP 規則の一覧。

IP アドレスを CIDR 表記で指定する受信 IP 規則の一覧 (例: 10.0.0.0/8)、および IpMask の一致または一致に基づいて実行する対応するアクション。 使用可能な値には、許可が含まれます。

--input-mapping-default-values

入力スキーマが customeventschema として指定されている場合、このパラメーターを使用して、既定値に基づいて入力マッピングを指定できます。 このパラメーターは、カスタム スキーマに、このパラメーターでサポートされている 3 つのフィールドのいずれかに対応するフィールドが含まれていない場合に使用できます。 スペース区切りのマッピングを 'key=value' 形式で指定します。 使用できるキー名は、'subject'、'eventtype'、'dataversion' です。 対応する値名では、マッピングに使用する既定値を指定する必要があります。これらは、発行されたイベントに特定のフィールドに対して有効なマッピングがない場合にのみ使用されます。

--input-mapping-fields

入力スキーマが customeventschema として指定されている場合、このパラメーターはフィールド名に基づいて入力マッピングを指定するために使用されます。 スペース区切りのマッピングを 'key=value' 形式で指定します。 使用できるキー名は、'id'、'topic'、'eventtime'、'subject'、'eventtype'、'dataversion' です。 対応する値の名前には、カスタム入力スキーマ内のフィールドの名前を指定する必要があります。 'id' または 'eventtime' のマッピングが指定されていない場合、Event Grid はこれら 2 つのフィールドの既定値を自動生成します。

--input-schema

受信イベントがこのトピック/ドメインに発行されるスキーマ。 このパラメーターの値として customeventschema を指定する場合は、少なくとも 1 つの --input_mapping_default_values/ --input_mapping_fields の値も指定する必要があります。

指定可能な値: cloudeventschemav1_0, customeventschema, eventgridschema
規定値: eventgridschema
--kind
プレビュー

トピック リソースの種類。

指定可能な値: azure, azurearc
規定値: Azure
--location -l

場所。 値の取得場所: az account list-locations. az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--mi-system-assigned

このパラメーターの存在は、SystemAssigned マネージド ID が使用されることを示します。

--mi-user-assigned
プレビュー

identityType がユーザーまたは混在している場合に、ユーザー割り当て ID を追加します。 この属性は、StorageQueue を除くすべての宛先の種類に対して有効です。 複数の --mi-user-assigned 引数を使用して、複数の属性を指定できます。

--public-network-access

これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 構成することで、特定の IP にさらに制限できます。

指定可能な値: disabled, enabled
--sku
プレビュー

リソースの SKU 名。

指定可能な値: basic, premium
規定値: Basic
--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

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

編集

トピックを削除します。

az eventgrid topic delete [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]

例

トピックを削除します。

az eventgrid topic delete -g rg1 --name topic1

省略可能のパラメーター

--ids

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

--name -n

トピックの名前。

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

編集

使用可能なトピックを一覧表示します。

az eventgrid topic list [--odata-query]
                        [--resource-group]

例

現在の Azure サブスクリプションのすべてのトピックを一覧表示します。

az eventgrid topic list

リソース グループ内のすべてのトピックを一覧表示します。

az eventgrid topic list -g rg1

"XYZ" というパターンを含む名前を持つリソース グループ内のすべてのトピックを一覧表示する

az eventgrid topic list -g rg1 --odata-query "Contains(name, 'XYZ')"

"name1" という名前のドメインを除く、リソース グループ内のすべてのトピックを一覧表示する

az eventgrid topic list -g rg1 --odata-query "NOT (name eq 'name1')"

省略可能のパラメーター

--odata-query

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<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 topic show

編集

トピックの詳細を取得します。

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

例

トピックの詳細を表示します。

az eventgrid topic show -g rg1 -n topic1

リソース ID に基づいてトピックの詳細を表示します。

az eventgrid topic show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1

省略可能のパラメーター

--ids

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

--name -n

トピックの名前。

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

編集

トピックを更新します。

az eventgrid topic update [--identity {noidentity, systemassigned}]
                          [--ids]
                          [--inbound-ip-rules]
                          [--mi-system-assigned]
                          [--mi-user-assigned]
                          [--name]
                          [--public-network-access {disabled, enabled}]
                          [--resource-group]
                          [--sku {basic, premium}]
                          [--subscription]
                          [--tags]

例

既存のトピックのプロパティを、新しい SKU、ID、パブリック ネットワーク アクセス情報で更新します。

az eventgrid topic update -g rg1 --name topic1 --sku Premium --identity systemassigned --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT --sku basic

省略可能のパラメーター

--identity
プレビュー 非推奨

引数 'identity' は非推奨となり、今後のリリースで削除される予定です。

リソースのマネージド ID の種類。 今後非推奨となり、--mi-system-assigned-identity に置き換えられます。

指定可能な値: noidentity, systemassigned
--ids

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

--inbound-ip-rules

IP アドレスを CIDR 表記で指定する受信 IP 規則の一覧 (例: 10.0.0.0/8)、および IpMask の一致または一致に基づいて実行する対応するアクション。 使用可能な値には、許可が含まれます。

--mi-system-assigned

このパラメーターの存在は、SystemAssigned マネージド ID が使用されることを示します。

--mi-user-assigned
プレビュー

identityType がユーザーまたは混在している場合に、ユーザー割り当て ID を追加します。 この属性は、StorageQueue を除くすべての宛先の種類に対して有効です。 複数の --mi-user-assigned 引数を使用して、複数の属性を指定できます。

--name -n

トピックの名前。

--public-network-access

これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 構成することで、特定の IP にさらに制限できます。

指定可能な値: disabled, enabled
--resource-group -g

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

--sku
プレビュー

リソースの SKU 名。

指定可能な値: basic, premium
--subscription

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

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

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