Galleries - Create Or Update

Service:: Compute

API Version:: 2024-03-03

Create or update a Shared Image Gallery.

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

URI Parameters

Name	In	Required	Type	Description
galleryName	path	True	string pattern: ^[^_\W][\w-._]{0,79}(?	The name of the Shared Image Gallery.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
identity		GalleryIdentity	The identity of the gallery, if configured.
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	Resource 'Gallery' update operation succeeded
201 Created	Gallery	Resource 'Gallery' create operation succeeded Headers Location: string Retry-After: integer
202 Accepted	Gallery	The request has been accepted for processing, but processing has not yet completed. Headers Location: string Retry-After: integer
Other Status Codes	CloudError	An unexpected error response.

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 with system-assigned and user-assigned managed identities.

Create or update a simple gallery.

Create a community gallery.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-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

Status code:: 200

{
  "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"
}

Status code:: 201

{
  "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"
}

Status code:: 202

{
  "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

HTTP

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

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

Sample response

Status code:: 200

{
  "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"
}

Status code:: 201

{
  "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"
}

Status code:: 202

{
  "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"
}

Create or update a simple gallery with soft deletion enabled.

Sample request

HTTP

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

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

Sample response

Status code:: 200

{
  "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"
}

Status code:: 201

{
  "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"
}

Status code:: 202

{
  "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 with system-assigned and user-assigned managed identities.

Sample request

HTTP

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

{
  "location": "West US",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description."
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryName"
}

Status code:: 201

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Status code:: 202

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "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

HTTP

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

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

Sample response

Status code:: 200

{
  "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"
}

Status code:: 201

{
  "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"
}

Status code:: 202

{
  "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.
Common.UserAssignedIdentitiesValue
CommunityGalleryInfo	Information of community gallery if current gallery is shared to community
createdByType	The type of identity that created the resource.
Gallery	Specifies information about the Shared Image Gallery that you want to create or update.
GalleryIdentifier	Describes the gallery unique name.
GalleryIdentity	Identity for the virtual machine.
GalleryProvisioningState	The provisioning state, which only appears in the response.
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
ResourceIdentityType	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.
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, which only appears in the response.
SharingStatus	Sharing status of current gallery.
SoftDeletePolicy	Contains information about the soft deletion policy of the gallery.
systemData	Metadata pertaining to creation and last modification of the resource.

ApiError

Object

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

Object

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

Object

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

Common.UserAssignedIdentitiesValue

Object

Name	Type	Description
clientId	string	The client id of user assigned identity.
principalId	string	The principal id of user assigned identity.

CommunityGalleryInfo

Object

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.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

Gallery

Object

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

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	GalleryIdentity	The identity of the gallery, if configured.
location	string	The geo-location where the resource lives
name	string	The name of the resource
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 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.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

GalleryIdentifier

Object

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.

GalleryIdentity

Object

Identity for the virtual machine.

Name	Type	Description
principalId	string	The principal id of the gallery identity. This property will only be provided for a system assigned identity.
tenantId	string	The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity.
type	ResourceIdentityType	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	<string, Common.UserAssignedIdentitiesValue>	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}'.

GalleryProvisioningState

Enumeration

The provisioning state, which only appears in the response.

Value	Description
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GallerySharingPermissionTypes

Enumeration

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

Value	Description
Private
Groups
Community

InnerError

Object

Inner error details.

Name	Type	Description
errordetail	string	The internal error message or exception dump.
exceptiontype	string	The exception type.

RegionalSharingStatus

Object

Gallery regional sharing status

Name	Type	Description
details	string	Details of gallery regional sharing failure.
region	string	Region name
state	SharingState	Gallery sharing state in current region

ResourceIdentityType

Enumeration

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.

Value	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

SharingProfile

Object

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

Object

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

Enumeration

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

Value	Description
Subscriptions
AADTenants

SharingState

Enumeration

The sharing state of the gallery, which only appears in the response.

Value	Description
Succeeded
InProgress
Failed
Unknown

SharingStatus

Object

Sharing status of current gallery.

Name	Type	Description
aggregatedState	SharingState	Aggregated sharing state of current gallery.
summary	RegionalSharingStatus[]	Summary of all regional sharing status.

SoftDeletePolicy

Object

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.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Galleries - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create a community gallery.

Sample request

Sample response

Create or update a simple gallery with sharing profile.

Sample request

Sample response

Create or update a simple gallery with soft deletion enabled.

Sample request

Sample response

Create or update a simple gallery with system-assigned and user-assigned managed identities.

Sample request

Sample response

Create or update a simple gallery.

Sample request

Sample response

Definitions

ApiError

ApiErrorBase

CloudError

Common.UserAssignedIdentitiesValue

CommunityGalleryInfo

createdByType

Gallery

GalleryIdentifier

GalleryIdentity

GalleryProvisioningState

GallerySharingPermissionTypes

InnerError

RegionalSharingStatus

ResourceIdentityType

SharingProfile

SharingProfileGroup

SharingProfileGroupTypes

SharingState

SharingStatus

SoftDeletePolicy

systemData