Get-AzVMwareCloudLink
Get an cloud link by name in a private cloud
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
Syntax
Get-AzVMwareCloudLink
-PrivateCloudName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzVMwareCloudLink
-Name <String>
-PrivateCloudName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzVMwareCloudLink
-InputObject <IVMwareIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Get an cloud link by name in a private cloud
Examples
Example 1: List cloud link under resource group
PS C:\> Get-AzVMwareCloudLink -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group
Name Type ResourceGroupName
---- ---- -----------------
azps_test_cloudlink Microsoft.AVS/privateClouds/cloudLinks azps_test_group
List cloud link under resource group
Example 2: Get cloud link by name in a private cloud
PS C:\> Get-AzVMwareCloudLink -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -Name azps_test_cloudlink
Name Type ResourceGroupName
---- ---- -----------------
azps_test_cloudlink Microsoft.AVS/privateClouds/cloudLinks azps_test_group
Get cloud link by name in a private cloud
Parameters
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IVMwareIdentity |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Name of the cloud link resource
| Type: | String |
| Aliases: | CloudLinkName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Name of the private cloud
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The ID of the target subscription.
| Type: | String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Notes
ALIASES
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT : Identity Parameter
[AddonName <String>]: Name of the addon for the private cloud[AuthorizationName <String>]: Name of the ExpressRoute Circuit Authorization in the private cloud[CloudLinkName <String>]: Name of the cloud link resource[ClusterName <String>]: Name of the cluster in the private cloud[DatastoreName <String>]: Name of the datastore in the private cloud cluster[DhcpId <String>]: NSX DHCP identifier. Generally the same as the DHCP display name[DnsServiceId <String>]: NSX DNS Service identifier. Generally the same as the DNS Service's display name[DnsZoneId <String>]: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name[GatewayId <String>]: NSX Gateway identifier. Generally the same as the Gateway's display name[GlobalReachConnectionName <String>]: Name of the global reach connection in the private cloud[HcxEnterpriseSiteName <String>]: Name of the HCX Enterprise Site in the private cloud[Id <String>]: Resource identity path[Location <String>]: Azure region[PortMirroringId <String>]: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name[PrivateCloudName <String>]: Name of the private cloud[PublicIPId <String>]: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name[ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.[ScriptCmdletName <String>]: Name of the script cmdlet resource in the script package in the private cloud[ScriptExecutionName <String>]: Name of the user-invoked script execution resource[ScriptPackageName <String>]: Name of the script package in the private cloud[SegmentId <String>]: NSX Segment identifier. Generally the same as the Segment's display name[SubscriptionId <String>]: The ID of the target subscription.[VMGroupId <String>]: NSX VM Group identifier. Generally the same as the VM Group's display name[VirtualMachineId <String>]: Virtual Machine identifier