Gallery Images - List

  • Reference
Service:
Dev Test Labs
API Version:
2018-09-15

List gallery images in a given lab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages?api-version=2018-09-15
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

URI Parameters

Name In Required Type Description
labName
 path True

string

The name of the lab.
resourceGroupName
 path True

string

The name of the resource group.
subscriptionId
 path True

string

The subscription ID.
api-version
 query True

string

Client API version.
$expand
 query

string

Specify the $expand query. Example: 'properties($select=author)'
$filter
 query

string

The filter to apply to the operation. Example: '$filter=contains(name,'myName')
$orderby
 query

string

The ordering expression for the results, using OData notation. Example: '$orderby=name desc'
$top
 query

integer

int32

The maximum number of resources to return from the operation. Example: '$top=10'

Responses

Name Type Description
200 OK

GalleryImageList

OK
Other Status Codes

CloudError

BadRequest

Security

azure_auth

OAuth2 Implicit Grant

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

Scopes

Name Description
user_impersonation Access Microsoft Azure

Examples

GalleryImages_List

Sample Request

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages?api-version=2018-09-15

Sample Response

Status code:
200 
{
  "value": [
    {
      "properties": {
        "author": "Canonical",
        "createdDate": "2020-12-14T23:43:43.7643542+00:00",
        "description": "Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu Server 20.04 LTS will be available until April 2025. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='https://ubuntu.com/azure' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>",
        "imageReference": {
          "offer": "0001-com-ubuntu-server-focal",
          "publisher": "canonical",
          "sku": "20_04-lts",
          "osType": "Linux",
          "version": "latest"
        },
        "icon": "https://106c4.wpc.azureedge.net/80106C4/Gallery-Prod/cdn/2015-02-24/prod20161101-microsoft-windowsazure-gallery/canonical.0001-com-ubuntu-server-focal20_04-lts-ARM.1.0.22/Icons/Small.png",
        "enabled": true
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/galleryimages/ubuntu server 20.04 lts",
      "name": "Ubuntu Server 20.04 LTS",
      "type": "Microsoft.DevTestLab/labs/galleryImages",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    },
    {
      "properties": {
        "author": "Microsoft",
        "createdDate": "2020-12-14T21:33:33.2464999+00:00",
        "description": "<p>This software is provided by Microsoft. Use of this software in Microsoft Azure is not permitted except under a volume licensing agreement with Microsoft. By clicking Create, I acknowledge that I or the company I work for is licensed to use this software under a volume licensing agreement with Microsoft and that the right to use it will be subject to that agreement.</p> <p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Microsoft and that the <a href='https://www.microsoft.com/en-us/Useterms/Retail/Windows/10/UseTerms_Retail_Windows_10_English.htm' target='_blank'>legal terms</a> of Microsoft apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='https://go.microsoft.com/fwlink/?LinkId=529552' target='_blank'>privacy statement</a> from Microsoft.</p>",
        "imageReference": {
          "offer": "Windows-10",
          "publisher": "MicrosoftWindowsDesktop",
          "sku": "20h2-ent",
          "osType": "Windows",
          "version": "latest"
        },
        "icon": "https://106c4.wpc.azureedge.net/80106C4/Gallery-Prod/cdn/2015-02-24/prod20161101-microsoft-windowsazure-gallery/microsoftwindowsdesktop.windows-1020h2-ent.1.0.238/Icons/Small.png",
        "enabled": true
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/galleryimages/windows 10 enterprise, version 20h2",
      "name": "Windows 10 Enterprise, Version 20H2",
      "type": "Microsoft.DevTestLab/labs/galleryImages",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Definitions

Name Description
CloudError

Error from a REST request.
CloudErrorBody

Body of an error from a REST request.
GalleryImage

A gallery image.
GalleryImageList

The response of a list operation.
GalleryImageReference

The reference information for an Azure Marketplace image.

CloudError

Error from a REST request.

Name Type Description
error

CloudErrorBody

The cloud error that occurred

CloudErrorBody

Body of an error from a REST request.

Name Type Description
code

string

The error code.
details

CloudErrorBody[]

Inner errors.
message

string

The error message.
target

string

The error target.

GalleryImage

A gallery image.

Name Type Description
id

string

The identifier of the resource.
location

string

The location of the resource.
name

string

The name of the resource.
properties.author

string

The author of the gallery image.
properties.createdDate

string

The creation date of the gallery image.
properties.description

string

The description of the gallery image.
properties.enabled

boolean

Indicates whether this gallery image is enabled.
properties.icon

string

The icon of the gallery image.
properties.imageReference

GalleryImageReference

The image reference of the gallery image.
properties.isPlanAuthorized

boolean

Indicates if the plan has been authorized for programmatic deployment.
properties.planId

string

The third party plan that applies to this image
tags

object

The tags of the resource.
type

string

The type of the resource.

GalleryImageList

The response of a list operation.

Name Type Description
nextLink

string

Link for next set of results.
value

GalleryImage[]

Results of the list operation.

GalleryImageReference

The reference information for an Azure Marketplace image.

Name Type Description
offer

string

The offer of the gallery image.
osType

string

The OS type of the gallery image.
publisher

string

The publisher of the gallery image.
sku

string

The SKU of the gallery image.
version

string

The version of the gallery image.