Class Application

Manages an Application within Azure Active Directory.

NOTE: If you're authenticating using a Service Principal then it must have permissions to both Read and write owned by applications and Sign in and read user profile within the Windows Azure Active Directory API.

Example Usage

using Pulumi;
using AzureAD = Pulumi.AzureAD;

class MyStack : Stack
{
public MyStack()
{
    var example = new AzureAD.Application("example", new AzureAD.ApplicationArgs
    {
        AppRoles = 
        {
            new AzureAD.Inputs.ApplicationAppRoleArgs
            {
                AllowedMemberTypes = 
                {
                    "User",
                    "Application",
                },
                Description = "Admins can manage roles and perform all task actions",
                DisplayName = "Admin",
                IsEnabled = true,
                Value = "Admin",
            },
        },
        AvailableToOtherTenants = false,
        Homepage = "https://homepage",
        IdentifierUris = 
        {
            "https://uri",
        },
        Oauth2AllowImplicitFlow = true,
        Owners = 
        {
            "00000004-0000-0000-c000-000000000000",
        },
        ReplyUrls = 
        {
            "https://replyurl",
        },
        RequiredResourceAccesses = 
        {
            new AzureAD.Inputs.ApplicationRequiredResourceAccessArgs
            {
                ResourceAccess = 
                {

                    {
                        { "id", "..." },
                        { "type", "Role" },
                    },

                    {
                        { "id", "..." },
                        { "type", "Scope" },
                    },

                    {
                        { "id", "..." },
                        { "type", "Scope" },
                    },
                },
                ResourceAppId = "00000003-0000-0000-c000-000000000000",
            },
            new AzureAD.Inputs.ApplicationRequiredResourceAccessArgs
            {
                ResourceAccess = 
                {

                    {
                        { "id", "..." },
                        { "type", "Scope" },
                    },
                },
                ResourceAppId = "00000002-0000-0000-c000-000000000000",
            },
        },
        Type = "webapp/api",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Application

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.AzureAD

Assembly: Pulumi.AzureAD.dll

Syntax

public class Application : CustomResource

Constructors

Application(String, ApplicationArgs, CustomResourceOptions)

Create a Application resource with the given unique name, arguments, and options.

Declaration

public Application(string name, ApplicationArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ApplicationArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApplicationId

The Application ID.

Declaration

public Output<string> ApplicationId { get; }

Property Value

Type	Description
Output<System.String>

AppRoles

A collection of app_role blocks as documented below. For more information https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles

Declaration

public Output<ImmutableArray<ApplicationAppRole>> AppRoles { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ApplicationAppRole>>

AvailableToOtherTenants

Is this Azure AD Application available to other tenants? Defaults to false.

Declaration

public Output<bool?> AvailableToOtherTenants { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

GroupMembershipClaims

Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects. Defaults to SecurityGroup. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.

Declaration

public Output<string> GroupMembershipClaims { get; }

Property Value

Type	Description
Output<System.String>

Homepage

The URL to the application's home page. If no homepage is specified this defaults to https://{name}.

Declaration

public Output<string> Homepage { get; }

Property Value

Type	Description
Output<System.String>

IdentifierUris

A list of user-defined URI(s) that uniquely identify a Web application within it's Azure AD tenant, or within a verified custom domain if the application is multi-tenant.

Declaration

public Output<ImmutableArray<string>> IdentifierUris { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

LogoutUrl

The URL of the logout page.

Declaration

public Output<string> LogoutUrl { get; }

Property Value

Type	Description
Output<System.String>

Name

The display name for the application.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Oauth2AllowImplicitFlow

Does this Azure AD Application allow OAuth2.0 implicit flow tokens? Defaults to false.

Declaration

public Output<bool?> Oauth2AllowImplicitFlow { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Oauth2Permissions

A collection of OAuth 2.0 permission scopes that the web API (resource) app exposes to client apps. Each permission is covered by a oauth2_permission block as documented below.

Declaration

public Output<ImmutableArray<ApplicationOauth2Permission>> Oauth2Permissions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ApplicationOauth2Permission>>

ObjectId

The Application's Object ID.

Declaration

public Output<string> ObjectId { get; }

Property Value

Type	Description
Output<System.String>

Owners

A list of Azure AD Object IDs that will be granted ownership of the application. Defaults to the Object ID of the caller creating the application. If a list is specified the caller Object ID will no longer be included unless explicitly added to the list.

Declaration

public Output<ImmutableArray<string>> Owners { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

PublicClient

Is this Azure AD Application a public client? Defaults to false.

Declaration

public Output<bool> PublicClient { get; }

Property Value

Type	Description
Output<System.Boolean>

ReplyUrls

A list of URLs that user tokens are sent to for sign in, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to.

Declaration

public Output<ImmutableArray<string>> ReplyUrls { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

RequiredResourceAccesses

A collection of required_resource_access blocks as documented below.

Declaration

public Output<ImmutableArray<ApplicationRequiredResourceAccess>> RequiredResourceAccesses { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ApplicationRequiredResourceAccess>>

Type

Type of an application: webapp/api or native. Defaults to webapp/api. For native apps type identifier_uris property can not not be set.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ApplicationState, CustomResourceOptions)

Get an existing Application resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Application Get(string name, Input<string> id, ApplicationState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ApplicationState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Application