Get-AzureRmNetworkProfile
Gets an existing network profile top level resource
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmNetworkProfile
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmNetworkProfile
-ResourceGroupName <String>
-Name <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmNetworkProfile
[-ResourceGroupName <String>]
[-Name <String>]
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmNetworkProfile
-ResourceId <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmNetworkProfile
-ResourceId <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzureRmNetworkProfile cmdlet retrieves an existing network profile top level resource
Examples
Example 1
$networkProfile = Get-AzureRmNetworkProfile -Name np1 -ResourceGroupName rg1This retrieves the network profile np1 in resource group rg1
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpandResource
The resource reference to be expanded.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the network profile.
| Type: | String |
| Aliases: | ResourceName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource group name of the network profile.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceId
The Azure resource manager id of the network profile.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |