Galleries - Create Or Update

Create or update a Shared Image Gallery.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}?api-version=2023-07-03

URI Parameters

Name In Required Type Description
galleryName
path True

string

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.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client Api Version.

Request Body

Name Required Type Description
location True

string

Resource location

properties.description

string

The description of this Shared Image Gallery resource. This property is updatable.

properties.identifier

GalleryIdentifier

Describes the gallery unique name.

properties.sharingProfile

SharingProfile

Profile for gallery sharing to subscription or tenant

properties.softDeletePolicy

SoftDeletePolicy

Contains information about the soft deletion policy of the gallery.

tags

object

Resource tags

Responses

Name Type Description
200 OK

Gallery

OK

201 Created

Gallery

Created

202 Accepted

Gallery

Accepted

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Create a community gallery.
Create or update a simple gallery with sharing profile.
Create or update a simple gallery with soft deletion enabled.
Create or update a simple gallery.

Create a community gallery.

Sample request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2023-07-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description.",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  }
}

Sample response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Sample request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2023-07-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description.",
    "sharingProfile": {
      "permissions": "Groups"
    }
  }
}

Sample response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Groups"
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "sharingProfile": {
      "permissions": "Groups"
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Groups"
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Sample request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2023-07-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description.",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  }
}

Sample response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Create or update a simple gallery.

Sample request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2023-07-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description."
  }
}

Sample response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating"
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryName"
}

Definitions

Name Description
ApiError

Api error.

ApiErrorBase

Api error base.

CloudError

An error response from the Compute service.

CommunityGalleryInfo

Information of community gallery if current gallery is shared to community

Gallery

Specifies information about the Shared Image Gallery that you want to create or update.

GalleryIdentifier

Describes the gallery unique name.

GalleryProvisioningState

The current state of the gallery or gallery artifact.

GallerySharingPermissionTypes

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

InnerError

Inner error details.

RegionalSharingStatus

Gallery regional sharing status

SharingProfile

Profile for gallery sharing to subscription or tenant

SharingProfileGroup

Group of the gallery sharing profile

SharingProfileGroupTypes

This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants.

SharingState

The sharing state of the gallery.

SharingStatus

Sharing status of current gallery.

SoftDeletePolicy

Contains information about the soft deletion policy of the gallery.

ApiError

Api error.

Name Type Description
code

string

The error code.

details

ApiErrorBase[]

The Api error details

innererror

InnerError

The Api inner error

message

string

The error message.

target

string

The target of the particular error.

ApiErrorBase

Api error base.

Name Type Description
code

string

The error code.

message

string

The error message.

target

string

The target of the particular error.

CloudError

An error response from the Compute service.

Name Type Description
error

ApiError

Api error.

CommunityGalleryInfo

Information of community gallery if current gallery is shared to community

Name Type Description
communityGalleryEnabled

boolean

Contains info about whether community gallery sharing is enabled.

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.

publicNames

string[]

Community gallery public name list.

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.

Specifies information about the Shared Image Gallery that you want to create or update.

Name Type Description
id

string

Resource Id

location

string

Resource location

name

string

Resource name

properties.description

string

The description of this Shared Image Gallery resource. This property is updatable.

properties.identifier

GalleryIdentifier

Describes the gallery unique name.

properties.provisioningState

GalleryProvisioningState

The current state of the gallery or gallery artifact.
The provisioning state, which only appears in the response.

properties.sharingProfile

SharingProfile

Profile for gallery sharing to subscription or tenant

properties.sharingStatus

SharingStatus

Sharing status of current gallery.

properties.softDeletePolicy

SoftDeletePolicy

Contains information about the soft deletion policy of the gallery.

tags

object

Resource tags

type

string

Resource type

GalleryIdentifier

Describes the gallery unique name.

Name Type Description
uniqueName

string

The unique name of the Shared Image Gallery. This name is generated automatically by Azure.

GalleryProvisioningState

The current state of the gallery or gallery artifact.

Name Type Description
Creating

string

Deleting

string

Failed

string

Migrating

string

Succeeded

string

Updating

string

GallerySharingPermissionTypes

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

Name Type Description
Community

string

Groups

string

Private

string

InnerError

Inner error details.

Name Type Description
errordetail

string

The internal error message or exception dump.

exceptiontype

string

The exception type.

RegionalSharingStatus

Gallery regional sharing status

Name Type Description
details

string

Details of gallery regional sharing failure.

region

string

Region name

state

SharingState

The sharing state of the gallery.
Gallery sharing state in current region

SharingProfile

Profile for gallery sharing to subscription or tenant

Name Type Description
communityGalleryInfo

CommunityGalleryInfo

Information of community gallery if current gallery is shared to community.

groups

SharingProfileGroup[]

A list of sharing profile groups.

permissions

GallerySharingPermissionTypes

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

SharingProfileGroup

Group of the gallery sharing profile

Name Type Description
ids

string[]

A list of subscription/tenant ids the gallery is aimed to be shared to.

type

SharingProfileGroupTypes

This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants.

SharingProfileGroupTypes

This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants.

Name Type Description
AADTenants

string

Subscriptions

string

SharingState

The sharing state of the gallery.

Name Type Description
Failed

string

InProgress

string

Succeeded

string

Unknown

string

SharingStatus

Sharing status of current gallery.

Name Type Description
aggregatedState

SharingState

The sharing state of the gallery.
Aggregated sharing state of current gallery.

summary

RegionalSharingStatus[]

Summary of all regional sharing status.

SoftDeletePolicy

Contains information about the soft deletion policy of the gallery.

Name Type Description
isSoftDeleteEnabled

boolean

Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.