Set-AzureNetworkSecurityGroupAssociation

Reference

Module:: Azure

Associates a network security group to a virtual machine, PaaS role, or network adapter.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Service Management APIs. See the Az PowerShell module for cmdlets to manage Azure Resource Manager resources.

Syntax

Set-AzureNetworkSecurityGroupAssociation
   -Name <String>
   [-Force]
   [-PassThru]
   -VirtualNetworkName <String>
   -SubnetName <String>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Set-AzureNetworkSecurityGroupAssociation
   -Name <String>
   [-Force]
   [-PassThru]
   -VM <PersistentVMRoleContext>
   -ServiceName <String>
   [-NetworkInterfaceName <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Set-AzureNetworkSecurityGroupAssociation
   -Name <String>
   [-Force]
   [-PassThru]
   [-Slot <String>]
   -RoleName <String>
   -ServiceName <String>
   [-NetworkInterfaceName <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Set-AzureNetworkSecurityGroupAssociation cmdlet associates a network security group to a virtual machine, platform as a service (PaaS) role, or network adapter.

Examples

Example 1: Assign a virtual machine to a network security group

PS C:\> Get-AzureVM -ServiceName "ContosoService" -Name "ContosoVM06" | Set-AzureNetworkSecurityGroupAssociation -Name "ContosoNetworkSecurityGroup"

This command gets a virtual machine named ContosoVM06 for the service named ContosoService, and passes that virtual machine object to the current cmdlet. The current cmdlet assigns the network security group named ContosoNetworkSecurityGroup to that virtual machine.

Parameters

-Force

Forces the command to run without asking for user confirmation.

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

-Name

Specifies the name of the network security group that this cmdlet sets.

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

-NetworkInterfaceName

Specifies the name of the network adapter to which this cmdlet applies the network security group.

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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

-RoleName

Specifies the name of a PaaS role to which this cmdlet applies the network security group.

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

-ServiceName

Specifies the name of a cloud service. The PaaS role belongs to the service that this parameter specifies.

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

-Slot

Specifies a PaaS slot. The PaaS role for which this cmdlet sets the network security group has the slot that this parameter specifies. Valid values are:

Production
Staging

The default value is Production.

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

-SubnetName

Specifies the name of a subnet to which this cmdlet associates the network security group.

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

-VirtualNetworkName

Specifies the name of a virtual network that contains the subnet to which this cmdlet associates the network security group.

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

-VM

Specifies the virtual machine to which this cmdlet applies the network security group.

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

Outputs

Boolean