@pulumi/azuread/applicationIdentifierUri.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * Manages a single Identifier URI for an application registration.
 *
 * This resource is analogous to the `identifierUris` property in the `azuread.Application` resource. When using these resources together, you should use the `ignoreChanges` lifecycle meta-argument (see example below).
 *
 * ## 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 exampleApplicationIdentifierUri = new azuread.ApplicationIdentifierUri("example", {
 *     applicationId: example.id,
 *     identifierUri: "https://app.example.com",
 * });
 * ```
 *
 * > **Tip** For managing multiple identifier URIs for the same application, create another instance of this resource
 *
 * *Usage with azuread.Application resource*
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = new azuread.Application("example", {displayName: "example"});
 * const exampleApplicationIdentifierUri = new azuread.ApplicationIdentifierUri("example", {applicationId: example.id});
 * ```
 *
 * ## Import
 *
 * Application Identifier URIs can be imported using the object ID of the application and the base64-encoded identifier URI, in the following format.
 *
 * ```sh
 * $ pulumi import azuread:index/applicationIdentifierUri:ApplicationIdentifierUri example /applications/00000000-0000-0000-0000-000000000000/identifierUris/aHR0cHM6Ly9leGFtcGxlLm5ldC8=
 * ```
 */
export declare class ApplicationIdentifierUri extends pulumi.CustomResource {
    /**
     * Get an existing ApplicationIdentifierUri 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?: ApplicationIdentifierUriState, opts?: pulumi.CustomResourceOptions): ApplicationIdentifierUri;
    /**
     * Returns true if the given object is an instance of ApplicationIdentifierUri.  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 ApplicationIdentifierUri;
    /**
     * The resource ID of the application registration. Changing this forces a new resource to be created.
     */
    readonly applicationId: pulumi.Output<string>;
    /**
     * The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. Changing this forces a new resource to be created.
     */
    readonly identifierUri: pulumi.Output<string>;
    /**
     * Create a ApplicationIdentifierUri 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: ApplicationIdentifierUriArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ApplicationIdentifierUri resources.
 */
export interface ApplicationIdentifierUriState {
    /**
     * The resource ID of the application registration. Changing this forces a new resource to be created.
     */
    applicationId?: pulumi.Input<string | undefined>;
    /**
     * The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. Changing this forces a new resource to be created.
     */
    identifierUri?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a ApplicationIdentifierUri resource.
 */
export interface ApplicationIdentifierUriArgs {
    /**
     * The resource ID of the application registration. Changing this forces a new resource to be created.
     */
    applicationId: pulumi.Input<string>;
    /**
     * The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. Changing this forces a new resource to be created.
     */
    identifierUri: pulumi.Input<string>;
}
//# sourceMappingURL=applicationIdentifierUri.d.ts.map