Azure DevTest Labs Formulas API

openapi: 3.2.0
info:
  description: The DevTest Labs Client.
  title: DevTestLabsClient ArmTemplates Formulas API
  version: '2.0'
  x-apisguru-categories:
  - cloud
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
  x-origin:
  - format: swagger
    url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json
  x-preferred: true
  x-providerName: azure.com
  x-serviceName: devtestlabs-DTL
  x-tags:
  - Azure
  - Microsoft
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Formulas
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas:
    get:
      description: List formulas in a given lab.
      operationId: Formulas_List
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: 'Specify the $expand query. Example: ''properties($select=description)'''
        in: query
        name: $expand
        example: example-value
        schema:
          type: string
      - description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')'
        in: query
        name: $filter
        example: example-value
        schema:
          type: string
      - description: 'The maximum number of resources to return from the operation. Example: ''$top=10'''
        in: query
        name: $top
        example: example-value
        schema:
          type: integer
          format: int32
      - description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc'''
        in: query
        name: $orderby
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormulaList'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Formulas
      x-ms-odata: '#/definitions/Formula'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Azure DevTest Labs Formulas_ List
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
  : delete:
      description: Delete formula.
      operationId: Formulas_Delete
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the formula.
        in: path
        name: name
        required: true
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Formulas
      summary: Azure DevTest Labs Formulas_ Delete
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      description: Get formula.
      operationId: Formulas_Get
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the formula.
        in: path
        name: name
        required: true
        example: example-value
        schema:
          type: string
      - description: 'Specify the $expand query. Example: ''properties($select=description)'''
        in: query
        name: $expand
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Formula'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Formulas
      summary: Azure DevTest Labs Formulas_ Get
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      description: Allows modifying tags of formulas. All other properties will be ignored.
      operationId: Formulas_Update
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the formula.
        in: path
        name: name
        required: true
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Formula'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Formulas
      summary: Azure DevTest Labs Formulas_ Update
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormulaFragment'
        description: A formula for creating a VM, specifying an image base and other parameters
        required: true
    put:
      description: Create or replace an existing formula. This operation can take a while to complete.
      operationId: Formulas_CreateOrUpdate
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the formula.
        in: path
        name: name
        required: true
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Formula'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Formula'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Formulas
      x-ms-long-running-operation: true
      summary: Azure DevTest Labs Formulas_ Create or Update
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Formula'
        description: A formula for creating a VM, specifying an image base and other parameters
        required: true
components:
  schemas:
    BulkCreationParameters:
      description: Parameters for creating multiple virtual machines as a single action.
      properties:
        instanceCount:
          description: The number of virtual machine instances to create.
          format: int32
          type: integer
      type: object
    CloudError:
      description: Error from a REST request.
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: The cloud error that occurred
      type: object
      x-ms-external: true
    FormulaFragment:
      allOf:
      - $ref: '#/components/schemas/UpdateResource'
      description: A formula for creating a VM, specifying an image base and other parameters
      properties:
        properties:
          $ref: '#/components/schemas/FormulaPropertiesFragment'
          description: The properties of the resource.
          x-ms-client-flatten: true
      type: object
    GalleryImageReference:
      description: The reference information for an Azure Marketplace image.
      properties:
        offer:
          description: The offer of the gallery image.
          type: string
        osType:
          description: The OS type of the gallery image.
          type: string
        publisher:
          description: The publisher of the gallery image.
          type: string
        sku:
          description: The SKU of the gallery image.
          type: string
        version:
          description: The version of the gallery image.
          type: string
      type: object
    DataDiskProperties:
      description: Request body for adding a new or existing data disk to a virtual machine.
      properties:
        attachNewDataDiskOptions:
          $ref: '#/components/schemas/AttachNewDataDiskOptions'
          description: Specifies options to attach a new disk to the virtual machine.
        existingLabDiskId:
          description: Specifies the existing lab disk id to attach to virtual machine.
          type: string
        hostCaching:
          description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).
          enum:
          - None
          - ReadOnly
          - ReadWrite
          type: string
          x-ms-enum:
            modelAsString: true
            name: HostCachingOptions
      type: object
    NetworkInterfacePropertiesFragment:
      description: Properties of a network interface.
      properties:
        dnsName:
          description: The DNS name.
          type: string
        privateIpAddress:
          description: The private IP address.
          type: string
        publicIpAddress:
          description: The public IP address.
          type: string
        publicIpAddressId:
          description: The resource ID of the public IP address.
          type: string
        rdpAuthority:
          description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
          type: string
        sharedPublicIpAddressConfiguration:
          $ref: '#/components/schemas/SharedPublicIpAddressConfigurationFragment'
          description: The configuration for sharing a public IP address across multiple virtual machines.
        sshAuthority:
          description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
          type: string
        subnetId:
          description: The resource ID of the sub net.
          type: string
        virtualNetworkId:
          description: The resource ID of the virtual network.
          type: string
      type: object
    ArtifactDeploymentStatusPropertiesFragment:
      description: Properties of an artifact deployment.
      properties:
        artifactsApplied:
          description: The total count of the artifacts that were successfully applied.
          format: int32
          type: integer
        deploymentStatus:
          description: The deployment status of the artifact.
          type: string
        totalArtifacts:
          description: The total count of the artifacts that were tentatively applied.
          format: int32
          type: integer
      type: object
    FormulaPropertiesFragment:
      description: Properties of a formula.
      properties:
        author:
          description: The author of the formula.
          type: string
        description:
          description: The description of the formula.
          type: string
        formulaContent:
          $ref: '#/components/schemas/LabVirtualMachineCreationParameterFragment'
          description: The content of the formula.
        osType:
          description: The OS type of the formula.
          type: string
        vm:
          $ref: '#/components/schemas/FormulaPropertiesFromVmFragment'
          description: Information about a VM from which a formula is to be created.
      type: object
    HourDetails:
      description: Properties of an hourly schedule.
      properties:
        minute:
          description: Minutes of the hour the schedule will run.
          format: int32
          type: integer
      type: object
    UpdateResource:
      description: Represents an update resource
      properties:
        tags:
          additionalProperties:
            type: string
          description: The tags of the resource.
          type: object
      type: object
    DataDiskPropertiesFragment:
      description: Request body for adding a new or existing data disk to a virtual machine.
      properties:
        attachNewDataDiskOptions:
          $ref: '#/components/schemas/AttachNewDataDiskOptionsFragment'
          description: Specifies options to attach a new disk to the virtual machine.
        existingLabDiskId:
          description: Specifies the existing lab disk id to attach to virtual machine.
          type: string
        hostCaching:
          description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).
          enum:
          - None
          - ReadOnly
          - ReadWrite
          type: string
          x-ms-enum:
            modelAsString: true
            name: HostCachingOptions
      type: object
    DayDetailsFragment:
      description: Properties of a daily schedule.
      properties:
        time:
          description: The time of day the schedule will occur.
          type: string
      type: object
    ArtifactInstallPropertiesFragment:
      description: Properties of an artifact.
      properties:
        artifactId:
          description: The artifact's identifier.
          type: string
        artifactTitle:
          description: The artifact's title.
          type: string
        deploymentStatusMessage:
          description: The status message from the deployment.
          type: string
        installTime:
          description: The time that the artifact starts to install on the virtual machine.
          format: date-time
          type: string
        parameters:
          description: The parameters of the artifact.
          items:
            $ref: '#/components/schemas/ArtifactParameterPropertiesFragment'
          type: array
        status:
          description: The status of the artifact.
          type: string
        vmExtensionStatusMessage:
          description: The status message from the virtual machine extension.
          type: string
      type: object
    WeekDetails:
      description: Properties of a weekly schedule.
      properties:
        time:
          description: The time of the day the schedule will occur.
          type: string
        weekdays:
          description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
          items:
            type: string
          type: array
      type: object
    ArtifactParameterProperties:
      description: Properties of an artifact parameter.
      properties:
        name:
          description: The name of the artifact parameter.
          type: string
        value:
          description: The value of the artifact parameter.
          type: string
      type: object
    AttachNewDataDiskOptions:
      description: Properties to attach new disk to the Virtual Machine.
      properties:
        diskName:
          description: The name of the disk to be attached.
          type: string
        diskSizeGiB:
          description: Size of the disk to be attached in GibiBytes.
          format: int32
          type: integer
        diskType:
          description: The storage type for the disk (i.e. Standard, Premium).
          enum:
          - Standard
          - Premium
          - StandardSSD
          type: string
          x-ms-enum:
            modelAsString: true
            name: StorageType
      type: object
    FormulaProperties:
      description: Properties of a formula.
      properties:
        author:
          description: The author of the formula.
          type: string
        creationDate:
          description: The creation date of the formula.
          format: date-time
          readOnly: true
          type: string
        description:
          description: The description of the formula.
          type: string
        formulaContent:
          $ref: '#/components/schemas/LabVirtualMachineCreationParameter'
          description: The content of the formula.
        osType:
          description: The OS type of the formula.
          type: string
        provisioningState:
          description: The provisioning status of the resource.
          readOnly: true
          type: string
        uniqueIdentifier:
          description: The unique immutable identifier of a resource (Guid).
          readOnly: true
          type: string
        vm:
          $ref: '#/components/schemas/FormulaPropertiesFromVm'
          description: Information about a VM from which a formula is to be created.
      type: object
    NotificationSettings:
      description: Notification settings for a schedule.
      properties:
        emailRecipient:
          description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
          type: string
        notificationLocale:
          description: The locale to use when sending a notification (fallback for unsupported languages is EN).
          type: string
        status:
          description: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            modelAsString: true
            name: EnableStatus
        timeInMinutes:
          description: Time in minutes before event at which notification will be sent.
          format: int32
          type: integer
        webhookUrl:
          description: The webhook URL to which the notification will be sent.
          type: string
      type: object
    NotificationSettingsFragment:
      description: Notification settings for a schedule.
      properties:
        emailRecipient:
          description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
          type: string
        notificationLocale:
          description: The locale to use when sending a notification (fallback for unsupported languages is EN).
          type: string
        status:
          description: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            modelAsString: true
            name: EnableStatus
        timeInMinutes:
          description: Time in minutes before event at which notification will be sent.
          format: int32
          type: integer
        webhookUrl:
          description: The webhook URL to which the notification will be sent.
          type: string
      type: object
    ArtifactParameterPropertiesFragment:
      description: Properties of an artifact parameter.
      properties:
        name:
          description: The name of the artifact parameter.
          type: string
        value:
          description: The value of the artifact parameter.
          type: string
      type: object
    FormulaPropertiesFromVmFragment:
      description: Information about a VM from which a formula is to be created.
      properties:
        labVmId:
          description: The identifier of the VM from which a formula is to be created.
          type: string
      type: object
    BulkCreationParametersFragment:
      description: Parameters for creating multiple virtual machines as a single action.
      properties:
        instanceCount:
          description: The number of virtual machine instances to create.
          format: int32
          type: integer
      type: object
    ScheduleCreationParameter:
      description: Properties for creating a schedule.
      properties:
        location:
          description: The location of the new virtual machine or environment
          type: string
        name:
          description: The name of the virtual machine or environment
          type: string
        properties:
          $ref: '#/components/schemas/ScheduleCreationParameterProperties'
          description: The properties of the schedule.
          x-ms-client-flatten: true
        tags:
          additionalProperties:
            type: string
          description: The tags of the resource.
          type: object
      type: object
    LabVirtualMachineCreationParameterProperties:
      description: Properties for virtual machine creation.
      properties:
        allowClaim:
          description: Indicates whether another user can take ownership of the virtual machine
          type: boolean
        artifactDeploymentStatus:
          $ref: '#/components/schemas/ArtifactDeploymentStatusProperties'
          description: The artifact deployment status for the virtual machine.
        artifacts:
          description: The artifacts to be installed on the virtual machine.
          items:
            $ref: '#/components/schemas/ArtifactInstallProperties'
          type: array
        bulkCreationParameters:
          $ref: '#/components/schemas/BulkCreationParameters'
          description: The number of virtual machine instances to create.
        computeId:
          description: The resource identifier (Microsoft.Compute) of the virtual machine.
          type: string
        createdByUser:
          description: The email address of creator of the virtual machine.
          type: string
        createdByUserId:
          description: The object identifier of the creator of the virtual machine.
          type: string
        createdDate:
          description: The creation date of the virtual machine.
          format: date-time
          type: string
        customImageId:
          description: The custom image identifier of the virtual machine.
          type: string
        dataDiskParameters:
          description: New or existing data disks to attach to the virtual machine after creation
          items:
            $ref: '#/components/schemas/DataDiskProperties'
          type: array
        disallowPublicIpAddress:
          description: Indicates whether the virtual machine is to be created without a public IP address.
          type: boolean
        environmentId:
          description: The resource ID of the environment that contains this virtual machine, if any.
          type: string
        expirationDate:
          description: The expiration date for VM.
          format: date-time
          type: string
        fqdn:
          description: The fully-qualified domain name of the virtual machine.
          type: string
        galleryImageReference:
          $ref: '#/components/schemas/GalleryImageReference'
          description: The Microsoft Azure Marketplace image reference of the virtual machine.
        isAuthenticationWithSshKey:
          description: Indicates whether this virtual machine uses an SSH key for authentication.
          type: boolean
        labSubnetName:
          description: The lab subnet name of the virtual machine.
          type: string
        labVirtualNetworkId:
          description: The lab virtual network identifier of the virtual machine.
          type: string
        lastKnownPowerState:
          description: Last known compute power state captured in DTL
          type: string
        networkInterface:
          $ref: '#/components/schemas/NetworkInterfaceProperties'
          description: The network interface properties.
        notes:
          description: The notes of the virtual machine.
          type: string
        osType:
          description: The OS type of the virtual machine.
          type: string
        ownerObjectId:
          description: The object identifier of the owner of the virtual machine.
          type: string
        ownerUserPrincipalName:
          description: The user principal name of the virtual machine owner.
          type: string
        password:
          description: The password of the virtual machine administrator.
          type: string
        planId:
          description: The id of the plan associated with the virtual machine image
          type: string
        scheduleParameters:
          description: Virtual Machine schedules to be created
          items:
            $ref: '#/components/schemas/ScheduleCreationParameter'
          type: array
        size:
          description: The size of the virtual machine.
          type: string
        sshKey:
          description: The SSH key of the virtual machine administrator.
          type: string
        storageType:
          description: Storage type to use for virtual machine (i.e. Standard, Premium).
          type: string
        userName:
          description: The user name of the virtual machine.
          type: string
        virtualMachineCreationSource:
          description: Tells source of creation of lab virtual machine. Output property only.
          enum:
          - FromCustomImage
          - FromGalleryImage
          - FromSharedGalleryImage
          type: string
          x-ms-enum:
            modelAsString: true
            name: VirtualMachineCreationSource
      type: object
    AttachNewDataDiskOptionsFragment:
      description: Properties to attach new disk to the Virtual Machine.
      properties:
        diskName:
          description: The name of the disk to be attached.
          type: string
        diskSizeGiB:
          description: Size of the disk to be attached in GibiBytes.
          format: int32
          type: integer
        diskType:
          description: The storage type for the disk (i.e. Standard, Premium).
          enum:
          - Standard
          - Premium
          - StandardSSD
          type: string
          x-ms-enum:
            modelAsString: true
            name: StorageType
      type: object
    SharedPublicIpAddressConfigurationFragment:
      description: Properties of a virtual machine that determine how it is connected to a load balancer.
      properties:
        inboundNatRules:
          description: The incoming NAT rules
          items:
            $ref: '#/components/schemas/InboundNatRuleFragment'
          type: array
      type: object
    Formula:
      allOf:
      - $ref: '#/components/schemas/Resource'
      description: A formula for creating a VM, specifying an image base and other parameters
      properties:
        properties:
          $ref: '#/components/schemas/FormulaProperties'
          description: The properties of the resource.
          x-ms-client-flatten: true
      required:
      - properties
      type: object
    LabVirtualMachineCreationParameterPropertiesFragment:
      description: Properties for virtual machine creation.
      properties:
        allowClaim:
          description: Indicates whether another user can take ownership of the virtual machine
          type: boolean
        artifactDeploymentStatus:
          $ref: '#/components/schemas/ArtifactDeploymentStatusPropertiesFragment'
          description: The artifact deployment status for the virtual machine.
        artifacts:
          description: The artifacts to be installed on the virtual machine.
          items:
            $ref: '#/components/schemas/ArtifactInstallPropertiesFragment'
          type: array
        bulkCreationParameters:
          $ref: '#/components/schemas/BulkCreationParametersFragment'
          description: The number of virtual machine instances to create.
        computeId:
          description: The resource identifier (Microsoft.Compute) of the virtual machine.
          type: string
        createdByUser:
          description: The email address of creator of the virtual machine.
          type: string
        createdByUserId:
          description: The object identifier of the creator of the virtual machine.
          type: string
        createdDate:
          description: The creation date of the virtual machine.
          format: date-time
          type: string
        customImageId:
          description: The custom image identifier of the virtual machine.
          type: string
        dataDiskParameters:
          description: New or existing data disks to attach to the virtual machine after creation
          items:
            $ref: '#/components/schemas/DataDiskPropertiesFragment'
          type: array
        disallowPublicIpAddress:
          description: Indicates whether the virtual machine is to be created without a public IP address.
          type: boolean
        environmentId:
          description: The resource ID of the environment that contains this virtual machine, if any.
          type: string
        expirationDate:
          description: The expiration date for VM.
          format: date-time
          type: string
        fqdn:
          description: The fully-qualified domain name of the virtual machine.
          type: string
        galleryImageReference:
          $ref: '#/components/schemas/GalleryImageReferenceFragment'
          description: The Microsoft Azure Marketplace image reference of the virtual machine.
        isAuthenticationWithSshKey:
          description: Indicates whether this virtual machine uses an SSH key for authentication.
          type: boolean
        labSubnetName:
          description: The lab subnet name of the virtual machine.
          type: string
        labVirtualNetworkId:
          description: The lab virtual network identifier of the virtual machine.
          type: string
        lastKnownPowerState:
          description: Last known compute power state captured in DTL
          type: string
        networkInterface:
          $ref: '#/components/schemas/NetworkInterfacePropertiesFragment'
          description: The network interface properties.
        notes:
          description: The notes of the virtual machine.
          type: string
        osType:
          description: The OS type of the virtual machine.
          type: string
        ownerObjectId:
          description: The object identifier of the owner of the virtual machine.
          type: string
        ownerUserPrincipalName:
          description: The user principal name of the virtual machine owner.
          type: string
        password:
          description: The password of the virtual machine administrator.
          type: string
        planId:
          description: The id of the plan associated with the virtual machine image
          type: string
        scheduleParameters:
          description: Virtual Machine schedules to be created
          items:
            $ref: '#/components/schemas/ScheduleCreationParameterFragment'
          type: array
        size:
          description: The size of the virtual machine.
          type: string
        sshKey:
          description: The SSH key of the virtual machine administrator.
          type: string
        storageType:
          description: Storage type to use for virtual machine (i.e. Standard, Premium).
          type: string
        userName:
    

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/azure-test-labs/refs/heads/main/openapi/azure-test-labs-formulas-api-openapi.yml