Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */

package com.microsoft.azure.management.graphrbac;

import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.graphrbac.implementation.GraphRbacManager;
import com.microsoft.azure.management.graphrbac.implementation.RoleAssignmentInner;
import com.microsoft.azure.management.resources.ResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasId;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasName;
import com.microsoft.azure.management.resources.fluentcore.arm.models.Resource;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Indexable;

An immutable client-side representation of an Azure AD role assignment.
/**
 * An immutable client-side representation of an Azure AD role assignment.
 */
@Fluent(ContainerName = "/Microsoft.Azure.Management.Graph.RBAC.Fluent")
public interface RoleAssignment extends
        Indexable,
        HasInner<RoleAssignmentInner>,
        HasId,
        HasName,
        HasManager<GraphRbacManager> {
    
Returns:
the role assignment scope/**
     * @return the role assignment scope
     */
    String scope();

    
Returns:
the role definition ID/**
     * @return the role definition ID
     */
    String roleDefinitionId();

    
Returns:
the principal ID/**
     * @return the principal ID
     */
    String principalId();

    /**************************************************************
     * Fluent interfaces to provision an role assignment
     **************************************************************/

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

    
Grouping of all the role assignment definition stages.
/**
     * Grouping of all the role assignment definition stages.
     */
    interface DefinitionStages {
        
The first stage of the role assignment definition.
/**
         * The first stage of the role assignment definition.
         */
        interface Blank extends WithAssignee {
        }

        
The stage of role assignment definition allowing specifying the assignee information.
/**
         * The stage of role assignment definition allowing specifying the assignee information.
         */
        interface WithAssignee {
            
Specifies the assignee of the role assignment.
Params:
objectId – the object ID of an Active Directory identity
Returns:
the next stage in role assignment definition/**
             * Specifies the assignee of the role assignment.
             *
             * @param objectId the object ID of an Active Directory identity
             * @return the next stage in role assignment definition
             */
            WithRole forObjectId(String objectId);

            
Specifies the assignee of the role assignment to be a user.
Params:
user – the user object
Returns:
the next stage in role assignment definition/**
             * Specifies the assignee of the role assignment to be a user.
             *
             * @param user the user object
             * @return the next stage in role assignment definition
             */
            WithRole forUser(ActiveDirectoryUser user);

            
Specifies the assignee of the role assignment to be a user.
Params:
name – the user's user principal name, full display name, or email address
Returns:
the next stage in role assignment definition/**
             * Specifies the assignee of the role assignment to be a user.
             *
             * @param name the user's user principal name, full display name, or email address
             * @return the next stage in role assignment definition
             */
            WithRole forUser(String name);

            
Specifies the assignee of the role assignment to be a group.
Params:
activeDirectoryGroup – the user group
Returns:
the next stage in role assignment definition/**
             * Specifies the assignee of the role assignment to be a group.
             *
             * @param activeDirectoryGroup the user group
             * @return the next stage in role assignment definition
             */
            WithRole forGroup(ActiveDirectoryGroup activeDirectoryGroup);

            
Specifies the assignee of the role assignment to be a service principal.
Params:
servicePrincipal – the service principal object
Returns:
the next stage in role assignment definition/**
             * Specifies the assignee of the role assignment to be a service principal.
             *
             * @param servicePrincipal the service principal object
             * @return the next stage in role assignment definition
             */
            WithRole forServicePrincipal(ServicePrincipal servicePrincipal);

            
Specifies the assignee of the role assignment to be a service principal.
Params:
servicePrincipalName – the service principal name
Returns:
the next stage in role assignment definition/**
             * Specifies the assignee of the role assignment to be a service principal.
             *
             * @param servicePrincipalName the service principal name
             * @return the next stage in role assignment definition
             */
            WithRole forServicePrincipal(String servicePrincipalName);
        }

        
The stage of role assignment definition allowing specifying the role.
/**
         * The stage of role assignment definition allowing specifying the role.
         */
        interface WithRole {
            
Specifies the name of a built in role for this assignment.
Params:
role – the name of the role
Returns:
the next stage in role assignment definition/**
             * Specifies the name of a built in role for this assignment.
             *
             * @param role the name of the role
             * @return the next stage in role assignment definition
             */
            WithScope withBuiltInRole(BuiltInRole role);
            
Specifies the ID of the custom role for this assignment.
Params:
roleDefinitionId – ID of the custom role definition
Returns:
the next stage in role assignment definition/**
             * Specifies the ID of the custom role for this assignment.
             *
             * @param roleDefinitionId ID of the custom role definition
             * @return the next stage in role assignment definition
             */
            WithScope withRoleDefinition(String roleDefinitionId);
        }

        
The stage of role assignment definition allowing specifying the scope of the assignment.
/**
         * The stage of role assignment definition allowing specifying the scope of the assignment.
         */
        interface WithScope {
            
Specifies the scope of the role assignment. The scope is usually the ID of
a subscription, a resource group, a resource, etc.
Params:
scope – the scope of the assignment
Returns:
the next stage in role assignment definition/**
             * Specifies the scope of the role assignment. The scope is usually the ID of
             * a subscription, a resource group, a resource, etc.
             *
             * @param scope the scope of the assignment
             * @return the next stage in role assignment definition
             */
            WithCreate withScope(String scope);

            
Specifies the scope of the role assignment to be a resource group.
Params:
resourceGroup – the resource group the assignee is assigned to access
Returns:
the next stage in role assignment definition/**
             * Specifies the scope of the role assignment to be a resource group.
             *
             * @param resourceGroup the resource group the assignee is assigned to access
             * @return the next stage in role assignment definition
             */
            WithCreate withResourceGroupScope(ResourceGroup resourceGroup);

            
Specifies the scope of the role assignment to be a specific resource.
Params:
resource – the resource the assignee is assigned to access
Returns:
the next stage in role assignment definition/**
             * Specifies the scope of the role assignment to be a specific resource.
             *
             * @param resource the resource the assignee is assigned to access
             * @return the next stage in role assignment definition
             */
            WithCreate withResourceScope(Resource resource);

            
Specifies the scope of the role assignment to be an entire subscription.
Params:
subscriptionId – the subscription the assignee is assigned to access
Returns:
the next stage in role assignment definition/**
             * Specifies the scope of the role assignment to be an entire subscription.
             *
             * @param subscriptionId the subscription the assignee is assigned to access
             * @return the next stage in role assignment definition
             */
            WithCreate withSubscriptionScope(String subscriptionId);
        }

        
An role assignment definition with sufficient inputs to create a new
role assignment in the cloud, but exposing additional optional inputs to
specify.
/**
         * An role assignment definition with sufficient inputs to create a new
         * role assignment in the cloud, but exposing additional optional inputs to
         * specify.
         */
        interface WithCreate extends
                Creatable<RoleAssignment> {
        }
    }
}