Azure Native v1.102.0, May 2 23

azure-native.compute.getGalleryImage

Explore with Pulumi AI

Retrieves information about a gallery image definition. API Version: 2020-09-30.

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: Optional[pulumi.Input[str]] = None,
                      gallery_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:compute:getGalleryImage
  arguments:
    # arguments dictionary

The following arguments are supported:

GalleryImageName string: The name of the gallery image definition to be retrieved.
GalleryName string: The name of the Shared Image Gallery from which the Image Definitions are to be retrieved.
ResourceGroupName string: The name of the resource group.

GalleryImageName string: The name of the gallery image definition to be retrieved.
GalleryName string: The name of the Shared Image Gallery from which the Image Definitions are to be retrieved.
ResourceGroupName string: The name of the resource group.

galleryImageName String: The name of the gallery image definition to be retrieved.
galleryName String: The name of the Shared Image Gallery from which the Image Definitions are to be retrieved.
resourceGroupName String: The name of the resource group.

galleryImageName string: The name of the gallery image definition to be retrieved.
galleryName string: The name of the Shared Image Gallery from which the Image Definitions are to be retrieved.
resourceGroupName string: The name of the resource group.

gallery_image_name str: The name of the gallery image definition to be retrieved.
gallery_name str: The name of the Shared Image Gallery from which the Image Definitions are to be retrieved.
resource_group_name str: The name of the resource group.

galleryImageName String: The name of the gallery image definition to be retrieved.
galleryName String: The name of the Shared Image Gallery from which the Image Definitions are to be retrieved.
resourceGroupName String: The name of the resource group.

getGalleryImage Result

The following output properties are available:

Id string: Resource Id
Identifier Pulumi.AzureNative.Compute.Outputs.GalleryImageIdentifierResponse: This is the gallery image definition identifier.
Location string: Resource location
Name string: Resource name
OsState string: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
OsType 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
ProvisioningState string: The provisioning state, which only appears in the response.
Type string: Resource type
Description string: The description of this gallery image definition resource. This property is updatable.
Disallowed Pulumi.AzureNative.Compute.Outputs.DisallowedResponse: Describes the disallowed disk types.
EndOfLifeDate string: 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.AzureNative.Compute.Outputs.GalleryImageFeatureResponse>: A list of gallery image features.
HyperVGeneration string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
PrivacyStatementUri string: The privacy statement uri.
PurchasePlan Pulumi.AzureNative.Compute.Outputs.ImagePurchasePlanResponse: Describes the gallery image definition purchase plan. This is used by marketplace images.
Recommended Pulumi.AzureNative.Compute.Outputs.RecommendedMachineConfigurationResponse: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
ReleaseNoteUri string: The release note uri.
Tags Dictionary<string, string>: Resource tags

Id string: Resource Id
Identifier GalleryImageIdentifierResponse: This is the gallery image definition identifier.
Location string: Resource location
Name string: Resource name
OsState string: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
OsType 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
ProvisioningState string: The provisioning state, which only appears in the response.
Type string: Resource type
Description string: The description of this gallery image definition resource. This property is updatable.
Disallowed DisallowedResponse: Describes the disallowed disk types.
EndOfLifeDate string: 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 []GalleryImageFeatureResponse: A list of gallery image features.
HyperVGeneration string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
PrivacyStatementUri string: The privacy statement uri.
PurchasePlan ImagePurchasePlanResponse: Describes the gallery image definition purchase plan. This is used by marketplace images.
Recommended RecommendedMachineConfigurationResponse: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
ReleaseNoteUri string: The release note uri.
Tags map[string]string: Resource tags

id String: Resource Id
identifier GalleryImageIdentifierResponse: This is the gallery image definition identifier.
location String: Resource location
name String: Resource name
osState String: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
osType 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
provisioningState String: The provisioning state, which only appears in the response.
type String: Resource type
description String: The description of this gallery image definition resource. This property is updatable.
disallowed DisallowedResponse: Describes the disallowed disk types.
endOfLifeDate String: 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<GalleryImageFeatureResponse>: A list of gallery image features.
hyperVGeneration String: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
privacyStatementUri String: The privacy statement uri.
purchasePlan ImagePurchasePlanResponse: Describes the gallery image definition purchase plan. This is used by marketplace images.
recommended RecommendedMachineConfigurationResponse: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
releaseNoteUri String: The release note uri.
tags Map<String,String>: Resource tags

id string: Resource Id
identifier GalleryImageIdentifierResponse: This is the gallery image definition identifier.
location string: Resource location
name string: Resource name
osState string: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
osType 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
provisioningState string: The provisioning state, which only appears in the response.
type string: Resource type
description string: The description of this gallery image definition resource. This property is updatable.
disallowed DisallowedResponse: Describes the disallowed disk types.
endOfLifeDate string: 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 GalleryImageFeatureResponse[]: A list of gallery image features.
hyperVGeneration string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
privacyStatementUri string: The privacy statement uri.
purchasePlan ImagePurchasePlanResponse: Describes the gallery image definition purchase plan. This is used by marketplace images.
recommended RecommendedMachineConfigurationResponse: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
releaseNoteUri string: The release note uri.
tags {[key: string]: string}: Resource tags

id str: Resource Id
identifier GalleryImageIdentifierResponse: This is the gallery image definition identifier.
location str: Resource location
name str: Resource name
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.
type str: Resource type
description str: The description of this gallery image definition resource. This property is updatable.
disallowed DisallowedResponse: Describes the disallowed disk types.
end_of_life_date str: 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[GalleryImageFeatureResponse]: A list of gallery image features.
hyper_v_generation str: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
privacy_statement_uri str: The privacy statement uri.
purchase_plan ImagePurchasePlanResponse: Describes the gallery image definition purchase plan. This is used by marketplace images.
recommended RecommendedMachineConfigurationResponse: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
release_note_uri str: The release note uri.
tags Mapping[str, str]: Resource tags

id String: Resource Id
identifier Property Map: This is the gallery image definition identifier.
location String: Resource location
name String: Resource name
osState String: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.
osType 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
provisioningState String: The provisioning state, which only appears in the response.
type String: Resource type
description String: The description of this gallery image definition resource. This property is updatable.
disallowed Property Map: Describes the disallowed disk types.
endOfLifeDate String: 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.
hyperVGeneration String: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
privacyStatementUri String: The privacy statement uri.
purchasePlan 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.
releaseNoteUri String: The release note uri.
tags Map<String>: Resource tags

Supporting Types

DisallowedResponse

DiskTypes List<string>: A list of disk types.

DiskTypes []string: A list of disk types.

diskTypes List<String>: A list of disk types.

diskTypes string[]: A list of disk types.

disk_types Sequence[str]: A list of disk types.

diskTypes List<String>: A list of disk types.

GalleryImageFeatureResponse

Name string: The name of the gallery image feature.
Value string: The value of the gallery image feature.

Name string: The name of the gallery image feature.
Value string: The value of the gallery image feature.

name String: The name of the gallery image feature.
value String: The value of the gallery image feature.

name string: The name of the gallery image feature.
value string: The value of the gallery image feature.

name str: The name of the gallery image feature.
value str: The value of the gallery image feature.

name String: The name of the gallery image feature.
value String: The value of the gallery image feature.

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.

ImagePurchasePlanResponse

Name string: The plan ID.
Product string: The product ID.
Publisher string: The publisher ID.

Name string: The plan ID.
Product string: The product ID.
Publisher string: The publisher ID.

name String: The plan ID.
product String: The product ID.
publisher String: The publisher ID.

name string: The plan ID.
product string: The product ID.
publisher string: The publisher ID.

name str: The plan ID.
product str: The product ID.
publisher str: The publisher ID.

name String: The plan ID.
product String: The product ID.
publisher String: The publisher ID.

RecommendedMachineConfigurationResponse

Memory Pulumi.AzureNative.Compute.Inputs.ResourceRangeResponse: Describes the resource range.
VCPUs Pulumi.AzureNative.Compute.Inputs.ResourceRangeResponse: Describes the resource range.

Memory ResourceRangeResponse: Describes the resource range.
VCPUs ResourceRangeResponse: Describes the resource range.

memory ResourceRangeResponse: Describes the resource range.
vCPUs ResourceRangeResponse: Describes the resource range.

memory ResourceRangeResponse: Describes the resource range.
vCPUs ResourceRangeResponse: Describes the resource range.

memory ResourceRangeResponse: Describes the resource range.
v_cpus ResourceRangeResponse: Describes the resource range.

memory Property Map: Describes the resource range.
vCPUs Property Map: Describes the resource range.

ResourceRangeResponse

Max int: The maximum number of the resource.
Min int: The minimum number of the resource.

Max int: The maximum number of the resource.
Min int: The minimum number of the resource.

max Integer: The maximum number of the resource.
min Integer: The minimum number of the resource.

max number: The maximum number of the resource.
min number: The minimum number of the resource.

max int: The maximum number of the resource.
min int: The minimum number of the resource.

max Number: The maximum number of the resource.
min Number: The minimum number of the resource.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0