EnrichedVirtualMachine

Enriched virtual machine data for list views

  • configuration
    Type: object
    required
    • categorySortOrder
      Type: integer
      required

      Sort order of the configuration category (e.g., General Purpose=1, Compute Optimized=2, Memory Optimized=3). Sort by this first.

    • cpu
      Type: integer
      required

      Integer numbers.

    • disk
      Type: integer
      required

      Integer numbers.

    • name
      Type: string
      required
    • ram
      Type: integer
      required

      Integer numbers.

    • skuCode
      Type: string nullable
      required

      SKU catalog code (sku_catalog.code). Null for VMs created before the Phase 3 cutover.

    • skuId
      Type: stringFormat: uuid nullable
      required

      SKU catalog id (sku_catalog.id). Null for VMs created before the Phase 3 cutover.

    • tierSortOrder
      Type: integer
      required

      Sort order of the tier within its category (e.g., Micro=1, Small=3, Medium=4, Large=5). Sort by this second.

  • createdAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • datacenter
    Type: object
    required
    • country
      Type: string
      required
    • countryAbbr
      Type: string
      required
    • id
      Type: stringFormat: uuid
      required
    • name
      Type: string
      required
    • region
      Type: string
      required
  • id
    Type: stringFormat: uuid
    required
  • name
    Type: string
    required
  • status
    Type: stringenum
    required

    VM lifecycle status. Rescuing and Unrescuing are transient transitions — the provider has accepted the operation but hasn't finished applying it. They settle to Rescue (success) or back to the prior state (failure) without further user action. UI should treat them as in-progress.

    values
    • Running
    • Stopped
    • Shutoff
    • Error
    • Provisioning
  • updatedAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • deletedAt
    Type: stringFormat: date-time nullable

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • imageName
    Type: string
  • primaryPrivateIp
    Type: string nullable
  • primaryPublicIp
    Type: string nullable
  • resourceGroupId
    Type: stringFormat: uuid nullable
  • resourceGroupName
    Type: string nullable