VirtualMachineOSProfile Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.
public class VirtualMachineOSProfile : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.Models.VirtualMachineOSProfile>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.Models.VirtualMachineOSProfile>type VirtualMachineOSProfile = class
interface IJsonModel<VirtualMachineOSProfile>
interface IPersistableModel<VirtualMachineOSProfile>Public Class VirtualMachineOSProfile
Implements IJsonModel(Of VirtualMachineOSProfile), IPersistableModel(Of VirtualMachineOSProfile)- Inheritance
-
VirtualMachineOSProfile
- Implements
Constructors
| VirtualMachineOSProfile() |
Initializes a new instance of VirtualMachineOSProfile. |
Properties
| AdminPassword |
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 <br> Has a digit <br> Has a special character (Regex match [\W_]) <br><br> Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "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. |
| AdminUsername |
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. |
| AllowExtensionOperations |
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. |
| ComputerName |
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. |
| CustomData |
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. |
| LinuxConfiguration |
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. |
| RequireGuestProvisionSignal |
Optional property which must either be set to True or omitted. |
| 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. |
| WindowsConfiguration |
Specifies Windows operating system settings on the virtual machine. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
| IJsonModel<VirtualMachineOSProfile>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<VirtualMachineOSProfile>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<VirtualMachineOSProfile>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<VirtualMachineOSProfile>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<VirtualMachineOSProfile>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
