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.ServicePrincipalInner;
import com.microsoft.azure.management.resources.ResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
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.Updatable;

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

An immutable client-side representation of an Azure AD service principal.
/**
 * An immutable client-side representation of an Azure AD service principal.
 */
@Fluent(ContainerName = "/Microsoft.Azure.Management.Graph.RBAC.Fluent")
public interface ServicePrincipal extends
        ActiveDirectoryObject,
        HasInner<ServicePrincipalInner>,
        Updatable<ServicePrincipal.Update> {
    
Returns:
app id./**
     * @return app id.
     */
    String applicationId();

    
Returns:
the list of names./**
     * @return the list of names.
     */
    List<String> servicePrincipalNames();

    
Returns:
the mapping of password credentials from their names/**
     * @return the mapping of password credentials from their names
     */
    Map<String, PasswordCredential> passwordCredentials();

    
Returns:
the mapping of certificate credentials from their names/**
     * @return the mapping of certificate credentials from their names
     */
    Map<String, CertificateCredential> certificateCredentials();

    
Returns:
the mapping from scopes to role assignments/**
     * @return the mapping from scopes to role assignments
     */
    Set<RoleAssignment> roleAssignments();

    /**************************************************************
     * Fluent interfaces to provision a service principal
     **************************************************************/

    
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.WithCreate {
    }

    
Grouping of all the service principal definition stages.
/**
     * Grouping of all the service principal definition stages.
     */
    interface DefinitionStages {
        
The first stage of the service principal definition.
/**
         * The first stage of the service principal definition.
         */
        interface Blank extends WithApplication {
        }

        
A service principal definition allowing application to be specified.
/**
         * A service principal definition allowing application to be specified.
         */
        interface WithApplication {
            
Specifies an existing application by its app ID.
Params:
id – the app ID of the application
Returns:
the next stage of the service principal definition/**
             * Specifies an existing application by its app ID.
             * @param id the app ID of the application
             * @return the next stage of the service principal definition
             */
            WithCreate withExistingApplication(String id);

            
Specifies an existing application to use by the service principal.
Params:
application – the application
Returns:
the next stage of the service principal definition/**
             * Specifies an existing application to use by the service principal.
             * @param application the application
             * @return the next stage of the service principal definition
             */
            WithCreate withExistingApplication(ActiveDirectoryApplication application);

            
Specifies a new application to create and use by the service principal.
Params:
applicationCreatable – the new application's creatable
Returns:
the next stage of the service principal definition/**
             * Specifies a new application to create and use by the service principal.
             * @param applicationCreatable the new application's creatable
             * @return the next stage of the service principal definition
             */
            WithCreate withNewApplication(Creatable<ActiveDirectoryApplication> applicationCreatable);

            
Specifies a new application to create and use by the service principal.
Params:
signOnUrl – the new application's sign on URL
Returns:
the next stage of the service principal definition/**
             * Specifies a new application to create and use by the service principal.
             * @param signOnUrl the new application's sign on URL
             * @return the next stage of the service principal definition
             */
            WithCreate withNewApplication(String signOnUrl);
        }

        
A service principal definition allowing credentials to be specified.
/**
         * A service principal definition allowing credentials to be specified.
         */
        interface WithCredential {
            
Starts the definition of a certificate credential.
Params:
name – the descriptive name of the certificate credential
Returns:
the first stage in certificate credential definition/**
             * Starts the definition of a certificate credential.
             * @param name the descriptive name of the certificate credential
             * @return the first stage in certificate credential definition
             */
            CertificateCredential.DefinitionStages.Blank<WithCreate> defineCertificateCredential(String name);

            
Starts the definition of a password credential.
Params:
name – the descriptive name of the password credential
Returns:
the first stage in password credential definition/**
             * Starts the definition of a password credential.
             * @param name the descriptive name of the password credential
             * @return the first stage in password credential definition
             */
            PasswordCredential.DefinitionStages.Blank<WithCreate> definePasswordCredential(String name);
        }

        
A service principal definition allowing role assignments to be added.
/**
         * A service principal definition allowing role assignments to be added.
         */
        interface WithRoleAssignment {
            
Assigns a new role to the service principal.
Params:
role – the role to assign to the service principal
scope – the scope the service principal can access
Returns:
the next stage of the service principal definition/**
             * Assigns a new role to the service principal.
             * @param role the role to assign to the service principal
             * @param scope the scope the service principal can access
             * @return the next stage of the service principal definition
             */
            WithCreate withNewRole(BuiltInRole role, String scope);

            
Assigns a new role to the service principal.
Params:
role – the role to assign to the service principal
subscriptionId – the subscription the service principal can access
Returns:
the next stage of the service principal definition/**
             * Assigns a new role to the service principal.
             * @param role the role to assign to the service principal
             * @param subscriptionId the subscription the service principal can access
             * @return the next stage of the service principal definition
             */
            WithCreate withNewRoleInSubscription(BuiltInRole role, String subscriptionId);

            
Assigns a new role to the service principal.
Params:
role – the role to assign to the service principal
resourceGroup – the resource group the service principal can access
Returns:
the next stage of the service principal definition/**
             * Assigns a new role to the service principal.
             * @param role the role to assign to the service principal
             * @param resourceGroup the resource group the service principal can access
             * @return the next stage of the service principal definition
             */
            WithCreate withNewRoleInResourceGroup(BuiltInRole role, ResourceGroup resourceGroup);
        }

        
A service principal definition with sufficient inputs to create a new
service principal in the cloud, but exposing additional optional inputs to
specify.
/**
         * A service principal definition with sufficient inputs to create a new
         * service principal in the cloud, but exposing additional optional inputs to
         * specify.
         */
        interface WithCreate extends
                Creatable<ServicePrincipal>,
                WithCredential,
                WithRoleAssignment {
        }
    }

    
Grouping of all the service principal update stages.
/**
     * Grouping of all the service principal update stages.
     */
    interface UpdateStages {
        
A service principal update allowing credentials to be specified.
/**
         * A service principal update allowing credentials to be specified.
         */
        interface WithCredential {
            
Starts the definition of a certificate credential.
Params:
name – the descriptive name of the certificate credential
Returns:
the first stage in certificate credential update/**
             * Starts the definition of a certificate credential.
             * @param name the descriptive name of the certificate credential
             * @return the first stage in certificate credential update
             */
            CertificateCredential.UpdateDefinitionStages.Blank<Update> defineCertificateCredential(String name);

            
Starts the definition of a password credential.
Params:
name – the descriptive name of the password credential
Returns:
the first stage in password credential update/**
             * Starts the definition of a password credential.
             * @param name the descriptive name of the password credential
             * @return the first stage in password credential update
             */
            PasswordCredential.UpdateDefinitionStages.Blank<Update> definePasswordCredential(String name);

            
Removes a credential.
Params:
name – the name of the credential
Returns:
the next stage of the service principal update/**
             * Removes a credential.
             * @param name the name of the credential
             * @return the next stage of the service principal update
             */
            Update withoutCredential(String name);
        }

        
A service principal update allowing role assignments to be added.
/**
         * A service principal update allowing role assignments to be added.
         */
        interface WithRoleAssignment {
            
Assigns a new role to the service principal.
Params:
role – the role to assign to the service principal
scope – the scope the service principal can access
Returns:
the next stage of the service principal update/**
             * Assigns a new role to the service principal.
             * @param role the role to assign to the service principal
             * @param scope the scope the service principal can access
             * @return the next stage of the service principal update
             */
            Update withNewRole(BuiltInRole role, String scope);

            
Assigns a new role to the service principal.
Params:
role – the role to assign to the service principal
subscriptionId – the subscription the service principal can access
Returns:
the next stage of the service principal update/**
             * Assigns a new role to the service principal.
             * @param role the role to assign to the service principal
             * @param subscriptionId the subscription the service principal can access
             * @return the next stage of the service principal update
             */
            Update withNewRoleInSubscription(BuiltInRole role, String subscriptionId);

            
Assigns a new role to the service principal.
Params:
role – the role to assign to the service principal
resourceGroup – the resource group the service principal can access
Returns:
the next stage of the service principal update/**
             * Assigns a new role to the service principal.
             * @param role the role to assign to the service principal
             * @param resourceGroup the resource group the service principal can access
             * @return the next stage of the service principal update
             */
            Update withNewRoleInResourceGroup(BuiltInRole role, ResourceGroup resourceGroup);

            
Removes a role from the service principal.
Params:
roleAssignment – the role assignment to remove
Returns:
the next stage of the service principal update/**
             * Removes a role from the service principal.
             * @param roleAssignment the role assignment to remove
             * @return the next stage of the service principal update
             */
            Update withoutRole(RoleAssignment roleAssignment);
        }
    }

    
The template for a service principal update operation, containing all the settings that can be modified.
/**
     * The template for a service principal update operation, containing all the settings that can be modified.
     */
    interface Update extends
            Appliable<ServicePrincipal>,
            ServicePrincipal.UpdateStages.WithCredential,
            ServicePrincipal.UpdateStages.WithRoleAssignment {

    }
}