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

package com.azure.resourcemanager.hardwaresecuritymodules.models;

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

/** An immutable client-side representation of DedicatedHsm. */
public interface DedicatedHsm {
    /**
     * 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 sku property: SKU details.
     *
     * @return the sku value.
     */
    Sku sku();

    /**
     * Gets the zones property: The Dedicated Hsm zones.
     *
     * @return the zones value.
     */
    List<String> zones();

    /**
     * Gets the networkProfile property: Specifies the network interfaces of the dedicated hsm.
     *
     * @return the networkProfile value.
     */
    NetworkProfile networkProfile();

    /**
     * Gets the managementNetworkProfile property: Specifies the management network interfaces of the dedicated hsm.
     *
     * @return the managementNetworkProfile value.
     */
    NetworkProfile managementNetworkProfile();

    /**
     * Gets the stampId property: This field will be used when RP does not support Availability zones.
     *
     * @return the stampId value.
     */
    String stampId();

    /**
     * Gets the statusMessage property: Resource Status Message.
     *
     * @return the statusMessage value.
     */
    String statusMessage();

    /**
     * Gets the provisioningState property: Provisioning state.
     *
     * @return the provisioningState value.
     */
    JsonWebKeyType provisioningState();

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

    /** The entirety of the DedicatedHsm definition. */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithLocation,
            DefinitionStages.WithResourceGroup,
            DefinitionStages.WithCreate {
    }
    /** The DedicatedHsm definition stages. */
    interface DefinitionStages {
        /** The first stage of the DedicatedHsm definition. */
        interface Blank extends WithLocation {
        }
        /** The stage of the DedicatedHsm 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 DedicatedHsm definition allowing to specify parent resource. */
        interface WithResourceGroup {
            /**
             * Specifies resourceGroupName.
             *
             * @param resourceGroupName The name of the Resource Group to which the resource belongs.
             * @return the next definition stage.
             */
            WithCreate withExistingResourceGroup(String resourceGroupName);
        }
        /**
         * The stage of the DedicatedHsm 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.WithSku,
                DefinitionStages.WithZones,
                DefinitionStages.WithNetworkProfile,
                DefinitionStages.WithManagementNetworkProfile,
                DefinitionStages.WithStampId {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            DedicatedHsm create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            DedicatedHsm create(Context context);
        }
        /** The stage of the DedicatedHsm 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 DedicatedHsm definition allowing to specify sku. */
        interface WithSku {
            /**
             * Specifies the sku property: SKU details.
             *
             * @param sku SKU details.
             * @return the next definition stage.
             */
            WithCreate withSku(Sku sku);
        }
        /** The stage of the DedicatedHsm definition allowing to specify zones. */
        interface WithZones {
            /**
             * Specifies the zones property: The Dedicated Hsm zones..
             *
             * @param zones The Dedicated Hsm zones.
             * @return the next definition stage.
             */
            WithCreate withZones(List<String> zones);
        }
        /** The stage of the DedicatedHsm definition allowing to specify networkProfile. */
        interface WithNetworkProfile {
            /**
             * Specifies the networkProfile property: Specifies the network interfaces of the dedicated hsm..
             *
             * @param networkProfile Specifies the network interfaces of the dedicated hsm.
             * @return the next definition stage.
             */
            WithCreate withNetworkProfile(NetworkProfile networkProfile);
        }
        /** The stage of the DedicatedHsm definition allowing to specify managementNetworkProfile. */
        interface WithManagementNetworkProfile {
            /**
             * Specifies the managementNetworkProfile property: Specifies the management network interfaces of the
             * dedicated hsm..
             *
             * @param managementNetworkProfile Specifies the management network interfaces of the dedicated hsm.
             * @return the next definition stage.
             */
            WithCreate withManagementNetworkProfile(NetworkProfile managementNetworkProfile);
        }
        /** The stage of the DedicatedHsm definition allowing to specify stampId. */
        interface WithStampId {
            /**
             * Specifies the stampId property: This field will be used when RP does not support Availability zones..
             *
             * @param stampId This field will be used when RP does not support Availability zones.
             * @return the next definition stage.
             */
            WithCreate withStampId(String stampId);
        }
    }
    /**
     * Begins update for the DedicatedHsm resource.
     *
     * @return the stage of resource update.
     */
    DedicatedHsm.Update update();

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

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        DedicatedHsm apply(Context context);
    }
    /** The DedicatedHsm update stages. */
    interface UpdateStages {
        /** The stage of the DedicatedHsm 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.
     */
    DedicatedHsm refresh();

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