Get-AzureRmImage

Reference

Module:: AzureRM.Compute

Gets the properties of an image.

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-AzureRmImage
   [[-ResourceGroupName] <String>]
   [[-ImageName] <String>]
   [[-Expand] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmImage cmdlet gets the properties of an image.

Examples

Example 1

PS C:\> Get-AzureRmImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01'

This command gets the properties of the image named 'Image01' in the resource group 'ResourceGroup01'.

Example 2

PS C:\> Get-AzureRmImage -ResourceGroupName 'ResourceGroup01'

This command gets the properties of all images in the resource group 'ResourceGroup01'.

Example 3

PS C:\> Get-AzureRmImage

This command gets the properties of all images under the subscription.

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

-Expand

Specifies the expand expression query.

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

-ImageName

Specifies the name of an image.

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

-ResourceGroupName

Specifies the name of a resource group.

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

Inputs

String

Outputs

PSImage

Share via