• Home
• com.azure.resourcemanager
• azure-resourcemanager-compute
• 2.42.0
• source code
• OSProfile.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.azure.resourcemanager.compute.models.OSProfile Maven / Gradle / Ivy

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.compute.models;

import com.azure.core.annotation.Fluent;
import com.azure.json.JsonReader;
import com.azure.json.JsonSerializable;
import com.azure.json.JsonToken;
import com.azure.json.JsonWriter;
import java.io.IOException;
import java.util.List;

/**
 * Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is
 * provisioned.
 */
@Fluent
public final class OSProfile implements JsonSerializable {
    /*
     * 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](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules).
     */
    private String computerName;

    /*
     * Specifies the name of the administrator account. 

 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.
     */
    private String adminUsername;

    /*
     * 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](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) 

 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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)
     */
    private String adminPassword;

    /*
     * 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](https://azure.microsoft.com/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](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init).
     */
    private String customData;

    /*
     * Specifies Windows operating system settings on the virtual machine.
     */
    private WindowsConfiguration windowsConfiguration;

    /*
     * Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux
     * distributions, see [Linux on Azure-Endorsed
     * Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).
     */
    private LinuxConfiguration linuxConfiguration;

    /*
     * 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](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault
     * virtual machine extension for
     * Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).
     */
    private List secrets;

    /*
     * 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.
     */
    private Boolean allowExtensionOperations;

    /*
     * Optional property which must either be set to True or omitted.
     */
    private Boolean requireGuestProvisionSignal;

    /**
     * Creates an instance of OSProfile class.
     */
    public OSProfile() {
    }

    /**
     * Get the computerName property: 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](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules).
     * 
     * @return the computerName value.
     */
    public String computerName() {
        return this.computerName;
    }

    /**
     * Set the computerName property: 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](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules).
     * 
     * @param computerName the computerName value to set.
     * @return the OSProfile object itself.
     */
    public OSProfile withComputerName(String computerName) {
        this.computerName = computerName;
        return this;
    }

    /**
     * Get the adminUsername property: 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.
     * 
     * @return the adminUsername value.
     */
    public String adminUsername() {
        return this.adminUsername;
    }

    /**
     * Set the adminUsername property: 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.
     * 
     * @param adminUsername the adminUsername value to set.
     * @return the OSProfile object itself.
     */
    public OSProfile withAdminUsername(String adminUsername) {
        this.adminUsername = adminUsername;
        return this;
    }

    /**
     * Get the adminPassword property: 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](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)
     * <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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection).
     * 
     * @return the adminPassword value.
     */
    public String adminPassword() {
        return this.adminPassword;
    }

    /**
     * Set the adminPassword property: 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](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)
     * <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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection).
     * 
     * @param adminPassword the adminPassword value to set.
     * @return the OSProfile object itself.
     */
    public OSProfile withAdminPassword(String adminPassword) {
        this.adminPassword = adminPassword;
        return this;
    }

    /**
     * Get the customData property: 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](https://azure.microsoft.com/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](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init).
     * 
     * @return the customData value.
     */
    public String customData() {
        return this.customData;
    }

    /**
     * Set the customData property: 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](https://azure.microsoft.com/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](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init).
     * 
     * @param customData the customData value to set.
     * @return the OSProfile object itself.
     */
    public OSProfile withCustomData(String customData) {
        this.customData = customData;
        return this;
    }

    /**
     * Get the windowsConfiguration property: Specifies Windows operating system settings on the virtual machine.
     * 
     * @return the windowsConfiguration value.
     */
    public WindowsConfiguration windowsConfiguration() {
        return this.windowsConfiguration;
    }

    /**
     * Set the windowsConfiguration property: Specifies Windows operating system settings on the virtual machine.
     * 
     * @param windowsConfiguration the windowsConfiguration value to set.
     * @return the OSProfile object itself.
     */
    public OSProfile withWindowsConfiguration(WindowsConfiguration windowsConfiguration) {
        this.windowsConfiguration = windowsConfiguration;
        return this;
    }

    /**
     * Get the linuxConfiguration property: Specifies the Linux operating system settings on the virtual machine. For a
     * list of supported Linux distributions, see [Linux on Azure-Endorsed
     * Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).
     * 
     * @return the linuxConfiguration value.
     */
    public LinuxConfiguration linuxConfiguration() {
        return this.linuxConfiguration;
    }

    /**
     * Set the linuxConfiguration property: Specifies the Linux operating system settings on the virtual machine. For a
     * list of supported Linux distributions, see [Linux on Azure-Endorsed
     * Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).
     * 
     * @param linuxConfiguration the linuxConfiguration value to set.
     * @return the OSProfile object itself.
     */
    public OSProfile withLinuxConfiguration(LinuxConfiguration linuxConfiguration) {
        this.linuxConfiguration = linuxConfiguration;
        return this;
    }

    /**
     * Get the secrets property: 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](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault
     * virtual machine extension for
     * Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).
     * 
     * @return the secrets value.
     */
    public List secrets() {
        return this.secrets;
    }

    /**
     * Set the secrets property: 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](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault
     * virtual machine extension for
     * Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).
     * 
     * @param secrets the secrets value to set.
     * @return the OSProfile object itself.
     */
    public OSProfile withSecrets(List secrets) {
        this.secrets = secrets;
        return this;
    }

    /**
     * Get the allowExtensionOperations property: 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.
     * 
     * @return the allowExtensionOperations value.
     */
    public Boolean allowExtensionOperations() {
        return this.allowExtensionOperations;
    }

    /**
     * Set the allowExtensionOperations property: 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.
     * 
     * @param allowExtensionOperations the allowExtensionOperations value to set.
     * @return the OSProfile object itself.
     */
    public OSProfile withAllowExtensionOperations(Boolean allowExtensionOperations) {
        this.allowExtensionOperations = allowExtensionOperations;
        return this;
    }

    /**
     * Get the requireGuestProvisionSignal property: Optional property which must either be set to True or omitted.
     * 
     * @return the requireGuestProvisionSignal value.
     */
    public Boolean requireGuestProvisionSignal() {
        return this.requireGuestProvisionSignal;
    }

    /**
     * Set the requireGuestProvisionSignal property: Optional property which must either be set to True or omitted.
     * 
     * @param requireGuestProvisionSignal the requireGuestProvisionSignal value to set.
     * @return the OSProfile object itself.
     */
    public OSProfile withRequireGuestProvisionSignal(Boolean requireGuestProvisionSignal) {
        this.requireGuestProvisionSignal = requireGuestProvisionSignal;
        return this;
    }

    /**
     * Validates the instance.
     * 
     * @throws IllegalArgumentException thrown if the instance is not valid.
     */
    public void validate() {
        if (windowsConfiguration() != null) {
            windowsConfiguration().validate();
        }
        if (linuxConfiguration() != null) {
            linuxConfiguration().validate();
        }
        if (secrets() != null) {
            secrets().forEach(e -> e.validate());
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
        jsonWriter.writeStartObject();
        jsonWriter.writeStringField("computerName", this.computerName);
        jsonWriter.writeStringField("adminUsername", this.adminUsername);
        jsonWriter.writeStringField("adminPassword", this.adminPassword);
        jsonWriter.writeStringField("customData", this.customData);
        jsonWriter.writeJsonField("windowsConfiguration", this.windowsConfiguration);
        jsonWriter.writeJsonField("linuxConfiguration", this.linuxConfiguration);
        jsonWriter.writeArrayField("secrets", this.secrets, (writer, element) -> writer.writeJson(element));
        jsonWriter.writeBooleanField("allowExtensionOperations", this.allowExtensionOperations);
        jsonWriter.writeBooleanField("requireGuestProvisionSignal", this.requireGuestProvisionSignal);
        return jsonWriter.writeEndObject();
    }

    /**
     * Reads an instance of OSProfile from the JsonReader.
     * 
     * @param jsonReader The JsonReader being read.
     * @return An instance of OSProfile if the JsonReader was pointing to an instance of it, or null if it was pointing
     * to JSON null.
     * @throws IOException If an error occurs while reading the OSProfile.
     */
    public static OSProfile fromJson(JsonReader jsonReader) throws IOException {
        return jsonReader.readObject(reader -> {
            OSProfile deserializedOSProfile = new OSProfile();
            while (reader.nextToken() != JsonToken.END_OBJECT) {
                String fieldName = reader.getFieldName();
                reader.nextToken();

                if ("computerName".equals(fieldName)) {
                    deserializedOSProfile.computerName = reader.getString();
                } else if ("adminUsername".equals(fieldName)) {
                    deserializedOSProfile.adminUsername = reader.getString();
                } else if ("adminPassword".equals(fieldName)) {
                    deserializedOSProfile.adminPassword = reader.getString();
                } else if ("customData".equals(fieldName)) {
                    deserializedOSProfile.customData = reader.getString();
                } else if ("windowsConfiguration".equals(fieldName)) {
                    deserializedOSProfile.windowsConfiguration = WindowsConfiguration.fromJson(reader);
                } else if ("linuxConfiguration".equals(fieldName)) {
                    deserializedOSProfile.linuxConfiguration = LinuxConfiguration.fromJson(reader);
                } else if ("secrets".equals(fieldName)) {
                    List secrets = reader.readArray(reader1 -> VaultSecretGroup.fromJson(reader1));
                    deserializedOSProfile.secrets = secrets;
                } else if ("allowExtensionOperations".equals(fieldName)) {
                    deserializedOSProfile.allowExtensionOperations = reader.getNullable(JsonReader::getBoolean);
                } else if ("requireGuestProvisionSignal".equals(fieldName)) {
                    deserializedOSProfile.requireGuestProvisionSignal = reader.getNullable(JsonReader::getBoolean);
                } else {
                    reader.skipChildren();
                }
            }

            return deserializedOSProfile;
        });
    }
}