az webpubsub

リファレンス

Note

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

Webpubsub を管理するコマンド。

コマンド

名前	説明	型	Status
az webpubsub client	クライアント接続を管理するコマンド。	拡張子	GA
az webpubsub client start	対話型クライアント接続を開始します。	拡張子	GA
az webpubsub create	Webpubsub を作成します。	拡張子	GA
az webpubsub delete	Webpubsub を削除します。	拡張子	GA
az webpubsub hub	Webpubsub ハブの設定を管理するコマンド。	拡張子	GA
az webpubsub hub create	WebPubSub サービスのハブ設定を作成します。	拡張子	GA
az webpubsub hub delete	WebPubSub サービスのハブ設定を削除します。	拡張子	GA
az webpubsub hub list	WebPubSub サービスのすべてのハブ設定を一覧表示します。	拡張子	GA
az webpubsub hub show	WebPubSub サービスのハブ設定を表示します。	拡張子	GA
az webpubsub hub update	WebPubSub サービスのハブ設定を更新します。	拡張子	GA
az webpubsub key	Webpubsub キーを管理するコマンド。	拡張子	GA
az webpubsub key regenerate	WebPubSub サービスのキーを再生成します。	拡張子	GA
az webpubsub key show	WebPubSub サービスの接続文字列とキーを表示します。	拡張子	GA
az webpubsub list	Webpubsub を一覧表示します。	拡張子	GA
az webpubsub list-skus	リソースの使用可能なすべての SKU を一覧表示します。	拡張子	GA
az webpubsub list-usage	リソース使用量クォータを場所別に一覧表示します。	拡張子	GA
az webpubsub network-rule	Webpubsub ネットワークルールを管理するコマンド。	拡張子	GA
az webpubsub network-rule show	WebPubSub サービスのネットワークアクセス制御を取得します。	拡張子	GA
az webpubsub network-rule update	WebPubSub サービスのネットワークアクセス制御を更新します。	拡張子	GA
az webpubsub replica	レプリカ設定を管理します。	拡張子	GA
az webpubsub replica create	Webpubsub サービスのレプリカを作成します。	拡張子	GA
az webpubsub replica delete	WebPubSub サービスのレプリカを削除します。	拡張子	GA
az webpubsub replica list	Webpubsub サービスのレプリカを一覧表示します。	拡張子	GA
az webpubsub replica show	レプリカの詳細を表示します。	拡張子	GA
az webpubsub restart	Webpubsub を再起動します。	拡張子	GA
az webpubsub service	Webpubsub サービスを管理するコマンド。	拡張子	GA
az webpubsub service broadcast	メッセージをハブにブロードキャストします。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub service connection	Webpubsub サービス接続を管理するコマンド。	拡張子	GA
az webpubsub service connection close	特定のクライアント接続を閉じます。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub service connection exist	クライアント接続が存在するかどうかを確認します。	拡張子	GA
az webpubsub service connection send	接続にメッセージを送信します。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub service group	Webpubsub サービスグループを管理するコマンド。	拡張子	GA
az webpubsub service group add-connection	グループへの接続を追加します。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub service group add-user	グループにユーザーを追加します。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub service group remove-connection	グループから接続を削除します。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub service group remove-user	グループからユーザーを削除します。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub service group send	グループにメッセージを送信します。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub service permission	Webpubsub サービスのアクセス許可を管理するコマンド。	拡張子	GA
az webpubsub service permission check	指定したグループへのアクセス許可が接続に付与されているかどうかを確認します。	拡張子	GA
az webpubsub service permission grant	接続に対するアクセス許可をグループに付与します。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub service permission revoke	接続からグループ権限を取り消します。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub service user	Webpubsub サービスユーザーを管理するコマンド。	拡張子	GA
az webpubsub service user exist	特定のユーザーに接続されているクライアント接続があるかどうかを確認します。	拡張子	GA
az webpubsub service user send	ユーザーにメッセージを送信します。操作が失敗すると、エラーがスローされます。	拡張子	GA
az webpubsub show	Webpubsub の詳細を表示します。	拡張子	GA
az webpubsub update	Webpubsub を更新します。	拡張子	GA

az webpubsub create

Webpubsub を作成します。

az webpubsub create --name
                    --resource-group
                    --sku
                    [--kind]
                    [--location]
                    [--tags]
                    [--unit-count]

例

Standard SKU とユニット 2 を使用して WebPubSub サービスを作成します。

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 2

プレミアム SKU とユニット 1 を使用して、Socket.IO 用の Web PubSub を作成します。

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Premium_P1 --unit-count 1 --kind SocketIO

必須のパラメーター

--name -n

Webpubsub の名前。

--resource-group -g

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

--sku

webpubsub サービスの SKU 名。使用できる値: Free_F1、Standard_S1、プレミアム_P1。

省略可能のパラメーター

--kind

Webpubsub サービスの種類。使用できる値: WebPubSub、SocketIO。

--location -l

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

--tags

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

--unit-count

Webpubsub サービスユニット数。

既定値: 1

グローバルパラメーター

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

Webpubsub を削除します。

az webpubsub delete [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

省略可能のパラメーター

--ids

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

--name -n

Webpubsub の名前。

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

Webpubsub を一覧表示します。

az webpubsub list [--resource-group]

省略可能のパラメーター

--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 webpubsub list-skus

リソースの使用可能なすべての SKU を一覧表示します。

az webpubsub list-skus [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

省略可能のパラメーター

--ids

--name -n

Webpubsub の名前。

--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 webpubsub list-usage

リソース使用量クォータを場所別に一覧表示します。

az webpubsub list-usage --location

必須のパラメーター

--location -l

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

グローバルパラメーター

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

Webpubsub を再起動します。

az webpubsub restart [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

省略可能のパラメーター

--ids

--name -n

Webpubsub の名前。

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

Webpubsub の詳細を表示します。

az webpubsub show [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

省略可能のパラメーター

--ids

--name -n

Webpubsub の名前。

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

Webpubsub を更新します。

az webpubsub update [--add]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--remove]
                    [--resource-group]
                    [--set]
                    [--sku]
                    [--subscription]
                    [--tags]
                    [--unit-count]

例

WebPubSub サービスをユニット 10 に更新します。

az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10

省略可能のパラメーター

--add

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

既定値: []

--force-string

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

既定値: False

--ids

--name -n

Webpubsub の名前。

--remove

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

既定値: []

--resource-group -g

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

--set

設定するプロパティパスと値を指定して、オブジェクトを更新します。例: --set property1.property2=<value>。

既定値: []

--sku

webpubsub サービスの SKU 名。使用できる値: Free_F1、Standard_S1、プレミアム_P1。

--subscription

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

--tags

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

--unit-count

Webpubsub サービスユニット数。

グローバルパラメーター

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

コマンド

az webpubsub create

例

必須のパラメーター

省略可能のパラメーター

az webpubsub delete

省略可能のパラメーター

az webpubsub list

省略可能のパラメーター

az webpubsub list-skus

省略可能のパラメーター

az webpubsub list-usage

必須のパラメーター

az webpubsub restart

省略可能のパラメーター

az webpubsub show

省略可能のパラメーター

az webpubsub update

例

省略可能のパラメーター

その他のリソース