Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. compute
  5. getGallery
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
pulumi/pulumi-azure-native

azure-native.compute.getGallery

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
pulumi/pulumi-azure-native

Retrieves information about a Shared Image Gallery.

Uses Azure REST API version 2024-03-03.

Other available API versions: 2022-03-03, 2022-08-03, 2023-07-03. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native compute [ApiVersion]. See the version guide for details.

Using getGallery

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 getGallery(args: GetGalleryArgs, opts?: InvokeOptions): Promise<GetGalleryResult>
function getGalleryOutput(args: GetGalleryOutputArgs, opts?: InvokeOptions): Output<GetGalleryResult>
Copy
def get_gallery(expand: Optional[str] = None,
                gallery_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                select: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGalleryResult
def get_gallery_output(expand: Optional[pulumi.Input[str]] = None,
                gallery_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                select: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGalleryResult]
Copy
func LookupGallery(ctx *Context, args *LookupGalleryArgs, opts ...InvokeOption) (*LookupGalleryResult, error)
func LookupGalleryOutput(ctx *Context, args *LookupGalleryOutputArgs, opts ...InvokeOption) LookupGalleryResultOutput
Copy

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

public static class GetGallery 
{
    public static Task<GetGalleryResult> InvokeAsync(GetGalleryArgs args, InvokeOptions? opts = null)
    public static Output<GetGalleryResult> Invoke(GetGalleryInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGalleryResult> getGallery(GetGalleryArgs args, InvokeOptions options)
public static Output<GetGalleryResult> getGallery(GetGalleryArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:compute:getGallery
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GalleryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Shared Image Gallery.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
The expand query option to apply on the operation.
Select string
The select expression to apply on the operation.
GalleryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Shared Image Gallery.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
The expand query option to apply on the operation.
Select string
The select expression to apply on the operation.
galleryName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Shared Image Gallery.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
The expand query option to apply on the operation.
select String
The select expression to apply on the operation.
galleryName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Shared Image Gallery.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
expand string
The expand query option to apply on the operation.
select string
The select expression to apply on the operation.
gallery_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Shared Image Gallery.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
expand str
The expand query option to apply on the operation.
select str
The select expression to apply on the operation.
galleryName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Shared Image Gallery.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
The expand query option to apply on the operation.
select String
The select expression to apply on the operation.

getGallery Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id
Location string
Resource location
Name string
Resource name
ProvisioningState string
The provisioning state, which only appears in the response.
SharingStatus Pulumi.AzureNative.Compute.Outputs.SharingStatusResponse
Sharing status of current gallery.
Type string
Resource type
Description string
The description of this Shared Image Gallery resource. This property is updatable.
Identifier Pulumi.AzureNative.Compute.Outputs.GalleryIdentifierResponse
Describes the gallery unique name.
Identity Pulumi.AzureNative.Compute.Outputs.GalleryIdentityResponse
The identity of the gallery, if configured.
SharingProfile Pulumi.AzureNative.Compute.Outputs.SharingProfileResponse
Profile for gallery sharing to subscription or tenant
SoftDeletePolicy Pulumi.AzureNative.Compute.Outputs.SoftDeletePolicyResponse
Contains information about the soft deletion policy of the gallery.
Tags Dictionary<string, string>
Resource tags
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id
Location string
Resource location
Name string
Resource name
ProvisioningState string
The provisioning state, which only appears in the response.
SharingStatus SharingStatusResponse
Sharing status of current gallery.
Type string
Resource type
Description string
The description of this Shared Image Gallery resource. This property is updatable.
Identifier GalleryIdentifierResponse
Describes the gallery unique name.
Identity GalleryIdentityResponse
The identity of the gallery, if configured.
SharingProfile SharingProfileResponse
Profile for gallery sharing to subscription or tenant
SoftDeletePolicy SoftDeletePolicyResponse
Contains information about the soft deletion policy of the gallery.
Tags map[string]string
Resource tags
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id
location String
Resource location
name String
Resource name
provisioningState String
The provisioning state, which only appears in the response.
sharingStatus SharingStatusResponse
Sharing status of current gallery.
type String
Resource type
description String
The description of this Shared Image Gallery resource. This property is updatable.
identifier GalleryIdentifierResponse
Describes the gallery unique name.
identity GalleryIdentityResponse
The identity of the gallery, if configured.
sharingProfile SharingProfileResponse
Profile for gallery sharing to subscription or tenant
softDeletePolicy SoftDeletePolicyResponse
Contains information about the soft deletion policy of the gallery.
tags Map<String,String>
Resource tags
azureApiVersion string
The Azure API version of the resource.
id string
Resource Id
location string
Resource location
name string
Resource name
provisioningState string
The provisioning state, which only appears in the response.
sharingStatus SharingStatusResponse
Sharing status of current gallery.
type string
Resource type
description string
The description of this Shared Image Gallery resource. This property is updatable.
identifier GalleryIdentifierResponse
Describes the gallery unique name.
identity GalleryIdentityResponse
The identity of the gallery, if configured.
sharingProfile SharingProfileResponse
Profile for gallery sharing to subscription or tenant
softDeletePolicy SoftDeletePolicyResponse
Contains information about the soft deletion policy of the gallery.
tags {[key: string]: string}
Resource tags
azure_api_version str
The Azure API version of the resource.
id str
Resource Id
location str
Resource location
name str
Resource name
provisioning_state str
The provisioning state, which only appears in the response.
sharing_status SharingStatusResponse
Sharing status of current gallery.
type str
Resource type
description str
The description of this Shared Image Gallery resource. This property is updatable.
identifier GalleryIdentifierResponse
Describes the gallery unique name.
identity GalleryIdentityResponse
The identity of the gallery, if configured.
sharing_profile SharingProfileResponse
Profile for gallery sharing to subscription or tenant
soft_delete_policy SoftDeletePolicyResponse
Contains information about the soft deletion policy of the gallery.
tags Mapping[str, str]
Resource tags
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id
location String
Resource location
name String
Resource name
provisioningState String
The provisioning state, which only appears in the response.
sharingStatus Property Map
Sharing status of current gallery.
type String
Resource type
description String
The description of this Shared Image Gallery resource. This property is updatable.
identifier Property Map
Describes the gallery unique name.
identity Property Map
The identity of the gallery, if configured.
sharingProfile Property Map
Profile for gallery sharing to subscription or tenant
softDeletePolicy Property Map
Contains information about the soft deletion policy of the gallery.
tags Map<String>
Resource tags

Supporting Types

CommunityGalleryInfoResponse

CommunityGalleryEnabled This property is required. bool
Contains info about whether community gallery sharing is enabled.
PublicNames This property is required. List<string>
Community gallery public name list.
Eula string
End-user license agreement for community gallery image.
PublicNamePrefix string
The prefix of the gallery name that will be displayed publicly. Visible to all users.
PublisherContact string
Community gallery publisher support email. The email address of the publisher. Visible to all users.
PublisherUri string
The link to the publisher website. Visible to all users.
CommunityGalleryEnabled This property is required. bool
Contains info about whether community gallery sharing is enabled.
PublicNames This property is required. []string
Community gallery public name list.
Eula string
End-user license agreement for community gallery image.
PublicNamePrefix string
The prefix of the gallery name that will be displayed publicly. Visible to all users.
PublisherContact string
Community gallery publisher support email. The email address of the publisher. Visible to all users.
PublisherUri string
The link to the publisher website. Visible to all users.
communityGalleryEnabled This property is required. Boolean
Contains info about whether community gallery sharing is enabled.
publicNames This property is required. List<String>
Community gallery public name list.
eula String
End-user license agreement for community gallery image.
publicNamePrefix String
The prefix of the gallery name that will be displayed publicly. Visible to all users.
publisherContact String
Community gallery publisher support email. The email address of the publisher. Visible to all users.
publisherUri String
The link to the publisher website. Visible to all users.
communityGalleryEnabled This property is required. boolean
Contains info about whether community gallery sharing is enabled.
publicNames This property is required. string[]
Community gallery public name list.
eula string
End-user license agreement for community gallery image.
publicNamePrefix string
The prefix of the gallery name that will be displayed publicly. Visible to all users.
publisherContact string
Community gallery publisher support email. The email address of the publisher. Visible to all users.
publisherUri string
The link to the publisher website. Visible to all users.
community_gallery_enabled This property is required. bool
Contains info about whether community gallery sharing is enabled.
public_names This property is required. Sequence[str]
Community gallery public name list.
eula str
End-user license agreement for community gallery image.
public_name_prefix str
The prefix of the gallery name that will be displayed publicly. Visible to all users.
publisher_contact str
Community gallery publisher support email. The email address of the publisher. Visible to all users.
publisher_uri str
The link to the publisher website. Visible to all users.
communityGalleryEnabled This property is required. Boolean
Contains info about whether community gallery sharing is enabled.
publicNames This property is required. List<String>
Community gallery public name list.
eula String
End-user license agreement for community gallery image.
publicNamePrefix String
The prefix of the gallery name that will be displayed publicly. Visible to all users.
publisherContact String
Community gallery publisher support email. The email address of the publisher. Visible to all users.
publisherUri String
The link to the publisher website. Visible to all users.

GalleryIdentifierResponse

UniqueName This property is required. string
The unique name of the Shared Image Gallery. This name is generated automatically by Azure.
UniqueName This property is required. string
The unique name of the Shared Image Gallery. This name is generated automatically by Azure.
uniqueName This property is required. String
The unique name of the Shared Image Gallery. This name is generated automatically by Azure.
uniqueName This property is required. string
The unique name of the Shared Image Gallery. This name is generated automatically by Azure.
unique_name This property is required. str
The unique name of the Shared Image Gallery. This name is generated automatically by Azure.
uniqueName This property is required. String
The unique name of the Shared Image Gallery. This name is generated automatically by Azure.

GalleryIdentityResponse

PrincipalId This property is required. string
The principal id of the gallery identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity.
Type string
The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Compute.Inputs.UserAssignedIdentitiesResponseUserAssignedIdentities>
The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
PrincipalId This property is required. string
The principal id of the gallery identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity.
Type string
The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery.
UserAssignedIdentities map[string]UserAssignedIdentitiesResponseUserAssignedIdentities
The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. String
The principal id of the gallery identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity.
type String
The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery.
userAssignedIdentities Map<String,UserAssignedIdentitiesResponseUserAssignedIdentities>
The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. string
The principal id of the gallery identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity.
type string
The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery.
userAssignedIdentities {[key: string]: UserAssignedIdentitiesResponseUserAssignedIdentities}
The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principal_id This property is required. str
The principal id of the gallery identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity.
type str
The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery.
user_assigned_identities Mapping[str, UserAssignedIdentitiesResponseUserAssignedIdentities]
The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. String
The principal id of the gallery identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity.
type String
The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery.
userAssignedIdentities Map<Property Map>
The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

RegionalSharingStatusResponse

State This property is required. string
Gallery sharing state in current region
Details string
Details of gallery regional sharing failure.
Region string
Region name
State This property is required. string
Gallery sharing state in current region
Details string
Details of gallery regional sharing failure.
Region string
Region name
state This property is required. String
Gallery sharing state in current region
details String
Details of gallery regional sharing failure.
region String
Region name
state This property is required. string
Gallery sharing state in current region
details string
Details of gallery regional sharing failure.
region string
Region name
state This property is required. str
Gallery sharing state in current region
details str
Details of gallery regional sharing failure.
region str
Region name
state This property is required. String
Gallery sharing state in current region
details String
Details of gallery regional sharing failure.
region String
Region name

SharingProfileGroupResponse

Ids List<string>
A list of subscription/tenant ids the gallery is aimed to be shared to.
Type string
This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants.
Ids []string
A list of subscription/tenant ids the gallery is aimed to be shared to.
Type string
This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants.
ids List<String>
A list of subscription/tenant ids the gallery is aimed to be shared to.
type String
This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants.
ids string[]
A list of subscription/tenant ids the gallery is aimed to be shared to.
type string
This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants.
ids Sequence[str]
A list of subscription/tenant ids the gallery is aimed to be shared to.
type str
This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants.
ids List<String>
A list of subscription/tenant ids the gallery is aimed to be shared to.
type String
This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants.

SharingProfileResponse

Groups This property is required. List<Pulumi.AzureNative.Compute.Inputs.SharingProfileGroupResponse>
A list of sharing profile groups.
CommunityGalleryInfo Pulumi.AzureNative.Compute.Inputs.CommunityGalleryInfoResponse
Information of community gallery if current gallery is shared to community.
Permissions string
This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community.
Groups This property is required. []SharingProfileGroupResponse
A list of sharing profile groups.
CommunityGalleryInfo CommunityGalleryInfoResponse
Information of community gallery if current gallery is shared to community.
Permissions string
This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community.
groups This property is required. List<SharingProfileGroupResponse>
A list of sharing profile groups.
communityGalleryInfo CommunityGalleryInfoResponse
Information of community gallery if current gallery is shared to community.
permissions String
This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community.
groups This property is required. SharingProfileGroupResponse[]
A list of sharing profile groups.
communityGalleryInfo CommunityGalleryInfoResponse
Information of community gallery if current gallery is shared to community.
permissions string
This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community.
groups This property is required. Sequence[SharingProfileGroupResponse]
A list of sharing profile groups.
community_gallery_info CommunityGalleryInfoResponse
Information of community gallery if current gallery is shared to community.
permissions str
This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community.
groups This property is required. List<Property Map>
A list of sharing profile groups.
communityGalleryInfo Property Map
Information of community gallery if current gallery is shared to community.
permissions String
This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community.

SharingStatusResponse

AggregatedState This property is required. string
Aggregated sharing state of current gallery.
Summary List<Pulumi.AzureNative.Compute.Inputs.RegionalSharingStatusResponse>
Summary of all regional sharing status.
AggregatedState This property is required. string
Aggregated sharing state of current gallery.
Summary []RegionalSharingStatusResponse
Summary of all regional sharing status.
aggregatedState This property is required. String
Aggregated sharing state of current gallery.
summary List<RegionalSharingStatusResponse>
Summary of all regional sharing status.
aggregatedState This property is required. string
Aggregated sharing state of current gallery.
summary RegionalSharingStatusResponse[]
Summary of all regional sharing status.
aggregated_state This property is required. str
Aggregated sharing state of current gallery.
summary Sequence[RegionalSharingStatusResponse]
Summary of all regional sharing status.
aggregatedState This property is required. String
Aggregated sharing state of current gallery.
summary List<Property Map>
Summary of all regional sharing status.

SoftDeletePolicyResponse

IsSoftDeleteEnabled bool
Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
IsSoftDeleteEnabled bool
Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
isSoftDeleteEnabled Boolean
Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
isSoftDeleteEnabled boolean
Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
is_soft_delete_enabled bool
Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
isSoftDeleteEnabled Boolean
Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.

UserAssignedIdentitiesResponseUserAssignedIdentities

ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.
clientId This property is required. string
The client id of user assigned identity.
principalId This property is required. string
The principal id of user assigned identity.
client_id This property is required. str
The client id of user assigned identity.
principal_id This property is required. str
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.

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
pulumi/pulumi-azure-native