import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a custom Role Definition, used to assign Roles to Users/Principals. See ['Understand role definitions'](https://docs.microsoft.com/azure/role-based-access-control/role-definitions) in the Azure documentation for more details. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const primary = azure.core.getSubscription({}); * const example = new azure.authorization.RoleDefinition("example", { * name: "my-custom-role", * scope: primary.then(primary => primary.id), * description: "This is a custom role created", * permissions: [{ * actions: ["*"], * notActions: [], * }], * assignableScopes: [primary.then(primary => primary.id)], * }); * ``` * * ### With Management Group * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const current = azure.core.getSubscription({}); * const example = new azure.management.Group("example", { * displayName: "ParentGroup", * subscriptionIds: [current.then(current => current.subscriptionId)], * }); * const exampleRoleDefinition = new azure.authorization.RoleDefinition("example", { * name: "example-mg-role", * scope: example.id, * description: "Example custom role scoped to a management group.", * permissions: [{ * actions: ["Microsoft.Insights/alertRules/*"], * notActions: [], * }], * assignableScopes: [example.id], * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.Authorization` - 2022-05-01-preview * * ## Import * * Role Definitions can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:authorization/roleDefinition:RoleDefinition example "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000|/subscriptions/00000000-0000-0000-0000-000000000000" * ``` * * > **Note:** This ID is specific to this provider - and is of the format `{roleDefinitionId}|{scope}`. */ export declare class RoleDefinition extends pulumi.CustomResource { /** * Get an existing RoleDefinition 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, state?: RoleDefinitionState, opts?: pulumi.CustomResourceOptions): RoleDefinition; /** * Returns true if the given object is an instance of RoleDefinition. 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 RoleDefinition; /** * One or more assignable scopes for this Role Definition, such as `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333`, `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup`, `/providers/Microsoft.Management/managementGroups/0b1f6471-1bf0-4dda-aec3-111122223333` , or `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM`. * * > **NOTE:** The value for `scope` is automatically included in this list if no other values supplied. */ readonly assignableScopes: pulumi.Output; /** * A description of the Role Definition. */ readonly description: pulumi.Output; /** * The name of the Role Definition. */ readonly name: pulumi.Output; /** * A `permissions` block as defined below. */ readonly permissions: pulumi.Output; /** * A unique UUID/GUID which identifies this role - one will be generated if not specified. Changing this forces a new resource to be created. */ readonly roleDefinitionId: pulumi.Output; /** * The Azure Resource Manager ID for the resource. */ readonly roleDefinitionResourceId: pulumi.Output; /** * The scope at which the Role Definition applies to, such as `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333`, `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup`, `/providers/Microsoft.Management/managementGroups/0b1f6471-1bf0-4dda-aec3-111122223333`, or `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM`. It is recommended to use the first entry of the `assignableScopes`. Changing this forces a new resource to be created. */ readonly scope: pulumi.Output; /** * Create a RoleDefinition 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: RoleDefinitionArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering RoleDefinition resources. */ export interface RoleDefinitionState { /** * One or more assignable scopes for this Role Definition, such as `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333`, `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup`, `/providers/Microsoft.Management/managementGroups/0b1f6471-1bf0-4dda-aec3-111122223333` , or `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM`. * * > **NOTE:** The value for `scope` is automatically included in this list if no other values supplied. */ assignableScopes?: pulumi.Input[]>; /** * A description of the Role Definition. */ description?: pulumi.Input; /** * The name of the Role Definition. */ name?: pulumi.Input; /** * A `permissions` block as defined below. */ permissions?: pulumi.Input[]>; /** * A unique UUID/GUID which identifies this role - one will be generated if not specified. Changing this forces a new resource to be created. */ roleDefinitionId?: pulumi.Input; /** * The Azure Resource Manager ID for the resource. */ roleDefinitionResourceId?: pulumi.Input; /** * The scope at which the Role Definition applies to, such as `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333`, `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup`, `/providers/Microsoft.Management/managementGroups/0b1f6471-1bf0-4dda-aec3-111122223333`, or `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM`. It is recommended to use the first entry of the `assignableScopes`. Changing this forces a new resource to be created. */ scope?: pulumi.Input; } /** * The set of arguments for constructing a RoleDefinition resource. */ export interface RoleDefinitionArgs { /** * One or more assignable scopes for this Role Definition, such as `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333`, `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup`, `/providers/Microsoft.Management/managementGroups/0b1f6471-1bf0-4dda-aec3-111122223333` , or `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM`. * * > **NOTE:** The value for `scope` is automatically included in this list if no other values supplied. */ assignableScopes?: pulumi.Input[]>; /** * A description of the Role Definition. */ description?: pulumi.Input; /** * The name of the Role Definition. */ name?: pulumi.Input; /** * A `permissions` block as defined below. */ permissions?: pulumi.Input[]>; /** * A unique UUID/GUID which identifies this role - one will be generated if not specified. Changing this forces a new resource to be created. */ roleDefinitionId?: pulumi.Input; /** * The scope at which the Role Definition applies to, such as `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333`, `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup`, `/providers/Microsoft.Management/managementGroups/0b1f6471-1bf0-4dda-aec3-111122223333`, or `/subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM`. It is recommended to use the first entry of the `assignableScopes`. Changing this forces a new resource to be created. */ scope: pulumi.Input; }