Get-AzGalleryImageDefinition
Get or list gallery image definitions.
Syntax
Get-AzGalleryImageDefinition
[-ResourceGroupName] <String>
[-GalleryName] <String>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzGalleryImageDefinition
[[-Name] <String>]
-GalleryUniqueName <String>
[-Scope <String>]
-Location <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzGalleryImageDefinition
[[-Name] <String>]
-GalleryPublicName <String>
-Location <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzGalleryImageDefinition
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzGalleryImageDefinition
[-Location <String>]
[-Community]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
Get or list gallery image definitions.
Examples
Example 1
Get-AzGalleryImageDefinition -ResourceGroupName rg1 -GalleryName gallery1 -GalleryImageDefinitionName image1
ResourceGroupName : rg1
Eula : eula
PrivacyStatementUri : Https://www.microsoft.com
ReleaseNoteUri : https://www.microsoft.com
OsType : Windows
OsState : Generalized
EndOfLifeDate : 2/18/2025 12:07:00 PM
Identifier :
Publisher : PsSDKTeamTest
Offer : testgalleryoffer1
Sku : testgallerysku1
Recommended :
VCPUs :
Min : 2
Max : 32
Memory :
Min : 1
Max : 100
Disallowed :
DiskTypes[0] : Standard_LRS
PurchasePlan :
Name : PsSDKTestPlan
Publisher : PSSDKTeam
Product : PsSDKTestProductWindowsVm
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provi
ders/Microsoft.Compute/galleries/gallery1/images/image1
Name : image1
Type : Microsoft.Compute/galleries/images
Location : eastus2
Tags : {}Get the gallery image definition.
Example 2
Get-AzGalleryImageDefinition -ResourceGroupName rg1 -GalleryName gallery1 -GalleryImageDefinitionName image*
ResourceGroupName : rg1
Eula : eula
PrivacyStatementUri : Https://www.microsoft.com
ReleaseNoteUri : https://www.microsoft.com
OsType : Windows
OsState : Generalized
EndOfLifeDate : 2/18/2025 12:07:00 PM
Identifier :
Publisher : PsSDKTeamTest
Offer : testgalleryoffer1
Sku : testgallerysku1
Recommended :
VCPUs :
Min : 2
Max : 32
Memory :
Min : 1
Max : 100
Disallowed :
DiskTypes[0] : Standard_LRS
PurchasePlan :
Name : PsSDKTestPlan
Publisher : PSSDKTeam
Product : PsSDKTestProductWindowsVm
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provi
ders/Microsoft.Compute/galleries/gallery1/images/image1
Name : image1
Type : Microsoft.Compute/galleries/images
Location : eastus2
Tags : {}
ResourceGroupName : rg1
Eula : eula
PrivacyStatementUri : Https://www.microsoft.com
ReleaseNoteUri : https://www.microsoft.com
OsType : Windows
OsState : Generalized
EndOfLifeDate : 2/18/2025 12:07:00 PM
Identifier :
Publisher : PsSDKTeamTest
Offer : testgalleryoffer1
Sku : testgallerysku1
Recommended :
VCPUs :
Min : 2
Max : 32
Memory :
Min : 1
Max : 100
Disallowed :
DiskTypes[0] : Standard_LRS
PurchasePlan :
Name : PsSDKTestPlan
Publisher : PSSDKTeam
Product : PsSDKTestProductWindowsVm
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provi
ders/Microsoft.Compute/galleries/gallery1/images/image2
Name : image2
Type : Microsoft.Compute/galleries/images
Location : eastus2
Tags : {}Get the gallery image definition that starts with "image".
Example 3
Get-AzGalleryImageDefinition -ResourceGroupName rg1 -GalleryName gallery1
ResourceGroupName : rg1
Eula : eula
PrivacyStatementUri : Https://www.microsoft.com
ReleaseNoteUri : https://www.microsoft.com
OsType : Windows
OsState : Generalized
EndOfLifeDate : 2/18/2025 12:07:00 PM
Identifier :
Publisher : PsSDKTeamTest
Offer : testgalleryoffer1
Sku : testgallerysku1
Recommended :
VCPUs :
Min : 2
Max : 32
Memory :
Min : 1
Max : 100
Disallowed :
DiskTypes[0] : Standard_LRS
PurchasePlan :
Name : PsSDKTestPlan
Publisher : PSSDKTeam
Product : PsSDKTestProductWindowsVm
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provi
ders/Microsoft.Compute/galleries/gallery1/images/image1
Name : image1
Type : Microsoft.Compute/galleries/images
Location : eastus2
Tags : {}
ResourceGroupName : rg1
Eula : eula
PrivacyStatementUri : Https://www.microsoft.com
ReleaseNoteUri : https://www.microsoft.com
OsType : Windows
OsState : Generalized
EndOfLifeDate : 2/18/2025 12:07:00 PM
Identifier :
Publisher : PsSDKTeamTest
Offer : testgalleryoffer1
Sku : testgallerysku1
Recommended :
VCPUs :
Min : 2
Max : 32
Memory :
Min : 1
Max : 100
Disallowed :
DiskTypes[0] : Standard_LRS
PurchasePlan :
Name : PsSDKTestPlan
Publisher : PSSDKTeam
Product : PsSDKTestProductWindowsVm
ProvisioningState : Succeeded
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provi
ders/Microsoft.Compute/galleries/gallery1/images/image2
Name : image2
Type : Microsoft.Compute/galleries/images
Location : eastus2
Tags : {}Get the gallery image definitions in gallery1.
Parameters
-Community
List community galleries.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GalleryName
The name of the gallery.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-GalleryPublicName
The public name of the Shared Image Gallery.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-GalleryUniqueName
The unique name of the Shared Image Gallery.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Location
Location of the Shared Image Gallery.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the gallery image definition.
| Type: | String |
| Aliases: | GalleryImageDefinitionName |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-ResourceGroupName
The name of the resource group.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceId
The resource ID for the gallery image definition
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Scope
Specifies galleries shared to subscription or tenant.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Outputs
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for