@pulumi/azuread
Version:
A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.
124 lines • 5.26 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.GroupRoleManagementPolicy = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Manage a role policy for an Azure AD group.
*
* ## API Permissions
*
* The following API permissions are required in order to use this resource.
*
* When authenticated with a service principal, this resource requires the `RoleManagementPolicy.ReadWrite.AzureADGroup` Microsoft Graph API permissions.
*
* When authenticated with a user principal, this resource requires `Global Administrator` directory role, or the `Privileged Role Administrator` role in Identity Governance.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const example = new azuread.Group("example", {
* displayName: "group-name",
* securityEnabled: true,
* });
* const member = new azuread.User("member", {
* userPrincipalName: "jdoe@example.com",
* displayName: "J. Doe",
* mailNickname: "jdoe",
* password: "SecretP@sswd99!",
* });
* const exampleGroupRoleManagementPolicy = new azuread.GroupRoleManagementPolicy("example", {
* groupId: example.id,
* roleId: "member",
* activeAssignmentRules: {
* expireAfter: "P365D",
* },
* eligibleAssignmentRules: {
* expirationRequired: false,
* },
* notificationRules: {
* eligibleAssignments: {
* approverNotifications: {
* notificationLevel: "Critical",
* defaultRecipients: false,
* additionalRecipients: [
* "someone@example.com",
* "someone.else@example.com",
* ],
* },
* },
* },
* });
* ```
*
* ## Import
*
* Because these policies are created automatically by Entra ID, they will auto-import on first use.
*/
class GroupRoleManagementPolicy extends pulumi.CustomResource {
/**
* Get an existing GroupRoleManagementPolicy 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 GroupRoleManagementPolicy(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of GroupRoleManagementPolicy. 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'] === GroupRoleManagementPolicy.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["activationRules"] = state?.activationRules;
resourceInputs["activeAssignmentRules"] = state?.activeAssignmentRules;
resourceInputs["description"] = state?.description;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["eligibleAssignmentRules"] = state?.eligibleAssignmentRules;
resourceInputs["groupId"] = state?.groupId;
resourceInputs["notificationRules"] = state?.notificationRules;
resourceInputs["roleId"] = state?.roleId;
}
else {
const args = argsOrState;
if (args?.groupId === undefined && !opts.urn) {
throw new Error("Missing required property 'groupId'");
}
if (args?.roleId === undefined && !opts.urn) {
throw new Error("Missing required property 'roleId'");
}
resourceInputs["activationRules"] = args?.activationRules;
resourceInputs["activeAssignmentRules"] = args?.activeAssignmentRules;
resourceInputs["eligibleAssignmentRules"] = args?.eligibleAssignmentRules;
resourceInputs["groupId"] = args?.groupId;
resourceInputs["notificationRules"] = args?.notificationRules;
resourceInputs["roleId"] = args?.roleId;
resourceInputs["description"] = undefined /*out*/;
resourceInputs["displayName"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(GroupRoleManagementPolicy.__pulumiType, name, resourceInputs, opts);
}
}
exports.GroupRoleManagementPolicy = GroupRoleManagementPolicy;
/** @internal */
GroupRoleManagementPolicy.__pulumiType = 'azuread:index/groupRoleManagementPolicy:GroupRoleManagementPolicy';
//# sourceMappingURL=groupRoleManagementPolicy.js.map