1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. ApplicationRegistration
Azure Active Directory (Azure AD) v5.52.0 published on Friday, Jun 14, 2024 by Pulumi

azuread.ApplicationRegistration

Explore with Pulumi AI

azuread logo
Azure Active Directory (Azure AD) v5.52.0 published on Friday, Jun 14, 2024 by Pulumi

    Manages an application registration within Azure Active Directory.

    For a more comprehensive alternative, please see the azuread.Application resource. Please note that this resource should not be used together with the azuread.Application resource when managing the same application.

    API Permissions

    The following API permissions are required in order to use this resource.

    When authenticated with a service principal, this resource requires one of the following application roles: Application.ReadWrite.OwnedBy or Application.ReadWrite.All

    When authenticated with a user principal, this resource may require one of the following directory roles: Application Administrator or Global Administrator

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azuread from "@pulumi/azuread";
    
    const example = new azuread.ApplicationRegistration("example", {
        displayName: "Example Application",
        description: "My example application",
        signInAudience: "AzureADMyOrg",
        homepageUrl: "https://app.hashitown.com/",
        logoutUrl: "https://app.hashitown.com/logout",
        marketingUrl: "https://hashitown.com/",
        privacyStatementUrl: "https://hashitown.com/privacy",
        supportUrl: "https://support.hashitown.com/",
        termsOfServiceUrl: "https://hashitown.com/terms",
    });
    
    import pulumi
    import pulumi_azuread as azuread
    
    example = azuread.ApplicationRegistration("example",
        display_name="Example Application",
        description="My example application",
        sign_in_audience="AzureADMyOrg",
        homepage_url="https://app.hashitown.com/",
        logout_url="https://app.hashitown.com/logout",
        marketing_url="https://hashitown.com/",
        privacy_statement_url="https://hashitown.com/privacy",
        support_url="https://support.hashitown.com/",
        terms_of_service_url="https://hashitown.com/terms")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
    			DisplayName:         pulumi.String("Example Application"),
    			Description:         pulumi.String("My example application"),
    			SignInAudience:      pulumi.String("AzureADMyOrg"),
    			HomepageUrl:         pulumi.String("https://app.hashitown.com/"),
    			LogoutUrl:           pulumi.String("https://app.hashitown.com/logout"),
    			MarketingUrl:        pulumi.String("https://hashitown.com/"),
    			PrivacyStatementUrl: pulumi.String("https://hashitown.com/privacy"),
    			SupportUrl:          pulumi.String("https://support.hashitown.com/"),
    			TermsOfServiceUrl:   pulumi.String("https://hashitown.com/terms"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureAD = Pulumi.AzureAD;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new AzureAD.ApplicationRegistration("example", new()
        {
            DisplayName = "Example Application",
            Description = "My example application",
            SignInAudience = "AzureADMyOrg",
            HomepageUrl = "https://app.hashitown.com/",
            LogoutUrl = "https://app.hashitown.com/logout",
            MarketingUrl = "https://hashitown.com/",
            PrivacyStatementUrl = "https://hashitown.com/privacy",
            SupportUrl = "https://support.hashitown.com/",
            TermsOfServiceUrl = "https://hashitown.com/terms",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azuread.ApplicationRegistration;
    import com.pulumi.azuread.ApplicationRegistrationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ApplicationRegistration("example", ApplicationRegistrationArgs.builder()
                .displayName("Example Application")
                .description("My example application")
                .signInAudience("AzureADMyOrg")
                .homepageUrl("https://app.hashitown.com/")
                .logoutUrl("https://app.hashitown.com/logout")
                .marketingUrl("https://hashitown.com/")
                .privacyStatementUrl("https://hashitown.com/privacy")
                .supportUrl("https://support.hashitown.com/")
                .termsOfServiceUrl("https://hashitown.com/terms")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azuread:ApplicationRegistration
        properties:
          displayName: Example Application
          description: My example application
          signInAudience: AzureADMyOrg
          homepageUrl: https://app.hashitown.com/
          logoutUrl: https://app.hashitown.com/logout
          marketingUrl: https://hashitown.com/
          privacyStatementUrl: https://hashitown.com/privacy
          supportUrl: https://support.hashitown.com/
          termsOfServiceUrl: https://hashitown.com/terms
    

    Create ApplicationRegistration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApplicationRegistration(name: string, args: ApplicationRegistrationArgs, opts?: CustomResourceOptions);
    @overload
    def ApplicationRegistration(resource_name: str,
                                args: ApplicationRegistrationArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApplicationRegistration(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                display_name: Optional[str] = None,
                                logout_url: Optional[str] = None,
                                group_membership_claims: Optional[Sequence[str]] = None,
                                homepage_url: Optional[str] = None,
                                implicit_access_token_issuance_enabled: Optional[bool] = None,
                                implicit_id_token_issuance_enabled: Optional[bool] = None,
                                description: Optional[str] = None,
                                marketing_url: Optional[str] = None,
                                notes: Optional[str] = None,
                                privacy_statement_url: Optional[str] = None,
                                requested_access_token_version: Optional[int] = None,
                                service_management_reference: Optional[str] = None,
                                sign_in_audience: Optional[str] = None,
                                support_url: Optional[str] = None,
                                terms_of_service_url: Optional[str] = None)
    func NewApplicationRegistration(ctx *Context, name string, args ApplicationRegistrationArgs, opts ...ResourceOption) (*ApplicationRegistration, error)
    public ApplicationRegistration(string name, ApplicationRegistrationArgs args, CustomResourceOptions? opts = null)
    public ApplicationRegistration(String name, ApplicationRegistrationArgs args)
    public ApplicationRegistration(String name, ApplicationRegistrationArgs args, CustomResourceOptions options)
    
    type: azuread:ApplicationRegistration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ApplicationRegistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApplicationRegistrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApplicationRegistrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationRegistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationRegistrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var applicationRegistrationResource = new AzureAD.ApplicationRegistration("applicationRegistrationResource", new()
    {
        DisplayName = "string",
        LogoutUrl = "string",
        GroupMembershipClaims = new[]
        {
            "string",
        },
        HomepageUrl = "string",
        ImplicitAccessTokenIssuanceEnabled = false,
        ImplicitIdTokenIssuanceEnabled = false,
        Description = "string",
        MarketingUrl = "string",
        Notes = "string",
        PrivacyStatementUrl = "string",
        RequestedAccessTokenVersion = 0,
        ServiceManagementReference = "string",
        SignInAudience = "string",
        SupportUrl = "string",
        TermsOfServiceUrl = "string",
    });
    
    example, err := azuread.NewApplicationRegistration(ctx, "applicationRegistrationResource", &azuread.ApplicationRegistrationArgs{
    	DisplayName: pulumi.String("string"),
    	LogoutUrl:   pulumi.String("string"),
    	GroupMembershipClaims: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	HomepageUrl:                        pulumi.String("string"),
    	ImplicitAccessTokenIssuanceEnabled: pulumi.Bool(false),
    	ImplicitIdTokenIssuanceEnabled:     pulumi.Bool(false),
    	Description:                        pulumi.String("string"),
    	MarketingUrl:                       pulumi.String("string"),
    	Notes:                              pulumi.String("string"),
    	PrivacyStatementUrl:                pulumi.String("string"),
    	RequestedAccessTokenVersion:        pulumi.Int(0),
    	ServiceManagementReference:         pulumi.String("string"),
    	SignInAudience:                     pulumi.String("string"),
    	SupportUrl:                         pulumi.String("string"),
    	TermsOfServiceUrl:                  pulumi.String("string"),
    })
    
    var applicationRegistrationResource = new ApplicationRegistration("applicationRegistrationResource", ApplicationRegistrationArgs.builder()
        .displayName("string")
        .logoutUrl("string")
        .groupMembershipClaims("string")
        .homepageUrl("string")
        .implicitAccessTokenIssuanceEnabled(false)
        .implicitIdTokenIssuanceEnabled(false)
        .description("string")
        .marketingUrl("string")
        .notes("string")
        .privacyStatementUrl("string")
        .requestedAccessTokenVersion(0)
        .serviceManagementReference("string")
        .signInAudience("string")
        .supportUrl("string")
        .termsOfServiceUrl("string")
        .build());
    
    application_registration_resource = azuread.ApplicationRegistration("applicationRegistrationResource",
        display_name="string",
        logout_url="string",
        group_membership_claims=["string"],
        homepage_url="string",
        implicit_access_token_issuance_enabled=False,
        implicit_id_token_issuance_enabled=False,
        description="string",
        marketing_url="string",
        notes="string",
        privacy_statement_url="string",
        requested_access_token_version=0,
        service_management_reference="string",
        sign_in_audience="string",
        support_url="string",
        terms_of_service_url="string")
    
    const applicationRegistrationResource = new azuread.ApplicationRegistration("applicationRegistrationResource", {
        displayName: "string",
        logoutUrl: "string",
        groupMembershipClaims: ["string"],
        homepageUrl: "string",
        implicitAccessTokenIssuanceEnabled: false,
        implicitIdTokenIssuanceEnabled: false,
        description: "string",
        marketingUrl: "string",
        notes: "string",
        privacyStatementUrl: "string",
        requestedAccessTokenVersion: 0,
        serviceManagementReference: "string",
        signInAudience: "string",
        supportUrl: "string",
        termsOfServiceUrl: "string",
    });
    
    type: azuread:ApplicationRegistration
    properties:
        description: string
        displayName: string
        groupMembershipClaims:
            - string
        homepageUrl: string
        implicitAccessTokenIssuanceEnabled: false
        implicitIdTokenIssuanceEnabled: false
        logoutUrl: string
        marketingUrl: string
        notes: string
        privacyStatementUrl: string
        requestedAccessTokenVersion: 0
        serviceManagementReference: string
        signInAudience: string
        supportUrl: string
        termsOfServiceUrl: string
    

    ApplicationRegistration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ApplicationRegistration resource accepts the following input properties:

    DisplayName string
    The display name for the application.
    Description string
    A description of the application, as shown to end users.
    GroupMembershipClaims List<string>
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    HomepageUrl string
    Home page or landing page of the application.
    ImplicitAccessTokenIssuanceEnabled bool
    Whether this web application can request an access token using OAuth implicit flow.
    ImplicitIdTokenIssuanceEnabled bool
    Whether this web application can request an ID token using OAuth implicit flow.
    LogoutUrl string
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    MarketingUrl string
    URL of the marketing page for the application.
    Notes string
    User-specified notes relevant for the management of the application.
    PrivacyStatementUrl string
    URL of the privacy statement for the application.
    RequestedAccessTokenVersion int
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    ServiceManagementReference string
    References application context information from a Service or Asset Management database.
    SignInAudience string
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    SupportUrl string
    URL of the support page for the application.
    TermsOfServiceUrl string
    URL of the terms of service statement for the application.
    DisplayName string
    The display name for the application.
    Description string
    A description of the application, as shown to end users.
    GroupMembershipClaims []string
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    HomepageUrl string
    Home page or landing page of the application.
    ImplicitAccessTokenIssuanceEnabled bool
    Whether this web application can request an access token using OAuth implicit flow.
    ImplicitIdTokenIssuanceEnabled bool
    Whether this web application can request an ID token using OAuth implicit flow.
    LogoutUrl string
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    MarketingUrl string
    URL of the marketing page for the application.
    Notes string
    User-specified notes relevant for the management of the application.
    PrivacyStatementUrl string
    URL of the privacy statement for the application.
    RequestedAccessTokenVersion int
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    ServiceManagementReference string
    References application context information from a Service or Asset Management database.
    SignInAudience string
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    SupportUrl string
    URL of the support page for the application.
    TermsOfServiceUrl string
    URL of the terms of service statement for the application.
    displayName String
    The display name for the application.
    description String
    A description of the application, as shown to end users.
    groupMembershipClaims List<String>
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    homepageUrl String
    Home page or landing page of the application.
    implicitAccessTokenIssuanceEnabled Boolean
    Whether this web application can request an access token using OAuth implicit flow.
    implicitIdTokenIssuanceEnabled Boolean
    Whether this web application can request an ID token using OAuth implicit flow.
    logoutUrl String
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    marketingUrl String
    URL of the marketing page for the application.
    notes String
    User-specified notes relevant for the management of the application.
    privacyStatementUrl String
    URL of the privacy statement for the application.
    requestedAccessTokenVersion Integer
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    serviceManagementReference String
    References application context information from a Service or Asset Management database.
    signInAudience String
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    supportUrl String
    URL of the support page for the application.
    termsOfServiceUrl String
    URL of the terms of service statement for the application.
    displayName string
    The display name for the application.
    description string
    A description of the application, as shown to end users.
    groupMembershipClaims string[]
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    homepageUrl string
    Home page or landing page of the application.
    implicitAccessTokenIssuanceEnabled boolean
    Whether this web application can request an access token using OAuth implicit flow.
    implicitIdTokenIssuanceEnabled boolean
    Whether this web application can request an ID token using OAuth implicit flow.
    logoutUrl string
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    marketingUrl string
    URL of the marketing page for the application.
    notes string
    User-specified notes relevant for the management of the application.
    privacyStatementUrl string
    URL of the privacy statement for the application.
    requestedAccessTokenVersion number
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    serviceManagementReference string
    References application context information from a Service or Asset Management database.
    signInAudience string
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    supportUrl string
    URL of the support page for the application.
    termsOfServiceUrl string
    URL of the terms of service statement for the application.
    display_name str
    The display name for the application.
    description str
    A description of the application, as shown to end users.
    group_membership_claims Sequence[str]
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    homepage_url str
    Home page or landing page of the application.
    implicit_access_token_issuance_enabled bool
    Whether this web application can request an access token using OAuth implicit flow.
    implicit_id_token_issuance_enabled bool
    Whether this web application can request an ID token using OAuth implicit flow.
    logout_url str
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    marketing_url str
    URL of the marketing page for the application.
    notes str
    User-specified notes relevant for the management of the application.
    privacy_statement_url str
    URL of the privacy statement for the application.
    requested_access_token_version int
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    service_management_reference str
    References application context information from a Service or Asset Management database.
    sign_in_audience str
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    support_url str
    URL of the support page for the application.
    terms_of_service_url str
    URL of the terms of service statement for the application.
    displayName String
    The display name for the application.
    description String
    A description of the application, as shown to end users.
    groupMembershipClaims List<String>
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    homepageUrl String
    Home page or landing page of the application.
    implicitAccessTokenIssuanceEnabled Boolean
    Whether this web application can request an access token using OAuth implicit flow.
    implicitIdTokenIssuanceEnabled Boolean
    Whether this web application can request an ID token using OAuth implicit flow.
    logoutUrl String
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    marketingUrl String
    URL of the marketing page for the application.
    notes String
    User-specified notes relevant for the management of the application.
    privacyStatementUrl String
    URL of the privacy statement for the application.
    requestedAccessTokenVersion Number
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    serviceManagementReference String
    References application context information from a Service or Asset Management database.
    signInAudience String
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    supportUrl String
    URL of the support page for the application.
    termsOfServiceUrl String
    URL of the terms of service statement for the application.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApplicationRegistration resource produces the following output properties:

    ClientId string
    The Client ID for the application, which is globally unique.
    DisabledByMicrosoft string
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    Id string
    The provider-assigned unique ID for this managed resource.
    ObjectId string
    The object ID of the application within the tenant.
    PublisherDomain string
    The verified publisher domain for the application.
    ClientId string
    The Client ID for the application, which is globally unique.
    DisabledByMicrosoft string
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    Id string
    The provider-assigned unique ID for this managed resource.
    ObjectId string
    The object ID of the application within the tenant.
    PublisherDomain string
    The verified publisher domain for the application.
    clientId String
    The Client ID for the application, which is globally unique.
    disabledByMicrosoft String
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    id String
    The provider-assigned unique ID for this managed resource.
    objectId String
    The object ID of the application within the tenant.
    publisherDomain String
    The verified publisher domain for the application.
    clientId string
    The Client ID for the application, which is globally unique.
    disabledByMicrosoft string
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    id string
    The provider-assigned unique ID for this managed resource.
    objectId string
    The object ID of the application within the tenant.
    publisherDomain string
    The verified publisher domain for the application.
    client_id str
    The Client ID for the application, which is globally unique.
    disabled_by_microsoft str
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    id str
    The provider-assigned unique ID for this managed resource.
    object_id str
    The object ID of the application within the tenant.
    publisher_domain str
    The verified publisher domain for the application.
    clientId String
    The Client ID for the application, which is globally unique.
    disabledByMicrosoft String
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    id String
    The provider-assigned unique ID for this managed resource.
    objectId String
    The object ID of the application within the tenant.
    publisherDomain String
    The verified publisher domain for the application.

    Look up Existing ApplicationRegistration Resource

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

    public static get(name: string, id: Input<ID>, state?: ApplicationRegistrationState, opts?: CustomResourceOptions): ApplicationRegistration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            client_id: Optional[str] = None,
            description: Optional[str] = None,
            disabled_by_microsoft: Optional[str] = None,
            display_name: Optional[str] = None,
            group_membership_claims: Optional[Sequence[str]] = None,
            homepage_url: Optional[str] = None,
            implicit_access_token_issuance_enabled: Optional[bool] = None,
            implicit_id_token_issuance_enabled: Optional[bool] = None,
            logout_url: Optional[str] = None,
            marketing_url: Optional[str] = None,
            notes: Optional[str] = None,
            object_id: Optional[str] = None,
            privacy_statement_url: Optional[str] = None,
            publisher_domain: Optional[str] = None,
            requested_access_token_version: Optional[int] = None,
            service_management_reference: Optional[str] = None,
            sign_in_audience: Optional[str] = None,
            support_url: Optional[str] = None,
            terms_of_service_url: Optional[str] = None) -> ApplicationRegistration
    func GetApplicationRegistration(ctx *Context, name string, id IDInput, state *ApplicationRegistrationState, opts ...ResourceOption) (*ApplicationRegistration, error)
    public static ApplicationRegistration Get(string name, Input<string> id, ApplicationRegistrationState? state, CustomResourceOptions? opts = null)
    public static ApplicationRegistration get(String name, Output<String> id, ApplicationRegistrationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClientId string
    The Client ID for the application, which is globally unique.
    Description string
    A description of the application, as shown to end users.
    DisabledByMicrosoft string
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    DisplayName string
    The display name for the application.
    GroupMembershipClaims List<string>
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    HomepageUrl string
    Home page or landing page of the application.
    ImplicitAccessTokenIssuanceEnabled bool
    Whether this web application can request an access token using OAuth implicit flow.
    ImplicitIdTokenIssuanceEnabled bool
    Whether this web application can request an ID token using OAuth implicit flow.
    LogoutUrl string
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    MarketingUrl string
    URL of the marketing page for the application.
    Notes string
    User-specified notes relevant for the management of the application.
    ObjectId string
    The object ID of the application within the tenant.
    PrivacyStatementUrl string
    URL of the privacy statement for the application.
    PublisherDomain string
    The verified publisher domain for the application.
    RequestedAccessTokenVersion int
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    ServiceManagementReference string
    References application context information from a Service or Asset Management database.
    SignInAudience string
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    SupportUrl string
    URL of the support page for the application.
    TermsOfServiceUrl string
    URL of the terms of service statement for the application.
    ClientId string
    The Client ID for the application, which is globally unique.
    Description string
    A description of the application, as shown to end users.
    DisabledByMicrosoft string
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    DisplayName string
    The display name for the application.
    GroupMembershipClaims []string
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    HomepageUrl string
    Home page or landing page of the application.
    ImplicitAccessTokenIssuanceEnabled bool
    Whether this web application can request an access token using OAuth implicit flow.
    ImplicitIdTokenIssuanceEnabled bool
    Whether this web application can request an ID token using OAuth implicit flow.
    LogoutUrl string
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    MarketingUrl string
    URL of the marketing page for the application.
    Notes string
    User-specified notes relevant for the management of the application.
    ObjectId string
    The object ID of the application within the tenant.
    PrivacyStatementUrl string
    URL of the privacy statement for the application.
    PublisherDomain string
    The verified publisher domain for the application.
    RequestedAccessTokenVersion int
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    ServiceManagementReference string
    References application context information from a Service or Asset Management database.
    SignInAudience string
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    SupportUrl string
    URL of the support page for the application.
    TermsOfServiceUrl string
    URL of the terms of service statement for the application.
    clientId String
    The Client ID for the application, which is globally unique.
    description String
    A description of the application, as shown to end users.
    disabledByMicrosoft String
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    displayName String
    The display name for the application.
    groupMembershipClaims List<String>
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    homepageUrl String
    Home page or landing page of the application.
    implicitAccessTokenIssuanceEnabled Boolean
    Whether this web application can request an access token using OAuth implicit flow.
    implicitIdTokenIssuanceEnabled Boolean
    Whether this web application can request an ID token using OAuth implicit flow.
    logoutUrl String
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    marketingUrl String
    URL of the marketing page for the application.
    notes String
    User-specified notes relevant for the management of the application.
    objectId String
    The object ID of the application within the tenant.
    privacyStatementUrl String
    URL of the privacy statement for the application.
    publisherDomain String
    The verified publisher domain for the application.
    requestedAccessTokenVersion Integer
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    serviceManagementReference String
    References application context information from a Service or Asset Management database.
    signInAudience String
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    supportUrl String
    URL of the support page for the application.
    termsOfServiceUrl String
    URL of the terms of service statement for the application.
    clientId string
    The Client ID for the application, which is globally unique.
    description string
    A description of the application, as shown to end users.
    disabledByMicrosoft string
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    displayName string
    The display name for the application.
    groupMembershipClaims string[]
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    homepageUrl string
    Home page or landing page of the application.
    implicitAccessTokenIssuanceEnabled boolean
    Whether this web application can request an access token using OAuth implicit flow.
    implicitIdTokenIssuanceEnabled boolean
    Whether this web application can request an ID token using OAuth implicit flow.
    logoutUrl string
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    marketingUrl string
    URL of the marketing page for the application.
    notes string
    User-specified notes relevant for the management of the application.
    objectId string
    The object ID of the application within the tenant.
    privacyStatementUrl string
    URL of the privacy statement for the application.
    publisherDomain string
    The verified publisher domain for the application.
    requestedAccessTokenVersion number
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    serviceManagementReference string
    References application context information from a Service or Asset Management database.
    signInAudience string
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    supportUrl string
    URL of the support page for the application.
    termsOfServiceUrl string
    URL of the terms of service statement for the application.
    client_id str
    The Client ID for the application, which is globally unique.
    description str
    A description of the application, as shown to end users.
    disabled_by_microsoft str
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    display_name str
    The display name for the application.
    group_membership_claims Sequence[str]
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    homepage_url str
    Home page or landing page of the application.
    implicit_access_token_issuance_enabled bool
    Whether this web application can request an access token using OAuth implicit flow.
    implicit_id_token_issuance_enabled bool
    Whether this web application can request an ID token using OAuth implicit flow.
    logout_url str
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    marketing_url str
    URL of the marketing page for the application.
    notes str
    User-specified notes relevant for the management of the application.
    object_id str
    The object ID of the application within the tenant.
    privacy_statement_url str
    URL of the privacy statement for the application.
    publisher_domain str
    The verified publisher domain for the application.
    requested_access_token_version int
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    service_management_reference str
    References application context information from a Service or Asset Management database.
    sign_in_audience str
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    support_url str
    URL of the support page for the application.
    terms_of_service_url str
    URL of the terms of service statement for the application.
    clientId String
    The Client ID for the application, which is globally unique.
    description String
    A description of the application, as shown to end users.
    disabledByMicrosoft String
    Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. DisabledDueToViolationOfServicesAgreement
    displayName String
    The display name for the application.
    groupMembershipClaims List<String>
    Configures the groups claim issued in a user or OAuth access token that the app expects. Possible values are None, SecurityGroup, DirectoryRole, ApplicationGroup or All.
    homepageUrl String
    Home page or landing page of the application.
    implicitAccessTokenIssuanceEnabled Boolean
    Whether this web application can request an access token using OAuth implicit flow.
    implicitIdTokenIssuanceEnabled Boolean
    Whether this web application can request an ID token using OAuth implicit flow.
    logoutUrl String
    The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
    marketingUrl String
    URL of the marketing page for the application.
    notes String
    User-specified notes relevant for the management of the application.
    objectId String
    The object ID of the application within the tenant.
    privacyStatementUrl String
    URL of the privacy statement for the application.
    publisherDomain String
    The verified publisher domain for the application.
    requestedAccessTokenVersion Number
    The access token version expected by this resource. Must be one of 1 or 2, and must be 2 when sign_in_audience is either AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount Defaults to 2.
    serviceManagementReference String
    References application context information from a Service or Asset Management database.
    signInAudience String
    The Microsoft account types that are supported for the current application. Must be one of AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount. Defaults to AzureADMyOrg.
    supportUrl String
    URL of the support page for the application.
    termsOfServiceUrl String
    URL of the terms of service statement for the application.

    Import

    Application Registrations can be imported using the object ID of the application, in the following format.

    $ pulumi import azuread:index/applicationRegistration:ApplicationRegistration example /applications/00000000-0000-0000-0000-000000000000
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Active Directory (Azure AD) pulumi/pulumi-azuread
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuread Terraform Provider.
    azuread logo
    Azure Active Directory (Azure AD) v5.52.0 published on Friday, Jun 14, 2024 by Pulumi