Get-AzureNetworkSecurityGroupAssociation

Module:

Azure Module

Gets a network security group for a virtual machine, network adapter, or PaaS role.

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

GetNetworkSecurityGroupAssociationForSubnet

Get-AzureNetworkSecurityGroupAssociation
    -VirtualNetworkName <String>
    -SubnetName <String>
    [-Detailed]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

GetNetworkSecurityGroupAssociationForIaaSRole

Get-AzureNetworkSecurityGroupAssociation
    -VM <PersistentVMRoleContext>
    -ServiceName <String>
    [-NetworkInterfaceName <String>]
    [-Detailed]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

GetNetworkSecurityGroupAssociationForPaaSRole

Get-AzureNetworkSecurityGroupAssociation
    -RoleName <String>
    -ServiceName <String>
    [-Slot <String>]
    [-NetworkInterfaceName <String>]
    [-Detailed]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Get-AzureNetworkSecurityGroupAssociation cmdlet gets the network security group for a virtual machine, network adapter, or platform as a service (PaaS) role.

Examples

Example 1: Get the network security group for a virtual machine

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

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 gets the network security group associated to that virtual machine.

Parameters

-Detailed

Indicates that this cmdlet returns details of the network security group that is associated to the virtual machine. These details include location and rules.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-NetworkInterfaceName

Specifies the name of the network adapter for which this cmdlet gets the network security group.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetNetworkSecurityGroupAssociationForIaaSRole

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

GetNetworkSecurityGroupAssociationForPaaSRole

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	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.

Parameter properties

Type:	AzureSMProfile
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RoleName

Specifies the name of a PaaS role for which this cmdlet gets the network security group.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetNetworkSecurityGroupAssociationForPaaSRole

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ServiceName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetNetworkSecurityGroupAssociationForIaaSRole

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

GetNetworkSecurityGroupAssociationForPaaSRole

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Slot

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

• Production
• Staging

The default value is Production.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetNetworkSecurityGroupAssociationForPaaSRole

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubnetName

Specifies the name of a subnet for which this cmdlet gets the network security group.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetNetworkSecurityGroupAssociationForSubnet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VirtualNetworkName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetNetworkSecurityGroupAssociationForSubnet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VM

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

Parameter properties

Type:	PersistentVMRoleContext
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetNetworkSecurityGroupAssociationForIaaSRole

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Microsoft.WindowsAzure.Commands.ServiceManagement.Network.NetworkSecurityGroup.Model.INetworkSecurityGroup

Related Links

• Remove-AzureNetworkSecurityGroupAssociation
• Set-AzureNetworkSecurityGroupAssociation