UNPKG

@pulumi/azuread

Version:

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

146 lines 6.35 kB
"use strict"; // *** WARNING: this file was generated by pulumi-language-nodejs. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); __setModuleDefault(result, mod); return result; }; Object.defineProperty(exports, "__esModule", { value: true }); exports.ApplicationRedirectUris = void 0; const pulumi = __importStar(require("@pulumi/pulumi")); const utilities = __importStar(require("./utilities")); /** * 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 * ``` */ 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, id, state, opts) { return new ApplicationRedirectUris(name, state, { ...opts, id: id }); } /** @internal */ static __pulumiType = 'azuread:index/applicationRedirectUris: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) { if (obj === undefined || obj === null) { return false; } return obj['__pulumiType'] === ApplicationRedirectUris.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["applicationId"] = state?.applicationId; resourceInputs["redirectUris"] = state?.redirectUris; resourceInputs["type"] = state?.type; } else { const args = argsOrState; if (args?.applicationId === undefined && !opts.urn) { throw new Error("Missing required property 'applicationId'"); } if (args?.redirectUris === undefined && !opts.urn) { throw new Error("Missing required property 'redirectUris'"); } if (args?.type === undefined && !opts.urn) { throw new Error("Missing required property 'type'"); } resourceInputs["applicationId"] = args?.applicationId; resourceInputs["redirectUris"] = args?.redirectUris; resourceInputs["type"] = args?.type; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(ApplicationRedirectUris.__pulumiType, name, resourceInputs, opts); } } exports.ApplicationRedirectUris = ApplicationRedirectUris; //# sourceMappingURL=applicationRedirectUris.js.map