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

package com.azure.resourcemanager.sqlvirtualmachine.models;

import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.sqlvirtualmachine.fluent.models.SqlVirtualMachineGroupInner;
import java.util.Map;

/** An immutable client-side representation of SqlVirtualMachineGroup. */
public interface SqlVirtualMachineGroup {
    /**
     * Gets the id property: Fully qualified resource Id for the resource.
     *
     * @return the id value.
     */
    String id();

    /**
     * Gets the name property: The name of the resource.
     *
     * @return the name value.
     */
    String name();

    /**
     * Gets the type property: The type of the resource.
     *
     * @return the type value.
     */
    String type();

    /**
     * Gets the location property: The geo-location where the resource lives.
     *
     * @return the location value.
     */
    String location();

    /**
     * Gets the tags property: Resource tags.
     *
     * @return the tags value.
     */
    Map<String, String> tags();

    /**
     * Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
     *
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the provisioningState property: Provisioning state to track the async operation status.
     *
     * @return the provisioningState value.
     */
    String provisioningState();

    /**
     * Gets the sqlImageOffer property: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
     *
     * @return the sqlImageOffer value.
     */
    String sqlImageOffer();

    /**
     * Gets the sqlImageSku property: SQL image sku.
     *
     * @return the sqlImageSku value.
     */
    SqlVmGroupImageSku sqlImageSku();

    /**
     * Gets the scaleType property: Scale type.
     *
     * @return the scaleType value.
     */
    ScaleType scaleType();

    /**
     * Gets the clusterManagerType property: Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by
     * the scale type of the group and the OS type.
     *
     * @return the clusterManagerType value.
     */
    ClusterManagerType clusterManagerType();

    /**
     * Gets the clusterConfiguration property: Cluster type.
     *
     * @return the clusterConfiguration value.
     */
    ClusterConfiguration clusterConfiguration();

    /**
     * Gets the wsfcDomainProfile property: Cluster Active Directory domain profile.
     *
     * @return the wsfcDomainProfile value.
     */
    WsfcDomainProfile wsfcDomainProfile();

    /**
     * Gets the region of the resource.
     *
     * @return the region of the resource.
     */
    Region region();

    /**
     * Gets the name of the resource region.
     *
     * @return the name of the resource region.
     */
    String regionName();

    /**
     * Gets the name of the resource group.
     *
     * @return the name of the resource group.
     */
    String resourceGroupName();

    /**
     * Gets the inner com.azure.resourcemanager.sqlvirtualmachine.fluent.models.SqlVirtualMachineGroupInner object.
     *
     * @return the inner object.
     */
    SqlVirtualMachineGroupInner innerModel();

    /** The entirety of the SqlVirtualMachineGroup definition. */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithLocation,
            DefinitionStages.WithResourceGroup,
            DefinitionStages.WithCreate {
    }
    /** The SqlVirtualMachineGroup definition stages. */
    interface DefinitionStages {
        /** The first stage of the SqlVirtualMachineGroup definition. */
        interface Blank extends WithLocation {
        }
        /** The stage of the SqlVirtualMachineGroup definition allowing to specify location. */
        interface WithLocation {
            /**
             * Specifies the region for the resource.
             *
             * @param location The geo-location where the resource lives.
             * @return the next definition stage.
             */
            WithResourceGroup withRegion(Region location);

            /**
             * Specifies the region for the resource.
             *
             * @param location The geo-location where the resource lives.
             * @return the next definition stage.
             */
            WithResourceGroup withRegion(String location);
        }
        /** The stage of the SqlVirtualMachineGroup definition allowing to specify parent resource. */
        interface WithResourceGroup {
            /**
             * Specifies resourceGroupName.
             *
             * @param resourceGroupName Name of the resource group that contains the resource. You can obtain this value
             *     from the Azure Resource Manager API or the portal.
             * @return the next definition stage.
             */
            WithCreate withExistingResourceGroup(String resourceGroupName);
        }
        /**
         * The stage of the SqlVirtualMachineGroup definition which contains all the minimum required properties for the
         * resource to be created, but also allows for any other optional properties to be specified.
         */
        interface WithCreate
            extends DefinitionStages.WithTags,
                DefinitionStages.WithSqlImageOffer,
                DefinitionStages.WithSqlImageSku,
                DefinitionStages.WithWsfcDomainProfile {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            SqlVirtualMachineGroup create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            SqlVirtualMachineGroup create(Context context);
        }
        /** The stage of the SqlVirtualMachineGroup definition allowing to specify tags. */
        interface WithTags {
            /**
             * Specifies the tags property: Resource tags..
             *
             * @param tags Resource tags.
             * @return the next definition stage.
             */
            WithCreate withTags(Map<String, String> tags);
        }
        /** The stage of the SqlVirtualMachineGroup definition allowing to specify sqlImageOffer. */
        interface WithSqlImageOffer {
            /**
             * Specifies the sqlImageOffer property: SQL image offer. Examples may include SQL2016-WS2016,
             * SQL2017-WS2016..
             *
             * @param sqlImageOffer SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
             * @return the next definition stage.
             */
            WithCreate withSqlImageOffer(String sqlImageOffer);
        }
        /** The stage of the SqlVirtualMachineGroup definition allowing to specify sqlImageSku. */
        interface WithSqlImageSku {
            /**
             * Specifies the sqlImageSku property: SQL image sku..
             *
             * @param sqlImageSku SQL image sku.
             * @return the next definition stage.
             */
            WithCreate withSqlImageSku(SqlVmGroupImageSku sqlImageSku);
        }
        /** The stage of the SqlVirtualMachineGroup definition allowing to specify wsfcDomainProfile. */
        interface WithWsfcDomainProfile {
            /**
             * Specifies the wsfcDomainProfile property: Cluster Active Directory domain profile..
             *
             * @param wsfcDomainProfile Cluster Active Directory domain profile.
             * @return the next definition stage.
             */
            WithCreate withWsfcDomainProfile(WsfcDomainProfile wsfcDomainProfile);
        }
    }
    /**
     * Begins update for the SqlVirtualMachineGroup resource.
     *
     * @return the stage of resource update.
     */
    SqlVirtualMachineGroup.Update update();

    /** The template for SqlVirtualMachineGroup update. */
    interface Update extends UpdateStages.WithTags {
        /**
         * Executes the update request.
         *
         * @return the updated resource.
         */
        SqlVirtualMachineGroup apply();

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        SqlVirtualMachineGroup apply(Context context);
    }
    /** The SqlVirtualMachineGroup update stages. */
    interface UpdateStages {
        /** The stage of the SqlVirtualMachineGroup update allowing to specify tags. */
        interface WithTags {
            /**
             * Specifies the tags property: Resource tags..
             *
             * @param tags Resource tags.
             * @return the next definition stage.
             */
            Update withTags(Map<String, String> tags);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    SqlVirtualMachineGroup refresh();

    /**
     * Refreshes the resource to sync with Azure.
     *
     * @param context The context to associate with this operation.
     * @return the refreshed resource.
     */
    SqlVirtualMachineGroup refresh(Context context);
}
