Class OSProfile

Specifies the operating system settings for the virtual machine.

Inheritance

OSProfile

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.Compute.dll

Syntax

public class OSProfile

Constructors

OSProfile()

Initializes a new instance of the OSProfile class.

Declaration

public OSProfile ();

OSProfile(String, String, String, String, WindowsConfiguration, LinuxConfiguration, IList<VaultSecretGroup>, Nullable<Boolean>)

Initializes a new instance of the OSProfile class.

Declaration

public OSProfile (string computerName = null, string adminUsername = null, string adminPassword = null, string customData = null, Microsoft.Azure.Management.Compute.Models.WindowsConfiguration windowsConfiguration = null, Microsoft.Azure.Management.Compute.Models.LinuxConfiguration linuxConfiguration = null, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VaultSecretGroup> secrets = null, Nullable<bool> allowExtensionOperations = null);

Parameters

String 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.

String adminUsername

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

String adminPassword

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 For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

String 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. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

WindowsConfiguration windowsConfiguration

Specifies Windows operating system settings on the virtual machine.

LinuxConfiguration linuxConfiguration

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.

IList<VaultSecretGroup> secrets

Specifies set of certificates that should be installed onto the virtual machine.

Nullable<Boolean> 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.

Properties

AdminPassword

Gets or sets 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 For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="adminPassword")]
public string AdminPassword { get; set; }

Property Value

String

AdminUsername

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="adminUsername")]
public string AdminUsername { get; set; }

Property Value

String

AllowExtensionOperations

Gets or sets 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.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="allowExtensionOperations")]
public Nullable<bool> AllowExtensionOperations { get; set; }

Property Value

Nullable<Boolean>

ComputerName

Gets or sets 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.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="computerName")]
public string ComputerName { get; set; }

Property Value

String

CustomData

Gets or sets 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. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="customData")]
public string CustomData { get; set; }

Property Value

String

LinuxConfiguration

Gets or sets 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.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="linuxConfiguration")]
public Microsoft.Azure.Management.Compute.Models.LinuxConfiguration LinuxConfiguration { get; set; }

Property Value

LinuxConfiguration

Secrets

Gets or sets specifies set of certificates that should be installed onto the virtual machine.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="secrets")]
public System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VaultSecretGroup> Secrets { get; set; }

Property Value

IList<VaultSecretGroup>

WindowsConfiguration

Gets or sets specifies Windows operating system settings on the virtual machine.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="windowsConfiguration")]
public Microsoft.Azure.Management.Compute.Models.WindowsConfiguration WindowsConfiguration { get; set; }

Property Value

WindowsConfiguration