Set-AzureNetworkSecurityRule

  • Reference
Module:
Azure

Adds or modifies a network security rule in a network security group.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Set-AzureNetworkSecurityRule
   -Name <String>
   -Type <String>
   -Priority <Int32>
   -Action <String>
   -SourceAddressPrefix <String>
   -SourcePortRange <String>
   -DestinationAddressPrefix <String>
   -DestinationPortRange <String>
   -Protocol <String>
   -NetworkSecurityGroup <INetworkSecurityGroup>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Set-AzureNetworkSecurityRule cmdlet adds or modifies an Azure network security rule in a network security group.

Parameters

-Action

Specifies the action for a network security rule. Valid values are: Allow and Deny.

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

-DestinationAddressPrefix

Specifies the Classless Interdomain Routing (CIDR) address of the destination IP range for the network security rule. An asterisk (*) specifies any IP address.

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

-DestinationPortRange

Specifies a destination port range for the network security rule. Valid values consist of integers from 0 to 65535. You can specify an individual value, or specify a range in the format LowerNumber-HigherNumber. A hyphen separates the two values.

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

-Name

Specifies the name for the network security rule that this cmdlet adds or modifies.

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

-NetworkSecurityGroup

Specifies the network security group that this cmdlet modifies. To obtain an INetworkSecurityGroup object, use the Get-AzureNetworkSecurityGroup cmdlet.

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

-Priority

Specifies the priority for the network security rule. Valid values are: integers from 100 to 4096.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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

-Protocol

Specifies the protocol for the network security rule. Valid values are:

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

-SourceAddressPrefix

Specifies the CIDR address of the source IP range for the network security rule. An asterisk (*) specifies any IP address.

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

-SourcePortRange

Specifies a source port range for the network security rule. Valid values consist of integers from 0 to 65535. You can specify an individual value, or specify a range in the format LowerNumber-HigherNumber. A hyphen separates the two values.

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

-Type

Specifies the type of connection for the network security rule. Valid values are: Inbound and Outbound.

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