azure-cli/lib/commands/arm/armsdk/models/imageOSDisk.js

Microsoft Azure Cross Platform Command Line tool

/*
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 * Changes may cause incorrect behavior and will be lost if the code is
 * regenerated.
 */

'use strict';

const models = require('./index');

/**
 * Describes an Operating System disk.
 *
 */
class ImageOSDisk {
  /**
   * Create a ImageOSDisk.
   * @member {string} osType This property allows you to specify the type of
   * the OS that is included in the disk if creating a VM from a custom image.
   * <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**.
   * Possible values include: 'Windows', 'Linux'
   * @member {string} osState The OS State. Possible values include:
   * 'Generalized', 'Specialized'
   * @member {object} [snapshot] The snapshot.
   * @member {string} [snapshot.id] Resource Id
   * @member {object} [managedDisk] The managedDisk.
   * @member {string} [managedDisk.id] Resource Id
   * @member {string} [blobUri] The Virtual Hard Disk.
   * @member {string} [caching] Specifies the caching requirements. <br><br>
   * Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br>
   * **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for
   * Premium storage**. Possible values include: 'None', 'ReadOnly',
   * 'ReadWrite'
   * @member {number} [diskSizeGB] Specifies the size of empty data disks in
   * gigabytes. This element can be used to overwrite the name of the disk in a
   * virtual machine image. <br><br> This value cannot be larger than 1023 GB
   * @member {string} [storageAccountType] Specifies the storage account type
   * for the managed disk. Possible values are: Standard_LRS or Premium_LRS.
   * Possible values include: 'Standard_LRS', 'Premium_LRS'
   */
  constructor() {
  }

  /**
   * Defines the metadata of ImageOSDisk
   *
   * @returns {object} metadata of ImageOSDisk
   *
   */
  mapper() {
    return {
      required: false,
      serializedName: 'ImageOSDisk',
      type: {
        name: 'Composite',
        className: 'ImageOSDisk',
        modelProperties: {
          osType: {
            required: true,
            serializedName: 'osType',
            type: {
              name: 'Enum',
              allowedValues: [ 'Windows', 'Linux' ]
            }
          },
          osState: {
            required: true,
            serializedName: 'osState',
            type: {
              name: 'Enum',
              allowedValues: [ 'Generalized', 'Specialized' ]
            }
          },
          snapshot: {
            required: false,
            serializedName: 'snapshot',
            type: {
              name: 'Composite',
              className: 'SubResource'
            }
          },
          managedDisk: {
            required: false,
            serializedName: 'managedDisk',
            type: {
              name: 'Composite',
              className: 'SubResource'
            }
          },
          blobUri: {
            required: false,
            serializedName: 'blobUri',
            type: {
              name: 'String'
            }
          },
          caching: {
            required: false,
            serializedName: 'caching',
            type: {
              name: 'Enum',
              allowedValues: [ 'None', 'ReadOnly', 'ReadWrite' ]
            }
          },
          diskSizeGB: {
            required: false,
            serializedName: 'diskSizeGB',
            type: {
              name: 'Number'
            }
          },
          storageAccountType: {
            required: false,
            serializedName: 'storageAccountType',
            type: {
              name: 'Enum',
              allowedValues: [ 'Standard_LRS', 'Premium_LRS' ]
            }
          }
        }
      }
    };
  }
}

module.exports = ImageOSDisk;