VirtualMachineDetailsModel

Virtual machine details for single VM view

  • configuration
    Type: object
    required

    VM tier configuration details

    • categoryCode
      Type: string
      required

      Category code (e.g. "standard")

    • code
      Type: string
      required

      Tier code (e.g. "standard-4")

    • cpu
      Type: integer
      required

      Integer numbers.

    • disk
      Type: integer
      required

      Integer numbers.

    • id
      Type: integer
      required

      Integer numbers.

    • name
      Type: string
      required

      Tier display name (e.g. "Standard 4")

    • 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.

  • consoleEnabled
    Type: boolean
    required
  • 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
  • hasStoredCredentials
    Type: boolean
    required

    True if legacy credentials (private key + password) are stored and retrievable. False if the VM uses a library SSH key (injected via cloud-init) or a user-provided password that was not stored.

  • id
    Type: stringFormat: uuid
    required
  • image
    Type: string
    required
  • name
    Type: string
    required
  • networkHotplug
    Type: boolean
    required
  • sshKeyId
    Type: stringFormat: uuid nullable
    required

    ID of the SSH key from the key library used for this VM, or null if not applicable.

  • sshKeyName
    Type: string nullable
    required

    Display name of the SSH key from the key library, or null if not applicable.

  • 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

  • usage
    Type: object
    required
    • cpuUsage
      Type: number
      required
    • ramUsage
      Type: number
      required
  • username
    Type: string
    required
  • 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

  • resourceGroupId
    Type: stringFormat: uuid nullable
  • resourceGroupName
    Type: string nullable