com.azure.resourcemanager.resources.models.PolicyAssignment Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.resourcemanager.resources.models;

import com.azure.core.annotation.Fluent;
import com.azure.resourcemanager.resources.fluentcore.arm.models.HasId;
import com.azure.resourcemanager.resources.fluentcore.arm.models.HasName;
import com.azure.resourcemanager.resources.fluentcore.model.Creatable;
import com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel;
import com.azure.resourcemanager.resources.fluentcore.model.Indexable;
import com.azure.resourcemanager.resources.fluentcore.model.Refreshable;
import com.azure.resourcemanager.resources.fluent.models.PolicyAssignmentInner;

import java.util.List;
import java.util.Map;

/**
 * An immutable client-side representation of an Azure policy assignment.
 */
@Fluent
public interface PolicyAssignment
    extends HasName, HasId, Indexable, Refreshable, HasInnerModel {

    /**
     * Gets display name of the policy assignment.
     *
     * @return the policy assignment display name
     */
    String displayName();

    /**
     * Gets Id of the policy definition.
     *
     * @return the policy definition Id
     */
    String policyDefinitionId();

    /**
     * Gets the scope at which the policy assignment exists.
     *
     * @return the scope at which the policy assignment exists
     */
    String scope();

    /**
     * Gets the type of the policy assignment.
     *
     * @return the type of the policy assignment
     */
    String type();

    /**
     * Gets the excluded scopes of the policy assignment.
     *
     * @return the excluded scopes of the policy assignment
     */
    List excludedScopes();

    /**
     * Gets the enforcement mode of the policy assignment.
     *
     * @return the enforcement mode of the policy assignment
     */
    EnforcementMode enforcementMode();

    /**
     * Gets the parameters of the policy assignment.
     *
     * @return the parameters of the policy assignment
     */
    Map parameters();

    /**
     * Container interface for all the definitions that need to be implemented.
     */
    interface Definition extends PolicyAssignment.DefinitionStages.Blank,
        PolicyAssignment.DefinitionStages.WithPolicyDefinition, PolicyAssignment.DefinitionStages.WithCreate {
    }

    /**
     * Grouping of all the policy assignment definition stages.
     */
    interface DefinitionStages {
        /**
         * The first stage of the policy assignment.
         */
        interface Blank extends PolicyAssignment.DefinitionStages.WithScope {
        }

        /**
         * A policy assignment specifying the scope of the policy.
         */
        interface WithScope {
            /**
             * Specifies the scope of the policy assignment.
             *
             * @param scope the scope of the policy assignment
             * @return the next stage of policy assignment
             */
            WithPolicyDefinition forScope(String scope);

            /**
             * Specifies the scope of the policy assignment to be a resource group.
             *
             * @param resourceGroup the resource group to assign the policy
             * @return the next stage of policy assignment
             */
            WithPolicyDefinition forResourceGroup(ResourceGroup resourceGroup);

            /**
             * Specifies the scope of the policy assignment to be a resource.
             *
             * @param genericResource the resource to assign the policy
             * @return the next stage of policy assignment
             */
            WithPolicyDefinition forResource(GenericResource genericResource);
        }

        /**
         * A policy assignment allowing the policy definition to be set.
         */
        interface WithPolicyDefinition {
            /**
             * Specifies the policy assignment.
             *
             * @param policyDefinitionId the ID of the policy assignment
             * @return the next stage of policy assignment
             */
            WithCreate withPolicyDefinitionId(String policyDefinitionId);

            /**
             * Specifies the policy definition.
             *
             * @param policyDefinition the policy definition
             * @return the next stage of policy assignment
             */
            WithCreate withPolicyDefinition(PolicyDefinition policyDefinition);
        }

        /**
         * A policy assignment allowing the display name to be set.
         */
        interface WithDisplayName {
            /**
             * Specifies the display name of the policy assignment.
             *
             * @param displayName the display name of the policy assignment
             * @return the next stage of policy assignment
             */
            WithCreate withDisplayName(String displayName);
        }

        /**
         * A policy assignment allowing the excluded scopes to be set.
         */
        interface WithExcludedScopes {
            /**
             * Specifies the excluded scope of the policy assignment.
             *
             * @param scope the scope to be excluded from the policy assignment
             * @return the next stage of policy assignment
             */
            WithCreate withExcludedScope(String scope);
        }

        /**
         * A policy assignment allowing the parameters to be set.
         */
        interface WithParameters {
            /**
             * Specifies the parameter of the policy assignment.
             *
             * @param name the name of the parameter
             * @param value the value of the parameter
             * @return the next stage of policy assignment
             */
            WithCreate withParameter(String name, Object value);
        }

        /**
         * A policy assignment allowing the enforcement mode to be set.
         */
        interface WithEnforcementMode {
            /**
             * Specifies the enforcement mode of the policy assignment.
             *
             * @param mode the enforcement mode of the policy assignment
             * @return the next stage of policy assignment
             */
            WithCreate withEnforcementMode(EnforcementMode mode);
        }

        /**
         * A policy assignment with sufficient inputs to create a new policy
         * assignment in the cloud, but exposing additional optional inputs to
         * specify.
         */
        interface WithCreate extends Creatable, DefinitionStages.WithDisplayName,
            DefinitionStages.WithExcludedScopes, DefinitionStages.WithParameters, DefinitionStages.WithEnforcementMode {
        }
    }
}