swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector VirtualMachineImageTemplate API
schemes:
- https
tags:
- name: VirtualMachineImageTemplate
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.VirtualMachineImages/imageTemplates:
    get:
      tags:
      - VirtualMachineImageTemplate
      operationId: microsoftAzureVirtualmachineimagetemplatesList
      description: Gets information about the VM image templates associated with the subscription.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageTemplateListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ApiError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List images by subscription.:
          $ref: ./examples/ListImageTemplates.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Virtualmachineimages Imagetemplates
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates:
    get:
      tags:
      - VirtualMachineImageTemplate
      operationId: microsoftAzureVirtualmachineimagetemplatesListbyresourcegroup
      description: Gets information about the VM image templates associated with the specified resource group.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageTemplateListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ApiError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List images by resource group:
          $ref: ./examples/ListImageTemplatesByRg.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Virtualmachineimages Imagetemplates
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}
  : put:
      tags:
      - VirtualMachineImageTemplate
      operationId: microsoftAzureVirtualmachineimagetemplatesCreateorupdate
      description: Create or update a virtual machine image template
      parameters:
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ImageTemplate'
        description: Parameters supplied to the CreateImageTemplate operation
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ImageTemplateNameParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageTemplate'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ImageTemplate'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ApiError'
      x-ms-examples:
        Create an Image Template.:
          $ref: ./examples/CreateImageTemplate.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Virtualmachineimages Imagetemplates Imagetemplatename
    patch:
      tags:
      - VirtualMachineImageTemplate
      operationId: microsoftAzureVirtualmachineimagetemplatesUpdate
      description: Update the tags for this Virtual Machine Image Template
      parameters:
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ImageTemplateUpdateParameters'
        description: Additional parameters for Image Template update.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ImageTemplateNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageTemplate'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ApiError'
      x-ms-examples:
        Update the tags for an Image Template.:
          $ref: ./examples/UpdateImageTemplateTags.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Virtualmachineimages Imagetemplates Imagetemplatename
    get:
      tags:
      - VirtualMachineImageTemplate
      operationId: microsoftAzureVirtualmachineimagetemplatesGet
      description: Get information about a virtual machine image template
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ImageTemplateNameParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ImageTemplate'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ApiError'
      x-ms-examples:
        Retrieve an Image Template.:
          $ref: ./examples/GetImageTemplate.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Virtualmachineimages Imagetemplates Imagetemplatename
    delete:
      tags:
      - VirtualMachineImageTemplate
      operationId: microsoftAzureVirtualmachineimagetemplatesDelete
      description: Delete a virtual machine image template
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ImageTemplateNameParameter'
      responses:
        '200':
          description: The operation was successful.
        '202':
          description: The operation will be completed asynchronously.
        '204':
          description: NoContent -- VM image template does not exist in the subscription.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ApiError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Delete an Image Template.:
          $ref: ./examples/DeleteImageTemplate.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Virtualmachineimages Imagetemplates Imagetemplatename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/run
  : post:
      tags:
      - VirtualMachineImageTemplate
      operationId: microsoftAzureVirtualmachineimagetemplatesRun
      description: Create artifacts from a existing image template
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ImageTemplateNameParameter'
      responses:
        '202':
          description: The operation will be completed asynchronously.
        '204':
          description: The operation was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ApiError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Create image(s) from existing imageTemplate.:
          $ref: ./examples/RunImageTemplate.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Virtualmachineimages Imagetemplates Imagetemplatename Run
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs
  : get:
      tags:
      - VirtualMachineImageTemplate
      operationId: microsoftAzureVirtualmachineimagetemplatesListrunoutputs
      description: List all run outputs for the specified Image Template resource
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ImageTemplateNameParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/RunOutputCollection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ApiError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Retrieve a list of all outputs created by the last run of an Image Template:
          $ref: ./examples/ListRunOutputs.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Virtualmachineimages Imagetemplates Imagetemplatename Runoutputs
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs/{runOutputName}
  : get:
      tags:
      - VirtualMachineImageTemplate
      operationId: microsoftAzureVirtualmachineimagetemplatesGetrunoutput
      description: Get the specified run output for the specified image template resource
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ImageTemplateNameParameter'
      - $ref: '#/parameters/RunOutputNameParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/RunOutput'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ApiError'
      x-ms-examples:
        Retrieve single runOutput:
          $ref: ./examples/GetRunOutput.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Virtualmachineimages Imagetemplates Imagetemplatename Runoutputs Runoutputname
definitions:
  ImageTemplateListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ImageTemplate'
      nextLink:
        type: string
        description: The continuation token.
  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.
  ImageTemplateSource:
    discriminator: type
    properties:
      type:
        type: string
        description: Specifies the type of source image you want to start with.
    required:
    - type
  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
        x-ms-mutability:
        - create
        - read
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    required:
    - location
    x-ms-azure-resource: true
  RunOutput:
    description: Represents an output that was created by running an image template.
    allOf:
    - $ref: '#/definitions/SubResource'
    properties:
      properties:
        $ref: '#/definitions/RunOutputProperties'
        x-ms-client-flatten: true
  ImageTemplateProperties:
    properties:
      source:
        $ref: '#/definitions/ImageTemplateSource'
        description: Specifies the properties used to describe the source image.
      customize:
        type: array
        items:
          $ref: '#/definitions/ImageTemplateCustomizer'
        description: Specifies the properties used to describe the customization steps of the image, like Image source etc
      distribute:
        type: array
        items:
          $ref: '#/definitions/ImageTemplateDistributor'
        description: The distribution targets where the image output needs to go to.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Provisioning state of the resource
        readOnly: true
      provisioningError:
        $ref: '#/definitions/ProvisioningError'
        description: Provisioning error, if any
        readOnly: true
      lastRunStatus:
        $ref: '#/definitions/ImageTemplateLastRunStatus'
        description: State of 'run' that is currently executing or was last executed.
        readOnly: true
    required:
    - source
    - distribute
  ImageTemplateDistributor:
    type: object
    description: Generic distribution object
    discriminator: type
    properties:
      type:
        type: string
        description: Type of distribution.
      runOutputName:
        type: string
        description: The name to be used for the associated RunOutput.
        pattern: ^[A-Za-z0-9-_]{1,64}$
      artifactTags:
        type: object
        additionalProperties:
          type: string
        description: Tags that will be applied to the artifact once it has been created/updated by the distributor.
    required:
    - type
    - runOutputName
  ImageTemplateUpdateParameters:
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: The user-specified tags associated with the image template.
    description: Parameters for updating an image template.
  ImageTemplateLastRunStatus:
    properties:
      startTime:
        type: string
        format: date-time
        description: Start time of the last run (UTC)
      endTime:
        type: string
        format: date-time
        description: End time of the last run (UTC)
      runState:
        type: string
        enum:
        - Running
        - Succeeded
        - PartiallySucceeded
        - Failed
        description: State of the last run
      runSubState:
        type: string
        enum:
        - Queued
        - Building
        - Customizing
        - Distributing
        description: Sub-state of the last run
      message:
        type: string
        description: Verbose information about the last run state
  SubResource:
    description: The Sub Resource model definition.
    properties:
      id:
        readOnly: true
        type: string
        description: Resource Id
      name:
        type: string
        description: Resource name
      type:
        readOnly: true
        type: string
        description: Resource type
    required:
    - name
  ImageTemplateCustomizer:
    discriminator: type
    properties:
      type:
        type: string
        description: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer
      name:
        type: string
        description: Friendly Name to provide context on what this customization step does
    required:
    - type
  RunOutputCollection:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/RunOutput'
      nextLink:
        type: string
        description: The continuation token.
  ProvisioningError:
    properties:
      provisioningErrorCode:
        type: string
        enum:
        - BadSourceType
        - BadPIRSource
        - BadISOSource
        - BadManagedImageSource
        - BadCustomizerType
        - UnsupportedCustomizerType
        - NoCustomizerScript
        - BadDistributeType
        - BadSharedImageDistribute
        - ServerError
        - Other
        description: Error code of the provisioning failure
      message:
        type: string
        description: Verbose error message about the provisioning failure
  RunOutputProperties:
    properties:
      artifactId:
        type: string
        description: The resource id of the artifact.
      artifactUri:
        type: string
        description: The location URI of the artifact.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Provisioning state of the resource
        readOnly: true
  ProvisioningState:
    type: string
    enum:
    - Creating
    - Succeeded
    - Failed
    - Deleting
    description: Provisioning state of the resource
  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.
  ImageTemplate:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ImageTemplateProperties'
    allOf:
    - $ref: '#/definitions/Resource'
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group.
    x-ms-parameter-location: method
  RunOutputNameParameter:
    name: runOutputName
    in: path
    required: true
    type: string
    description: The name of the run output
    pattern: ^[A-Za-z0-9-_]{1,64}$
    x-ms-parameter-location: method
  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.
  ImageTemplateNameParameter:
    name: imageTemplateName
    in: path
    required: true
    type: string
    description: The name of the image Template
    pattern: ^[A-Za-z0-9-_]{1,64}$
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'