swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Galleries API
schemes:
- https
tags:
- name: Galleries
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}:
    put:
      tags:
      - Galleries
      operationId: microsoftAzureGalleriesCreateorupdate
      description: Create or update a Shared Image Gallery.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        type: string
        description: 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.
      - $ref: '#/parameters/ApiVersionParameter'
      - name: gallery
        in: body
        required: true
        schema:
          $ref: '#/definitions/Gallery'
        description: Parameters supplied to the create or update Shared Image Gallery operation.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Gallery'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Gallery'
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/Gallery'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Create or update a simple gallery.:
          $ref: ./examples/CreateOrUpdateASimpleGallery.json
        Create or update a simple gallery with sharing profile.:
          $ref: ./examples/CreateOrUpdateASimpleGalleryWithSharingProfile.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname
    patch:
      tags:
      - Galleries
      operationId: microsoftAzureGalleriesUpdate
      description: Update a Shared Image Gallery.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        type: string
        description: 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.
      - $ref: '#/parameters/ApiVersionParameter'
      - name: gallery
        in: body
        required: true
        schema:
          $ref: '#/definitions/GalleryUpdate'
        description: Parameters supplied to the update Shared Image Gallery operation.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Gallery'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Update a simple gallery.:
          $ref: ./examples/UpdateASimpleGallery.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname
    get:
      tags:
      - Galleries
      operationId: microsoftAzureGalleriesGet
      description: Retrieves information about a Shared Image Gallery.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        type: string
        description: The name of the Shared Image Gallery.
      - $ref: '#/parameters/ApiVersionParameter'
      - name: $select
        in: query
        required: false
        type: string
        description: The select expression to apply on the operation.
        enum:
        - Permissions
        x-ms-enum:
          name: SelectPermissions
          modelAsString: true
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Gallery'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Get a gallery.:
          $ref: ./examples/GetAGallery.json
        Get a gallery with select permissions.:
          $ref: ./examples/GetAGalleryWithSelectPermissions.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname
    delete:
      tags:
      - Galleries
      operationId: microsoftAzureGalleriesDelete
      description: Delete a Shared Image Gallery.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        type: string
        description: The name of the Shared Image Gallery 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'
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete a gallery.:
          $ref: ./examples/DeleteAGallery.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries:
    get:
      tags:
      - Galleries
      operationId: microsoftAzureGalleriesListbyresourcegroup
      description: List galleries under a resource group.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GalleryList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        List galleries in a resource group.:
          $ref: ./examples/ListGalleriesInAResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries
  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries:
    get:
      tags:
      - Galleries
      operationId: microsoftAzureGalleriesList
      description: List galleries under a subscription.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GalleryList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        List galleries in a subscription.:
          $ref: ./examples/ListGalleriesInASubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Galleries
definitions:
  GalleryUpdate:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/GalleryProperties'
    allOf:
    - $ref: '#/definitions/UpdateResourceDefinition'
    description: Specifies information about the Shared Image Gallery that you want to update.
  GalleryList:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Gallery'
        description: A list of galleries.
      nextLink:
        type: string
        description: The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries.
    required:
    - value
    description: The List Galleries operation response.
  GalleryIdentifier:
    properties:
      uniqueName:
        readOnly: true
        type: string
        description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure.
    description: Describes the gallery unique name.
  Resource:
    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
  GalleryProperties:
    properties:
      description:
        type: string
        description: The description of this Shared Image Gallery resource. This property is updatable.
      identifier:
        $ref: '#/definitions/GalleryIdentifier'
      provisioningState:
        readOnly: true
        type: string
        title: The current state of the gallery.
        description: The provisioning state, which only appears in the response.
        enum:
        - Creating
        - Updating
        - Failed
        - Succeeded
        - Deleting
        - Migrating
      sharingProfile:
        $ref: '#/definitions/SharingProfile'
    description: Describes the properties of a Shared Image Gallery.
  CloudError:
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/ApiError'
    description: An error response from the Compute service.
  SharingProfileGroup:
    description: Group of the gallery sharing profile
    properties:
      type:
        type: string
        description: 'This property allows you to specify the type of sharing group. <br><br> Possible values are: <br><br> **Subscriptions** <br><br> **AADTenants**'
        enum:
        - Subscriptions
        - AADTenants
        x-ms-enum:
          name: SharingProfileGroupTypes
          modelAsString: true
      ids:
        type: array
        items:
          type: string
        description: A list of subscription/tenant ids the gallery is aimed to be shared to.
  Gallery:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/GalleryProperties'
    allOf:
    - $ref: '#/definitions/Resource'
    description: Specifies information about the Shared Image Gallery that you want to create or update.
  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
  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.
  SharingProfile:
    description: Profile for gallery sharing to subscription or tenant
    properties:
      permissions:
        type: string
        description: 'This property allows you to specify the permission of sharing gallery. <br><br> Possible values are: <br><br> **Private** <br><br> **Groups**'
        enum:
        - Private
        - Groups
        x-ms-enum:
          name: GallerySharingPermissionTypes
          modelAsString: true
      groups:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/SharingProfileGroup'
        description: A list of sharing profile groups.
  InnerError:
    properties:
      exceptiontype:
        type: string
        description: The exception type.
      errordetail:
        type: string
        description: The internal error message or exception dump.
    description: Inner error details.
  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.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  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.
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: The name of the resource group.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'