OsProfileResponse

data class OsProfileResponse(val adminUsername: String? = null, val customData: String? = null, val customDataRequired: Boolean? = null, val linuxConfiguration: LinuxConfigurationResponse? = null)

Specifies the operating system settings for the role instance.

Constructors

Link copied to clipboard
constructor(adminUsername: String? = null, customData: String? = null, customDataRequired: Boolean? = null, linuxConfiguration: LinuxConfigurationResponse? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val adminUsername: String? = null

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

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • 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.

  • Link copied to clipboard
    val customData: String? = null

    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.

    Note: Do not pass any secrets or passwords in customData property

    This property cannot be updated after the VM is created.

    customData is passed to the VM to be saved as a file. For more information see Custom Data on Azure VMs

    For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation

    Link copied to clipboard

    Indicates if custom data is required to deploy this role.

    Link copied to clipboard

    Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions

    For running non-endorsed distributions, see Information for Non-Endorsed Distributions.