class Azure::Compute::Mgmt::V2019_03_01::Models::OSProfile

Specifies the operating system settings for the virtual machine.

Attributes

admin_password[RW]

@return [String] Specifies the password of the administrator account.
**Minimum-length (Windows):** 8 characters
**Minimum-length (Linux):** 6 characters
**Max-length (Windows):** 123 characters
**Max-length (Linux):** 72 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [W_])
**Disallowed values:** “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!”
For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)
For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)

admin_username[RW]

@return [String] Specifies the name of the administrator account.
**Windows-only restriction:** Cannot end in “.”
**Disallowed values:** “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”.
**Minimum-length (Linux):** 1 character
**Max-length (Linux):** 64 characters
**Max-length (Windows):** 20 characters
<li> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
> For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](
docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

allow_extension_operations[RW]

@return [Boolean] Specifies whether extension operations should be allowed on the virtual machine.
This may only be set to False when no extensions are present on the virtual machine.

computer_name[RW]

@return [String] Specifies the host OS name of the virtual machine.
This name cannot be updated after the VM is created.
**Max-length (Windows):** 15 characters
**Max-length (Linux):** 64 characters.
For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions).

custom_data[RW]

@return [String] Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.
For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

linux_configuration[RW]

@return [LinuxConfiguration] Specifies the Linux operating system settings on the virtual machine.
For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).

require_guest_provision_signal[RW]

@return [Boolean] Specifies whether the guest provision signal is required from the virtual machine.

secrets[RW]

@return [Array<VaultSecretGroup>] Specifies set of certificates that should be installed onto the virtual machine.

windows_configuration[RW]

@return [WindowsConfiguration] Specifies Windows operating system settings on the virtual machine.

Public Class Methods

mapper() click to toggle source

Mapper for OSProfile class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2019-03-01/generated/azure_mgmt_compute/models/osprofile.rb, line 97
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'OSProfile',
    type: {
      name: 'Composite',
      class_name: 'OSProfile',
      model_properties: {
        computer_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'computerName',
          type: {
            name: 'String'
          }
        },
        admin_username: {
          client_side_validation: true,
          required: false,
          serialized_name: 'adminUsername',
          type: {
            name: 'String'
          }
        },
        admin_password: {
          client_side_validation: true,
          required: false,
          serialized_name: 'adminPassword',
          type: {
            name: 'String'
          }
        },
        custom_data: {
          client_side_validation: true,
          required: false,
          serialized_name: 'customData',
          type: {
            name: 'String'
          }
        },
        windows_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'windowsConfiguration',
          type: {
            name: 'Composite',
            class_name: 'WindowsConfiguration'
          }
        },
        linux_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'linuxConfiguration',
          type: {
            name: 'Composite',
            class_name: 'LinuxConfiguration'
          }
        },
        secrets: {
          client_side_validation: true,
          required: false,
          serialized_name: 'secrets',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VaultSecretGroupElementType',
                type: {
                  name: 'Composite',
                  class_name: 'VaultSecretGroup'
                }
            }
          }
        },
        allow_extension_operations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'allowExtensionOperations',
          type: {
            name: 'Boolean'
          }
        },
        require_guest_provision_signal: {
          client_side_validation: true,
          required: false,
          serialized_name: 'requireGuestProvisionSignal',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end