Microsoft Azure VMExtensions API

openapi: 3.2.0
info:
  version: 2015-12-01-preview
  title: Microsoft Azure Compute Admin Client VM Extensions API
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: VMExtensions
paths:
  ? /subscriptions/{subscriptionId}/providers/Microsoft.Compute.Admin/locations/{location}/artifactTypes/VMExtension/publishers/{publisher}/types/{type}/versions/{version}
  : get:
      x-ms-examples:
        Returns requested Virtual Machine Extension Image.:
          $ref: examples/VMExtensions/Get.json
      tags:
      - VMExtensions
      summary: Microsoft Azure Returns Requested Virtual Machine Extension Image
      description: Returns requested Virtual Machine Extension Image matching publisher, type, version.
      operationId: microsoftAzureVmextensionsGet
      parameters:
      - $ref: Compute.json#/parameters/SubscriptionIdParameter
      - $ref: Compute.json#/parameters/LocationParameter
      - $ref: Compute.json#/parameters/PublisherParameter
      - $ref: '#/components/parameters/TypeParameter'
      - $ref: Compute.json#/parameters/VersionParameter
      - $ref: ../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMExtension'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
          content:
            application/json:
              schema:
                $ref: Compute.json#/definitions/CrpErrorResponse
    put:
      x-ms-examples:
        Create a Virtual Machine Extension Image.:
          $ref: examples/VMExtensions/Create.json
      tags:
      - VMExtensions
      summary: Microsoft Azure Create A Virtual Machine Extension Image
      description: Create a Virtual Machine Extension Image with publisher, version.
      operationId: microsoftAzureVmextensionsCreate
      parameters:
      - $ref: Compute.json#/parameters/SubscriptionIdParameter
      - $ref: Compute.json#/parameters/LocationParameter
      - $ref: Compute.json#/parameters/PublisherParameter
      - $ref: '#/components/parameters/TypeParameter'
      - $ref: Compute.json#/parameters/VersionParameter
      - $ref: ../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/VMExtensionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMExtension'
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMExtension'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
          content:
            application/json:
              schema:
                $ref: Compute.json#/definitions/CrpErrorResponse
    delete:
      x-ms-examples:
        Delete a Virtual Machine Extension Image.:
          $ref: examples/VMExtensions/Delete.json
      tags:
      - VMExtensions
      summary: Microsoft Azure Deletes A Virtual Machine Extension Image
      description: Deletes specified Virtual Machine Extension Image.
      operationId: microsoftAzureVmextensionsDelete
      parameters:
      - $ref: Compute.json#/parameters/SubscriptionIdParameter
      - $ref: Compute.json#/parameters/LocationParameter
      - $ref: Compute.json#/parameters/PublisherParameter
      - $ref: '#/components/parameters/TypeParameter'
      - $ref: Compute.json#/parameters/VersionParameter
      - $ref: ../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
          content:
            application/json:
              schema:
                $ref: Compute.json#/definitions/CrpErrorResponse
  /subscriptions/{subscriptionId}/providers/Microsoft.Compute.Admin/locations/{location}/artifactTypes/VMExtension:
    get:
      x-ms-examples:
        Returns a list of all Virtual Machine Extension Image.:
          $ref: examples/VMExtensions/List.json
      tags:
      - VMExtensions
      summary: Microsoft Azure Returns A List Of All Virtual Machine Extension Images
      description: List of all Virtual Machine Extension Images for the current location are returned.
      operationId: microsoftAzureVmextensionsList
      parameters:
      - $ref: Compute.json#/parameters/SubscriptionIdParameter
      - $ref: Compute.json#/parameters/LocationParameter
      - $ref: ../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMExtensionList'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
          content:
            application/json:
              schema:
                $ref: Compute.json#/definitions/CrpErrorResponse
components:
  parameters:
    VMExtensionParameter:
      description: Virtual Machine Extension Image creation properties.
      name: extension
      in: body
      required: true
      schema:
        $ref: '#/components/schemas/VMExtensionParameters'
      x-ms-parameter-location: method
    TypeParameter:
      description: Type of extension.
      name: type
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    VMExtensionParameters:
      description: Parameters used to create a new Virtual Machine Extension Image.
      type: object
      properties:
        properties:
          description: Properties of a Virtual Machine Extension Image.
          x-ms-client-flatten: true
          $ref: '#/components/schemas/VMExtensionProperties'
    VMExtensionList:
      description: List of virtual machine extensions.
      type: array
      items:
        $ref: '#/components/schemas/VMExtension'
    VMExtension:
      description: Virtual Machine Extension Image.
      type: object
      properties:
        properties:
          description: Inner properties of a Virtual Machine Extension Image.
          x-ms-client-flatten: true
          $ref: '#/components/schemas/VMExtensionProperties'
      allOf:
      - $ref: Compute.json#/definitions/CrpResource
    VMExtensionProperties:
      description: Properties of a Virtual Machine Extension Image.
      type: object
      properties:
        vmOsType:
          description: Target virtual machine operating system type necessary for deploying the extension handler.
          $ref: PlatformImages.json#/definitions/OsType
        publisher:
          description: The publisher of the VM Extension
          type: string
        computeRole:
          description: Compute role
          type: string
        vmScaleSetEnabled:
          description: Value indicating whether the extension is enabled for virtual machine scale set support.
          type: boolean
        supportMultipleExtensions:
          description: True if supports multiple extensions.
          type: boolean
        isSystemExtension:
          description: Indicates if the extension is for the system.
          type: boolean
        sourceBlob:
          description: URI to Azure or AzureStack blob.
          $ref: '#/components/schemas/AzureBlob'
        provisioningState:
          description: Provisioning state of extension.
          $ref: Compute.json#/definitions/ProvisioningState
    AzureBlob:
      description: Azure or AzureStack blob information.
      type: object
      properties:
        uri:
          description: URI to Azure or AzureStack blob.
          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: Authorization uses an Azure Active Directory OAuth2 flow.