azure.mgmt.compute.v2017_12_01.models.VirtualMachineScaleSetOSProfile.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2017_12_01.models.VirtualMachineScaleSetOSProfile
name: VirtualMachineScaleSetOSProfile
fullName: azure.mgmt.compute.v2017_12_01.models.VirtualMachineScaleSetOSProfile
module: azure.mgmt.compute.v2017_12_01.models
inheritances:
- azure.mgmt.compute._serialization.Model
summary: Describes a virtual machine scale set OS profile.
constructor:
  syntax: 'VirtualMachineScaleSetOSProfile(*, computer_name_prefix: 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, **kwargs: Any)'
  keywordOnlyParameters:
  - name: computer_name_prefix
    description: '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.'
    types:
    - <xref:str>
  - name: admin_username
    description: '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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
      # pylint: disable=line-too-long

      `<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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).  #
      pylint: disable=line-too-long'
    types:
    - <xref:str>
  - name: admin_password
    description: '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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)  #
      pylint: disable=line-too-long

      `<br>``<br>` 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).  #
      pylint: disable=line-too-long'
    types:
    - <xref:str>
  - name: custom_data
    description: '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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).  #
      pylint: disable=line-too-long'
    types:
    - <xref:str>
  - name: windows_configuration
    description: 'Specifies Windows operating system settings on the virtual

      machine.'
    types:
    - <xref:azure.mgmt.compute.v2017_12_01.models.WindowsConfiguration>
  - name: linux_configuration
    description: '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/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_<<  #
      pylint: disable=line-too-long

      `<br>``<br>` 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).  #
      pylint: disable=line-too-long'
    types:
    - <xref:azure.mgmt.compute.v2017_12_01.models.LinuxConfiguration>
  - name: secrets
    description: 'Specifies set of certificates that should be installed onto the
      virtual

      machines in the scale set.'
    types:
    - <xref:list>[<xref:azure.mgmt.compute.v2017_12_01.models.VaultSecretGroup>]
variables:
- description: '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.'
  name: computer_name_prefix
  types:
  - <xref:str>
- description: '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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
    # pylint: disable=line-too-long

    `<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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).  #
    pylint: disable=line-too-long'
  name: admin_username
  types:
  - <xref:str>
- description: '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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)  #
    pylint: disable=line-too-long

    `<br>``<br>` 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).  #
    pylint: disable=line-too-long'
  name: admin_password
  types:
  - <xref:str>
- description: '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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).  #
    pylint: disable=line-too-long'
  name: custom_data
  types:
  - <xref:str>
- description: 'Specifies Windows operating system settings on the virtual

    machine.'
  name: windows_configuration
  types:
  - <xref:azure.mgmt.compute.v2017_12_01.models.WindowsConfiguration>
- description: '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/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_<<  #
    pylint: disable=line-too-long

    `<br>``<br>` 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).  #
    pylint: disable=line-too-long'
  name: linux_configuration
  types:
  - <xref:azure.mgmt.compute.v2017_12_01.models.LinuxConfiguration>
- description: 'Specifies set of certificates that should be installed onto the virtual
    machines

    in the scale set.'
  name: secrets
  types:
  - <xref:list>[<xref:azure.mgmt.compute.v2017_12_01.models.VaultSecretGroup>]