swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SharedGalleryImages API
schemes:
- https
tags:
- name: SharedGalleryImages
paths:
  ? /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images
  : get:
      tags:
      - SharedGalleryImages
      operationId: microsoftAzureSharedgalleryimagesList
      description: List shared gallery images by subscription id or tenant id.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/LocationNameParamter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: galleryUniqueName
        in: path
        required: true
        type: string
        description: The unique name of the Shared Gallery.
      - name: sharedTo
        in: query
        required: false
        type: string
        description: The query parameter to decide what shared galleries to fetch when doing listing operations.
        enum:
        - tenant
        x-ms-enum:
          name: SharedToValues
          modelAsString: true
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SharedGalleryImageList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Get a gallery.:
          $ref: ./examples/ListSharedGalleryImages.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Locations Location Sharedgalleries Galleryuniquename Images
  ? /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}
  : get:
      tags:
      - SharedGalleryImages
      operationId: microsoftAzureSharedgalleryimagesGet
      description: Get a shared gallery image by subscription id or tenant id.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/LocationNameParamter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: galleryUniqueName
        in: path
        required: true
        type: string
        description: The unique name of the Shared Gallery.
      - name: galleryImageName
        in: path
        required: true
        type: string
        description: The name of the Shared Gallery Image Definition from which the Image Versions are to be listed.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SharedGalleryImage'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Get a gallery.:
          $ref: ./examples/GetASharedGalleryImage.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Locations Location Sharedgalleries Galleryuniquename Images Galleryimagename
definitions:
  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.
  SharedGalleryIdentifier:
    properties:
      uniqueId:
        type: string
        description: The unique id of this shared gallery.
    description: The identifier information of shared gallery.
  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.
  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.
  SharedGalleryImage:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/SharedGalleryImageProperties'
    allOf:
    - $ref: '#/definitions/PirSharedGalleryResource'
    description: Specifies information about the gallery image definition that you want to create or update.
  PirSharedGalleryResource:
    properties:
      identifier:
        x-ms-client-flatten: true
        $ref: '#/definitions/SharedGalleryIdentifier'
    allOf:
    - $ref: '#/definitions/PirResource'
    description: Base information about the shared gallery resource in pir.
  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.
  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:
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/ApiError'
    description: An error response from the Compute service.
  PirResource:
    description: The Resource model definition.
    properties:
      name:
        readOnly: true
        type: string
        description: Resource name
      location:
        readOnly: true
        type: string
        description: Resource location
  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.
  InnerError:
    properties:
      exceptiontype:
        type: string
        description: The exception type.
      errordetail:
        type: string
        description: The internal error message or exception dump.
    description: Inner error details.
  SharedGalleryImageProperties:
    properties:
      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. <br><br> Possible values are: <br><br> **Windows** <br><br> **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
      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'
      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.
      purchasePlan:
        $ref: '#/definitions/ImagePurchasePlan'
    required:
    - osType
    - osState
    - identifier
    description: Describes the properties of a gallery image definition.
  SharedGalleryImageList:
    description: The List Shared Gallery Images operation response.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/SharedGalleryImage'
        description: A list of shared gallery images.
      nextLink:
        type: string
        description: The uri to fetch the next page of shared gallery images. Call ListNext() with this to fetch the next page of shared gallery images.
    required:
    - value
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.
  LocationNameParamter:
    name: location
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: Resource location.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'