@pulumi/azuread
Version:
A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.
110 lines • 5.53 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.AccessPackageResourcePackageAssociation = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Manages the resources added to access packages 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.Group("example", {
* displayName: "example-group",
* securityEnabled: true,
* });
* const exampleAccessPackageCatalog = new azuread.AccessPackageCatalog("example", {
* displayName: "example-catalog",
* description: "Example catalog",
* });
* const exampleAccessPackageResourceCatalogAssociation = new azuread.AccessPackageResourceCatalogAssociation("example", {
* catalogId: exampleCatalog.id,
* resourceOriginId: exampleGroup.objectId,
* resourceOriginSystem: "AadGroup",
* });
* const exampleAccessPackage = new azuread.AccessPackage("example", {
* displayName: "example-package",
* description: "Example Package",
* catalogId: exampleCatalog.id,
* });
* const exampleAccessPackageResourcePackageAssociation = new azuread.AccessPackageResourcePackageAssociation("example", {
* accessPackageId: exampleAccessPackage.id,
* catalogResourceAssociationId: exampleAccessPackageResourceCatalogAssociation.id,
* });
* ```
*
* ## Import
*
* The resource and catalog association can be imported using the access package ID, the access package ResourceRoleScope, the resource origin ID, and the access type, e.g.
*
* ```sh
* $ pulumi import azuread:index/accessPackageResourcePackageAssociation:AccessPackageResourcePackageAssociation example 00000000-0000-0000-0000-000000000000/11111111-1111-1111-1111-111111111111_22222222-2222-2222-2222-22222222/33333333-3333-3333-3333-33333333/Member
* ```
*
* -> This ID format is unique to Terraform and is composed of the Access Package ID, the access package ResourceRoleScope (in the format Role_Scope), the Resource Origin ID, and the Access Type, in the format `{AccessPackageID}/{ResourceRoleScope}/{ResourceOriginID}/{AccessType}`.
*/
class AccessPackageResourcePackageAssociation extends pulumi.CustomResource {
/**
* Get an existing AccessPackageResourcePackageAssociation 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 AccessPackageResourcePackageAssociation(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of AccessPackageResourcePackageAssociation. 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'] === AccessPackageResourcePackageAssociation.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["accessPackageId"] = state?.accessPackageId;
resourceInputs["accessType"] = state?.accessType;
resourceInputs["catalogResourceAssociationId"] = state?.catalogResourceAssociationId;
}
else {
const args = argsOrState;
if (args?.accessPackageId === undefined && !opts.urn) {
throw new Error("Missing required property 'accessPackageId'");
}
if (args?.catalogResourceAssociationId === undefined && !opts.urn) {
throw new Error("Missing required property 'catalogResourceAssociationId'");
}
resourceInputs["accessPackageId"] = args?.accessPackageId;
resourceInputs["accessType"] = args?.accessType;
resourceInputs["catalogResourceAssociationId"] = args?.catalogResourceAssociationId;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(AccessPackageResourcePackageAssociation.__pulumiType, name, resourceInputs, opts);
}
}
exports.AccessPackageResourcePackageAssociation = AccessPackageResourcePackageAssociation;
/** @internal */
AccessPackageResourcePackageAssociation.__pulumiType = 'azuread:index/accessPackageResourcePackageAssociation:AccessPackageResourcePackageAssociation';
//# sourceMappingURL=accessPackageResourcePackageAssociation.js.map