swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector GalleryImages API schemes: - https tags: - name: GalleryImages paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages : get: tags: - GalleryImages description: List gallery images in a given lab. operationId: microsoftAzureGalleryimagesList parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labName in: path description: The name of the lab. required: true type: string - name: $expand in: query description: 'Specify the $expand query. Example: ''properties($select=author)''' type: string - name: $filter in: query description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')' type: string - name: $top in: query description: 'The maximum number of resources to return from the operation. Example: ''$top=10''' type: integer format: int32 - name: $orderby in: query description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc''' type: string - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/GalleryImageList' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/GalleryImage' x-ms-examples: GalleryImages_List: $ref: ./examples/GalleryImages_List.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Galleryimages ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages : get: tags: - GalleryImages description: List gallery images in a given lab account. operationId: microsoftAzureGalleryimagesList parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: $expand in: query description: 'Specify the $expand query. Example: ''properties($select=author)''' required: false type: string - name: $filter in: query description: The filter to apply to the operation. required: false type: string - name: $top in: query description: The maximum number of resources to return from the operation. required: false type: integer format: int32 - name: $orderby in: query description: The ordering expression for the results, using OData notation. required: false type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/ResponseWithContinuation[GalleryImage]' default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/GalleryImage' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Galleryimages ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages/{galleryImageName} : get: tags: - GalleryImages description: Get gallery image operationId: microsoftAzureGalleryimagesGet parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: galleryImageName in: path description: The name of the gallery Image. required: true type: string - name: $expand in: query description: 'Specify the $expand query. Example: ''properties($select=author)''' required: false type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/GalleryImage_2' default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Galleryimages Galleryimagename put: tags: - GalleryImages description: Create or replace an existing Gallery Image. operationId: microsoftAzureGalleryimagesCreateorupdate parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: galleryImageName in: path description: The name of the gallery Image. required: true type: string - name: galleryImage in: body description: Represents an image from the Azure Marketplace required: true schema: $ref: '#/definitions/GalleryImage_2' - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/GalleryImage_2' '201': description: Created schema: $ref: '#/definitions/GalleryImage_2' default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Galleryimages Galleryimagename delete: tags: - GalleryImages description: Delete gallery image. operationId: microsoftAzureGalleryimagesDelete parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: galleryImageName in: path description: The name of the gallery Image. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '204': description: No Content default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Galleryimages Galleryimagename patch: tags: - GalleryImages description: Modify properties of gallery images. operationId: microsoftAzureGalleryimagesUpdate parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - name: labAccountName in: path description: The name of the lab Account. required: true type: string - name: galleryImageName in: path description: The name of the gallery Image. required: true type: string - name: galleryImage in: body description: Represents an image from the Azure Marketplace required: true schema: $ref: '#/definitions/GalleryImageFragment' - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/GalleryImage_2' default: description: BadRequest schema: $ref: '#/definitions/CloudError_2' security: - azure_auth: - user_impersonation summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Galleryimages Galleryimagename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName} : put: tags: - GalleryImages operationId: microsoftAzureGalleryimagesCreateorupdate description: Create or update a gallery image definition. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - name: galleryName in: path required: true type: string description: The name of the Shared Image Gallery in which the Image Definition is to be created. - name: galleryImageName in: path required: true type: string description: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. - $ref: '#/parameters/ApiVersionParameter' - name: galleryImage in: body required: true schema: $ref: '#/definitions/GalleryImage_3' description: Parameters supplied to the create or update gallery image operation. responses: '200': description: OK schema: $ref: '#/definitions/GalleryImage_3' '201': description: Created schema: $ref: '#/definitions/GalleryImage_3' '202': description: Accepted schema: $ref: '#/definitions/GalleryImage_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true x-ms-examples: Create or update a simple gallery image.: $ref: ./examples/CreateOrUpdateASimpleGalleryImage.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Images Galleryimagename patch: tags: - GalleryImages operationId: microsoftAzureGalleryimagesUpdate description: Update a gallery image definition. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - name: galleryName in: path required: true type: string description: The name of the Shared Image Gallery in which the Image Definition is to be updated. - name: galleryImageName in: path required: true type: string description: The name of the gallery image definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. - $ref: '#/parameters/ApiVersionParameter' - name: galleryImage in: body required: true schema: $ref: '#/definitions/GalleryImageUpdate' description: Parameters supplied to the update gallery image operation. responses: '200': description: OK schema: $ref: '#/definitions/GalleryImage_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true x-ms-examples: Update a simple gallery image.: $ref: ./examples/UpdateASimpleGalleryImage.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Images Galleryimagename get: tags: - GalleryImages operationId: microsoftAzureGalleryimagesGet description: Retrieves information about a gallery image definition. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - name: galleryName in: path required: true type: string description: The name of the Shared Image Gallery from which the Image Definitions are to be retrieved. - name: galleryImageName in: path required: true type: string description: The name of the gallery image definition to be retrieved. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/GalleryImage_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-examples: Get a gallery image.: $ref: ./examples/GetAGalleryImage.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Images Galleryimagename delete: tags: - GalleryImages operationId: microsoftAzureGalleryimagesDelete description: Delete a gallery image. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - name: galleryName in: path required: true type: string description: The name of the Shared Image Gallery in which the Image Definition is to be deleted. - name: galleryImageName in: path required: true type: string description: The name of the gallery image definition to be deleted. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true x-ms-examples: Delete a gallery image.: $ref: ./examples/DeleteAGalleryImage.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Images Galleryimagename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images : get: tags: - GalleryImages operationId: microsoftAzureGalleryimagesListbygallery description: List gallery image definitions in a gallery. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - name: galleryName in: path required: true type: string description: The name of the Shared Image Gallery from which Image Definitions are to be listed. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/GalleryImageList_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-examples: List gallery images in a gallery.: $ref: ./examples/ListGalleryImagesInAGallery.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Images definitions: GalleryImageProperties: description: Properties of a gallery image. type: object properties: author: description: The author of the gallery image. type: string createdDate: format: date-time description: The creation date of the gallery image. type: string readOnly: true description: description: The description of the gallery image. type: string imageReference: $ref: '#/definitions/GalleryImageReference' description: The image reference of the gallery image. icon: description: The icon of the gallery image. type: string enabled: description: Indicates whether this gallery image is enabled. type: boolean planId: description: The third party plan that applies to this image type: string isPlanAuthorized: description: Indicates if the plan has been authorized for programmatic deployment. type: boolean GalleryImageList_2: properties: value: type: array items: $ref: '#/definitions/GalleryImage_3' description: A list of Shared Image Gallery images. nextLink: type: string description: The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions. required: - value description: The List Gallery Images operation response. GalleryImageIdentifier: properties: publisher: type: string description: The name of the gallery image definition publisher. offer: type: string description: The name of the gallery image definition offer. sku: type: string description: The name of the gallery image definition SKU. required: - publisher - offer - sku description: This is the gallery image definition identifier. ImagePurchasePlan: properties: name: type: string description: The plan ID. publisher: type: string description: The publisher ID. product: type: string description: The product ID. description: Describes the gallery image definition purchase plan. This is used by marketplace images. GalleryImage_3: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/GalleryImageProperties_3' allOf: - $ref: '#/definitions/Resource_2' description: Specifies information about the gallery image definition that you want to create or update. GalleryImageFragment: description: Represents an image from the Azure Marketplace type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/GalleryImagePropertiesFragment' description: The gallery image properties x-ms-client-flatten: true ResponseWithContinuation[GalleryImage]: description: The response of a list operation. type: object properties: value: description: Results of the list operation. type: array items: $ref: '#/definitions/GalleryImage_2' nextLink: description: Link for next set of results. type: string ApiErrorBase: properties: code: type: string description: The error code. target: type: string description: The target of the particular error. message: type: string description: The error message. description: Api error base. CloudErrorBody: description: Body of an error from a REST request. type: object properties: code: description: The error code. type: string message: description: The error message. type: string target: description: The error target. type: string details: description: Inner errors. type: array items: $ref: '#/definitions/CloudErrorBody' x-ms-external: true GalleryImage: description: A gallery image. required: - properties type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/GalleryImageProperties' description: The properties of the resource. x-ms-client-flatten: true Resource: description: An Azure resource. type: object properties: id: description: The identifier of the resource. type: string readOnly: true name: description: The name of the resource. type: string readOnly: true type: description: The type of the resource. type: string readOnly: true location: description: The location of the resource. type: string tags: description: The tags of the resource. type: object additionalProperties: type: string x-ms-azure-resource: true UpdateResourceDefinition: description: The Update Resource model definition. properties: id: readOnly: true type: string description: Resource Id name: readOnly: true type: string description: Resource name type: readOnly: true type: string description: Resource type tags: type: object additionalProperties: type: string description: Resource tags x-ms-azure-resource: true GalleryImageProperties_3: properties: description: type: string description: The description of this gallery image definition resource. This property is updatable. eula: type: string description: The Eula agreement for the gallery image definition. privacyStatementUri: type: string description: The privacy statement uri. releaseNoteUri: type: string description: The release note uri. osType: type: string description: 'This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

Possible values are:

**Windows**

**Linux**' enum: - Windows - Linux x-ms-enum: name: OperatingSystemTypes modelAsString: false osState: type: string description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. enum: - Generalized - Specialized x-ms-enum: name: OperatingSystemStateTypes modelAsString: false hyperVGeneration: type: string description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. enum: - V1 - V2 x-ms-enum: name: HyperVGeneration modelAsString: true features: type: array items: $ref: '#/definitions/GalleryImageFeature' description: A list of gallery image features. endOfLifeDate: type: string format: date-time description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. identifier: $ref: '#/definitions/GalleryImageIdentifier' recommended: $ref: '#/definitions/RecommendedMachineConfiguration' disallowed: $ref: '#/definitions/Disallowed' purchasePlan: $ref: '#/definitions/ImagePurchasePlan' provisioningState: readOnly: true type: string title: The current state of the gallery image definition. description: The provisioning state, which only appears in the response. enum: - Creating - Updating - Failed - Succeeded - Deleting - Migrating required: - osType - osState - identifier description: Describes the properties of a gallery image definition. InnerError: properties: exceptiontype: type: string description: The exception type. errordetail: type: string description: The internal error message or exception dump. description: Inner error details. GalleryImageProperties_2: description: The gallery image properties type: object properties: author: description: The author of the gallery image. type: string readOnly: true createdDate: format: date-time description: The creation date of the gallery image. type: string readOnly: true description: description: The description of the gallery image. type: string readOnly: true imageReference: $ref: '#/definitions/GalleryImageReference' description: The image reference of the gallery image. readOnly: true icon: description: The icon of the gallery image. type: string readOnly: true isEnabled: description: Indicates whether this gallery image is enabled. type: boolean isOverride: description: Indicates whether this gallery has been overridden for this lab account type: boolean planId: description: The third party plan that applies to this image type: string readOnly: true isPlanAuthorized: description: Indicates if the plan has been authorized for programmatic deployment. type: boolean provisioningState: description: The provisioning status of the resource. type: string uniqueIdentifier: description: The unique immutable identifier of a resource (Guid). type: string latestOperationResult: $ref: '#/definitions/LatestOperationResult' description: 'The details of the latest operation. ex: status, error' readOnly: true GalleryImageFeature: properties: name: type: string description: The name of the gallery image feature. value: type: string description: The value of the gallery image feature. description: A feature for gallery image. GalleryImageUpdate: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/GalleryImageProperties_3' allOf: - $ref: '#/definitions/UpdateResourceDefinition' description: Specifies information about the gallery image definition that you want to update. GalleryImageReference: description: The reference information for an Azure Marketplace image. type: object properties: offer: description: The offer of the gallery image. type: string publisher: description: The publisher of the gallery image. type: string sku: description: The SKU of the gallery image. type: string osType: description: The OS type of the gallery image. type: string version: description: The version of the gallery image. type: string CloudError_3: x-ms-external: true properties: error: $ref: '#/definitions/ApiError' description: An error response from the Compute service. GalleryImageList: description: The response of a list operation. type: object properties: value: description: Results of the list operation. type: array items: $ref: '#/definitions/GalleryImage' nextLink: description: Link for next set of results. type: string GalleryImagePropertiesFragment: description: The gallery image properties type: object properties: isEnabled: description: Indicates whether this gallery image is enabled. type: boolean isOverride: description: Indicates whether this gallery has been overridden for this lab account type: boolean isPlanAuthorized: description: Indicates if the plan has been authorized for programmatic deployment. type: boolean provisioningState: description: The provisioning status of the resource. type: string uniqueIdentifier: description: The unique immutable identifier of a resource (Guid). type: string CloudErrorBody_2: description: Body of an error from a REST request. type: object properties: code: type: string message: type: string target: type: string details: description: Inner errors. type: array items: $ref: '#/definitions/CloudErrorBody_2' x-ms-external: true ResourceRange: properties: min: type: integer format: int32 description: The minimum number of the resource. max: type: integer format: int32 description: The maximum number of the resource. description: Describes the resource range. Disallowed: properties: diskTypes: type: array items: type: string description: A list of disk types. description: Describes the disallowed disk types. GalleryImage_2: description: Represents an image from the Azure Marketplace type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/GalleryImageProperties_2' description: The gallery image properties x-ms-client-flatten: true Resource_2: description: The Resource model definition. properties: id: readOnly: true type: string description: Resource Id name: readOnly: true type: string description: Resource name type: readOnly: true type: string description: Resource type location: type: string description: Resource location tags: type: object additionalProperties: type: string description: Resource tags required: - location x-ms-azure-resource: true RecommendedMachineConfiguration: properties: vCPUs: $ref: '#/definitions/ResourceRange' memory: $ref: '#/definitions/ResourceRange' description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. CloudError: description: Error from a REST request. type: object properties: error: $ref: '#/definitions/CloudErrorBody' description: The cloud error that occurred x-ms-external: true ApiError: properties: details: type: array items: $ref: '#/definitions/ApiErrorBase' description: The Api error details innererror: $ref: '#/definitions/InnerError' description: The Api inner error code: type: string description: The error code. target: type: string description: The target of the particular error. message: type: string description: The error message. description: Api error. LatestOperationResult: description: Details of the status of an operation. type: object properties: status: description: The current status of the operation. type: string readOnly: true errorCode: description: Error code on failure. type: string readOnly: true errorMessage: description: The error message. type: string readOnly: true requestUri: description: Request URI of the operation. type: string readOnly: true httpMethod: description: The HttpMethod - PUT/POST/DELETE for the operation. type: string readOnly: true operationUrl: description: The URL to use to check long-running operation status type: string readOnly: true CloudError_2: description: Error from a REST request. type: object properties: error: $ref: '#/definitions/CloudErrorBody_2' x-ms-external: true parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: Client Api Version. resourceGroupName: name: resourceGroupName in: path description: The name of the resource group. required: true type: string x-ms-parameter-location: method api-version: name: api-version in: query description: Client API version. required: true type: string default: '2018-09-15' ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string x-ms-parameter-location: method description: The name of the resource group. subscriptionId: name: subscriptionId in: path description: The subscription ID. required: true type: string SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. api-version_2: name: api-version in: query description: Client API version. required: true type: string default: '2018-10-15' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'