Get-AzNetworkSecurityGroup
Gets a network security group.
Syntax
Get-AzNetworkSecurityGroup
[-Name <String>]
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzNetworkSecurityGroup
-Name <String>
-ResourceGroupName <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzNetworkSecurityGroup cmdlet gets an Azure network security group.
Examples
Example 1: Retrieve an existing network security group
Get-AzNetworkSecurityGroup -Name nsg1 -ResourceGroupName "rg1"
Name : nsg1
ResourceGroupName : rg1
Location : eastus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provider
s/Microsoft.Network/networkSecurityGroups/nsg1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
FlushConnection : False
SecurityRules : []
DefaultSecurityRules : [
{
"Name": "AllowVnetInBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound",
"Description": "Allow inbound traffic from all VMs in VNET",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"VirtualNetwork"
],
"DestinationAddressPrefix": [
"VirtualNetwork"
],
"Access": "Allow",
"Priority": 65000,
"Direction": "Inbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
},
{
"Name": "AllowAzureLoadBalancerInBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBou
nd",
"Description": "Allow inbound traffic from azure load balancer",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"AzureLoadBalancer"
],
"DestinationAddressPrefix": [
"*"
],
"Access": "Allow",
"Priority": 65001,
"Direction": "Inbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
},
{
"Name": "DenyAllInBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound",
"Description": "Deny all inbound traffic",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"*"
],
"DestinationAddressPrefix": [
"*"
],
"Access": "Deny",
"Priority": 65500,
"Direction": "Inbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
},
{
"Name": "AllowVnetOutBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound",
"Description": "Allow outbound traffic from all VMs to all VMs in VNET",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"VirtualNetwork"
],
"DestinationAddressPrefix": [
"VirtualNetwork"
],
"Access": "Allow",
"Priority": 65000,
"Direction": "Outbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
},
{
"Name": "AllowInternetOutBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound",
"Description": "Allow outbound traffic from all VMs to Internet",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"*"
],
"DestinationAddressPrefix": [
"Internet"
],
"Access": "Allow",
"Priority": 65001,
"Direction": "Outbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
},
{
"Name": "DenyAllOutBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound",
"Description": "Deny all outbound traffic",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"*"
],
"DestinationAddressPrefix": [
"*"
],
"Access": "Deny",
"Priority": 65500,
"Direction": "Outbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
}
]
NetworkInterfaces : []
Subnets : []
This command returns contents of Azure network security group "nsg1" in resource group "rg1"
Example 2: List existing network security groups using filtering
Get-AzNetworkSecurityGroup -Name nsg*
Name : nsg1
ResourceGroupName : rg1
Location : eastus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provider
s/Microsoft.Network/networkSecurityGroups/nsg1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
FlushConnection : False
SecurityRules : []
DefaultSecurityRules : [
{
"Name": "AllowVnetInBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound",
"Description": "Allow inbound traffic from all VMs in VNET",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"VirtualNetwork"
],
"DestinationAddressPrefix": [
"VirtualNetwork"
],
"Access": "Allow",
"Priority": 65000,
"Direction": "Inbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
},
{
"Name": "AllowAzureLoadBalancerInBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBou
nd",
"Description": "Allow inbound traffic from azure load balancer",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"AzureLoadBalancer"
],
"DestinationAddressPrefix": [
"*"
],
"Access": "Allow",
"Priority": 65001,
"Direction": "Inbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
},
{
"Name": "DenyAllInBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound",
"Description": "Deny all inbound traffic",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"*"
],
"DestinationAddressPrefix": [
"*"
],
"Access": "Deny",
"Priority": 65500,
"Direction": "Inbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
},
{
"Name": "AllowVnetOutBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound",
"Description": "Allow outbound traffic from all VMs to all VMs in VNET",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"VirtualNetwork"
],
"DestinationAddressPrefix": [
"VirtualNetwork"
],
"Access": "Allow",
"Priority": 65000,
"Direction": "Outbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
},
{
"Name": "AllowInternetOutBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound",
"Description": "Allow outbound traffic from all VMs to Internet",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"*"
],
"DestinationAddressPrefix": [
"Internet"
],
"Access": "Allow",
"Priority": 65001,
"Direction": "Outbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
},
{
"Name": "DenyAllOutBound",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide
rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound",
"Description": "Deny all outbound traffic",
"Protocol": "*",
"SourcePortRange": [
"*"
],
"DestinationPortRange": [
"*"
],
"SourceAddressPrefix": [
"*"
],
"DestinationAddressPrefix": [
"*"
],
"Access": "Deny",
"Priority": 65500,
"Direction": "Outbound",
"ProvisioningState": "Succeeded",
"SourceApplicationSecurityGroups": [],
"DestinationApplicationSecurityGroups": []
}
]
NetworkInterfaces : []
Subnets : []
This command returns contents of Azure network security groups that start with "nsg"
PARAMETERS
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpandResource
The resource reference to be expanded.
Type: System.String
Parameter Sets: Expand
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Name
Specifies the name of the network security group that this cmdlet gets.
Type: System.String
Parameter Sets: NoExpand
Aliases: ResourceName
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: System.String
Parameter Sets: Expand
Aliases: ResourceName
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
-ResourceGroupName
Specifies the name of the resource group that the network security group belongs to.
Type: System.String
Parameter Sets: NoExpand
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: System.String
Parameter Sets: Expand
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
System.String
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup
NOTES
RELATED LINKS
PARAMETERS
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpandResource
The resource reference to be expanded.
Type: System.String
Parameter Sets: Expand
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Name
The resource name.
Type: System.String
Parameter Sets: NoExpand
Aliases: ResourceName
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: System.String
Parameter Sets: Expand
Aliases: ResourceName
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
-ResourceGroupName
The resource group name.
Type: System.String
Parameter Sets: NoExpand
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: System.String
Parameter Sets: Expand
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
RELATED LINKS
PARAMETERS
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpandResource
The resource reference to be expanded.
Type: System.String
Parameter Sets: Expand
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Name
The resource name.
Type: System.String
Parameter Sets: NoExpand
Aliases: ResourceName
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: System.String
Parameter Sets: Expand
Aliases: ResourceName
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
-ResourceGroupName
The resource group name.
Type: System.String
Parameter Sets: NoExpand
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: System.String
Parameter Sets: Expand
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
RELATED LINKS
PARAMETERS
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpandResource
The resource reference to be expanded.
Type: System.String
Parameter Sets: Expand
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Name
The resource name.
Type: System.String
Parameter Sets: NoExpand
Aliases: ResourceName
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: System.String
Parameter Sets: Expand
Aliases: ResourceName
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
-ResourceGroupName
The resource group name.
Type: System.String
Parameter Sets: NoExpand
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: System.String
Parameter Sets: Expand
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
RELATED LINKS
PARAMETERS
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpandResource
The resource reference to be expanded.
Type: System.String
Parameter Sets: Expand
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Name
The resource name.
Type: System.String
Parameter Sets: NoExpand
Aliases: ResourceName
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: System.String
Parameter Sets: Expand
Aliases: ResourceName
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
-ResourceGroupName
The resource group name.
Type: System.String
Parameter Sets: NoExpand
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: System.String
Parameter Sets: Expand
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
RELATED LINKS
Azure PowerShell