@pulumi/azuread/applicationRedirectUris.d.ts

A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Manages the redirect URIs for an application registration.
 *
 * > This resource is incompatible with the `azuread.Application` resource, instead use this with the `azuread.ApplicationRegistration` resource.
 *
 * ## 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 using the `Application.ReadWrite.OwnedBy` application role, the principal being used to run Terraform must be an owner of the application.
 *
 * When authenticated with a user principal, this resource may require one of the following directory roles: `Application Administrator` or `Global Administrator`
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = new azuread.ApplicationRegistration("example", {displayName: "example"});
 * const examplePublic = new azuread.ApplicationRedirectUris("example_public", {
 *     applicationId: example.id,
 *     type: "PublicClient",
 *     redirectUris: [
 *         "myapp://auth",
 *         "sample.mobile.app.bundie.id://auth",
 *         "https://login.microsoftonline.com/common/oauth2/nativeclient",
 *         "https://login.live.com/oauth20_desktop.srf",
 *         "ms-appx-web://Microsoft.AAD.BrokerPlugin/00000000-1111-1111-1111-222222222222",
 *         "urn:ietf:wg:oauth:2.0:foo",
 *     ],
 * });
 * const exampleSpa = new azuread.ApplicationRedirectUris("example_spa", {
 *     applicationId: example.id,
 *     type: "SPA",
 *     redirectUris: [
 *         "https://mobile.example.com/",
 *         "https://beta.example.com/",
 *     ],
 * });
 * const exampleWeb = new azuread.ApplicationRedirectUris("example_web", {
 *     applicationId: example.id,
 *     type: "Web",
 *     redirectUris: [
 *         "https://app.example.com/",
 *         "https://classic.example.com/",
 *         "urn:ietf:wg:oauth:2.0:oob",
 *     ],
 * });
 * ```
 *
 * ## Import
 *
 * Application API Access can be imported using the object ID of the application and the URI type, in the following format.
 *
 * ```sh
 * $ pulumi import azuread:index/applicationRedirectUris:ApplicationRedirectUris example /applications/00000000-0000-0000-0000-000000000000/redirectUris/Web
 * ```
 */
export declare class ApplicationRedirectUris extends pulumi.CustomResource {
    /**
     * Get an existing ApplicationRedirectUris resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApplicationRedirectUrisState, opts?: pulumi.CustomResourceOptions): ApplicationRedirectUris;
    /**
     * Returns true if the given object is an instance of ApplicationRedirectUris.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is ApplicationRedirectUris;
    /**
     * The resource ID of the application registration. Changing this forces a new resource to be created.
     */
    readonly applicationId: pulumi.Output<string>;
    /**
     * A set of redirect URIs to assign to the application.
     */
    readonly redirectUris: pulumi.Output<string[]>;
    /**
     * The type of redirect URIs to manage. Must be one of: `PublicClient`, `SPA`, or `Web`. Changing this forces a new resource to be created.
     */
    readonly type: pulumi.Output<string>;
    /**
     * Create a ApplicationRedirectUris resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: ApplicationRedirectUrisArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ApplicationRedirectUris resources.
 */
export interface ApplicationRedirectUrisState {
    /**
     * The resource ID of the application registration. Changing this forces a new resource to be created.
     */
    applicationId?: pulumi.Input<string | undefined>;
    /**
     * A set of redirect URIs to assign to the application.
     */
    redirectUris?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The type of redirect URIs to manage. Must be one of: `PublicClient`, `SPA`, or `Web`. Changing this forces a new resource to be created.
     */
    type?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a ApplicationRedirectUris resource.
 */
export interface ApplicationRedirectUrisArgs {
    /**
     * The resource ID of the application registration. Changing this forces a new resource to be created.
     */
    applicationId: pulumi.Input<string>;
    /**
     * A set of redirect URIs to assign to the application.
     */
    redirectUris: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The type of redirect URIs to manage. Must be one of: `PublicClient`, `SPA`, or `Web`. Changing this forces a new resource to be created.
     */
    type: pulumi.Input<string>;
}
//# sourceMappingURL=applicationRedirectUris.d.ts.map