com.azure.resourcemanager.avs.models.HcxEnterpriseSite Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-avs Show documentation
This package contains Microsoft Azure SDK for Avs Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Azure VMware Solution API. Package tag package-2023-09-01.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.avs.models;

import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.avs.fluent.models.HcxEnterpriseSiteInner;

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

    /**
     * Gets the provisioningState property: The provisioning state of the resource.
     * 
     * @return the provisioningState value.
     */
    HcxEnterpriseSiteProvisioningState provisioningState();

    /**
     * Gets the activationKey property: The activation key.
     * 
     * @return the activationKey value.
     */
    String activationKey();

    /**
     * Gets the status property: The status of the HCX Enterprise Site.
     * 
     * @return the status value.
     */
    HcxEnterpriseSiteStatus status();

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

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

    /**
     * The entirety of the HcxEnterpriseSite definition.
     */
    interface Definition
        extends DefinitionStages.Blank, DefinitionStages.WithParentResource, DefinitionStages.WithCreate {
    }

    /**
     * The HcxEnterpriseSite definition stages.
     */
    interface DefinitionStages {
        /**
         * The first stage of the HcxEnterpriseSite definition.
         */
        interface Blank extends WithParentResource {
        }

        /**
         * The stage of the HcxEnterpriseSite definition allowing to specify parent resource.
         */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, privateCloudName.
             * 
             * @param resourceGroupName The name of the resource group. The name is case insensitive.
             * @param privateCloudName Name of the private cloud.
             * @return the next definition stage.
             */
            WithCreate withExistingPrivateCloud(String resourceGroupName, String privateCloudName);
        }

        /**
         * The stage of the HcxEnterpriseSite 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 {
            /**
             * Executes the create request.
             * 
             * @return the created resource.
             */
            HcxEnterpriseSite create();

            /**
             * Executes the create request.
             * 
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            HcxEnterpriseSite create(Context context);
        }
    }

    /**
     * Begins update for the HcxEnterpriseSite resource.
     * 
     * @return the stage of resource update.
     */
    HcxEnterpriseSite.Update update();

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

        /**
         * Executes the update request.
         * 
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        HcxEnterpriseSite apply(Context context);
    }

    /**
     * The HcxEnterpriseSite update stages.
     */
    interface UpdateStages {
    }

    /**
     * Refreshes the resource to sync with Azure.
     * 
     * @return the refreshed resource.
     */
    HcxEnterpriseSite refresh();

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