PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/?api-version=2022-08-03
Update a Shared Image Gallery.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
galleryName |
String | Yes |
The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. |
subscriptionId |
String | Yes |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
resourceGroupName |
String | Yes |
The name of the resource group. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id |
name |
String | No |
Resource name |
properties |
Object | No |
Describes the properties of a Shared Image Gallery. |
properties.softDeletePolicy |
Object | No |
Contains information about the soft deletion policy of the gallery. |
properties.softDeletePolicy.isSoftDeleteEnabled |
Boolean | No |
Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. |
properties.description |
String | No |
The description of this Shared Image Gallery resource. This property is updatable. |
properties.identifier |
Object | No |
Describes the gallery unique name. |
properties.identifier.uniqueName |
String | No |
The unique name of the Shared Image Gallery. This name is generated automatically by Azure. |
properties.provisioningState |
String | No |
The provisioning state, which only appears in the response. Possible values:
|
properties.sharingProfile |
Object | No |
Profile for gallery sharing to subscription or tenant |
properties.sharingProfile.communityGalleryInfo |
Object | No |
Information of community gallery if current gallery is shared to community |
properties.sharingProfile.communityGalleryInfo.publisherContact |
String | No |
Community gallery publisher support email. The email address of the publisher. Visible to all users. |
properties.sharingProfile.communityGalleryInfo.publicNames[] |
Array | No |
Community gallery public name list. |
properties.sharingProfile.communityGalleryInfo.communityGalleryEnabled |
Boolean | No |
Contains info about whether community gallery sharing is enabled. |
properties.sharingProfile.communityGalleryInfo.eula |
String | No |
End-user license agreement for community gallery image. |
properties.sharingProfile.communityGalleryInfo.publicNamePrefix |
String | No |
The prefix of the gallery name that will be displayed publicly. Visible to all users. |
properties.sharingProfile.communityGalleryInfo.publisherUri |
String | No |
The link to the publisher website. Visible to all users. |
properties.sharingProfile.groups[] |
Array | No |
A list of sharing profile groups. |
properties.sharingProfile.groups[].type |
String | No |
This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants. Possible values:
|
properties.sharingProfile.groups[].ids[] |
Array | No |
A list of subscription/tenant ids the gallery is aimed to be shared to. |
properties.sharingProfile.permissions |
String | No |
This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community. Possible values:
|
properties.sharingStatus |
Object | No |
Sharing status of current gallery. |
properties.sharingStatus.aggregatedState |
String | No |
The sharing state of the gallery, which only appears in the response. Possible values:
|
properties.sharingStatus.summary[] |
Array | No |
Summary of all regional sharing status. |
properties.sharingStatus.summary[].region |
String | No |
Region name |
properties.sharingStatus.summary[].state |
String | No |
The sharing state of the gallery, which only appears in the response. Possible values:
|
properties.sharingStatus.summary[].details |
String | No |
Details of gallery regional sharing failure. |
tags |
Object | No |
Resource tags |
type |
String | No |
Resource type |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.