@pulumi/azuread
Version:
A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.
100 lines • 4.06 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.AccessPackage = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Manages an Access Package within Identity Governance in Azure Active Directory.
*
* ## API Permissions
*
* The following API permissions are required in order to use this resource.
*
* When authenticated with a service principal, this resource requires the following application role: `EntitlementManagement.ReadWrite.All`.
*
* When authenticated with a user principal, this resource requires one of the following directory roles: `Catalog owner`, `Access package manager` or `Global Administrator`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const example = new azuread.AccessPackageCatalog("example", {
* displayName: "example-catalog",
* description: "Example catalog",
* });
* const exampleAccessPackage = new azuread.AccessPackage("example", {
* catalogId: example.id,
* displayName: "access-package",
* description: "Access Package",
* });
* ```
*
* ## Import
*
* Access Packages can be imported using the `id`, e.g.
*
* ```sh
* $ pulumi import azuread:index/accessPackage:AccessPackage example_package 00000000-0000-0000-0000-000000000000
* ```
*/
class AccessPackage extends pulumi.CustomResource {
/**
* Get an existing AccessPackage 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 AccessPackage(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of AccessPackage. 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'] === AccessPackage.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["catalogId"] = state?.catalogId;
resourceInputs["description"] = state?.description;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["hidden"] = state?.hidden;
}
else {
const args = argsOrState;
if (args?.catalogId === undefined && !opts.urn) {
throw new Error("Missing required property 'catalogId'");
}
if (args?.description === undefined && !opts.urn) {
throw new Error("Missing required property 'description'");
}
if (args?.displayName === undefined && !opts.urn) {
throw new Error("Missing required property 'displayName'");
}
resourceInputs["catalogId"] = args?.catalogId;
resourceInputs["description"] = args?.description;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["hidden"] = args?.hidden;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(AccessPackage.__pulumiType, name, resourceInputs, opts);
}
}
exports.AccessPackage = AccessPackage;
/** @internal */
AccessPackage.__pulumiType = 'azuread:index/accessPackage:AccessPackage';
//# sourceMappingURL=accessPackage.js.map