1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. getMarketplaceGalleryImage
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.azurestackhci.getMarketplaceGalleryImage

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Gets a marketplace gallery image

Uses Azure REST API version 2025-02-01-preview.

Other available API versions: 2022-12-15-preview, 2023-07-01-preview, 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurestackhci [ApiVersion]. See the version guide for details.

Using getMarketplaceGalleryImage

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 getMarketplaceGalleryImage(args: GetMarketplaceGalleryImageArgs, opts?: InvokeOptions): Promise<GetMarketplaceGalleryImageResult>
function getMarketplaceGalleryImageOutput(args: GetMarketplaceGalleryImageOutputArgs, opts?: InvokeOptions): Output<GetMarketplaceGalleryImageResult>
Copy
def get_marketplace_gallery_image(marketplace_gallery_image_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetMarketplaceGalleryImageResult
def get_marketplace_gallery_image_output(marketplace_gallery_image_name: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetMarketplaceGalleryImageResult]
Copy
func LookupMarketplaceGalleryImage(ctx *Context, args *LookupMarketplaceGalleryImageArgs, opts ...InvokeOption) (*LookupMarketplaceGalleryImageResult, error)
func LookupMarketplaceGalleryImageOutput(ctx *Context, args *LookupMarketplaceGalleryImageOutputArgs, opts ...InvokeOption) LookupMarketplaceGalleryImageResultOutput
Copy

> Note: This function is named LookupMarketplaceGalleryImage in the Go SDK.

public static class GetMarketplaceGalleryImage 
{
    public static Task<GetMarketplaceGalleryImageResult> InvokeAsync(GetMarketplaceGalleryImageArgs args, InvokeOptions? opts = null)
    public static Output<GetMarketplaceGalleryImageResult> Invoke(GetMarketplaceGalleryImageInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMarketplaceGalleryImageResult> getMarketplaceGalleryImage(GetMarketplaceGalleryImageArgs args, InvokeOptions options)
public static Output<GetMarketplaceGalleryImageResult> getMarketplaceGalleryImage(GetMarketplaceGalleryImageArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azurestackhci:getMarketplaceGalleryImage
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

MarketplaceGalleryImageName
This property is required.
Changes to this property will trigger replacement.
string
Name of the marketplace gallery image
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
MarketplaceGalleryImageName
This property is required.
Changes to this property will trigger replacement.
string
Name of the marketplace gallery image
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
marketplaceGalleryImageName
This property is required.
Changes to this property will trigger replacement.
String
Name of the marketplace gallery image
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
marketplaceGalleryImageName
This property is required.
Changes to this property will trigger replacement.
string
Name of the marketplace gallery image
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
marketplace_gallery_image_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the marketplace gallery image
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
marketplaceGalleryImageName
This property is required.
Changes to this property will trigger replacement.
String
Name of the marketplace gallery image
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getMarketplaceGalleryImage Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
OsType string
Operating system type that the gallery image uses [Windows, Linux]
ProvisioningState string
Provisioning state of the marketplace gallery image.
Status Pulumi.AzureNative.AzureStackHCI.Outputs.MarketplaceGalleryImageStatusResponse
The observed state of marketplace gallery images
SystemData Pulumi.AzureNative.AzureStackHCI.Outputs.SystemDataResponse
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"
CloudInitDataSource string
Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]
ContainerId string
Storage ContainerID of the storage container to be used for marketplace gallery image
ExtendedLocation Pulumi.AzureNative.AzureStackHCI.Outputs.ExtendedLocationResponse
The extendedLocation of the resource.
HyperVGeneration string
The hypervisor generation of the Virtual Machine [V1, V2]
Identifier Pulumi.AzureNative.AzureStackHCI.Outputs.GalleryImageIdentifierResponse
This is the gallery image definition identifier.
Tags Dictionary<string, string>
Resource tags.
Version Pulumi.AzureNative.AzureStackHCI.Outputs.GalleryImageVersionResponse
Specifies information about the gallery image version that you want to create or update.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
OsType string
Operating system type that the gallery image uses [Windows, Linux]
ProvisioningState string
Provisioning state of the marketplace gallery image.
Status MarketplaceGalleryImageStatusResponse
The observed state of marketplace gallery images
SystemData SystemDataResponse
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"
CloudInitDataSource string
Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]
ContainerId string
Storage ContainerID of the storage container to be used for marketplace gallery image
ExtendedLocation ExtendedLocationResponse
The extendedLocation of the resource.
HyperVGeneration string
The hypervisor generation of the Virtual Machine [V1, V2]
Identifier GalleryImageIdentifierResponse
This is the gallery image definition identifier.
Tags map[string]string
Resource tags.
Version GalleryImageVersionResponse
Specifies information about the gallery image version that you want to create or update.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
osType String
Operating system type that the gallery image uses [Windows, Linux]
provisioningState String
Provisioning state of the marketplace gallery image.
status MarketplaceGalleryImageStatusResponse
The observed state of marketplace gallery images
systemData SystemDataResponse
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"
cloudInitDataSource String
Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]
containerId String
Storage ContainerID of the storage container to be used for marketplace gallery image
extendedLocation ExtendedLocationResponse
The extendedLocation of the resource.
hyperVGeneration String
The hypervisor generation of the Virtual Machine [V1, V2]
identifier GalleryImageIdentifierResponse
This is the gallery image definition identifier.
tags Map<String,String>
Resource tags.
version GalleryImageVersionResponse
Specifies information about the gallery image version that you want to create or update.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the resource
osType string
Operating system type that the gallery image uses [Windows, Linux]
provisioningState string
Provisioning state of the marketplace gallery image.
status MarketplaceGalleryImageStatusResponse
The observed state of marketplace gallery images
systemData SystemDataResponse
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"
cloudInitDataSource string
Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]
containerId string
Storage ContainerID of the storage container to be used for marketplace gallery image
extendedLocation ExtendedLocationResponse
The extendedLocation of the resource.
hyperVGeneration string
The hypervisor generation of the Virtual Machine [V1, V2]
identifier GalleryImageIdentifierResponse
This is the gallery image definition identifier.
tags {[key: string]: string}
Resource tags.
version GalleryImageVersionResponse
Specifies information about the gallery image version that you want to create or update.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the resource
os_type str
Operating system type that the gallery image uses [Windows, Linux]
provisioning_state str
Provisioning state of the marketplace gallery image.
status MarketplaceGalleryImageStatusResponse
The observed state of marketplace gallery images
system_data SystemDataResponse
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"
cloud_init_data_source str
Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]
container_id str
Storage ContainerID of the storage container to be used for marketplace gallery image
extended_location ExtendedLocationResponse
The extendedLocation of the resource.
hyper_v_generation str
The hypervisor generation of the Virtual Machine [V1, V2]
identifier GalleryImageIdentifierResponse
This is the gallery image definition identifier.
tags Mapping[str, str]
Resource tags.
version GalleryImageVersionResponse
Specifies information about the gallery image version that you want to create or update.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
osType String
Operating system type that the gallery image uses [Windows, Linux]
provisioningState String
Provisioning state of the marketplace gallery image.
status Property Map
The observed state of marketplace gallery images
systemData 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"
cloudInitDataSource String
Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]
containerId String
Storage ContainerID of the storage container to be used for marketplace gallery image
extendedLocation Property Map
The extendedLocation of the resource.
hyperVGeneration String
The hypervisor generation of the Virtual Machine [V1, V2]
identifier Property Map
This is the gallery image definition identifier.
tags Map<String>
Resource tags.
version Property Map
Specifies information about the gallery image version that you want to create or update.

Supporting Types

ExtendedLocationResponse

Name string
The name of the extended location.
Type string
The type of the extended location.
Name string
The name of the extended location.
Type string
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.
name string
The name of the extended location.
type string
The type of the extended location.
name str
The name of the extended location.
type str
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.

GalleryImageIdentifierResponse

Offer This property is required. string
The name of the gallery image definition offer.
Publisher This property is required. string
The name of the gallery image definition publisher.
Sku This property is required. string
The name of the gallery image definition SKU.
Offer This property is required. string
The name of the gallery image definition offer.
Publisher This property is required. string
The name of the gallery image definition publisher.
Sku This property is required. string
The name of the gallery image definition SKU.
offer This property is required. String
The name of the gallery image definition offer.
publisher This property is required. String
The name of the gallery image definition publisher.
sku This property is required. String
The name of the gallery image definition SKU.
offer This property is required. string
The name of the gallery image definition offer.
publisher This property is required. string
The name of the gallery image definition publisher.
sku This property is required. string
The name of the gallery image definition SKU.
offer This property is required. str
The name of the gallery image definition offer.
publisher This property is required. str
The name of the gallery image definition publisher.
sku This property is required. str
The name of the gallery image definition SKU.
offer This property is required. String
The name of the gallery image definition offer.
publisher This property is required. String
The name of the gallery image definition publisher.
sku This property is required. String
The name of the gallery image definition SKU.

GalleryImageVersionResponse

StorageProfile This property is required. Pulumi.AzureNative.AzureStackHCI.Inputs.GalleryImageVersionStorageProfileResponse
This is the storage profile of a Gallery Image Version.
Name string
This is the version of the gallery image.
StorageProfile This property is required. GalleryImageVersionStorageProfileResponse
This is the storage profile of a Gallery Image Version.
Name string
This is the version of the gallery image.
storageProfile This property is required. GalleryImageVersionStorageProfileResponse
This is the storage profile of a Gallery Image Version.
name String
This is the version of the gallery image.
storageProfile This property is required. GalleryImageVersionStorageProfileResponse
This is the storage profile of a Gallery Image Version.
name string
This is the version of the gallery image.
storage_profile This property is required. GalleryImageVersionStorageProfileResponse
This is the storage profile of a Gallery Image Version.
name str
This is the version of the gallery image.
storageProfile This property is required. Property Map
This is the storage profile of a Gallery Image Version.
name String
This is the version of the gallery image.

GalleryImageVersionStorageProfileResponse

OsDiskImage GalleryOSDiskImageResponse
This is the OS disk image.
osDiskImage GalleryOSDiskImageResponse
This is the OS disk image.
osDiskImage GalleryOSDiskImageResponse
This is the OS disk image.
os_disk_image GalleryOSDiskImageResponse
This is the OS disk image.
osDiskImage Property Map
This is the OS disk image.

GalleryOSDiskImageResponse

SizeInMB This property is required. double
This property indicates the size of the VHD to be created.
SizeInMB This property is required. float64
This property indicates the size of the VHD to be created.
sizeInMB This property is required. Double
This property indicates the size of the VHD to be created.
sizeInMB This property is required. number
This property indicates the size of the VHD to be created.
size_in_mb This property is required. float
This property indicates the size of the VHD to be created.
sizeInMB This property is required. Number
This property indicates the size of the VHD to be created.

MarketplaceGalleryImageStatusDownloadStatusResponse

DownloadSizeInMB double
The downloaded sized of the image in MB
DownloadSizeInMB float64
The downloaded sized of the image in MB
downloadSizeInMB Double
The downloaded sized of the image in MB
downloadSizeInMB number
The downloaded sized of the image in MB
download_size_in_mb float
The downloaded sized of the image in MB
downloadSizeInMB Number
The downloaded sized of the image in MB

MarketplaceGalleryImageStatusProvisioningStatusResponse

Status This property is required. string
The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]
OperationId string
The ID of the operation performed on the gallery image
Status This property is required. string
The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]
OperationId string
The ID of the operation performed on the gallery image
status This property is required. String
The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]
operationId String
The ID of the operation performed on the gallery image
status This property is required. string
The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]
operationId string
The ID of the operation performed on the gallery image
status This property is required. str
The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]
operation_id str
The ID of the operation performed on the gallery image
status This property is required. String
The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]
operationId String
The ID of the operation performed on the gallery image

MarketplaceGalleryImageStatusResponse

DownloadStatus Pulumi.AzureNative.AzureStackHCI.Inputs.MarketplaceGalleryImageStatusDownloadStatusResponse
The download status of the gallery image
ErrorCode string
MarketplaceGalleryImage provisioning error code
ErrorMessage string
Descriptive error message
ProgressPercentage double
The progress of the operation in percentage
ProvisioningStatus Pulumi.AzureNative.AzureStackHCI.Inputs.MarketplaceGalleryImageStatusProvisioningStatusResponse
Provisioning status of marketplace gallery image
DownloadStatus MarketplaceGalleryImageStatusDownloadStatusResponse
The download status of the gallery image
ErrorCode string
MarketplaceGalleryImage provisioning error code
ErrorMessage string
Descriptive error message
ProgressPercentage float64
The progress of the operation in percentage
ProvisioningStatus MarketplaceGalleryImageStatusProvisioningStatusResponse
Provisioning status of marketplace gallery image
downloadStatus MarketplaceGalleryImageStatusDownloadStatusResponse
The download status of the gallery image
errorCode String
MarketplaceGalleryImage provisioning error code
errorMessage String
Descriptive error message
progressPercentage Double
The progress of the operation in percentage
provisioningStatus MarketplaceGalleryImageStatusProvisioningStatusResponse
Provisioning status of marketplace gallery image
downloadStatus MarketplaceGalleryImageStatusDownloadStatusResponse
The download status of the gallery image
errorCode string
MarketplaceGalleryImage provisioning error code
errorMessage string
Descriptive error message
progressPercentage number
The progress of the operation in percentage
provisioningStatus MarketplaceGalleryImageStatusProvisioningStatusResponse
Provisioning status of marketplace gallery image
download_status MarketplaceGalleryImageStatusDownloadStatusResponse
The download status of the gallery image
error_code str
MarketplaceGalleryImage provisioning error code
error_message str
Descriptive error message
progress_percentage float
The progress of the operation in percentage
provisioning_status MarketplaceGalleryImageStatusProvisioningStatusResponse
Provisioning status of marketplace gallery image
downloadStatus Property Map
The download status of the gallery image
errorCode String
MarketplaceGalleryImage provisioning error code
errorMessage String
Descriptive error message
progressPercentage Number
The progress of the operation in percentage
provisioningStatus Property Map
Provisioning status of marketplace gallery image

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
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_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi