az notification-hub

Note

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

このコマンド グループは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

通知ハブを管理します。

コマンド

名前	説明	型	Status
az notification-hub authorization-rule	通知ハブの承認規則を管理するコマンド。	拡張	Experimental
az notification-hub authorization-rule create	通知ハブの承認規則を作成します。	拡張	Experimental
az notification-hub authorization-rule delete	notificationHub 承認規則を削除します。	拡張	Experimental
az notification-hub authorization-rule list	通知ハブの承認規則を一覧表示します。	拡張	Experimental
az notification-hub authorization-rule list-keys	プライマリとセカンダリの接続文字列を通知ハブに一覧表示します。	拡張	Experimental
az notification-hub authorization-rule regenerate-keys	通知ハブ承認規則のプライマリ キーまたはセカンダリ キーを再生成します。	拡張	Experimental
az notification-hub authorization-rule show	通知ハブの承認規則を名前で表示します。	拡張	Experimental
az notification-hub check-availability	名前空間内の特定の通知ハブの可用性を確認します。	拡張	Experimental
az notification-hub create	名前空間に通知ハブを作成します。	拡張	Experimental
az notification-hub credential	通知ハブの資格情報を管理するコマンド。	拡張	Experimental
az notification-hub credential adm	通知ハブを管理します。	拡張	Experimental
az notification-hub credential adm update	Amazon(ADM) の資格情報を更新します。	拡張	Experimental
az notification-hub credential apns	通知ハブを管理します。	拡張	Experimental
az notification-hub credential apns update	Apple(APNS) の資格情報を更新します。	拡張	Experimental
az notification-hub credential baidu	通知ハブを管理します。	拡張	Experimental
az notification-hub credential baidu update	Baidu(Andrioid China) の資格情報を更新します。	拡張	Experimental
az notification-hub credential gcm	通知ハブを管理します。	拡張	Experimental
az notification-hub credential gcm update	Google GCM/FCM API キーを更新します。	拡張	Experimental
az notification-hub credential list	通知ハブに関連付けられている PNS 資格情報を一覧表示します。	拡張	Experimental
az notification-hub credential mpns	通知ハブを管理します。	拡張	Experimental
az notification-hub credential mpns update	Windows 電話(MPNS) の資格情報を更新します。	拡張	Experimental
az notification-hub credential wns	通知ハブを管理します。	拡張	Experimental
az notification-hub credential wns update	Windows (WNS) の資格情報を更新します。	拡張	Experimental
az notification-hub delete	名前空間に関連付けられている通知ハブを削除します。	拡張	Experimental
az notification-hub list	名前空間に関連付けられている通知ハブを一覧表示します。	拡張	Experimental
az notification-hub namespace	通知ハブの名前空間を管理するコマンド。	拡張	Experimental
az notification-hub namespace authorization-rule	通知ハブの名前空間承認規則を管理するコマンド。	拡張	Experimental
az notification-hub namespace authorization-rule create	名前空間の承認規則を作成します。	拡張	Experimental
az notification-hub namespace authorization-rule delete	名前空間の承認規則を削除します。	拡張	Experimental
az notification-hub namespace authorization-rule list	名前空間の承認規則を一覧表示します。	拡張	Experimental
az notification-hub namespace authorization-rule list-keys	名前空間へのプライマリとセカンダリの接続文字列を一覧表示します。	拡張	Experimental
az notification-hub namespace authorization-rule regenerate-keys	名前空間の承認規則に対してプライマリ/セカンダリ キーを再生成します。	拡張	Experimental
az notification-hub namespace authorization-rule show	名前空間の承認規則を名前で取得します。	拡張	Experimental
az notification-hub namespace check-availability	すべての Azure サブスクリプションで、指定されたサービス名前空間の可用性を確認します。 これは、サービス名前空間名に基づいて doメイン 名が作成されるため便利です。	拡張	Experimental
az notification-hub namespace create	サービス名前空間を作成します。 作成されると、この名前空間のリソース マニフェストは変更できません。 この操作はべき等です。	拡張	Experimental
az notification-hub namespace delete	既存の名前空間を削除します。 この操作により、名前空間に関連付けられているすべての notificationHub も削除されます。	拡張	Experimental
az notification-hub namespace list	使用可能な名前空間を一覧表示します。	拡張	Experimental
az notification-hub namespace show	指定した名前空間の説明を返します。	拡張	Experimental
az notification-hub namespace update	サービス名前空間を更新します。 名前空間のリソース マニフェストは不変であり、変更できません。	拡張	Experimental
az notification-hub namespace wait	条件が満たされるまで CLI を待機状態にします。	拡張	Experimental
az notification-hub show	通知ハブの情報を表示します。	拡張	Experimental
az notification-hub test-send	プッシュ通知の送信をテストします。	拡張	Experimental
az notification-hub update	名前空間内の通知ハブを更新します。	拡張	Experimental

az notification-hub check-availability

実験用

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

名前空間内の特定の通知ハブの可用性を確認します。

az notification-hub check-availability --name
                                       [--ids]
                                       [--namespace-name]
                                       [--resource-group]
                                       [--subscription]

例

指定された通知ハブ名の可用性を確認する

az notification-hub check-availability --resource-group MyResourceGroup --namespace-name "locp-newns" --name my-hub

必須のパラメーター

--name -n

リソース名。

省略可能のパラメーター

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

グローバル パラメーター

--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 notification-hub create

実験用

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

名前空間に通知ハブを作成します。

az notification-hub create --name
                           --namespace-name
                           --resource-group
                           [--location]
                           [--registration-ttl]
                           [--tags]

例

通知ハブを作成する

az notification-hub create --resource-group MyResourceGroup --namespace-name my-namespace --name my-hub --location "South Central US"

必須のパラメーター

--name -n

通知ハブ名。

--namespace-name

名前空間の名前。

--resource-group -g

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

省略可能のパラメーター

--location -l

リソースの場所 指定しない場合は、リソース グループの場所が使用されます。

--registration-ttl

作成された NotificationHub の RegistrationTtl。

--tags

リソース タグでは、短縮構文、json-file、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。

グローバル パラメーター

--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 notification-hub delete

実験用

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

名前空間に関連付けられている通知ハブを削除します。

az notification-hub delete [--ids]
                           [--name]
                           [--namespace-name]
                           [--resource-group]
                           [--subscription]
                           [--yes]

例

通知ハブを削除する

az notification-hub delete --resource-group MyResourceGroup --namespace-name my-namespace --name my-hub

省略可能のパラメーター

--ids

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

--name -n

通知ハブ名。

--namespace-name

名前空間の名前。

--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 notification-hub list

実験用

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

名前空間に関連付けられている通知ハブを一覧表示します。

az notification-hub list --namespace-name
                         --resource-group
                         [--max-items]
                         [--next-token]

例

通知ハブを一覧表示する

az notification-hub list --resource-group MyResourceGroup --namespace-name my-namespace

必須のパラメーター

--namespace-name

名前空間の名前。

--resource-group -g

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

省略可能のパラメーター

--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 notification-hub show

実験用

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

通知ハブの情報を表示します。

az notification-hub show [--ids]
                         [--name]
                         [--namespace-name]
                         [--resource-group]
                         [--subscription]

省略可能のパラメーター

--ids

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

--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 notification-hub test-send

実験用

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

プッシュ通知の送信をテストします。

az notification-hub test-send --namespace-name
                              --notification-format {apple, baidu, gcm, template, windows, windowsphone}
                              --notification-hub-name
                              --resource-group
                              [--message]
                              [--payload]
                              [--tag]
                              [--title]

例

メッセージ本文を使用した送信通知のテスト

az notification-hub test-send --resource-group MyResourceGroup --namespace-name \
my-namespace --notification-hub-name my-hub --notification-format gcm \
--message "test notification"

ファイルからの通知の送信をテストする

az notification-hub test-send --resource-group MyResourceGroup --namespace-name \
my-namespace --notification-hub-name my-hub --notification-format gcm \
--payload @path/to/file

json 文字列を使用して通知を送信するテスト

az notification-hub test-send --resource-group MyResourceGroup --namespace-name \
my-namespace --notification-hub-name my-hub --notification-format gcm \
--payload "{\"data\":{\"message\":\"test notification\"}}"

必須のパラメーター

--namespace-name

名前空間の名前。

--notification-format

通知メッセージの形式。

承認された値: apple, baidu, gcm, template, windows, windowsphone

--notification-hub-name

通知ハブ名。

--resource-group -g

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

省略可能のパラメーター

--message

送信するメッセージ本文。 None でない場合、ペイロードは無視されます。

--payload

JSON 形式のメッセージのペイロード。

--tag

このオプションを使用して、特定の登録セットにテスト通知を送信できます。 選択したプラットフォームで 10 件のランダム登録にプッシュ通知を送信する場合は、このフィールドを空のままにします。

--title

通知のタイトル。

グローバル パラメーター

--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 notification-hub update

実験用

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

名前空間内の通知ハブを更新します。

az notification-hub update [--add]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--location]
                           [--name]
                           [--namespace-name]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--subscription]
                           [--tags]

例

通知ハブを更新する

az notification-hub update --resource-group MyResourceGroup --namespace-name my-namespace --name "sdk-notificationHubs-8708"

省略可能のパラメーター

--add

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

--force-string

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

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

--ids

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

--location -l

リソースの場所。

--name --notification-hub-name -n

通知ハブ名。

--namespace-name

名前空間の名前。

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

--tags

リソース タグでは、短縮構文、json-file、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。

グローバル パラメーター

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