az webpubsub hub
Note
このリファレンスは、Azure CLI (バージョン 2.56.0 以降) の Webpubsub 拡張機能の一部です。 拡張機能は、az webpubsub hub コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
Webpubsub ハブの設定を管理するコマンド。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az webpubsub hub create |
サーバーレス モードで webPubSub サービスまたは Web PubSub のハブ設定を作成 Socket.IO。 |
Extension | GA |
az webpubsub hub delete |
WebPubSub サービスのハブ設定を削除します。 |
Extension | GA |
az webpubsub hub list |
WebPubSub サービスのすべてのハブ設定を一覧表示します。 |
Extension | GA |
az webpubsub hub show |
WebPubSub サービスのハブ設定を表示します。 |
Extension | GA |
az webpubsub hub update |
サーバーレス モードで WebPubSub サービスまたは Web PubSub のハブ設定を更新 Socket.IO。 |
Extension | GA |
az webpubsub hub create
サーバーレス モードで webPubSub サービスまたは Web PubSub のハブ設定を作成 Socket.IO。
az webpubsub hub create --hub-name
--name
--resource-group
[--allow-anonymous {false, true}]
[--event-handler]
[--websocket-keepalive]
例
2 つのイベント ハンドラー設定を使用してハブ設定を作成する
az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"
匿名接続が許可されたハブ設定を作成する
az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true
必須のパラメーター
管理するハブ。
Webpubsub の名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
このハブに対して匿名接続が許可される場合に設定します。 True は許可を意味し、False は拒否を意味します。
プロパティ | 値 |
---|---|
規定値: | False |
指定可能な値: | false, true |
イベント ハンドラー設定のテンプレート 項目。 key=value パターンを使用してプロパティを設定します。 サポートされているキーは、"url-template"、"user-event-pattern"、"system-event"、"auth-type"、"auth-resource" です。 複数の "システム イベント" を設定すると、配列が作成され、その他のプロパティでは、最後のセットのみがアクティブになります。
ハブ内のすべてのクライアントの WebSocket キープアライブ間隔 (秒単位)。 有効な範囲: 1 ~ 120。 既定値は 20 秒です。
プロパティ | 値 |
---|---|
規定値: | 20 |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az webpubsub hub delete
WebPubSub サービスのハブ設定を削除します。
az webpubsub hub delete [--hub-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ハブの名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
Webpubsub の名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az webpubsub hub list
WebPubSub サービスのすべてのハブ設定を一覧表示します。
az webpubsub hub list --name
--resource-group
必須のパラメーター
Webpubsub の名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az webpubsub hub show
WebPubSub サービスのハブ設定を表示します。
az webpubsub hub show [--hub-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ハブの名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
Webpubsub の名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az webpubsub hub update
サーバーレス モードで WebPubSub サービスまたは Web PubSub のハブ設定を更新 Socket.IO。
az webpubsub hub update --hub-name
[--add]
[--allow-anonymous {false, true}]
[--event-handler]
[--force-string]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--websocket-keepalive]
例
ハブのイベント ハンドラー設定を更新する
az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"
匿名接続を許可するように更新する
az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true
Web ソケットキープ アライブ間隔への更新 (既定値は 20 秒、最小値は 1、最大値は 120)
az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --websocket-keepalive 30
必須のパラメーター
管理するハブ。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
このハブに対して匿名接続が許可される場合に設定します。 True は許可を意味し、False は拒否を意味します。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
イベント ハンドラー設定のテンプレート 項目。 key=value パターンを使用してプロパティを設定します。 サポートされているキーは、"url-template"、"user-event-pattern"、"system-event"、"auth-type"、"auth-resource" です。 複数の "システム イベント" を設定すると、配列が作成され、その他のプロパティでは、最後のセットのみがアクティブになります。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | False |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
Webpubsub の名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
ハブ内のすべてのクライアントの WebSocket キープアライブ間隔 (秒単位)。 有効な範囲: 1 ~ 120。 既定値は 20 秒です。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |