Get-AzStackHCIVMLogicalNetwork

Reference

Module:: Az.StackHCIVM

Gets a logical network

Syntax

Get-AzStackHCIVMLogicalNetwork
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStackHCIVMLogicalNetwork
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStackHCIVMLogicalNetwork
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStackHCIVMLogicalNetwork
   [-ResourceId <String>]
   [-DefaultProfile <PSObject>]
   [-NoWait]
   [<CommonParameters>]

Description

Gets a logical network

Examples

Example 1: Get a Logical Network

Get-AzStackHCIVMLogicalNetwork -Name 'testLnet' -ResourceGroupName 'test-rg'

Name            ResourceGroupName
----            -----------------
testLnet       test-rg

This command gets a specific logical network in the specified resource group.

Example 2: List all Logical Networks in a Resource Group

Get-AzStackHCIVMLogicalNetwork -ResourceGroupName 'test-rg'

Name            ResourceGroupName
----            -----------------
testLnet       test-rg

This command lists all logical networks in the specified resource group.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Name of the logical network

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

-NoWait

Run the command asynchronously

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-ResourceId

The ARM ID of the logical network.

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

-SubscriptionId

The ID of the target subscription.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

ILogicalNetworks

Share via