OSProfile Class
Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.
Constructor
OSProfile(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
computer_name
|
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. |
|
admin_username
|
Specifies the name of the administrator account. |
|
admin_password
|
Specifies the password of the administrator account. |
|
custom_data
|
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. The property '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. |
|
windows_configuration
|
Specifies Windows operating system settings on the virtual machine. |
|
linux_configuration
|
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. |
|
secrets
|
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. |
|
allow_extension_operations
|
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. |
|
require_guest_provision_signal
|
Optional property which must either be set to True or omitted. |
Attributes
admin_password
** 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: "<xref:mailto:abc@123>", "<xref:mailto:P@$$w0rd>", "<xref:mailto:P@ssw0rd>", "<xref:mailto:P@ssword123>",
"Pa$$word", "<xref:mailto: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
For
resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs
using the VMAccess Extension.
admin_password: str | None
admin_username
Specifies the name of the administrator account.
This property cannot be updated after
the VM is created.
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.
admin_username: str | None
allow_extension_operations
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.
allow_extension_operations: bool | None
computer_name
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.
computer_name: str | None
custom_data
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. The property '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.
custom_data: str | None
linux_configuration
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
linux_configuration: _models.LinuxConfiguration | None
require_guest_provision_signal
Optional property which must either be set to True or omitted.
require_guest_provision_signal: bool | None
secrets
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
secrets: list['_models.VaultSecretGroup'] | None
windows_configuration
Specifies Windows operating system settings on the virtual machine.
windows_configuration: _models.WindowsConfiguration | None