Update-AzSignalR

モジュール:

Az.SignalR Module

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

構文

ResourceGroupParameterSet (既定)

Update-AzSignalR
    [-Name] <String>
    [-ResourceGroupName <String>]
    [-Sku <String>]
    [-UnitCount <Int32>]
    [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
    [-ServiceMode <String>]
    [-AllowedOrigin <String[]>]
    [-EnableSystemAssignedIdentity <Boolean>]
    [-UserAssignedIdentity <String[]>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceIdParameterSet

Update-AzSignalR
    -ResourceId <String>
    [-Sku <String>]
    [-UnitCount <Int32>]
    [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
    [-ServiceMode <String>]
    [-AllowedOrigin <String[]>]
    [-EnableSystemAssignedIdentity <Boolean>]
    [-UserAssignedIdentity <String[]>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectParameterSet

Update-AzSignalR
    -InputObject <PSSignalRResource>
    [-Sku <String>]
    [-UnitCount <Int32>]
    [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
    [-ServiceMode <String>]
    [-AllowedOrigin <String[]>]
    [-EnableSystemAssignedIdentity <Boolean>]
    [-UserAssignedIdentity <String[]>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

SignalR サービスを更新します。 パラメーターが指定されていない場合は、次の値が使用されます。

• ResourceGroupName: Set-AzDefault -ResourceGroupNameによって設定された既定のリソース グループ。
• Sku: Standard_S1

例

例 1: 特定の SignalR サービスを更新します。

Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -UnitCount 5

HostName                                 Location       ExternalIp      Sku         UnitCount ProvisioningState Version
--------                                 --------       ----------      ---         --------- ----------------- -------
mysignalr1.service.signalr.net           eastus         52.179.3.5      Standard_S1 5         Succeeded         1.0

例 2: ServiceMode と AllowedOrigin を指定する

Update-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr2 -ServiceMode Serverless -AllowedOrigin http://example1.com:12345, https://example2.cn

HostName                                 Location       ExternalIp      Sku         UnitCount ProvisioningState Version
--------                                 --------       ----------      ---         --------- ----------------- -------
mysignalr1.service.signalr.net           eastus         52.179.3.5      Standard_S1 1         Succeeded         1.0

例 3: システム割り当てマネージド ID を有効にする

Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -EnableSystemAssignedIdentity $true

HostName                                 Location       ExternalIp      Sku         UnitCount ProvisioningState Version
--------                                 --------       ----------      ---         --------- ----------------- -------
mysignalr1.service.signalr.net           eastus         52.179.3.5      Standard_S1 1         Succeeded         1.0

このコマンドにより、SignalR サービスのシステム割り当てマネージド ID が有効になります。 この ID を使用して、SignalR サービスの代わりに他のAzure リソースにアクセスできます。

例 4: システム割り当てマネージド ID を無効にする

Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -EnableSystemAssignedIdentity $false

HostName                                 Location       ExternalIp      Sku         UnitCount ProvisioningState Version
--------                                 --------       ----------      ---         --------- ----------------- -------
mysignalr1.service.signalr.net           eastus         52.179.3.5      Standard_S1 1         Succeeded         1.0

このコマンドは、SignalR サービスのシステム割り当てマネージド ID を無効にします。

例 5: システム割り当て ID からユーザー割り当て ID に切り替える

# First create a user-assigned managed identity
$userIdentity = New-AzUserAssignedIdentity -ResourceGroupName myResourceGroup -Name myUserIdentity -Location eastus

# Switch from system-assigned to user-assigned identity
Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -EnableSystemAssignedIdentity $false -UserAssignedIdentity $userIdentity.Id

HostName                                 Location       ExternalIp      Sku         UnitCount ProvisioningState Version
--------                                 --------       ----------      ---         --------- ----------------- -------
mysignalr1.service.signalr.net           eastus         52.179.3.5      Standard_S1 1         Succeeded         1.0

このコマンドは、システム割り当て ID を無効にし、SignalR サービスのユーザー割り当て ID を有効にします。 SignalR では、システム割り当て ID とユーザー割り当て ID の両方が同時にサポートされないことに注意してください。

例 6: ユーザー割り当て ID を更新する

# Create multiple user-assigned managed identities
$identity1 = New-AzUserAssignedIdentity -ResourceGroupName myResourceGroup -Name myUserIdentity1 -Location eastus
$identity2 = New-AzUserAssignedIdentity -ResourceGroupName myResourceGroup -Name myUserIdentity2 -Location eastus

# Update SignalR service with new user-assigned identities
Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -UserAssignedIdentity $identity1.Id, $identity2.Id

HostName                                 Location       ExternalIp      Sku         UnitCount ProvisioningState Version
--------                                 --------       ----------      ---         --------- ----------------- -------
mysignalr1.service.signalr.net           eastus         52.179.3.5      Standard_S1 1         Succeeded         1.0

このコマンドは、新しいユーザー割り当てマネージド ID を使用するように SignalR サービスを更新します。 既存のユーザー割り当て ID は、指定した ID に置き換えられます。

例 7: ユーザー割り当て ID をすべて削除する

Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -UserAssignedIdentity @()

HostName                                 Location       ExternalIp      Sku         UnitCount ProvisioningState Version
--------                                 --------       ----------      ---         --------- ----------------- -------
mysignalr1.service.signalr.net           eastus         52.179.3.5      Standard_S1 1         Succeeded         1.0

このコマンドは、空の配列を指定して、SignalR サービスからすべてのユーザー割り当てマネージド ID を削除します。

例 8: マネージド ID を完全に無効にする

Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -EnableSystemAssignedIdentity $false -UserAssignedIdentity @()

HostName                                 Location       ExternalIp      Sku         UnitCount ProvisioningState Version
--------                                 --------       ----------      ---         --------- ----------------- -------
mysignalr1.service.signalr.net           eastus         52.179.3.5      Standard_S1 1         Succeeded         1.0

このコマンドは、システム割り当て ID を無効にし、すべてのユーザー割り当て ID を削除することで、SignalR サービスのマネージド ID を完全に無効にします。

パラメーター

-AllowedOrigin

SignalR サービスで許可される配信元。 すべてを許可するには、"*" を使用し、リストから他のすべてのオリジンを削除します。 スラッシュはドメインの一部として、または TLD の後には使用できません

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-AsJob

バックグラウンド ジョブでコマンドレットを実行します。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	Cf

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-DefaultProfile

Azureとの通信に使用される資格情報、アカウント、テナント、サブスクリプション。

パラメーターのプロパティ

型:	IAzureContextContainer
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	AzContext, AzureRmContext, AzureCredential

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-EnableSystemAssignedIdentity

システム割り当て ID を有効または無効にします。 システム割り当て ID を有効にする$trueは、$false無効にします。 指定しない場合、システム割り当て ID に変更は行われません。

パラメーターのプロパティ

型:	Nullable<T>[Boolean]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-InputObject

SignalR リソース オブジェクト。

パラメーターのプロパティ

型:	PSSignalRResource
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

InputObjectParameterSet

配置:	Named
必須:	True
パイプラインからの値:	True
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Name

SignalR サービス名。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

ResourceGroupParameterSet

配置:	0
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-ResourceGroupName

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

ResourceGroupParameterSet

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-ResourceId

SignalR サービスリソース ID。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

ResourceIdParameterSet

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-ServiceMode

SignalR サービスのサービス モード。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Sku

SignalR サービス SKU。 既定値は "Standard_S1" です。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Tag

SignalR サービスのタグ。

パラメーターのプロパティ

型:	IDictionary<TKey,TValue>[System.String,System.String]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-UnitCount

SignalR サービス ユニットの数。{1、2、5、10、20、50、100} からの値のみ。 既定値は 1 です。

パラメーターのプロパティ

型:	Nullable<T>[Int32]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-UserAssignedIdentity

ユーザー割り当て ID を設定します。 すべてのユーザー割り当て ID を削除するには、空の配列 @() を指定します。 指定しない場合、ユーザー割り当て ID は変更されません。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	wi

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。

入力

String

PSSignalRResource

出力

PSSignalRResource