Show / Hide Table of Contents

    Class VirtualMachineScaleSetOSProfile

    Describes a virtual machine scale set OS profile.

    Inheritance
    Object
    VirtualMachineScaleSetOSProfile
    Namespace: System.Dynamic.ExpandoObject
    Assembly: Microsoft.Azure.Management.Compute.dll
    Syntax
    public class VirtualMachineScaleSetOSProfile

    Constructors

    VirtualMachineScaleSetOSProfile()

    Initializes a new instance of the VirtualMachineScaleSetOSProfile class.

    Declaration
    public VirtualMachineScaleSetOSProfile ();

    VirtualMachineScaleSetOSProfile(String, String, String, String, WindowsConfiguration, LinuxConfiguration, IList<VaultSecretGroup>)

    Initializes a new instance of the VirtualMachineScaleSetOSProfile class.

    Declaration
    public VirtualMachineScaleSetOSProfile (string computerNamePrefix = 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);
    Parameters
    String computerNamePrefix

    Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.

    String adminUsername

    Specifies the name of the administrator account. <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 <br><br><li> For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure<br><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. <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

    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. <br><br> 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. <br><br>For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions <br><br> 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 machines in the scale set.

    Properties

    AdminPassword

    Gets or sets specifies the password of the administrator account. &lt;br&gt;&lt;br&gt; Minimum-length (Windows): 8 characters &lt;br&gt;&lt;br&gt; Minimum-length (Linux): 6 characters &lt;br&gt;&lt;br&gt; Max-length (Windows): 123 characters &lt;br&gt;&lt;br&gt; Max-length (Linux): 72 characters &lt;br&gt;&lt;br&gt; Complexity requirements: 3 out of 4 conditions below need to be fulfilled &lt;br&gt; Has lower characters &lt;br&gt;Has upper characters &lt;br&gt; Has a digit &lt;br&gt; Has a special character (Regex match [\W_]) &lt;br&gt;&lt;br&gt; Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" &lt;br&gt;&lt;br&gt; For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM &lt;br&gt;&lt;br&gt; 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. &lt;br&gt;&lt;br&gt; Windows-only restriction: Cannot end in "." &lt;br&gt;&lt;br&gt; 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". &lt;br&gt;&lt;br&gt; Minimum-length (Linux): 1 character &lt;br&gt;&lt;br&gt; Max-length (Linux): 64 characters &lt;br&gt;&lt;br&gt; Max-length (Windows): 20 characters &lt;br&gt;&lt;br&gt;&lt;li&gt; For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure&lt;br&gt;&lt;li&gt; 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

    ComputerNamePrefix

    Gets or sets specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="computerNamePrefix")]
    public string ComputerNamePrefix { 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. &lt;br&gt;&lt;br&gt; 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. &lt;br&gt;&lt;br&gt;For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions &lt;br&gt;&lt;br&gt; 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 machines in the scale set.

    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

    Back to top Azure SDK for Net