Get-AzLabServicesPlanImage

Reference

Module:: Az.LabServices

Gets an image resource.

Syntax

Get-AzLabServicesPlanImage
   [-SubscriptionId <String[]>]
   -ResourceId <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzLabServicesPlanImage
   -LabPlanName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -DisplayName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzLabServicesPlanImage
   -LabPlanName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-Filter <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

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

Get-AzLabServicesPlanImage
   [-Name <String>]
   [-SubscriptionId <String[]>]
   -LabPlan <LabPlan>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets an image resource.

Examples

Example 1: Get all image in the lab plan.

Get-AzLabServicesPlanImage -LabPlanName "Plan Name" -ResourceGroupName "Group Name"

Name
----
128technology.128t_networking_platform.128t_networking_platform
128technology.128technology_conductor_hourly.128technology_conductor_hourly_427
128technology.128technology_conductor_hourly.128technology_conductor_hourly_452

Gets all the available images, this is usually a long list of images.

Example 2: Get specific image in the lab plan.

Get-AzLabServicesPlanImage -LabPlanName "Plan Name"  -ResourceGroupName "Group Name" -Name 'canonical.0001-com-ubuntu-server-focal.20_04-lts'

Name
----
canonical.0001-com-ubuntu-server-focal.20_04-lts

Returns the specific image.

Example 3: Get specific image using display name.

Get-AzLabServicesPlanImage -LabPlanName "Plan Name" -ResourceGroupName "Group Name" -DisplayName 'Ubuntu Server 20.04 LTS'

Name
----
canonical.0001-com-ubuntu-server-focal.20_04-lts

Returns the specific image with the display 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

-DisplayName

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

-Filter

The filter to apply to the operation.

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

-LabPlan

To construct, see NOTES section for LABPLAN properties and create a hash table.

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

-LabPlanName

The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

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

-Name

The image name.

Type:	String
Aliases:	ImageName
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:	True
Accept wildcard characters:	False

-ResourceId

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

LabPlan

String

Outputs

IImage

Share via