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

package com.azure.resourcemanager.managednetworkfabric.models;

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

/** An immutable client-side representation of NetworkFabricController. */
public interface NetworkFabricController {
    /**
     * 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 infrastructureServices property: InfrastructureServices IP ranges.
     *
     * @return the infrastructureServices value.
     */
    InfrastructureServices infrastructureServices();

    /**
     * Gets the workloadServices property: WorkloadServices IP ranges.
     *
     * @return the workloadServices value.
     */
    WorkloadServices workloadServices();

    /**
     * Gets the managedResourceGroupConfiguration property: Managed Resource Group configuration properties.
     *
     * @return the managedResourceGroupConfiguration value.
     */
    ManagedResourceGroupConfiguration managedResourceGroupConfiguration();

    /**
     * Gets the networkFabricIds property: The NF-ID will be an input parameter used by the NF to link and get
     * associated with the parent NFC Service.
     *
     * @return the networkFabricIds value.
     */
    List<String> networkFabricIds();

    /**
     * Gets the workloadManagementNetwork property: A workload management network is required for all the tenant
     * (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or
     * any other MSFT/Public endpoints.
     *
     * @return the workloadManagementNetwork value.
     */
    Boolean workloadManagementNetwork();

    /**
     * Gets the ipv4AddressSpace property: IPv4 Network Fabric Controller Address Space.
     *
     * @return the ipv4AddressSpace value.
     */
    String ipv4AddressSpace();

    /**
     * Gets the ipv6AddressSpace property: IPv6 Network Fabric Controller Address Space.
     *
     * @return the ipv6AddressSpace value.
     */
    String ipv6AddressSpace();

    /**
     * Gets the operationalState property: The Operational Status would always be NULL. Look only in to the Provisioning
     * state for the latest status.
     *
     * @return the operationalState value.
     */
    NetworkFabricControllerOperationalState operationalState();

    /**
     * Gets the provisioningState property: Provides you the latest status of the NFC service, whether it is Accepted,
     * updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC
     * provisioning.
     *
     * @return the provisioningState value.
     */
    ProvisioningState provisioningState();

    /**
     * Gets the infrastructureExpressRouteConnections property: As part of an update, the Infrastructure ExpressRoute
     * CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure
     * services. (This is a Mandatory attribute).
     *
     * @return the infrastructureExpressRouteConnections value.
     */
    List<ExpressRouteConnectionInformation> infrastructureExpressRouteConnections();

    /**
     * Gets the workloadExpressRouteConnections property: As part of an update, the workload ExpressRoute CircuitID
     * should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is
     * a Mandatory attribute).
     *
     * @return the workloadExpressRouteConnections value.
     */
    List<ExpressRouteConnectionInformation> workloadExpressRouteConnections();

    /**
     * Gets the annotation property: Switch configuration description.
     *
     * @return the annotation value.
     */
    String annotation();

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

    /** The entirety of the NetworkFabricController definition. */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithLocation,
            DefinitionStages.WithResourceGroup,
            DefinitionStages.WithCreate {
    }
    /** The NetworkFabricController definition stages. */
    interface DefinitionStages {
        /** The first stage of the NetworkFabricController definition. */
        interface Blank extends WithLocation {
        }
        /** The stage of the NetworkFabricController 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 NetworkFabricController 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.
             */
            WithCreate withExistingResourceGroup(String resourceGroupName);
        }
        /**
         * The stage of the NetworkFabricController 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.WithManagedResourceGroupConfiguration,
                DefinitionStages.WithIpv4AddressSpace,
                DefinitionStages.WithIpv6AddressSpace,
                DefinitionStages.WithInfrastructureExpressRouteConnections,
                DefinitionStages.WithWorkloadExpressRouteConnections,
                DefinitionStages.WithAnnotation {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            NetworkFabricController create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            NetworkFabricController create(Context context);
        }
        /** The stage of the NetworkFabricController 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 NetworkFabricController definition allowing to specify managedResourceGroupConfiguration.
         */
        interface WithManagedResourceGroupConfiguration {
            /**
             * Specifies the managedResourceGroupConfiguration property: Managed Resource Group configuration
             * properties..
             *
             * @param managedResourceGroupConfiguration Managed Resource Group configuration properties.
             * @return the next definition stage.
             */
            WithCreate withManagedResourceGroupConfiguration(
                ManagedResourceGroupConfiguration managedResourceGroupConfiguration);
        }
        /** The stage of the NetworkFabricController definition allowing to specify ipv4AddressSpace. */
        interface WithIpv4AddressSpace {
            /**
             * Specifies the ipv4AddressSpace property: IPv4 Network Fabric Controller Address Space..
             *
             * @param ipv4AddressSpace IPv4 Network Fabric Controller Address Space.
             * @return the next definition stage.
             */
            WithCreate withIpv4AddressSpace(String ipv4AddressSpace);
        }
        /** The stage of the NetworkFabricController definition allowing to specify ipv6AddressSpace. */
        interface WithIpv6AddressSpace {
            /**
             * Specifies the ipv6AddressSpace property: IPv6 Network Fabric Controller Address Space..
             *
             * @param ipv6AddressSpace IPv6 Network Fabric Controller Address Space.
             * @return the next definition stage.
             */
            WithCreate withIpv6AddressSpace(String ipv6AddressSpace);
        }
        /**
         * The stage of the NetworkFabricController definition allowing to specify
         * infrastructureExpressRouteConnections.
         */
        interface WithInfrastructureExpressRouteConnections {
            /**
             * Specifies the infrastructureExpressRouteConnections property: As part of an update, the Infrastructure
             * ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated
             * for Infrastructure services. (This is a Mandatory attribute).
             *
             * @param infrastructureExpressRouteConnections As part of an update, the Infrastructure ExpressRoute
             *     CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for
             *     Infrastructure services. (This is a Mandatory attribute).
             * @return the next definition stage.
             */
            WithCreate withInfrastructureExpressRouteConnections(
                List<ExpressRouteConnectionInformation> infrastructureExpressRouteConnections);
        }
        /** The stage of the NetworkFabricController definition allowing to specify workloadExpressRouteConnections. */
        interface WithWorkloadExpressRouteConnections {
            /**
             * Specifies the workloadExpressRouteConnections property: As part of an update, the workload ExpressRoute
             * CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload
             * services. (This is a Mandatory attribute)..
             *
             * @param workloadExpressRouteConnections As part of an update, the workload ExpressRoute CircuitID should
             *     be provided to create and Provision a NFC. This Express route is dedicated for Workload services.
             *     (This is a Mandatory attribute).
             * @return the next definition stage.
             */
            WithCreate withWorkloadExpressRouteConnections(
                List<ExpressRouteConnectionInformation> workloadExpressRouteConnections);
        }
        /** The stage of the NetworkFabricController definition allowing to specify annotation. */
        interface WithAnnotation {
            /**
             * Specifies the annotation property: Switch configuration description..
             *
             * @param annotation Switch configuration description.
             * @return the next definition stage.
             */
            WithCreate withAnnotation(String annotation);
        }
    }
    /**
     * Begins update for the NetworkFabricController resource.
     *
     * @return the stage of resource update.
     */
    NetworkFabricController.Update update();

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

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        NetworkFabricController apply(Context context);
    }
    /** The NetworkFabricController update stages. */
    interface UpdateStages {
        /** The stage of the NetworkFabricController update allowing to specify tags. */
        interface WithTags {
            /**
             * Specifies the tags property: Azure resource tags that will replace the existing ones..
             *
             * @param tags Azure resource tags that will replace the existing ones.
             * @return the next definition stage.
             */
            Update withTags(Map<String, String> tags);
        }
        /**
         * The stage of the NetworkFabricController update allowing to specify infrastructureExpressRouteConnections.
         */
        interface WithInfrastructureExpressRouteConnections {
            /**
             * Specifies the infrastructureExpressRouteConnections property: As part of an update, the Infrastructure
             * ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated
             * for Infrastructure services. (This is a Mandatory attribute).
             *
             * @param infrastructureExpressRouteConnections As part of an update, the Infrastructure ExpressRoute
             *     CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for
             *     Infrastructure services. (This is a Mandatory attribute).
             * @return the next definition stage.
             */
            Update withInfrastructureExpressRouteConnections(
                List<ExpressRouteConnectionInformation> infrastructureExpressRouteConnections);
        }
        /** The stage of the NetworkFabricController update allowing to specify workloadExpressRouteConnections. */
        interface WithWorkloadExpressRouteConnections {
            /**
             * Specifies the workloadExpressRouteConnections property: As part of an update, the workload ExpressRoute
             * CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload
             * services. (This is a Mandatory attribute)..
             *
             * @param workloadExpressRouteConnections As part of an update, the workload ExpressRoute CircuitID should
             *     be provided to create and Provision a NFC. This Express route is dedicated for Workload services.
             *     (This is a Mandatory attribute).
             * @return the next definition stage.
             */
            Update withWorkloadExpressRouteConnections(
                List<ExpressRouteConnectionInformation> workloadExpressRouteConnections);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    NetworkFabricController refresh();

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

    /**
     * Implements the operation to the underlying resources.
     *
     * <p>Enables the workloadManagementNetwork (Tenant Network).
     *
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void enableWorkloadManagementNetwork();

    /**
     * Implements the operation to the underlying resources.
     *
     * <p>Enables the workloadManagementNetwork (Tenant Network).
     *
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void enableWorkloadManagementNetwork(Context context);

    /**
     * Implements the operation to the underlying resources.
     *
     * <p>Disables the workloadManagementNetwork (Tenant Network).
     *
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void disableWorkloadManagementNetwork();

    /**
     * Implements the operation to the underlying resources.
     *
     * <p>Disables the workloadManagementNetwork (Tenant Network).
     *
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void disableWorkloadManagementNetwork(Context context);
}
