Get-AzGallerySoftDeletedImageVersion
Get soft-deleted image versions from an Azure Compute Gallery.
Syntax
DefaultParameter (Default)
Get-AzGallerySoftDeletedImageVersion
-ResourceGroupName <String>
-GalleryName <String>
-GalleryImageDefinitionName <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
ResourceIdParameter
Get-AzGallerySoftDeletedImageVersion
-GalleryImageDefinitionResourceId <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
ObjectParameter
Get-AzGallerySoftDeletedImageVersion
-InputObject <PSGalleryImage>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
Description
Lists soft-deleted image versions for a gallery image definition. Use -Name to return only the matching version.
Examples
Example 1
Get-AzGallerySoftDeletedImageVersion -ResourceGroupName $rgname -GalleryName $galleryName `
-GalleryImageDefinitionName $imageName
List all soft-deleted versions for an image definition.
Example 2
Get-AzGalleryImageDefinition -ResourceGroupName $rgname -GalleryName $galleryName -Name $imageName |
Get-AzGallerySoftDeletedImageVersion -Name '1.0.0'
Get a specific soft-deleted version by piping an image definition.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-GalleryImageDefinitionName
The name of the gallery image definition.
Parameter properties
| Type: | String
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | GalleryImageName |
Parameter sets
DefaultParameter
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-GalleryImageDefinitionResourceId
The resource ID of the gallery image definition.
Parameter properties
| Type: | String
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ResourceIdParameter
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-GalleryName
The name of the gallery.
Parameter properties
| Type: | String
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
DefaultParameter
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
The gallery image definition whose soft-deleted versions are listed.
| Type: | PSGalleryImage
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
ObjectParameter
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Filter the results to the specified gallery image version name.
Parameter properties
| Type: | String
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | GalleryImageVersionName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The name of the resource group.
Parameter properties
| Type: | String
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
DefaultParameter
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
Outputs