Azure Active Directory (Azure AD) v5.38.0, May 17 23
Azure Active Directory (Azure AD) v5.38.0, May 17 23
azuread.AccessPackageResourceCatalogAssociation
Explore with Pulumi AI
Manages the resources added to access package catalogs 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
or Global Administrator
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureAD = Pulumi.AzureAD;
return await Deployment.RunAsync(() =>
{
var exampleGroup = new AzureAD.Group("exampleGroup", new()
{
DisplayName = "example-group",
SecurityEnabled = true,
});
var exampleAccessPackageCatalog = new AzureAD.AccessPackageCatalog("exampleAccessPackageCatalog", new()
{
DisplayName = "example-catalog",
Description = "Example catalog",
});
var exampleAccessPackageResourceCatalogAssociation = new AzureAD.AccessPackageResourceCatalogAssociation("exampleAccessPackageResourceCatalogAssociation", new()
{
CatalogId = azuread_access_package_catalog.Example_catalog.Id,
ResourceOriginId = azuread_group.Example_group.Object_id,
ResourceOriginSystem = "AadGroup",
});
});
package main
import (
"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := azuread.NewGroup(ctx, "exampleGroup", &azuread.GroupArgs{
DisplayName: pulumi.String("example-group"),
SecurityEnabled: pulumi.Bool(true),
})
if err != nil {
return err
}
_, err = azuread.NewAccessPackageCatalog(ctx, "exampleAccessPackageCatalog", &azuread.AccessPackageCatalogArgs{
DisplayName: pulumi.String("example-catalog"),
Description: pulumi.String("Example catalog"),
})
if err != nil {
return err
}
_, err = azuread.NewAccessPackageResourceCatalogAssociation(ctx, "exampleAccessPackageResourceCatalogAssociation", &azuread.AccessPackageResourceCatalogAssociationArgs{
CatalogId: pulumi.Any(azuread_access_package_catalog.Example_catalog.Id),
ResourceOriginId: pulumi.Any(azuread_group.Example_group.Object_id),
ResourceOriginSystem: pulumi.String("AadGroup"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuread.Group;
import com.pulumi.azuread.GroupArgs;
import com.pulumi.azuread.AccessPackageCatalog;
import com.pulumi.azuread.AccessPackageCatalogArgs;
import com.pulumi.azuread.AccessPackageResourceCatalogAssociation;
import com.pulumi.azuread.AccessPackageResourceCatalogAssociationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
.displayName("example-group")
.securityEnabled(true)
.build());
var exampleAccessPackageCatalog = new AccessPackageCatalog("exampleAccessPackageCatalog", AccessPackageCatalogArgs.builder()
.displayName("example-catalog")
.description("Example catalog")
.build());
var exampleAccessPackageResourceCatalogAssociation = new AccessPackageResourceCatalogAssociation("exampleAccessPackageResourceCatalogAssociation", AccessPackageResourceCatalogAssociationArgs.builder()
.catalogId(azuread_access_package_catalog.example_catalog().id())
.resourceOriginId(azuread_group.example_group().object_id())
.resourceOriginSystem("AadGroup")
.build());
}
}
import pulumi
import pulumi_azuread as azuread
example_group = azuread.Group("exampleGroup",
display_name="example-group",
security_enabled=True)
example_access_package_catalog = azuread.AccessPackageCatalog("exampleAccessPackageCatalog",
display_name="example-catalog",
description="Example catalog")
example_access_package_resource_catalog_association = azuread.AccessPackageResourceCatalogAssociation("exampleAccessPackageResourceCatalogAssociation",
catalog_id=azuread_access_package_catalog["example_catalog"]["id"],
resource_origin_id=azuread_group["example_group"]["object_id"],
resource_origin_system="AadGroup")
import * as pulumi from "@pulumi/pulumi";
import * as azuread from "@pulumi/azuread";
const exampleGroup = new azuread.Group("exampleGroup", {
displayName: "example-group",
securityEnabled: true,
});
const exampleAccessPackageCatalog = new azuread.AccessPackageCatalog("exampleAccessPackageCatalog", {
displayName: "example-catalog",
description: "Example catalog",
});
const exampleAccessPackageResourceCatalogAssociation = new azuread.AccessPackageResourceCatalogAssociation("exampleAccessPackageResourceCatalogAssociation", {
catalogId: azuread_access_package_catalog.example_catalog.id,
resourceOriginId: azuread_group.example_group.object_id,
resourceOriginSystem: "AadGroup",
});
resources:
exampleGroup:
type: azuread:Group
properties:
displayName: example-group
securityEnabled: true
exampleAccessPackageCatalog:
type: azuread:AccessPackageCatalog
properties:
displayName: example-catalog
description: Example catalog
exampleAccessPackageResourceCatalogAssociation:
type: azuread:AccessPackageResourceCatalogAssociation
properties:
catalogId: ${azuread_access_package_catalog.example_catalog.id}
resourceOriginId: ${azuread_group.example_group.object_id}
resourceOriginSystem: AadGroup
Create AccessPackageResourceCatalogAssociation Resource
new AccessPackageResourceCatalogAssociation(name: string, args: AccessPackageResourceCatalogAssociationArgs, opts?: CustomResourceOptions);
@overload
def AccessPackageResourceCatalogAssociation(resource_name: str,
opts: Optional[ResourceOptions] = None,
catalog_id: Optional[str] = None,
resource_origin_id: Optional[str] = None,
resource_origin_system: Optional[str] = None)
@overload
def AccessPackageResourceCatalogAssociation(resource_name: str,
args: AccessPackageResourceCatalogAssociationArgs,
opts: Optional[ResourceOptions] = None)
func NewAccessPackageResourceCatalogAssociation(ctx *Context, name string, args AccessPackageResourceCatalogAssociationArgs, opts ...ResourceOption) (*AccessPackageResourceCatalogAssociation, error)
public AccessPackageResourceCatalogAssociation(string name, AccessPackageResourceCatalogAssociationArgs args, CustomResourceOptions? opts = null)
public AccessPackageResourceCatalogAssociation(String name, AccessPackageResourceCatalogAssociationArgs args)
public AccessPackageResourceCatalogAssociation(String name, AccessPackageResourceCatalogAssociationArgs args, CustomResourceOptions options)
type: azuread:AccessPackageResourceCatalogAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AccessPackageResourceCatalogAssociationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AccessPackageResourceCatalogAssociationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AccessPackageResourceCatalogAssociationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AccessPackageResourceCatalogAssociationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AccessPackageResourceCatalogAssociationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AccessPackageResourceCatalogAssociation Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The AccessPackageResourceCatalogAssociation resource accepts the following input properties:
- Catalog
Id string The unique ID of the access package catalog. Changing this forces a new resource to be created.
- Resource
Origin stringId The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- Resource
Origin stringSystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
- Catalog
Id string The unique ID of the access package catalog. Changing this forces a new resource to be created.
- Resource
Origin stringId The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- Resource
Origin stringSystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
- catalog
Id String The unique ID of the access package catalog. Changing this forces a new resource to be created.
- resource
Origin StringId The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- resource
Origin StringSystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
- catalog
Id string The unique ID of the access package catalog. Changing this forces a new resource to be created.
- resource
Origin stringId The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- resource
Origin stringSystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
- catalog_
id str The unique ID of the access package catalog. Changing this forces a new resource to be created.
- resource_
origin_ strid The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- resource_
origin_ strsystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
- catalog
Id String The unique ID of the access package catalog. Changing this forces a new resource to be created.
- resource
Origin StringId The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- resource
Origin StringSystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the AccessPackageResourceCatalogAssociation resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing AccessPackageResourceCatalogAssociation Resource
Get an existing AccessPackageResourceCatalogAssociation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AccessPackageResourceCatalogAssociationState, opts?: CustomResourceOptions): AccessPackageResourceCatalogAssociation
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
catalog_id: Optional[str] = None,
resource_origin_id: Optional[str] = None,
resource_origin_system: Optional[str] = None) -> AccessPackageResourceCatalogAssociation
func GetAccessPackageResourceCatalogAssociation(ctx *Context, name string, id IDInput, state *AccessPackageResourceCatalogAssociationState, opts ...ResourceOption) (*AccessPackageResourceCatalogAssociation, error)
public static AccessPackageResourceCatalogAssociation Get(string name, Input<string> id, AccessPackageResourceCatalogAssociationState? state, CustomResourceOptions? opts = null)
public static AccessPackageResourceCatalogAssociation get(String name, Output<String> id, AccessPackageResourceCatalogAssociationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Catalog
Id string The unique ID of the access package catalog. Changing this forces a new resource to be created.
- Resource
Origin stringId The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- Resource
Origin stringSystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
- Catalog
Id string The unique ID of the access package catalog. Changing this forces a new resource to be created.
- Resource
Origin stringId The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- Resource
Origin stringSystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
- catalog
Id String The unique ID of the access package catalog. Changing this forces a new resource to be created.
- resource
Origin StringId The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- resource
Origin StringSystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
- catalog
Id string The unique ID of the access package catalog. Changing this forces a new resource to be created.
- resource
Origin stringId The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- resource
Origin stringSystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
- catalog_
id str The unique ID of the access package catalog. Changing this forces a new resource to be created.
- resource_
origin_ strid The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- resource_
origin_ strsystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
- catalog
Id String The unique ID of the access package catalog. Changing this forces a new resource to be created.
- resource
Origin StringId The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
- resource
Origin StringSystem The type of the resource in the origin system, such as
SharePointOnline
,AadApplication
orAadGroup
. Changing this forces a new resource to be created.
Import
The resource and catalog association can be imported using the catalog ID and the resource origin ID, e.g.
$ pulumi import azuread:index/accessPackageResourceCatalogAssociation:AccessPackageResourceCatalogAssociation example 00000000-0000-0000-0000-000000000000/11111111-1111-1111-1111-111111111111
-> This ID format is unique to Terraform and is composed of the Catalog ID and the Resource Origin ID in the format {CatalogID}/{ResourceOriginID}
.
Package Details
- Repository
- Azure Active Directory (Azure AD) pulumi/pulumi-azuread
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azuread
Terraform Provider.