Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-AzGalleryImageDefinition
- Module:
- Az.Compute Module
Get or list gallery image definitions.
Syntax
DefaultParameter (Default)
Get-AzGalleryImageDefinition
[-ResourceGroupName] <String>
[-GalleryName] <String>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
SharedGalleryParameterSet
Get-AzGalleryImageDefinition
[[-Name] <String>]
-GalleryUniqueName <String>
-Location <String>
[-Scope <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
CommunityGalleryParameterSet
Get-AzGalleryImageDefinition
[[-Name] <String>]
-GalleryPublicName <String>
-Location <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ResourceIdParameter
Get-AzGalleryImageDefinition
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ListCommunityGalleryParameterSet
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-GalleryName
The name of the gallery.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-GalleryPublicName
The public name of the Shared Image Gallery.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-GalleryUniqueName
The unique name of the Shared Image Gallery.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Location
Location of the Shared Image Gallery.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
The name of the gallery image definition.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | GalleryImageDefinitionName |
Parameter sets
-ResourceGroupName
The name of the resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceId
The resource ID for the gallery image definition
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Scope
Specifies galleries shared to subscription or tenant.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
Outputs
PSGalleryImage
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
Was this page helpful?