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

package com.azure.resourcemanager.networkcloud.models;

import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.networkcloud.fluent.models.ClusterManagerInner;
import java.util.List;
import java.util.Map;

/** An immutable client-side representation of ClusterManager. */
public interface ClusterManager {
    /**
     * 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: Azure Resource Manager metadata containing createdBy and modifiedBy information.
     *
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the analyticsWorkspaceId property: The resource ID of the Log Analytics workspace that is used for the logs
     * collection.
     *
     * @return the analyticsWorkspaceId value.
     */
    String analyticsWorkspaceId();

    /**
     * Gets the availabilityZones property: Field deprecated, this value will no longer influence the cluster manager
     * allocation process and will be removed in a future version. The Azure availability zones within the region that
     * will be used to support the cluster manager resource.
     *
     * @return the availabilityZones value.
     */
    List<String> availabilityZones();

    /**
     * Gets the clusterVersions property: The list of the cluster versions the manager supports. It is used as input in
     * clusterVersion property of a cluster resource.
     *
     * @return the clusterVersions value.
     */
    List<ClusterAvailableVersion> clusterVersions();

    /**
     * Gets the detailedStatus property: The detailed status that provides additional information about the cluster
     * manager.
     *
     * @return the detailedStatus value.
     */
    ClusterManagerDetailedStatus detailedStatus();

    /**
     * Gets the detailedStatusMessage property: The descriptive message about the current detailed status.
     *
     * @return the detailedStatusMessage value.
     */
    String detailedStatusMessage();

    /**
     * Gets the fabricControllerId property: The resource ID of the fabric controller that has one to one mapping with
     * the cluster manager.
     *
     * @return the fabricControllerId value.
     */
    String fabricControllerId();

    /**
     * Gets the managedResourceGroupConfiguration property: ManagedResourceGroupConfiguration represents the
     * configuration of the resource group managed by Azure.
     *
     * <p>The configuration of the managed resource group associated with the resource.
     *
     * @return the managedResourceGroupConfiguration value.
     */
    ManagedResourceGroupConfiguration managedResourceGroupConfiguration();

    /**
     * Gets the managerExtendedLocation property: ExtendedLocation represents the Azure custom location where the
     * resource will be created.
     *
     * <p>The extended location (custom location) that represents the cluster manager's control plane location. This
     * extended location is used when creating cluster and rack manifest resources.
     *
     * @return the managerExtendedLocation value.
     */
    ExtendedLocation managerExtendedLocation();

    /**
     * Gets the provisioningState property: The provisioning state of the cluster manager.
     *
     * @return the provisioningState value.
     */
    ClusterManagerProvisioningState provisioningState();

    /**
     * Gets the vmSize property: Field deprecated, this value will no longer influence the cluster manager allocation
     * process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the
     * cluster manager resource.
     *
     * @return the vmSize value.
     */
    String vmSize();

    /**
     * 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.networkcloud.fluent.models.ClusterManagerInner object.
     *
     * @return the inner object.
     */
    ClusterManagerInner innerModel();

    /** The entirety of the ClusterManager definition. */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithLocation,
            DefinitionStages.WithResourceGroup,
            DefinitionStages.WithFabricControllerId,
            DefinitionStages.WithCreate {
    }
    /** The ClusterManager definition stages. */
    interface DefinitionStages {
        /** The first stage of the ClusterManager definition. */
        interface Blank extends WithLocation {
        }
        /** The stage of the ClusterManager 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 ClusterManager definition allowing to specify parent resource. */
        interface WithResourceGroup {
            /**
             * Specifies resourceGroupName.
             *
             * @param resourceGroupName The name of the resource group. The name is case insensitive.
             * @return the next definition stage.
             */
            WithFabricControllerId withExistingResourceGroup(String resourceGroupName);
        }
        /** The stage of the ClusterManager definition allowing to specify fabricControllerId. */
        interface WithFabricControllerId {
            /**
             * Specifies the fabricControllerId property: The resource ID of the fabric controller that has one to one
             * mapping with the cluster manager..
             *
             * @param fabricControllerId The resource ID of the fabric controller that has one to one mapping with the
             *     cluster manager.
             * @return the next definition stage.
             */
            WithCreate withFabricControllerId(String fabricControllerId);
        }
        /**
         * The stage of the ClusterManager 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.WithAnalyticsWorkspaceId,
                DefinitionStages.WithAvailabilityZones,
                DefinitionStages.WithManagedResourceGroupConfiguration,
                DefinitionStages.WithVmSize {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            ClusterManager create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            ClusterManager create(Context context);
        }
        /** The stage of the ClusterManager 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 ClusterManager definition allowing to specify analyticsWorkspaceId. */
        interface WithAnalyticsWorkspaceId {
            /**
             * Specifies the analyticsWorkspaceId property: The resource ID of the Log Analytics workspace that is used
             * for the logs collection..
             *
             * @param analyticsWorkspaceId The resource ID of the Log Analytics workspace that is used for the logs
             *     collection.
             * @return the next definition stage.
             */
            WithCreate withAnalyticsWorkspaceId(String analyticsWorkspaceId);
        }
        /** The stage of the ClusterManager definition allowing to specify availabilityZones. */
        interface WithAvailabilityZones {
            /**
             * Specifies the availabilityZones property: Field deprecated, this value will no longer influence the
             * cluster manager allocation process and will be removed in a future version. The Azure availability zones
             * within the region that will be used to support the cluster manager resource..
             *
             * @param availabilityZones Field deprecated, this value will no longer influence the cluster manager
             *     allocation process and will be removed in a future version. The Azure availability zones within the
             *     region that will be used to support the cluster manager resource.
             * @return the next definition stage.
             */
            WithCreate withAvailabilityZones(List<String> availabilityZones);
        }
        /** The stage of the ClusterManager definition allowing to specify managedResourceGroupConfiguration. */
        interface WithManagedResourceGroupConfiguration {
            /**
             * Specifies the managedResourceGroupConfiguration property: ManagedResourceGroupConfiguration represents
             * the configuration of the resource group managed by Azure.
             *
             * <p>The configuration of the managed resource group associated with the resource..
             *
             * @param managedResourceGroupConfiguration ManagedResourceGroupConfiguration represents the configuration
             *     of the resource group managed by Azure.
             *     <p>The configuration of the managed resource group associated with the resource.
             * @return the next definition stage.
             */
            WithCreate withManagedResourceGroupConfiguration(
                ManagedResourceGroupConfiguration managedResourceGroupConfiguration);
        }
        /** The stage of the ClusterManager definition allowing to specify vmSize. */
        interface WithVmSize {
            /**
             * Specifies the vmSize property: Field deprecated, this value will no longer influence the cluster manager
             * allocation process and will be removed in a future version. The size of the Azure virtual machines to use
             * for hosting the cluster manager resource..
             *
             * @param vmSize Field deprecated, this value will no longer influence the cluster manager allocation
             *     process and will be removed in a future version. The size of the Azure virtual machines to use for
             *     hosting the cluster manager resource.
             * @return the next definition stage.
             */
            WithCreate withVmSize(String vmSize);
        }
    }
    /**
     * Begins update for the ClusterManager resource.
     *
     * @return the stage of resource update.
     */
    ClusterManager.Update update();

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

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

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