Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. labservices
  5. getGalleryImage
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.labservices.getGalleryImage

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get gallery image Azure REST API version: 2018-10-15.

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>
Copy
def get_gallery_image(expand: Optional[str] = None,
                      gallery_image_name: Optional[str] = None,
                      lab_account_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetGalleryImageResult
def get_gallery_image_output(expand: Optional[pulumi.Input[str]] = None,
                      gallery_image_name: Optional[pulumi.Input[str]] = None,
                      lab_account_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetGalleryImageResult]
Copy
func LookupGalleryImage(ctx *Context, args *LookupGalleryImageArgs, opts ...InvokeOption) (*LookupGalleryImageResult, error)
func LookupGalleryImageOutput(ctx *Context, args *LookupGalleryImageOutputArgs, opts ...InvokeOption) LookupGalleryImageResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetGalleryImageResult> getGalleryImage(GetGalleryImageArgs args, InvokeOptions options)
public static Output<GetGalleryImageResult> getGalleryImage(GetGalleryImageArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:labservices:getGalleryImage
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GalleryImageName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gallery Image.
LabAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab Account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Specify the $expand query. Example: 'properties($select=author)'
GalleryImageName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gallery Image.
LabAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab Account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Specify the $expand query. Example: 'properties($select=author)'
galleryImageName
This property is required.
Changes to this property will trigger replacement.
String
The name of the gallery Image.
labAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab Account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Specify the $expand query. Example: 'properties($select=author)'
galleryImageName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gallery Image.
labAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab Account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
expand string
Specify the $expand query. Example: 'properties($select=author)'
gallery_image_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the gallery Image.
lab_account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the lab Account.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
expand str
Specify the $expand query. Example: 'properties($select=author)'
galleryImageName
This property is required.
Changes to this property will trigger replacement.
String
The name of the gallery Image.
labAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab Account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Specify the $expand query. Example: 'properties($select=author)'

getGalleryImage Result

The following output properties are available:

Author string
The author of the gallery image.
CreatedDate string
The creation date of the gallery image.
Description string
The description of the gallery image.
Icon string
The icon of the gallery image.
Id string
The identifier of the resource.
ImageReference Pulumi.AzureNative.LabServices.Outputs.GalleryImageReferenceResponse
The image reference of the gallery image.
LatestOperationResult Pulumi.AzureNative.LabServices.Outputs.LatestOperationResultResponse
The details of the latest operation. ex: status, error
Name string
The name of the resource.
PlanId string
The third party plan that applies to this image
Type string
The type of the resource.
IsEnabled bool
Indicates whether this gallery image is enabled.
IsOverride bool
Indicates whether this gallery has been overridden for this lab account
IsPlanAuthorized bool
Indicates if the plan has been authorized for programmatic deployment.
Location string
The location of the resource.
ProvisioningState string
The provisioning status of the resource.
Tags Dictionary<string, string>
The tags of the resource.
UniqueIdentifier string
The unique immutable identifier of a resource (Guid).
Author string
The author of the gallery image.
CreatedDate string
The creation date of the gallery image.
Description string
The description of the gallery image.
Icon string
The icon of the gallery image.
Id string
The identifier of the resource.
ImageReference GalleryImageReferenceResponse
The image reference of the gallery image.
LatestOperationResult LatestOperationResultResponse
The details of the latest operation. ex: status, error
Name string
The name of the resource.
PlanId string
The third party plan that applies to this image
Type string
The type of the resource.
IsEnabled bool
Indicates whether this gallery image is enabled.
IsOverride bool
Indicates whether this gallery has been overridden for this lab account
IsPlanAuthorized bool
Indicates if the plan has been authorized for programmatic deployment.
Location string
The location of the resource.
ProvisioningState string
The provisioning status of the resource.
Tags map[string]string
The tags of the resource.
UniqueIdentifier string
The unique immutable identifier of a resource (Guid).
author String
The author of the gallery image.
createdDate String
The creation date of the gallery image.
description String
The description of the gallery image.
icon String
The icon of the gallery image.
id String
The identifier of the resource.
imageReference GalleryImageReferenceResponse
The image reference of the gallery image.
latestOperationResult LatestOperationResultResponse
The details of the latest operation. ex: status, error
name String
The name of the resource.
planId String
The third party plan that applies to this image
type String
The type of the resource.
isEnabled Boolean
Indicates whether this gallery image is enabled.
isOverride Boolean
Indicates whether this gallery has been overridden for this lab account
isPlanAuthorized Boolean
Indicates if the plan has been authorized for programmatic deployment.
location String
The location of the resource.
provisioningState String
The provisioning status of the resource.
tags Map<String,String>
The tags of the resource.
uniqueIdentifier String
The unique immutable identifier of a resource (Guid).
author string
The author of the gallery image.
createdDate string
The creation date of the gallery image.
description string
The description of the gallery image.
icon string
The icon of the gallery image.
id string
The identifier of the resource.
imageReference GalleryImageReferenceResponse
The image reference of the gallery image.
latestOperationResult LatestOperationResultResponse
The details of the latest operation. ex: status, error
name string
The name of the resource.
planId string
The third party plan that applies to this image
type string
The type of the resource.
isEnabled boolean
Indicates whether this gallery image is enabled.
isOverride boolean
Indicates whether this gallery has been overridden for this lab account
isPlanAuthorized boolean
Indicates if the plan has been authorized for programmatic deployment.
location string
The location of the resource.
provisioningState string
The provisioning status of the resource.
tags {[key: string]: string}
The tags of the resource.
uniqueIdentifier string
The unique immutable identifier of a resource (Guid).
author str
The author of the gallery image.
created_date str
The creation date of the gallery image.
description str
The description of the gallery image.
icon str
The icon of the gallery image.
id str
The identifier of the resource.
image_reference GalleryImageReferenceResponse
The image reference of the gallery image.
latest_operation_result LatestOperationResultResponse
The details of the latest operation. ex: status, error
name str
The name of the resource.
plan_id str
The third party plan that applies to this image
type str
The type of the resource.
is_enabled bool
Indicates whether this gallery image is enabled.
is_override bool
Indicates whether this gallery has been overridden for this lab account
is_plan_authorized bool
Indicates if the plan has been authorized for programmatic deployment.
location str
The location of the resource.
provisioning_state str
The provisioning status of the resource.
tags Mapping[str, str]
The tags of the resource.
unique_identifier str
The unique immutable identifier of a resource (Guid).
author String
The author of the gallery image.
createdDate String
The creation date of the gallery image.
description String
The description of the gallery image.
icon String
The icon of the gallery image.
id String
The identifier of the resource.
imageReference Property Map
The image reference of the gallery image.
latestOperationResult Property Map
The details of the latest operation. ex: status, error
name String
The name of the resource.
planId String
The third party plan that applies to this image
type String
The type of the resource.
isEnabled Boolean
Indicates whether this gallery image is enabled.
isOverride Boolean
Indicates whether this gallery has been overridden for this lab account
isPlanAuthorized Boolean
Indicates if the plan has been authorized for programmatic deployment.
location String
The location of the resource.
provisioningState String
The provisioning status of the resource.
tags Map<String>
The tags of the resource.
uniqueIdentifier String
The unique immutable identifier of a resource (Guid).

Supporting Types

GalleryImageReferenceResponse

Offer string
The offer of the gallery image.
OsType string
The OS type of the gallery image.
Publisher string
The publisher of the gallery image.
Sku string
The SKU of the gallery image.
Version string
The version of the gallery image.
Offer string
The offer of the gallery image.
OsType string
The OS type of the gallery image.
Publisher string
The publisher of the gallery image.
Sku string
The SKU of the gallery image.
Version string
The version of the gallery image.
offer String
The offer of the gallery image.
osType String
The OS type of the gallery image.
publisher String
The publisher of the gallery image.
sku String
The SKU of the gallery image.
version String
The version of the gallery image.
offer string
The offer of the gallery image.
osType string
The OS type of the gallery image.
publisher string
The publisher of the gallery image.
sku string
The SKU of the gallery image.
version string
The version of the gallery image.
offer str
The offer of the gallery image.
os_type str
The OS type of the gallery image.
publisher str
The publisher of the gallery image.
sku str
The SKU of the gallery image.
version str
The version of the gallery image.
offer String
The offer of the gallery image.
osType String
The OS type of the gallery image.
publisher String
The publisher of the gallery image.
sku String
The SKU of the gallery image.
version String
The version of the gallery image.

LatestOperationResultResponse

ErrorCode This property is required. string
Error code on failure.
ErrorMessage This property is required. string
The error message.
HttpMethod This property is required. string
The HttpMethod - PUT/POST/DELETE for the operation.
OperationUrl This property is required. string
The URL to use to check long-running operation status
RequestUri This property is required. string
Request URI of the operation.
Status This property is required. string
The current status of the operation.
ErrorCode This property is required. string
Error code on failure.
ErrorMessage This property is required. string
The error message.
HttpMethod This property is required. string
The HttpMethod - PUT/POST/DELETE for the operation.
OperationUrl This property is required. string
The URL to use to check long-running operation status
RequestUri This property is required. string
Request URI of the operation.
Status This property is required. string
The current status of the operation.
errorCode This property is required. String
Error code on failure.
errorMessage This property is required. String
The error message.
httpMethod This property is required. String
The HttpMethod - PUT/POST/DELETE for the operation.
operationUrl This property is required. String
The URL to use to check long-running operation status
requestUri This property is required. String
Request URI of the operation.
status This property is required. String
The current status of the operation.
errorCode This property is required. string
Error code on failure.
errorMessage This property is required. string
The error message.
httpMethod This property is required. string
The HttpMethod - PUT/POST/DELETE for the operation.
operationUrl This property is required. string
The URL to use to check long-running operation status
requestUri This property is required. string
Request URI of the operation.
status This property is required. string
The current status of the operation.
error_code This property is required. str
Error code on failure.
error_message This property is required. str
The error message.
http_method This property is required. str
The HttpMethod - PUT/POST/DELETE for the operation.
operation_url This property is required. str
The URL to use to check long-running operation status
request_uri This property is required. str
Request URI of the operation.
status This property is required. str
The current status of the operation.
errorCode This property is required. String
Error code on failure.
errorMessage This property is required. String
The error message.
httpMethod This property is required. String
The HttpMethod - PUT/POST/DELETE for the operation.
operationUrl This property is required. String
The URL to use to check long-running operation status
requestUri This property is required. String
Request URI of the operation.
status This property is required. String
The current status of the operation.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native