Class: Azure::Compute::Mgmt::V2019_12_01::Models::OSProfile

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb

Overview

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#admin_password ⇒ String


**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](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](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)

Returns:

  • (String) —

    Specifies the password of the administrator account.



58
59
60
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb', line 58

def admin_password
  @admin_password
end

#admin_username ⇒ String


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](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
> 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](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

Returns:

  • (String) —

    Specifies the name of the administrator account.



40
41
42
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb', line 40

def admin_username
  @admin_username
end

#allow_extension_operations ⇒ Boolean

allowed on the virtual machine.
This may only be set to False when no extensions are present on the virtual machine.

Returns:

  • (Boolean) —

    Specifies whether extension operations should be



93
94
95
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb', line 93

def allow_extension_operations
  @allow_extension_operations
end

#computer_name ⇒ String


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](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions).

Returns:

  • (String) —

    Specifies the host OS name of the virtual machine.



22
23
24
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb', line 22

def computer_name
  @computer_name
end

#custom_data ⇒ String

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](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](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

Returns:

  • (String) —

    Specifies a base-64 encoded string of custom data. The



71
72
73
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb', line 71

def custom_data
  @custom_data
end

#linux_configuration ⇒ LinuxConfiguration

settings on the virtual machine.
For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](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](docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).

Returns:



84
85
86
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb', line 84

def linux_configuration
  @linux_configuration
end

#require_guest_provision_signal ⇒ Boolean

required to infer provision success of the virtual machine.

Returns:

  • (Boolean) —

    Specifies whether the guest provision signal is



97
98
99
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb', line 97

def require_guest_provision_signal
  @require_guest_provision_signal
end

#secrets ⇒ Array<VaultSecretGroup>

should be installed onto the virtual machine.

Returns:



88
89
90
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb', line 88

def secrets
  @secrets
end

#windows_configuration ⇒ WindowsConfiguration

settings on the virtual machine.

Returns:



75
76
77
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb', line 75

def windows_configuration
  @windows_configuration
end

Class Method Details

.mapper ⇒ Object

Mapper for OSProfile class as Ruby Hash. This will be used for serialization/deserialization.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/osprofile.rb', line 104

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'OSProfile',
    type: {
      name: 'Composite',
      class_name: 'OSProfile',
      model_properties: {
        computer_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'computerName',
          type: {
            name: 'String'
          }
        },
        admin_username: {
          client_side_validation: true,
          required: false,
          serialized_name: 'adminUsername',
          type: {
            name: 'String'
          }
        },
        admin_password: {
          client_side_validation: true,
          required: false,
          serialized_name: 'adminPassword',
          type: {
            name: 'String'
          }
        },
        custom_data: {
          client_side_validation: true,
          required: false,
          serialized_name: 'customData',
          type: {
            name: 'String'
          }
        },
        windows_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'windowsConfiguration',
          type: {
            name: 'Composite',
            class_name: 'WindowsConfiguration'
          }
        },
        linux_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'linuxConfiguration',
          type: {
            name: 'Composite',
            class_name: 'LinuxConfiguration'
          }
        },
        secrets: {
          client_side_validation: true,
          required: false,
          serialized_name: 'secrets',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VaultSecretGroupElementType',
                type: {
                  name: 'Composite',
                  class_name: 'VaultSecretGroup'
                }
            }
          }
        },
        allow_extension_operations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'allowExtensionOperations',
          type: {
            name: 'Boolean'
          }
        },
        require_guest_provision_signal: {
          client_side_validation: true,
          required: false,
          serialized_name: 'requireGuestProvisionSignal',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end