OSProfile (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.resourcemanager.compute.models.OSProfile

```
public final class OSProfile
extends Object
```
Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Constructor Summary

Constructors
Constructor and Description

OSProfile()

Constructors
Constructor and Description
`OSProfile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`adminPassword()` Get the adminPassword property: Specifies the password of the administrator account.
`String`	`adminUsername()` Get the adminUsername property: Specifies the name of the administrator account.
`Boolean`	`allowExtensionOperations()` Get the allowExtensionOperations property: Specifies whether extension operations should be allowed on the virtual machine.
`String`	`computerName()` Get the computerName property: Specifies the host OS name of the virtual machine.
`String`	`customData()` Get the customData property: Specifies a base-64 encoded string of custom data.
`LinuxConfiguration`	`linuxConfiguration()` Get the linuxConfiguration property: Specifies the Linux operating system settings on the virtual machine.
`Boolean`	`requireGuestProvisionSignal()` Get the requireGuestProvisionSignal property: Specifies whether the guest provision signal is required to infer provision success of the virtual machine.
`List<VaultSecretGroup>`	`secrets()` Get the secrets property: Specifies set of certificates that should be installed onto the virtual machine.
`void`	`validate()` Validates the instance.
`WindowsConfiguration`	`windowsConfiguration()` Get the windowsConfiguration property: Specifies Windows operating system settings on the virtual machine.
`OSProfile`	`withAdminPassword(String adminPassword)` Set the adminPassword property: Specifies the password of the administrator account.
`OSProfile`	`withAdminUsername(String adminUsername)` Set the adminUsername property: Specifies the name of the administrator account.
`OSProfile`	`withAllowExtensionOperations(Boolean allowExtensionOperations)` Set the allowExtensionOperations property: Specifies whether extension operations should be allowed on the virtual machine.
`OSProfile`	`withComputerName(String computerName)` Set the computerName property: Specifies the host OS name of the virtual machine.
`OSProfile`	`withCustomData(String customData)` Set the customData property: Specifies a base-64 encoded string of custom data.
`OSProfile`	`withLinuxConfiguration(LinuxConfiguration linuxConfiguration)` Set the linuxConfiguration property: Specifies the Linux operating system settings on the virtual machine.
`OSProfile`	`withRequireGuestProvisionSignal(Boolean requireGuestProvisionSignal)` Set the requireGuestProvisionSignal property: Specifies whether the guest provision signal is required to infer provision success of the virtual machine.
`OSProfile`	`withSecrets(List<VaultSecretGroup> secrets)` Set the secrets property: Specifies set of certificates that should be installed onto the virtual machine.
`OSProfile`	`withWindowsConfiguration(WindowsConfiguration windowsConfiguration)` Set the windowsConfiguration property: Specifies Windows operating system settings on the virtual machine.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - OSProfile
```
public OSProfile()
```
- Method Detail
 - computerName
```
public String computerName()
```
 Get the computerName property: 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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions).
 
 Returns:
 
 the computerName value.
 - withComputerName
```
public OSProfile withComputerName(String computerName)
```
 Set the computerName property: 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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions).
 
 Parameters:
 
 computerName - the computerName value to set.
 
 Returns:
 
 the OSProfile object itself.
 - adminUsername
```
public String adminUsername()
```
 Get the adminUsername property: 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 <li> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) <li> 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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
 
 Returns:
 
 the adminUsername value.
 - withAdminUsername
```
public OSProfile withAdminUsername(String adminUsername)
```
 Set the adminUsername property: 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 <li> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) <li> 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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
 
 Parameters:
 
 adminUsername - the adminUsername value to set.
 
 Returns:
 
 the OSProfile object itself.
 - adminPassword
```
public String adminPassword()
```
 Get the adminPassword property: 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](https://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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password).
 
 Returns:
 
 the adminPassword value.
 - withAdminPassword
```
public OSProfile withAdminPassword(String adminPassword)
```
 Set the adminPassword property: 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](https://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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password).
 
 Parameters:
 
 adminPassword - the adminPassword value to set.
 
 Returns:
 
 the OSProfile object itself.
 - customData
```
public String customData()
```
 Get the customData property: 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](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/) For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
 
 Returns:
 
 the customData value.
 - withCustomData
```
public OSProfile withCustomData(String customData)
```
 Set the customData property: 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](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/) For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
 
 Parameters:
 
 customData - the customData value to set.
 
 Returns:
 
 the OSProfile object itself.
 - windowsConfiguration
```
public WindowsConfiguration windowsConfiguration()
```
 Get the windowsConfiguration property: Specifies Windows operating system settings on the virtual machine.
 
 Returns:
 
 the windowsConfiguration value.
 - withWindowsConfiguration
```
public OSProfile withWindowsConfiguration(WindowsConfiguration windowsConfiguration)
```
 Set the windowsConfiguration property: Specifies Windows operating system settings on the virtual machine.
 
 Parameters:
 
 windowsConfiguration - the windowsConfiguration value to set.
 
 Returns:
 
 the OSProfile object itself.
 - linuxConfiguration
```
public LinuxConfiguration linuxConfiguration()
```
 Get the linuxConfiguration property: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
 
 Returns:
 
 the linuxConfiguration value.
 - withLinuxConfiguration
```
public OSProfile withLinuxConfiguration(LinuxConfiguration linuxConfiguration)
```
 Set the linuxConfiguration property: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
 
 Parameters:
 
 linuxConfiguration - the linuxConfiguration value to set.
 
 Returns:
 
 the OSProfile object itself.
 - secrets
```
public List<VaultSecretGroup> secrets()
```
 Get the secrets property: Specifies set of certificates that should be installed onto the virtual machine.
 
 Returns:
 
 the secrets value.
 - withSecrets
```
public OSProfile withSecrets(List<VaultSecretGroup> secrets)
```
 Set the secrets property: Specifies set of certificates that should be installed onto the virtual machine.
 
 Parameters:
 
 secrets - the secrets value to set.
 
 Returns:
 
 the OSProfile object itself.
 - allowExtensionOperations
```
public Boolean allowExtensionOperations()
```
 Get the allowExtensionOperations property: 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.
 
 Returns:
 
 the allowExtensionOperations value.
 - withAllowExtensionOperations
```
public OSProfile withAllowExtensionOperations(Boolean allowExtensionOperations)
```
 Set the allowExtensionOperations property: 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.
 
 Parameters:
 
 allowExtensionOperations - the allowExtensionOperations value to set.
 
 Returns:
 
 the OSProfile object itself.
 - requireGuestProvisionSignal
```
public Boolean requireGuestProvisionSignal()
```
 Get the requireGuestProvisionSignal property: Specifies whether the guest provision signal is required to infer provision success of the virtual machine.
 
 Returns:
 
 the requireGuestProvisionSignal value.
 - withRequireGuestProvisionSignal
```
public OSProfile withRequireGuestProvisionSignal(Boolean requireGuestProvisionSignal)
```
 Set the requireGuestProvisionSignal property: Specifies whether the guest provision signal is required to infer provision success of the virtual machine.
 
 Parameters:
 
 requireGuestProvisionSignal - the requireGuestProvisionSignal value to set.
 
 Returns:
 
 the OSProfile object itself.
 - validate
```
public void validate()
```
 Validates the instance.
 
 Throws:
 
 IllegalArgumentException - thrown if the instance is not valid.

Class OSProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OSProfile

Method Detail

computerName

withComputerName

adminUsername

withAdminUsername

adminPassword

withAdminPassword

customData

withCustomData

windowsConfiguration

withWindowsConfiguration

linuxConfiguration

withLinuxConfiguration

secrets

withSecrets

allowExtensionOperations

withAllowExtensionOperations

requireGuestProvisionSignal

withRequireGuestProvisionSignal

validate