az signalr

Azure SignalR Service を管理します。

コマンド

名前	説明	型	Status
az signalr cors	Azure SignalR Service の CORS を管理します。	コア	GA
az signalr cors add	許可された配信元を SignalR Service に追加します。	コア	GA
az signalr cors list	SignalR サービスの許可された配信元を一覧表示します。	コア	GA
az signalr cors remove	SignalR サービスから許可された配信元を削除します。	コア	GA
az signalr cors update	許可された配信元を SignalR Service に更新します。	コア	GA
az signalr create	SignalR サービスを作成します。	コア	GA
az signalr custom-certificate	カスタム証明書の設定を管理します。	コア	GA
az signalr custom-certificate create	SignalR Service のカスタム証明書を作成します。	コア	GA
az signalr custom-certificate delete	SignalR Service のカスタム証明書を削除します。	コア	GA
az signalr custom-certificate list	SignalR Service のカスタム証明書を一覧表示します。	コア	GA
az signalr custom-certificate show	SignalR Service のカスタム証明書の詳細を表示します。	コア	GA
az signalr custom-certificate update	SignalR Service のカスタム証明書を更新します。	コア	GA
az signalr custom-domain	カスタム doメイン 設定を管理します。	コア	GA
az signalr custom-domain create	SignalR Service のカスタム doメイン を作成します。	コア	GA
az signalr custom-domain delete	SignalR Service のカスタム doメイン を削除します。	コア	GA
az signalr custom-domain list	SignalR Service のカスタム doメイン を一覧表示します。	コア	GA
az signalr custom-domain show	SignalR Service のカスタム doメインの詳細を表示します。	コア	GA
az signalr custom-domain update	SignalR Service のカスタム doメイン を更新します。	コア	GA
az signalr delete	SignalR サービスを削除します。	コア	GA
az signalr identity	マネージド ID の設定を管理します。	コア	GA
az signalr identity assign	SignalR Service のマネージド ID を割り当てます。	コア	GA
az signalr identity remove	SignalR Service のマネージド ID を削除します。	コア	GA
az signalr identity show	SignalR Service のマネージド ID を表示します。	コア	GA
az signalr key	Azure SignalR Service のキーを管理します。	コア	GA
az signalr key list	SignalR Service のアクセス キーを一覧表示します。	コア	GA
az signalr key renew	SignalR Service のアクセス キーを再生成します。	コア	GA
az signalr list	現在のサブスクリプションのすべての SignalR Service を一覧表示します。	コア	GA
az signalr network-rule	ネットワーク規則を管理します。	コア	GA
az signalr network-rule list	SignalR Service のネットワーク アクセス制御を取得します。	コア	GA
az signalr network-rule update	SignalR Service のネットワーク アクセス制御を更新します。	コア	GA
az signalr replica	レプリカ設定を管理します。	コア	GA
az signalr replica create	SignalR Service のレプリカを作成します。	コア	GA
az signalr replica delete	SignalR Service のレプリカを削除します。	コア	GA
az signalr replica list	SignalR Service のレプリカを一覧表示します。	コア	GA
az signalr replica show	レプリカの詳細を表示します。	コア	GA
az signalr restart	既存の SignalR サービスを再起動します。	コア	GA
az signalr show	SignalR サービスの詳細を取得します。	コア	GA
az signalr update	既存の SignalR サービスを更新します。	コア	GA
az signalr upstream	アップストリーム設定を管理します。	コア	GA
az signalr upstream clear	既存の SignalR Service のアップストリーム設定をクリアします。	コア	GA
az signalr upstream list	既存の SignalR Service のアップストリーム設定を一覧表示します。	コア	GA
az signalr upstream update	既存の SignalR Service の順序に依存するアップストリーム設定を更新します。	コア	GA

az signalr create

SignalR サービスを作成します。

az signalr create --name
                  --resource-group
                  --sku
                  [--allowed-origins]
                  [--default-action {Allow, Deny}]
                  [--enable-message-logs {false, true}]
                  [--location]
                  [--service-mode {Classic, Default, Serverless}]
                  [--tags]
                  [--unit-count]

例

プレミアム SKU と既定のモードを使用して SignalR Service を作成する

az signalr create -n MySignalR -g MyResourceGroup --sku Premium_P1

プレミアム SKU とサーバーレス モードで SignalR Service を作成し、メッセージング ログを有効にします。

az signalr create -n MySignalR -g MyResourceGroup --sku Premium_P1 --unit-count 1 --service-mode Serverless --enable-message-logs True

必須のパラメーター

--name -n

Signalr サービスの名前。

--resource-group -g

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

--sku

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

省略可能のパラメーター

--allowed-origins -a

クロスオリジン呼び出しを許可する必要があるスペース区切りオリジン (例: http://example.com:12345)。 すべてを許可するには、"*" を使用します。

--default-action

ルールが一致しない場合に適用される既定のアクション。

承認された値: Allow, Deny

既定値: Allow

--enable-message-logs

Signalr Service が生成するメッセージ ログのスイッチ。

承認された値: false, true

既定値: False

--location -l

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

--service-mode

Signalr サービスが動作するサービス モード。

承認された値: Classic, Default, Serverless

既定値: Default

--tags

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

--unit-count

Signalr サービス ユニット数。

既定値: 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 signalr delete

SignalR サービスを削除します。

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

例

SignalR サービスを削除します。

az signalr delete -n MySignalR -g MyResourceGroup

省略可能のパラメーター

--ids

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

--name -n

Signalr サービスの名前。

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

現在のサブスクリプションのすべての SignalR Service を一覧表示します。

az signalr list [--resource-group]

例

SignalR Service を一覧表示し、結果をテーブルに表示します。

az signalr list -o table

リソース グループ内の SignalR Service を一覧表示し、結果をテーブルに表示します。

az signalr list -g MySignalR -o table

省略可能のパラメーター

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

既存の SignalR サービスを再起動します。

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

例

SignalR Service インスタンスを再起動します。

az signalr restart -n MySignalR -g MyResourceGroup

省略可能のパラメーター

--ids

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

--name -n

Signalr サービスの名前。

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

SignalR サービスの詳細を取得します。

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

例

SignalR Service の SKU を取得します。

az signalr show -n MySignalR -g MyResourceGroup --query sku

省略可能のパラメーター

--ids

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

--name -n

Signalr サービスの名前。

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

既存の SignalR サービスを更新します。

az signalr update [--add]
                  [--allowed-origins]
                  [--default-action {Allow, Deny}]
                  [--enable-message-logs {false, true}]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--remove]
                  [--resource-group]
                  [--service-mode {Classic, Default, Serverless}]
                  [--set]
                  [--sku]
                  [--subscription]
                  [--tags]
                  [--unit-count]

例

ユニット数を更新してサービスをスケーリングします。

az signalr update -n MySignalR -g MyResourceGroup --sku Standard_S1 --unit-count 50

サービス モードを更新します。

az signalr update -n MySignalR -g MyResourceGroup --service-mode Serverless

サービスでメッセージング ログを有効にするための更新。

az signalr update -n MySignalR -g MyResourceGroup --enable-message-logs True

省略可能のパラメーター

--add

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

既定値: []

--allowed-origins -a

クロスオリジン呼び出しを許可する必要があるスペース区切りオリジン (例: http://example.com:12345)。 すべてを許可するには、"*" を使用します。

--default-action

ルールが一致しない場合に適用される既定のアクション。

承認された値: Allow, Deny

--enable-message-logs

Signalr Service が生成するメッセージ ログのスイッチ。

承認された値: false, true

--force-string

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

既定値: False

--ids

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

--name -n

Signalr サービスの名前。

--remove

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

既定値: []

--resource-group -g

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

--service-mode

Signalr サービスが動作するサービス モード。

承認された値: Classic, Default, Serverless

--set

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

既定値: []

--sku

Signalr サービスの SKU 名。 例: Standard_S1。

--subscription

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

--tags

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

--unit-count

Signalr サービス ユニット数。

既定値: 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 を使います。