Edit

Share via

Get-AzCustomLocation

  • Reference
Module:
Az.CustomLocation

Gets the details of the customLocation with a specified resource group and name.

Syntax

PowerShell 
Get-AzCustomLocation
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
PowerShell 
Get-AzCustomLocation
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
PowerShell 
Get-AzCustomLocation
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
PowerShell 
Get-AzCustomLocation
   -InputObject <ICustomLocationIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the details of the customLocation with a specified resource group and name.

Examples

Example 1: List the details of the customLocation.

PowerShell 
Get-AzCustomLocation

Location Name                Namespace      ResourceGroupName
-------- ----                ---------      -----------------
eastus   azps-customlocation azps-namespace azps_test_cluster

List the details of the customLocation.

Example 2: List the details of the customLocation with a specified resource group.

PowerShell 
Get-AzCustomLocation -ResourceGroupName azps_test_cluster

Location Name                Namespace      ResourceGroupName
-------- ----                ---------      -----------------
eastus   azps-customlocation azps-namespace azps_test_cluster

List the details of the customLocation with a specified resource group.

Example 3: Gets the details of the customLocation with a specified resource group and name.

PowerShell 
Get-AzCustomLocation -ResourceGroupName azps_test_cluster -Name azps-customlocation

Location Name                Namespace      ResourceGroupName
-------- ----                ---------      -----------------
eastus   azps-customlocation azps-namespace azps_test_cluster

Gets the details of the customLocation with a specified resource group and name.

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

-InputObject

Identity Parameter

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

-Name

Custom Locations name.

Type:String
Position:Named
Default value:None
Required:True
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

-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

Inputs

Outputs