Update-AzSignalRNetworkAcl
Update the Network ACL of a SignalR service.
Syntax
Update-AzSignalRNetworkAcl
[-ResourceGroupName <String>]
[-Name] <String>
[-AsJob]
[-DefaultAction <String>]
[-PublicNetwork]
[-PrivateEndpointName <String[]>]
[-Allow <String[]>]
[-Deny <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzSignalRNetworkAcl
-ResourceId <String>
[-AsJob]
[-DefaultAction <String>]
[-PublicNetwork]
[-PrivateEndpointName <String[]>]
[-Allow <String[]>]
[-Deny <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzSignalRNetworkAcl
-InputObject <PSSignalRResource>
[-AsJob]
[-DefaultAction <String>]
[-PublicNetwork]
[-PrivateEndpointName <String[]>]
[-Allow <String[]>]
[-Deny <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update the Network ACL of a SignalR service, including the default action and the network Acls for public and private connection.
Examples
Example 1: Allow RESTAPI,ClientConnection for public network and set default action to Deny
$networkAcl = Update-AzSignalRNetworkAcl -Name pssignalr -ResourceGroupName test_resource_group -DefaultAction Deny -PublicNetwork -Allow RESTAPI,ClientConnection
$networkAcl
DefaultAction PublicNetwork PrivateEndpoints
------------- ------------- ----------------
Deny Microsoft.Azure.Commands.SignalR.Models.PSNetworkAcl {pssignalr.70197ffc-d138-49a5-a336-98b21a8d04d1}
$networkAcl.PublicNetwork
Allow Deny
----- ----
{ClientConnection, RESTAPI} {}
Example 2: Allow client connection and server connection for a private endpoint connection
$networkAcl = Update-AzSignalRNetworkAcl -Name pssignalr -ResourceGroupName test_resource_group -PrivateEndpointName pssignalr.70197ffc-d138-49a5-a336-98b21a8d04d1 -Allow ClientConnection,ServerConnection
$networkAcl.PrivateEndpoints[0]
Name Allow Deny
---- ----- ----
pssignalr.70197ffc-d138-49a5-a336-98b21a8d04d1 {ServerConnection, ClientConnection} {}
Example 3: Deny client connection for both public network and a private endpoint connection
$networkAcl = Update-AzSignalRNetworkAcl -Name pssignalr -ResourceGroupName test_resource_group -PrivateEndpointName pssignalr.70197ffc-d138-49a5-a336-98b21a8d04d1 -PublicNetwork -Deny ClientConnection
Parameters
-Allow
Allowed network ACLs
Type: | String[] |
Accepted values: | ClientConnection, ServerConnection, RESTAPI, Trace |
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 |
-DefaultAction
Default Action of SignalR network ACLs, either allow or deny. It decides whether deny network ACLs or allow network ACLs take effect. For example, if the default action is allow, then only the deny ACLs matters.
Type: | String |
Accepted values: | Allow, Deny |
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 |
-Deny
Denied network ACLs
Type: | String[] |
Accepted values: | ClientConnection, ServerConnection, RESTAPI, Trace |
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 |
-PrivateEndpointName
Name(s) of private endpoint(s) to be updated
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PublicNetwork
Update public network ACLs
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
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 |
-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
Outputs
Azure PowerShell