Update-AzSignalR

Reference

Module:: Az.SignalR

Update a SignalR service.

Syntax

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

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

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

Description

Update a SignalR service. The following values will be used for the parameters if not specified:

ResourceGroupName: the default resource group set by Set-AzDefault -ResourceGroupName.
Sku: Standard_S1

Examples

Example 1: Update a specific SignalR service.

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

Example 2: Specify ServiceMode and 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

Parameters

-AllowedOrigin

The allowed origins for the SignalR service. To allow all, use "*" and remove all other origins from the list. Slashes are not allowed as part of domain or after TLD

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

Run the cmdlet in background job.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

The SignalR resource object.

Type:	PSSignalRResource
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The SignalR service name.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The resource group name. The default one will be used if not specified.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

The SignalR service resource ID.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ServiceMode

The service mode for the SignalR service.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Sku

The SignalR service SKU. Default to "Standard_S1".

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

The tags for the SignalR service.

Type:	IDictionary<TKey,TValue>[System.String,System.String]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UnitCount

The SignalR service unit count, value only from {1, 2, 5, 10, 20, 50, 100}. Default to 1.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

PSSignalRResource

Outputs