Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. getGalleryImage
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurestackhci.getGalleryImage

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

    Gets a gallery image Azure REST API version: 2022-12-15-preview.

    Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2024-01-01.

    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,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetGalleryImageResult
def get_gallery_image_output(gallery_image_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:azurestackhci:getGalleryImage
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GalleryImageName string
    Name of the gallery image
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    GalleryImageName string
    Name of the gallery image
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    galleryImageName String
    Name of the gallery image
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    galleryImageName string
    Name of the gallery image
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    gallery_image_name str
    Name of the gallery image
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    galleryImageName String
    Name of the gallery image
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getGalleryImage Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the gallery image.
    Status Pulumi.AzureNative.AzureStackHCI.Outputs.GalleryImageStatusResponse
    The observed state of 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]
    ContainerName string
    Container Name for storage container
    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.
    ImagePath string
    location of the image the gallery image should be created from
    OsType string
    Operating system type that the gallery image uses [Windows, Linux]
    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.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the gallery image.
    Status GalleryImageStatusResponse
    The observed state of 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]
    ContainerName string
    Container Name for storage container
    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.
    ImagePath string
    location of the image the gallery image should be created from
    OsType string
    Operating system type that the gallery image uses [Windows, Linux]
    Tags map[string]string
    Resource tags.
    Version GalleryImageVersionResponse
    Specifies information about the gallery image version that you want to create or update.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the gallery image.
    status GalleryImageStatusResponse
    The observed state of 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]
    containerName String
    Container Name for storage container
    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.
    imagePath String
    location of the image the gallery image should be created from
    osType String
    Operating system type that the gallery image uses [Windows, Linux]
    tags Map<String,String>
    Resource tags.
    version GalleryImageVersionResponse
    Specifies information about the gallery image version that you want to create or update.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    Provisioning state of the gallery image.
    status GalleryImageStatusResponse
    The observed state of 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]
    containerName string
    Container Name for storage container
    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.
    imagePath string
    location of the image the gallery image should be created from
    osType string
    Operating system type that the gallery image uses [Windows, Linux]
    tags {[key: string]: string}
    Resource tags.
    version GalleryImageVersionResponse
    Specifies information about the gallery image version that you want to create or update.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    Provisioning state of the gallery image.
    status GalleryImageStatusResponse
    The observed state of 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_name str
    Container Name for storage container
    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.
    image_path str
    location of the image the gallery image should be created from
    os_type str
    Operating system type that the gallery image uses [Windows, Linux]
    tags Mapping[str, str]
    Resource tags.
    version GalleryImageVersionResponse
    Specifies information about the gallery image version that you want to create or update.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the gallery image.
    status Property Map
    The observed state of 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]
    containerName String
    Container Name for storage container
    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.
    imagePath String
    location of the image the gallery image should be created from
    osType String
    Operating system type that the gallery image uses [Windows, Linux]
    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 string
    The name of the gallery image definition offer.
    Publisher string
    The name of the gallery image definition publisher.
    Sku string
    The name of the gallery image definition SKU.
    Offer string
    The name of the gallery image definition offer.
    Publisher string
    The name of the gallery image definition publisher.
    Sku string
    The name of the gallery image definition SKU.
    offer String
    The name of the gallery image definition offer.
    publisher String
    The name of the gallery image definition publisher.
    sku String
    The name of the gallery image definition SKU.
    offer string
    The name of the gallery image definition offer.
    publisher string
    The name of the gallery image definition publisher.
    sku string
    The name of the gallery image definition SKU.
    offer str
    The name of the gallery image definition offer.
    publisher str
    The name of the gallery image definition publisher.
    sku str
    The name of the gallery image definition SKU.
    offer String
    The name of the gallery image definition offer.
    publisher String
    The name of the gallery image definition publisher.
    sku String
    The name of the gallery image definition SKU.

    GalleryImageStatusResponse

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

    GalleryImageStatusResponseDownloadStatus

    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

    GalleryImageStatusResponseProvisioningStatus

    OperationId string
    The ID of the operation performed on the gallery image
    Status 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 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 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 string
    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 str
    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 String
    The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]

    GalleryImageVersionResponse

    StorageProfile 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 GalleryImageVersionStorageProfileResponse
    This is the storage profile of a Gallery Image Version.
    Name string
    This is the version of the gallery image.
    storageProfile GalleryImageVersionStorageProfileResponse
    This is the storage profile of a Gallery Image Version.
    name String
    This is the version of the gallery image.
    storageProfile GalleryImageVersionStorageProfileResponse
    This is the storage profile of a Gallery Image Version.
    name string
    This is the version of the gallery image.
    storage_profile GalleryImageVersionStorageProfileResponse
    This is the storage profile of a Gallery Image Version.
    name str
    This is the version of the gallery image.
    storageProfile 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 double
    This property indicates the size of the VHD to be created.
    SizeInMB float64
    This property indicates the size of the VHD to be created.
    sizeInMB Double
    This property indicates the size of the VHD to be created.
    sizeInMB number
    This property indicates the size of the VHD to be created.
    size_in_mb float
    This property indicates the size of the VHD to be created.
    sizeInMB Number
    This property indicates the size of the VHD to be created.

    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure-native