OSProfile Class

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Inheritance

azure.mgmt.compute._serialization.Model

OSProfile

Constructor

OSProfile(*, computer_name: str | None = None, admin_username: str | None = None, admin_password: str | None = None, custom_data: str | None = None, windows_configuration: _models.WindowsConfiguration | None = None, linux_configuration: _models.LinuxConfiguration | None = None, secrets: List[_models.VaultSecretGroup] | None = None, allow_extension_operations: bool | None = None, require_guest_provision_signal: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
computer_name	str Specifies the host OS name of the virtual machine. <br>``<br> This name cannot be updated after the VM is created. <br>``<br> Max-length (Windows): 15 characters <br>``<br> Max-length (Linux): 64 characters. <br>``<br> For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
admin_username	str Specifies the name of the administrator account. <br>``<br> This property cannot be updated after the VM is created. <br>``<br> Windows-only restriction: Cannot end in "." <br>``<br> 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". <br>``<br> Minimum-length (Linux): 1 character <br>``<br> Max-length (Linux): 64 characters <br>``<br> Max-length (Windows): 20 characters.
admin_password	str Specifies the password of the administrator account. <br>``<br> Minimum-length (Windows): 8 characters <br>``<br> Minimum-length (Linux): 6 characters <br>``<br> Max-length (Windows): 123 characters <br>``<br> Max-length (Linux): 72 characters <br>``<br> Complexity requirements: 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters :code:<br> Has a digit <br> Has a special character (Regex match [W_]) <br>``<br> 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!" <br>``<br> For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM <br>``<br> For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension.
custom_data	str 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. <br>``<br> Note: Do not pass any secrets or passwords in customData property <br>``<br> This property cannot be updated after the VM is created. <br>``<br> customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs <br>``<br> For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation.
windows_configuration	WindowsConfiguration Specifies Windows operating system settings on the virtual machine.
linux_configuration	LinuxConfiguration Specifies the Linux operating system settings on the virtual machine. <br>>>:code:<br>For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions <https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros>_<<.
secrets	list[VaultSecretGroup] 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	bool Specifies whether extension operations should be allowed on the virtual machine. <br>:code:>><<<br>This may only be set to False when no extensions are present on the virtual machine.
require_guest_provision_signal	bool Optional property which must either be set to True or omitted.

Variables

Name	Description
computer_name	str Specifies the host OS name of the virtual machine. <br>``<br> This name cannot be updated after the VM is created. <br>``<br> Max-length (Windows): 15 characters <br>``<br> Max-length (Linux): 64 characters. <br>``<br> For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
admin_username	str Specifies the name of the administrator account. <br>``<br> This property cannot be updated after the VM is created. <br>``<br> Windows-only restriction: Cannot end in "." <br>``<br> 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". <br>``<br> Minimum-length (Linux): 1 character <br>``<br> Max-length (Linux): 64 characters <br>``<br> Max-length (Windows): 20 characters.
admin_password	str Specifies the password of the administrator account. <br>``<br> Minimum-length (Windows): 8 characters <br>``<br> Minimum-length (Linux): 6 characters <br>``<br> Max-length (Windows): 123 characters <br>``<br> Max-length (Linux): 72 characters <br>``<br> Complexity requirements: 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters :code:<br> Has a digit <br> Has a special character (Regex match [W_]) <br>``<br> 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!" <br>``<br> For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM <br>``<br> For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension.
custom_data	str 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. <br>``<br> Note: Do not pass any secrets or passwords in customData property <br>``<br> This property cannot be updated after the VM is created. <br>``<br> customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs <br>``<br> For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation.
windows_configuration	WindowsConfiguration Specifies Windows operating system settings on the virtual machine.
linux_configuration	LinuxConfiguration Specifies the Linux operating system settings on the virtual machine. <br>>>:code:<br>For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions <https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros>_<<.
secrets	list[VaultSecretGroup] 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	bool Specifies whether extension operations should be allowed on the virtual machine. <br>:code:>><<<br>This may only be set to False when no extensions are present on the virtual machine.
require_guest_provision_signal	bool Optional property which must either be set to True or omitted.