Microsoft Azure GalleryApplications API

openapi: 3.2.0
info:
  title: Microsoft Azure SharedImageGalleryServiceClient Gallery…
  description: Shared Image Gallery Service Client.
  version: '2020-09-30'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: GalleryApplications
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}
  : put:
      tags:
      - GalleryApplications
      operationId: microsoftAzureGalleryapplicationsCreateorupdate
      description: Create or update a gallery Application Definition.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        description: The name of the Shared Application Gallery in which the Application Definition is to be created.
        schema:
          type: string
      - name: galleryApplicationName
        in: path
        required: true
        description: The name of the gallery Application 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.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplication'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplication'
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplication'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Create or update a simple gallery Application.:
          $ref: ./examples/CreateOrUpdateASimpleGalleryApplication.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GalleryApplication'
        description: Parameters supplied to the create or update gallery Application operation.
        required: true
    patch:
      tags:
      - GalleryApplications
      operationId: microsoftAzureGalleryapplicationsUpdate
      description: Update a gallery Application Definition.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        description: The name of the Shared Application Gallery in which the Application Definition is to be updated.
        schema:
          type: string
      - name: galleryApplicationName
        in: path
        required: true
        description: The name of the gallery Application 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.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplication'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Update a simple gallery Application.:
          $ref: ./examples/UpdateASimpleGalleryApplication.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GalleryApplicationUpdate'
        description: Parameters supplied to the update gallery Application operation.
        required: true
    get:
      tags:
      - GalleryApplications
      operationId: microsoftAzureGalleryapplicationsGet
      description: Retrieves information about a gallery Application Definition.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        description: The name of the Shared Application Gallery from which the Application Definitions are to be retrieved.
        schema:
          type: string
      - name: galleryApplicationName
        in: path
        required: true
        description: The name of the gallery Application Definition to be retrieved.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplication'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Get a gallery Application.:
          $ref: ./examples/GetAGalleryApplication.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    delete:
      tags:
      - GalleryApplications
      operationId: microsoftAzureGalleryapplicationsDelete
      description: Delete a gallery Application.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        description: The name of the Shared Application Gallery in which the Application Definition is to be deleted.
        schema:
          type: string
      - name: galleryApplicationName
        in: path
        required: true
        description: The name of the gallery Application Definition to be deleted.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete a gallery Application.:
          $ref: ./examples/DeleteAGalleryApplication.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications
  : get:
      tags:
      - GalleryApplications
      operationId: microsoftAzureGalleryapplicationsListbygallery
      description: List gallery Application Definitions in a gallery.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        description: The name of the Shared Application Gallery from which Application Definitions are to be listed.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplicationList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        List gallery Applications in a gallery.:
          $ref: ./examples/ListGalleryApplicationsInAGallery.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    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
    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.
    CloudError:
      x-ms-external: true
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
      description: An error response from the Compute service.
    GalleryApplicationList:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/GalleryApplication'
          description: A list of Gallery Applications.
        nextLink:
          type: string
          description: The uri to fetch the next page of Application Definitions in the Application Gallery. Call ListNext() with this to fetch the next page of gallery Application Definitions.
      required:
      - value
      description: The List Gallery Applications operation response.
    ApiError:
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/ApiErrorBase'
          description: The Api error details
        innererror:
          $ref: '#/components/schemas/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.
    GalleryApplication:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/GalleryApplicationProperties'
      allOf:
      - $ref: '#/components/schemas/Resource'
      description: Specifies information about the gallery Application Definition that you want to create or update.
    GalleryApplicationProperties:
      properties:
        description:
          type: string
          description: The description of this gallery Application Definition resource. This property is updatable.
        eula:
          type: string
          description: The Eula agreement for the gallery Application Definition.
        privacyStatementUri:
          type: string
          description: The privacy statement uri.
        releaseNoteUri:
          type: string
          description: The release note uri.
        endOfLifeDate:
          type: string
          format: date-time
          description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
        supportedOSType:
          type: string
          description: 'This property allows you to specify the supported type of the OS that application is built for. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**'
          enum:
          - Windows
          - Linux
          x-ms-enum:
            name: OperatingSystemTypes
            modelAsString: false
      required:
      - supportedOSType
      description: Describes the properties of a gallery Application Definition.
    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
    GalleryApplicationUpdate:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/GalleryApplicationProperties'
      allOf:
      - $ref: '#/components/schemas/UpdateResourceDefinition'
      description: Specifies information about the gallery Application Definition that you want to update.
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      x-ms-parameter-location: method
      description: The name of the resource group.
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow