com.azure.resourcemanager.authorization.models.ServicePrincipal Maven / Gradle / Ivy

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

package com.azure.resourcemanager.authorization.models;

import com.azure.core.annotation.Fluent;
import com.azure.resourcemanager.authorization.fluent.models.MicrosoftGraphServicePrincipalInner;
import com.azure.resourcemanager.resources.fluentcore.model.Appliable;
import com.azure.resourcemanager.resources.fluentcore.model.Creatable;
import com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel;
import com.azure.resourcemanager.resources.fluentcore.model.Updatable;
import com.azure.resourcemanager.resources.models.ResourceGroup;

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

/** An immutable client-side representation of an Azure AD service principal. */
@Fluent
public interface ServicePrincipal
    extends ActiveDirectoryObject,
        HasInnerModel,
        Updatable {
    /** @return app id. */
    String applicationId();

    /** @return the list of names. */
    List servicePrincipalNames();

    /** @return the mapping of password credentials from their names */
    Map passwordCredentials();

    /** @return the mapping of certificate credentials from their names */
    Map certificateCredentials();

    /** @return the mapping from scopes to role assignments */
    Set roleAssignments();

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

    /** 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. */
    interface DefinitionStages {
        /** The first stage of the service principal definition. */
        interface Blank extends WithApplication {
        }

        /** A service principal definition allowing application to be specified. */
        interface WithApplication {
            /**
             * 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.
             *
             * @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.
             *
             * @param applicationCreatable the new application's creatable
             * @return the next stage of the service principal definition
             */
            WithCreate withNewApplication(Creatable applicationCreatable);

            /**
             * 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);

            /**
             * Specifies a new application to create and use by the service principal.
             *
             * @return the next stage of the service principal definition
             */
            WithCreate withNewApplication();
        }

        /** A service principal definition allowing credentials to be specified. */
        interface WithCredential {
            /**
             * 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 defineCertificateCredential(String name);

            /**
             * 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 definePasswordCredential(String name);
        }

        /** A service principal definition allowing role assignments to be added. */
        interface WithRoleAssignment {
            /**
             * 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.
             *
             * @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.
             *
             * @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.
         */
        interface WithCreate extends Creatable, WithCredential, WithRoleAssignment {
        }
    }

    /** Grouping of all the service principal update stages. */
    interface UpdateStages {
        /** A service principal update allowing credentials to be specified. */
        interface WithCredential {
            /**
             * 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.DefinitionStages.Blank
                defineCertificateCredential(String name);

            /**
             * 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.DefinitionStages.Blank definePasswordCredential(String name);

            /**
             * 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. */
        interface WithRoleAssignment {
            /**
             * 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.
             *
             * @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.
             *
             * @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.
             *
             * @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. */
    interface Update
        extends Appliable,
            ServicePrincipal.UpdateStages.WithCredential,
            ServicePrincipal.UpdateStages.WithRoleAssignment {
    }
}