次の方法で共有

az providerhub notification-registration

  • リファレンス

Note

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

providerhub で通知登録を管理します。

コマンド

名前 説明 型 状態
az providerhub notification-registration create

通知登録を作成します。

 拡張子 GA
az providerhub notification-registration delete

通知登録を削除します。

 拡張子 GA
az providerhub notification-registration list

指定されたプロバイダーの通知登録の一覧を一覧表示します。

 拡張子 GA
az providerhub notification-registration show

通知登録の詳細を取得します。

 拡張子 GA
az providerhub notification-registration update

通知登録を更新します。

 拡張子 GA

az providerhub notification-registration create

通知登録を作成します。

az providerhub notification-registration create --name
                                                --provider-namespace
                                                [--included-events]
                                                [--message-scope {NotSpecified, RegisteredSubscriptions}]
                                                [--notification-endpoints]
                                                [--notification-mode {EventHub, NotSpecified, WebHook}]

例

notification-registration create

az providerhub notification-registration create --name "{notificationRegistration}" --included-events "*/write" "Microsoft.Contoso/employees/delete" --message-scope "RegisteredSubscriptions" --notification-endpoints [{notification-destination:/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications,locations:[EastUS]}] --notification-mode "EventHub" --provider-namespace "{providerNamespace}"

必須のパラメーター

--name --notification-registration-name -n

通知の登録。

--provider-namespace

ProviderHub 内でホストされているリソース プロバイダーの名前。

省略可能のパラメーター

--included-events

RP にメッセージを送信するイベントを次に示します。 メッセージ形式は{RP 名前空間}/{ResourceType}/{action}の形式です。 使用可能なアクションは、書き込み、削除、移動/アクションです。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--message-scope

RP に送信されるメッセージを制限します。 既定値は RegisteredSubscriptions です。 使用可能な値は、グローバル (Azure のすべてのメッセージ) と RegisteredSubscriptions (RP によって登録されたサブスクリプション内のメッセージのみ) です。

指定可能な値: NotSpecified, RegisteredSubscriptions
--notification-endpoints

これらは、通知メッセージの場所です。 通知は、イベント リソースの場所のリージョンに送信されます (たとえば、米国東部の VM は、米国東部の指定されたエンドポイントにメッセージを送信します)。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--notification-mode

通知を RP に送信する方法を決定します。 使用可能な 2 つのモードは、EventHub と Webhook です。

指定可能な値: EventHub, NotSpecified, WebHook
グローバル パラメーター
--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 providerhub notification-registration delete

通知登録を削除します。

az providerhub notification-registration delete [--ids]
                                                [--name]
                                                [--provider-namespace]
                                                [--subscription]
                                                [--yes]

例

notification-registration delete

az providerhub notification-registration delete -y --name "{notificationRegistration}" --provider-namespace "{providerNamespace}"

省略可能のパラメーター

--ids

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

--name --notification-registration-name -n

通知の登録。

--provider-namespace

ProviderHub 内でホストされているリソース プロバイダーの名前。

--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 providerhub notification-registration list

指定されたプロバイダーの通知登録の一覧を一覧表示します。

az providerhub notification-registration list --provider-namespace
                                              [--max-items]
                                              [--next-token]

例

notification-registration list

az providerhub notification-registration list --provider-namespace "{providerNamespace}"

必須のパラメーター

--provider-namespace

ProviderHub 内でホストされているリソース プロバイダーの名前。

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

--next-token

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

グローバル パラメーター
--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 providerhub notification-registration show

通知登録の詳細を取得します。

az providerhub notification-registration show [--ids]
                                              [--name]
                                              [--provider-namespace]
                                              [--subscription]

例

notification-registration show

az providerhub notification-registration show --name "{notificationRegistration}" --provider-namespace "{providerNamespace}"

省略可能のパラメーター

--ids

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

--name --notification-registration-name -n

通知の登録。

--provider-namespace

ProviderHub 内でホストされているリソース プロバイダーの名前。

--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 providerhub notification-registration update

通知登録を更新します。

az providerhub notification-registration update [--add]
                                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--ids]
                                                [--included-events]
                                                [--message-scope {NotSpecified, RegisteredSubscriptions}]
                                                [--name]
                                                [--notification-endpoints]
                                                [--notification-mode {EventHub, NotSpecified, WebHook}]
                                                [--provider-namespace]
                                                [--remove]
                                                [--set]
                                                [--subscription]

例

notification-registration update

az providerhub notification-registration update --name "{notificationRegistration}" --included-events "*/write" "Microsoft.Contoso/employees/delete" --message-scope "RegisteredSubscriptions" --notification-endpoints [{notification-destination:/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications,locations:[EastUS]}] --notification-mode "EventHub" --provider-namespace "{providerNamespace}"

省略可能のパラメーター

--add

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

--force-string

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

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

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

--included-events

RP にメッセージを送信するイベントを次に示します。 メッセージ形式は{RP 名前空間}/{ResourceType}/{action}の形式です。 使用可能なアクションは、書き込み、削除、移動/アクションです。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--message-scope

RP に送信されるメッセージを制限します。 既定値は RegisteredSubscriptions です。 使用可能な値は、グローバル (Azure のすべてのメッセージ) と RegisteredSubscriptions (RP によって登録されたサブスクリプション内のメッセージのみ) です。

指定可能な値: NotSpecified, RegisteredSubscriptions
--name --notification-registration-name -n

通知の登録。

--notification-endpoints

これらは、通知メッセージの場所です。 通知は、イベント リソースの場所のリージョンに送信されます (たとえば、米国東部の VM は、米国東部の指定されたエンドポイントにメッセージを送信します)。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--notification-mode

通知を RP に送信する方法を決定します。 使用可能な 2 つのモードは、EventHub と Webhook です。

指定可能な値: EventHub, NotSpecified, WebHook
--provider-namespace

ProviderHub 内でホストされているリソース プロバイダーの名前。

--remove

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

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