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

package com.azure.resourcemanager.azureadexternalidentities.models;

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

/** An immutable client-side representation of B2CTenantResource. */
public interface B2CTenantResource {
    /**
     * 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 sku property: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at
     * [aka.ms/b2cBilling](https://aka.ms/b2cBilling).
     *
     * @return the sku value.
     */
    B2CResourceSku sku();

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

    /**
     * Gets the billingConfig property: The billing configuration for the tenant.
     *
     * @return the billingConfig value.
     */
    B2CTenantResourcePropertiesBillingConfig billingConfig();

    /**
     * Gets the tenantId property: An identifier of the Azure AD B2C tenant.
     *
     * @return the tenantId value.
     */
    String tenantId();

    /**
     * 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 inner com.azure.resourcemanager.azureadexternalidentities.fluent.models.B2CTenantResourceInner object.
     *
     * @return the inner object.
     */
    B2CTenantResourceInner innerModel();

    /** The entirety of the B2CTenantResource definition. */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithLocation,
            DefinitionStages.WithResourceGroup,
            DefinitionStages.WithSku,
            DefinitionStages.WithCreate {
    }
    /** The B2CTenantResource definition stages. */
    interface DefinitionStages {
        /** The first stage of the B2CTenantResource definition. */
        interface Blank extends WithLocation {
        }
        /** The stage of the B2CTenantResource definition allowing to specify location. */
        interface WithLocation {
            /**
             * Specifies the region for the resource.
             *
             * @param location The location in which the resource is hosted and data resides. Can be one of 'United
             *     States', 'Europe', 'Asia Pacific', or 'Australia'. Refer to [this
             *     documentation](https://aka.ms/B2CDataResidency) for more information.
             * @return the next definition stage.
             */
            WithResourceGroup withRegion(Region location);

            /**
             * Specifies the region for the resource.
             *
             * @param location The location in which the resource is hosted and data resides. Can be one of 'United
             *     States', 'Europe', 'Asia Pacific', or 'Australia'. Refer to [this
             *     documentation](https://aka.ms/B2CDataResidency) for more information.
             * @return the next definition stage.
             */
            WithResourceGroup withRegion(String location);
        }
        /** The stage of the B2CTenantResource definition allowing to specify parent resource. */
        interface WithResourceGroup {
            /**
             * Specifies resourceGroupName.
             *
             * @param resourceGroupName The name of the resource group.
             * @return the next definition stage.
             */
            WithSku withExistingResourceGroup(String resourceGroupName);
        }
        /** The stage of the B2CTenantResource definition allowing to specify sku. */
        interface WithSku {
            /**
             * Specifies the sku property: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C
             * billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling)..
             *
             * @param sku SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at
             *     [aka.ms/b2cBilling](https://aka.ms/b2cBilling).
             * @return the next definition stage.
             */
            WithCreate withSku(B2CResourceSku sku);
        }
        /**
         * The stage of the B2CTenantResource 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.WithDisplayName, DefinitionStages.WithCountryCode {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            B2CTenantResource create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            B2CTenantResource create(Context context);
        }
        /** The stage of the B2CTenantResource 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 B2CTenantResource definition allowing to specify displayName. */
        interface WithDisplayName {
            /**
             * Specifies the displayName property: The display name of the Azure AD B2C tenant..
             *
             * @param displayName The display name of the Azure AD B2C tenant.
             * @return the next definition stage.
             */
            WithCreate withDisplayName(String displayName);
        }
        /** The stage of the B2CTenantResource definition allowing to specify countryCode. */
        interface WithCountryCode {
            /**
             * Specifies the countryCode property: Country code of Azure tenant (e.g. 'US'). Refer to
             * [aka.ms/B2CDataResidency](https://aka.ms/B2CDataResidency) to see valid country codes and corresponding
             * data residency locations. If you do not see a country code in an valid data residency location, choose
             * one from the list..
             *
             * @param countryCode Country code of Azure tenant (e.g. 'US'). Refer to
             *     [aka.ms/B2CDataResidency](https://aka.ms/B2CDataResidency) to see valid country codes and
             *     corresponding data residency locations. If you do not see a country code in an valid data residency
             *     location, choose one from the list.
             * @return the next definition stage.
             */
            WithCreate withCountryCode(String countryCode);
        }
    }
    /**
     * Begins update for the B2CTenantResource resource.
     *
     * @return the stage of resource update.
     */
    B2CTenantResource.Update update();

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

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        B2CTenantResource apply(Context context);
    }
    /** The B2CTenantResource update stages. */
    interface UpdateStages {
        /** The stage of the B2CTenantResource 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);
        }
        /** The stage of the B2CTenantResource update allowing to specify sku. */
        interface WithSku {
            /**
             * Specifies the sku property: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C
             * billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling)..
             *
             * @param sku SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at
             *     [aka.ms/b2cBilling](https://aka.ms/b2cBilling).
             * @return the next definition stage.
             */
            Update withSku(B2CResourceSku sku);
        }
        /** The stage of the B2CTenantResource update allowing to specify billingConfig. */
        interface WithBillingConfig {
            /**
             * Specifies the billingConfig property: The billing configuration for the tenant..
             *
             * @param billingConfig The billing configuration for the tenant.
             * @return the next definition stage.
             */
            Update withBillingConfig(B2CTenantResourcePropertiesBillingConfig billingConfig);
        }
        /** The stage of the B2CTenantResource update allowing to specify tenantId. */
        interface WithTenantId {
            /**
             * Specifies the tenantId property: An identifier of the Azure AD B2C tenant..
             *
             * @param tenantId An identifier of the Azure AD B2C tenant.
             * @return the next definition stage.
             */
            Update withTenantId(String tenantId);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    B2CTenantResource refresh();

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