published on Wednesday, Jul 29, 2026 by Pulumi
published on Wednesday, Jul 29, 2026 by Pulumi
Retrieves information about a gallery image definition.
Uses Azure REST API version 2024-03-03.
Other available API versions: 2022-03-03, 2022-08-03, 2023-07-03, 2025-03-03, 2025-12-03. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native compute [ApiVersion]. See the version guide for details.
Using getGalleryImage
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGalleryImage(args: GetGalleryImageArgs, opts?: InvokeOptions): Promise<GetGalleryImageResult>
function getGalleryImageOutput(args: GetGalleryImageOutputArgs, opts?: InvokeOptions): Output<GetGalleryImageResult>def get_gallery_image(gallery_image_name: Optional[str] = None,
gallery_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGalleryImageResult
def get_gallery_image_output(gallery_image_name: pulumi.Input[Optional[str]] = None,
gallery_name: pulumi.Input[Optional[str]] = None,
resource_group_name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGalleryImageResult]func LookupGalleryImage(ctx *Context, args *LookupGalleryImageArgs, opts ...InvokeOption) (*LookupGalleryImageResult, error)
func LookupGalleryImageOutput(ctx *Context, args *LookupGalleryImageOutputArgs, opts ...InvokeOption) LookupGalleryImageResultOutput> Note: This function is named LookupGalleryImage in the Go SDK.
public static class GetGalleryImage
{
public static Task<GetGalleryImageResult> InvokeAsync(GetGalleryImageArgs args, InvokeOptions? opts = null)
public static Output<GetGalleryImageResult> Invoke(GetGalleryImageInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetGalleryImageResult> getGalleryImage(GetGalleryImageArgs args, InvokeOptions options)
public static Output<GetGalleryImageResult> getGalleryImage(GetGalleryImageArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:compute:getGalleryImage
arguments:
# arguments dictionarydata "azure-native_compute_get_gallery_image" "name" {
# arguments
}The following arguments are supported:
- Gallery
Image stringName - The name of the gallery image definition to be retrieved.
- Gallery
Name string - The name of the Shared Image Gallery.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Gallery
Image stringName - The name of the gallery image definition to be retrieved.
- Gallery
Name string - The name of the Shared Image Gallery.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- gallery_
image_ stringname - The name of the gallery image definition to be retrieved.
- gallery_
name string - The name of the Shared Image Gallery.
- resource_
group_ stringname - The name of the resource group. The name is case insensitive.
- gallery
Image StringName - The name of the gallery image definition to be retrieved.
- gallery
Name String - The name of the Shared Image Gallery.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- gallery
Image stringName - The name of the gallery image definition to be retrieved.
- gallery
Name string - The name of the Shared Image Gallery.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- gallery_
image_ strname - The name of the gallery image definition to be retrieved.
- gallery_
name str - The name of the Shared Image Gallery.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- gallery
Image StringName - The name of the gallery image definition to be retrieved.
- gallery
Name String - The name of the Shared Image Gallery.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getGalleryImage Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Identifier
Pulumi.
Azure Native. Compute. Outputs. Gallery Image Identifier Response - This is the gallery image definition identifier.
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Os
State string - This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
- Os
Type string - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
- Provisioning
State string - The provisioning state, which only appears in the response.
- System
Data Pulumi.Azure Native. Compute. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Allow
Update boolImage - Optional. Must be set to true if the gallery image features are being updated.
- Architecture string
- The architecture of the image. Applicable to OS disks only.
- Description string
- The description of this gallery image definition resource. This property is updatable.
- Disallowed
Pulumi.
Azure Native. Compute. Outputs. Disallowed Response - Describes the disallowed disk types.
- End
Of stringLife Date - The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
- Eula string
- The Eula agreement for the gallery image definition.
- Features
List<Pulumi.
Azure Native. Compute. Outputs. Gallery Image Feature Response> - A list of gallery image features.
- Hyper
VGeneration string - The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- Privacy
Statement stringUri - The privacy statement uri.
- Purchase
Plan Pulumi.Azure Native. Compute. Outputs. Image Purchase Plan Response - Describes the gallery image definition purchase plan. This is used by marketplace images.
- Recommended
Pulumi.
Azure Native. Compute. Outputs. Recommended Machine Configuration Response - The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
- Release
Note stringUri - The release note uri.
- Dictionary<string, string>
- Resource tags.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Identifier
Gallery
Image Identifier Response - This is the gallery image definition identifier.
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Os
State string - This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
- Os
Type string - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
- Provisioning
State string - The provisioning state, which only appears in the response.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Allow
Update boolImage - Optional. Must be set to true if the gallery image features are being updated.
- Architecture string
- The architecture of the image. Applicable to OS disks only.
- Description string
- The description of this gallery image definition resource. This property is updatable.
- Disallowed
Disallowed
Response - Describes the disallowed disk types.
- End
Of stringLife Date - The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
- Eula string
- The Eula agreement for the gallery image definition.
- Features
[]Gallery
Image Feature Response - A list of gallery image features.
- Hyper
VGeneration string - The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- Privacy
Statement stringUri - The privacy statement uri.
- Purchase
Plan ImagePurchase Plan Response - Describes the gallery image definition purchase plan. This is used by marketplace images.
- Recommended
Recommended
Machine Configuration Response - The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
- Release
Note stringUri - The release note uri.
- map[string]string
- Resource tags.
- azure_
api_ stringversion - The Azure API version of the resource.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- identifier object
- This is the gallery image definition identifier.
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- os_
state string - This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
- os_
type string - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
- provisioning_
state string - The provisioning state, which only appears in the response.
- system_
data object - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- allow_
update_ boolimage - Optional. Must be set to true if the gallery image features are being updated.
- architecture string
- The architecture of the image. Applicable to OS disks only.
- description string
- The description of this gallery image definition resource. This property is updatable.
- disallowed object
- Describes the disallowed disk types.
- end_
of_ stringlife_ date - The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
- eula string
- The Eula agreement for the gallery image definition.
- features list(object)
- A list of gallery image features.
- hyper_
v_ stringgeneration - The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- privacy_
statement_ stringuri - The privacy statement uri.
- purchase_
plan object - Describes the gallery image definition purchase plan. This is used by marketplace images.
- recommended object
- The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
- release_
note_ stringuri - The release note uri.
- map(string)
- Resource tags.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- identifier
Gallery
Image Identifier Response - This is the gallery image definition identifier.
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- os
State String - This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
- os
Type String - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
- provisioning
State String - The provisioning state, which only appears in the response.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- allow
Update BooleanImage - Optional. Must be set to true if the gallery image features are being updated.
- architecture String
- The architecture of the image. Applicable to OS disks only.
- description String
- The description of this gallery image definition resource. This property is updatable.
- disallowed
Disallowed
Response - Describes the disallowed disk types.
- end
Of StringLife Date - The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
- eula String
- The Eula agreement for the gallery image definition.
- features
List<Gallery
Image Feature Response> - A list of gallery image features.
- hyper
VGeneration String - The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- privacy
Statement StringUri - The privacy statement uri.
- purchase
Plan ImagePurchase Plan Response - Describes the gallery image definition purchase plan. This is used by marketplace images.
- recommended
Recommended
Machine Configuration Response - The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
- release
Note StringUri - The release note uri.
- Map<String,String>
- Resource tags.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- identifier
Gallery
Image Identifier Response - This is the gallery image definition identifier.
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- os
State string - This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
- os
Type string - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
- provisioning
State string - The provisioning state, which only appears in the response.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- allow
Update booleanImage - Optional. Must be set to true if the gallery image features are being updated.
- architecture string
- The architecture of the image. Applicable to OS disks only.
- description string
- The description of this gallery image definition resource. This property is updatable.
- disallowed
Disallowed
Response - Describes the disallowed disk types.
- end
Of stringLife Date - The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
- eula string
- The Eula agreement for the gallery image definition.
- features
Gallery
Image Feature Response[] - A list of gallery image features.
- hyper
VGeneration string - The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- privacy
Statement stringUri - The privacy statement uri.
- purchase
Plan ImagePurchase Plan Response - Describes the gallery image definition purchase plan. This is used by marketplace images.
- recommended
Recommended
Machine Configuration Response - The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
- release
Note stringUri - The release note uri.
- {[key: string]: string}
- Resource tags.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- identifier
Gallery
Image Identifier Response - This is the gallery image definition identifier.
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- os_
state str - This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
- os_
type str - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
- provisioning_
state str - The provisioning state, which only appears in the response.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- allow_
update_ boolimage - Optional. Must be set to true if the gallery image features are being updated.
- architecture str
- The architecture of the image. Applicable to OS disks only.
- description str
- The description of this gallery image definition resource. This property is updatable.
- disallowed
Disallowed
Response - Describes the disallowed disk types.
- end_
of_ strlife_ date - The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
- eula str
- The Eula agreement for the gallery image definition.
- features
Sequence[Gallery
Image Feature Response] - A list of gallery image features.
- hyper_
v_ strgeneration - The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- privacy_
statement_ struri - The privacy statement uri.
- purchase_
plan ImagePurchase Plan Response - Describes the gallery image definition purchase plan. This is used by marketplace images.
- recommended
Recommended
Machine Configuration Response - The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
- release_
note_ struri - The release note uri.
- Mapping[str, str]
- Resource tags.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- identifier Property Map
- This is the gallery image definition identifier.
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- os
State String - This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
- os
Type String - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
- provisioning
State String - The provisioning state, which only appears in the response.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- allow
Update BooleanImage - Optional. Must be set to true if the gallery image features are being updated.
- architecture String
- The architecture of the image. Applicable to OS disks only.
- description String
- The description of this gallery image definition resource. This property is updatable.
- disallowed Property Map
- Describes the disallowed disk types.
- end
Of StringLife Date - The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
- eula String
- The Eula agreement for the gallery image definition.
- features List<Property Map>
- A list of gallery image features.
- hyper
VGeneration String - The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- privacy
Statement StringUri - The privacy statement uri.
- purchase
Plan Property Map - Describes the gallery image definition purchase plan. This is used by marketplace images.
- recommended Property Map
- The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
- release
Note StringUri - The release note uri.
- Map<String>
- Resource tags.
Supporting Types
DisallowedResponse
- Disk
Types List<string> - A list of disk types.
- Disk
Types []string - A list of disk types.
- disk_
types list(string) - A list of disk types.
- disk
Types List<String> - A list of disk types.
- disk
Types string[] - A list of disk types.
- disk_
types Sequence[str] - A list of disk types.
- disk
Types List<String> - A list of disk types.
GalleryImageFeatureResponse
- Name string
- The name of the gallery image feature.
- Starts
At stringVersion - The minimum gallery image version which supports this feature.
- Value string
- The value of the gallery image feature.
- Name string
- The name of the gallery image feature.
- Starts
At stringVersion - The minimum gallery image version which supports this feature.
- Value string
- The value of the gallery image feature.
- name string
- The name of the gallery image feature.
- starts_
at_ stringversion - The minimum gallery image version which supports this feature.
- value string
- The value of the gallery image feature.
- name String
- The name of the gallery image feature.
- starts
At StringVersion - The minimum gallery image version which supports this feature.
- value String
- The value of the gallery image feature.
- name string
- The name of the gallery image feature.
- starts
At stringVersion - The minimum gallery image version which supports this feature.
- value string
- The value of the gallery image feature.
- name str
- The name of the gallery image feature.
- starts_
at_ strversion - The minimum gallery image version which supports this feature.
- value str
- The value of the gallery image feature.
- name String
- The name of the gallery image feature.
- starts
At StringVersion - The minimum gallery image version which supports this feature.
- value String
- The value of the gallery image feature.
GalleryImageIdentifierResponse
ImagePurchasePlanResponse
RecommendedMachineConfigurationResponse
- Memory
Pulumi.
Azure Native. Compute. Inputs. Resource Range Response - Describes the resource range.
- VCPUs
Pulumi.
Azure Native. Compute. Inputs. Resource Range Response - Describes the resource range.
- Memory
Resource
Range Response - Describes the resource range.
- VCPUs
Resource
Range Response - Describes the resource range.
- memory
Resource
Range Response - Describes the resource range.
- v
CPUs ResourceRange Response - Describes the resource range.
- memory
Resource
Range Response - Describes the resource range.
- v
CPUs ResourceRange Response - Describes the resource range.
- memory
Resource
Range Response - Describes the resource range.
- v_
cpus ResourceRange Response - Describes the resource range.
- memory Property Map
- Describes the resource range.
- v
CPUs Property Map - Describes the resource range.
ResourceRangeResponse
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at string - The timestamp of resource creation (UTC).
- created_
by string - The identity that created the resource.
- created_
by_ stringtype - The type of identity that created the resource.
- last_
modified_ stringat - The timestamp of resource last modification (UTC)
- last_
modified_ stringby - The identity that last modified the resource.
- last_
modified_ stringby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Wednesday, Jul 29, 2026 by Pulumi