1. Packages
  2. Azure Native v2
  3. API Docs
  4. compute
  5. getGalleryApplication
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

azure-native-v2.compute.getGalleryApplication

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

Retrieves information about a gallery Application Definition. Azure REST API version: 2022-03-03.

Other available API versions: 2022-08-03, 2023-07-03, 2024-03-03.

Using getGalleryApplication

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 getGalleryApplication(args: GetGalleryApplicationArgs, opts?: InvokeOptions): Promise<GetGalleryApplicationResult>
function getGalleryApplicationOutput(args: GetGalleryApplicationOutputArgs, opts?: InvokeOptions): Output<GetGalleryApplicationResult>
Copy
def get_gallery_application(gallery_application_name: Optional[str] = None,
                            gallery_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetGalleryApplicationResult
def get_gallery_application_output(gallery_application_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[GetGalleryApplicationResult]
Copy
func LookupGalleryApplication(ctx *Context, args *LookupGalleryApplicationArgs, opts ...InvokeOption) (*LookupGalleryApplicationResult, error)
func LookupGalleryApplicationOutput(ctx *Context, args *LookupGalleryApplicationOutputArgs, opts ...InvokeOption) LookupGalleryApplicationResultOutput
Copy

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

public static class GetGalleryApplication 
{
    public static Task<GetGalleryApplicationResult> InvokeAsync(GetGalleryApplicationArgs args, InvokeOptions? opts = null)
    public static Output<GetGalleryApplicationResult> Invoke(GetGalleryApplicationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGalleryApplicationResult> getGalleryApplication(GetGalleryApplicationArgs args, InvokeOptions options)
public static Output<GetGalleryApplicationResult> getGalleryApplication(GetGalleryApplicationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:compute:getGalleryApplication
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GalleryApplicationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gallery Application Definition to be retrieved.
GalleryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Shared Application Gallery from which the Application Definitions are to be retrieved.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
GalleryApplicationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gallery Application Definition to be retrieved.
GalleryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Shared Application Gallery from which the Application Definitions are to be retrieved.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
galleryApplicationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the gallery Application Definition to be retrieved.
galleryName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Shared Application Gallery from which the Application Definitions are to be retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
galleryApplicationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gallery Application Definition to be retrieved.
galleryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Shared Application Gallery from which the Application Definitions are to be retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
gallery_application_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the gallery Application Definition to be retrieved.
gallery_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Shared Application Gallery from which the Application Definitions are to be retrieved.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
galleryApplicationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the gallery Application Definition to be retrieved.
galleryName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Shared Application Gallery from which the Application Definitions are to be retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getGalleryApplication Result

The following output properties are available:

Id string
Resource Id
Location string
Resource location
Name string
Resource name
SupportedOSType string
This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows Linux
Type string
Resource type
CustomActions List<Pulumi.AzureNative.Compute.Outputs.GalleryApplicationCustomActionResponse>
A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
Description string
The description of this gallery Application Definition resource. This property is updatable.
EndOfLifeDate string
The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
Eula string
The Eula agreement for the gallery Application Definition.
PrivacyStatementUri string
The privacy statement uri.
ReleaseNoteUri string
The release note uri.
Tags Dictionary<string, string>
Resource tags
Id string
Resource Id
Location string
Resource location
Name string
Resource name
SupportedOSType string
This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows Linux
Type string
Resource type
CustomActions []GalleryApplicationCustomActionResponse
A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
Description string
The description of this gallery Application Definition resource. This property is updatable.
EndOfLifeDate string
The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
Eula string
The Eula agreement for the gallery Application Definition.
PrivacyStatementUri string
The privacy statement uri.
ReleaseNoteUri string
The release note uri.
Tags map[string]string
Resource tags
id String
Resource Id
location String
Resource location
name String
Resource name
supportedOSType String
This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows Linux
type String
Resource type
customActions List<GalleryApplicationCustomActionResponse>
A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
description String
The description of this gallery Application Definition resource. This property is updatable.
endOfLifeDate String
The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
eula String
The Eula agreement for the gallery Application Definition.
privacyStatementUri String
The privacy statement uri.
releaseNoteUri String
The release note uri.
tags Map<String,String>
Resource tags
id string
Resource Id
location string
Resource location
name string
Resource name
supportedOSType string
This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows Linux
type string
Resource type
customActions GalleryApplicationCustomActionResponse[]
A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
description string
The description of this gallery Application Definition resource. This property is updatable.
endOfLifeDate string
The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
eula string
The Eula agreement for the gallery Application Definition.
privacyStatementUri string
The privacy statement uri.
releaseNoteUri string
The release note uri.
tags {[key: string]: string}
Resource tags
id str
Resource Id
location str
Resource location
name str
Resource name
supported_os_type str
This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows Linux
type str
Resource type
custom_actions Sequence[GalleryApplicationCustomActionResponse]
A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
description str
The description of this gallery Application Definition resource. This property is updatable.
end_of_life_date str
The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
eula str
The Eula agreement for the gallery Application Definition.
privacy_statement_uri str
The privacy statement uri.
release_note_uri str
The release note uri.
tags Mapping[str, str]
Resource tags
id String
Resource Id
location String
Resource location
name String
Resource name
supportedOSType String
This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows Linux
type String
Resource type
customActions List<Property Map>
A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
description String
The description of this gallery Application Definition resource. This property is updatable.
endOfLifeDate String
The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
eula String
The Eula agreement for the gallery Application Definition.
privacyStatementUri String
The privacy statement uri.
releaseNoteUri String
The release note uri.
tags Map<String>
Resource tags

Supporting Types

GalleryApplicationCustomActionParameterResponse

Name This property is required. string
The name of the custom action. Must be unique within the Gallery Application Version.
DefaultValue string
The default value of the parameter. Only applies to string types
Description string
A description to help users understand what this parameter means
Required bool
Indicates whether this parameter must be passed when running the custom action.
Type string
Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob
Name This property is required. string
The name of the custom action. Must be unique within the Gallery Application Version.
DefaultValue string
The default value of the parameter. Only applies to string types
Description string
A description to help users understand what this parameter means
Required bool
Indicates whether this parameter must be passed when running the custom action.
Type string
Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob
name This property is required. String
The name of the custom action. Must be unique within the Gallery Application Version.
defaultValue String
The default value of the parameter. Only applies to string types
description String
A description to help users understand what this parameter means
required Boolean
Indicates whether this parameter must be passed when running the custom action.
type String
Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob
name This property is required. string
The name of the custom action. Must be unique within the Gallery Application Version.
defaultValue string
The default value of the parameter. Only applies to string types
description string
A description to help users understand what this parameter means
required boolean
Indicates whether this parameter must be passed when running the custom action.
type string
Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob
name This property is required. str
The name of the custom action. Must be unique within the Gallery Application Version.
default_value str
The default value of the parameter. Only applies to string types
description str
A description to help users understand what this parameter means
required bool
Indicates whether this parameter must be passed when running the custom action.
type str
Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob
name This property is required. String
The name of the custom action. Must be unique within the Gallery Application Version.
defaultValue String
The default value of the parameter. Only applies to string types
description String
A description to help users understand what this parameter means
required Boolean
Indicates whether this parameter must be passed when running the custom action.
type String
Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob

GalleryApplicationCustomActionResponse

Name This property is required. string
The name of the custom action. Must be unique within the Gallery Application Version.
Script This property is required. string
The script to run when executing this custom action.
Description string
Description to help the users understand what this custom action does.
Parameters List<Pulumi.AzureNative.Compute.Inputs.GalleryApplicationCustomActionParameterResponse>
The parameters that this custom action uses
Name This property is required. string
The name of the custom action. Must be unique within the Gallery Application Version.
Script This property is required. string
The script to run when executing this custom action.
Description string
Description to help the users understand what this custom action does.
Parameters []GalleryApplicationCustomActionParameterResponse
The parameters that this custom action uses
name This property is required. String
The name of the custom action. Must be unique within the Gallery Application Version.
script This property is required. String
The script to run when executing this custom action.
description String
Description to help the users understand what this custom action does.
parameters List<GalleryApplicationCustomActionParameterResponse>
The parameters that this custom action uses
name This property is required. string
The name of the custom action. Must be unique within the Gallery Application Version.
script This property is required. string
The script to run when executing this custom action.
description string
Description to help the users understand what this custom action does.
parameters GalleryApplicationCustomActionParameterResponse[]
The parameters that this custom action uses
name This property is required. str
The name of the custom action. Must be unique within the Gallery Application Version.
script This property is required. str
The script to run when executing this custom action.
description str
Description to help the users understand what this custom action does.
parameters Sequence[GalleryApplicationCustomActionParameterResponse]
The parameters that this custom action uses
name This property is required. String
The name of the custom action. Must be unique within the Gallery Application Version.
script This property is required. String
The script to run when executing this custom action.
description String
Description to help the users understand what this custom action does.
parameters List<Property Map>
The parameters that this custom action uses

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