Update-AzGallery

Module:

Az.Compute

Update a gallery.

Syntax

Update-AzGallery
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-AsJob]
      [-Description <String>]
      [-Tag <Hashtable>]
      [-Permission <String>]
      [-Subscription <String[]>]
      [-Tenant <String[]>]
      [-RemoveSubscription <String[]>]
      [-RemoveTenant <String[]>]
      [-Share]
      [-Community]
      [-Reset]
      [-PublisherUri <String>]
      [-PublisherContact <String>]
      [-Eula <String>]
      [-PublicNamePrefix <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzGallery
      [-ResourceId] <String>
      [-AsJob]
      [-Description <String>]
      [-Tag <Hashtable>]
      [-Permission <String>]
      [-Subscription <String[]>]
      [-Tenant <String[]>]
      [-RemoveSubscription <String[]>]
      [-RemoveTenant <String[]>]
      [-Share]
      [-Community]
      [-Reset]
      [-PublisherUri <String>]
      [-PublisherContact <String>]
      [-Eula <String>]
      [-PublicNamePrefix <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzGallery
      [-InputObject] <PSGallery>
      [-AsJob]
      [-Description <String>]
      [-Tag <Hashtable>]
      [-Permission <String>]
      [-Subscription <String[]>]
      [-Tenant <String[]>]
      [-RemoveSubscription <String[]>]
      [-RemoveTenant <String[]>]
      [-Share]
      [-Community]
      [-Reset]
      [-PublisherUri <String>]
      [-PublisherContact <String>]
      [-Eula <String>]
      [-PublicNamePrefix <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update a gallery.

Examples

Example 1

Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -Description $galleryDescription

Update a gallery.

Example 2

Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -Permission Groups -Share -Tenant xxxxxxxx-xxx-xxxxxxx,zzzzzz-zzzzzzz-zzzzzz

Update a gallery to be shared and add two subscriptions it is to be shared with.

Parameters

-AsJob

Run cmdlet in the background

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Community

Update sharing profile of the gallery to community.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

The description of the gallery resource.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Eula

Gets or sets end-user license agreement for community gallery image.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

The PS Gallery Object.

Type:	PSGallery
Aliases:	Gallery
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the gallery.

Type:	String
Aliases:	GalleryName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Permission

This property allows you to specify the permission of the sharing gallery. Possible values are: 'Private' and 'Groups'.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PublicNamePrefix

Gets or sets the prefix of the gallery name that will be displayed publicly. Visible to all users.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PublisherContact

Gets or sets community gallery publisher support email. The email address of the publisher. Visible to all users.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PublisherUri

Gets or sets the link to the publisher website. Visible to all users.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-RemoveSubscription

A list of subscription IDs the gallery will stop sharing to.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-RemoveTenant

A list of tenant IDs the gallery will stop sharing to.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Reset

Resets the sharing permission of the gallery to 'Private'.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

The resource Id for the gallery

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Share

Update sharing profile of the gallery.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Subscription

A list of subscription IDs the gallery is aimed to be shared to.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

Resource tags

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Tenant

A list of tenant IDs the gallery is aimed to be shared to.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

PSGallery

Hashtable

Outputs

PSGallery