次の方法で共有


az webpubsub hub

Note

This reference is part of the webpubsub extension for the Azure CLI (version 2.56.0 or higher). 拡張機能は、az webpubsub hub コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

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

必須のパラメーター

--hub-name

管理するハブ。

--name -n

Webpubsub の名前。

--resource-group -g

リソース グループの名前。 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.

--allow-anonymous

このハブに対して匿名接続が許可される場合に設定します。 True は許可を意味し、False は拒否を意味します。

プロパティ
規定値: False
指定可能な値: false, true
--event-handler

イベント ハンドラー設定のテンプレート 項目。 key=value パターンを使用してプロパティを設定します。 サポートされているキーは、"url-template"、"user-event-pattern"、"system-event"、"auth-type"、"auth-resource" です。 複数の "システム イベント" を設定すると、配列が作成され、その他のプロパティでは、最後のセットのみがアクティブになります。

--websocket-keepalive

ハブ内のすべてのクライアントの WebSocket キープアライブ間隔 (秒単位)。 有効な範囲: 1 ~ 120。 既定値は 20 秒です。

プロパティ
規定値: 20
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --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.

--hub-name

ハブの名前。

プロパティ
Parameter group: Resource Id Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--name -n

Webpubsub の名前。

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az webpubsub hub list

WebPubSub サービスのすべてのハブ設定を一覧表示します。

az webpubsub hub list --name
                      --resource-group

必須のパラメーター

--name -n

Webpubsub の名前。

--resource-group -g

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

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --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.

--hub-name

ハブの名前。

プロパティ
Parameter group: Resource Id Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--name -n

Webpubsub の名前。

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --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

必須のパラメーター

--hub-name

管理するハブ。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

プロパティ
Parameter group: Generic Update Arguments
規定値: []
--allow-anonymous

このハブに対して匿名接続が許可される場合に設定します。 True は許可を意味し、False は拒否を意味します。

プロパティ
指定可能な値: false, true
--event-handler

イベント ハンドラー設定のテンプレート 項目。 key=value パターンを使用してプロパティを設定します。 サポートされているキーは、"url-template"、"user-event-pattern"、"system-event"、"auth-type"、"auth-resource" です。 複数の "システム イベント" を設定すると、配列が作成され、その他のプロパティでは、最後のセットのみがアクティブになります。

--force-string

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

プロパティ
Parameter group: Generic Update Arguments
規定値: False
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--name -n

Webpubsub の名前。

プロパティ
Parameter group: Resource Id Arguments
--remove

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

プロパティ
Parameter group: Generic Update Arguments
規定値: []
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--set

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

プロパティ
Parameter group: Generic Update Arguments
規定値: []
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--websocket-keepalive

ハブ内のすべてのクライアントの WebSocket キープアライブ間隔 (秒単位)。 有効な範囲: 1 ~ 120。 既定値は 20 秒です。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False