Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. AccessPackageResourceCatalogAssociation
Azure Active Directory (Azure AD) v6.4.0 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azuread

azuread.AccessPackageResourceCatalogAssociation

Explore with Pulumi AI

Azure Active Directory (Azure AD) v6.4.0 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azuread

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

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",
});
Copy
import pulumi
import pulumi_azuread as azuread

example = azuread.Group("example",
    display_name="example-group",
    security_enabled=True)
example_access_package_catalog = azuread.AccessPackageCatalog("example",
    display_name="example-catalog",
    description="Example catalog")
example_access_package_resource_catalog_association = azuread.AccessPackageResourceCatalogAssociation("example",
    catalog_id=example_catalog["id"],
    resource_origin_id=example_group["objectId"],
    resource_origin_system="AadGroup")
Copy
package main

import (
	"github.com/pulumi/pulumi-azuread/sdk/v6/go/azuread"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azuread.NewGroup(ctx, "example", &azuread.GroupArgs{
			DisplayName:     pulumi.String("example-group"),
			SecurityEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAccessPackageCatalog(ctx, "example", &azuread.AccessPackageCatalogArgs{
			DisplayName: pulumi.String("example-catalog"),
			Description: pulumi.String("Example catalog"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAccessPackageResourceCatalogAssociation(ctx, "example", &azuread.AccessPackageResourceCatalogAssociationArgs{
			CatalogId:            pulumi.Any(exampleCatalog.Id),
			ResourceOriginId:     pulumi.Any(exampleGroup.ObjectId),
			ResourceOriginSystem: pulumi.String("AadGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureAD = Pulumi.AzureAD;

return await Deployment.RunAsync(() => 
{
    var example = new AzureAD.Group("example", new()
    {
        DisplayName = "example-group",
        SecurityEnabled = true,
    });

    var exampleAccessPackageCatalog = new AzureAD.AccessPackageCatalog("example", new()
    {
        DisplayName = "example-catalog",
        Description = "Example catalog",
    });

    var exampleAccessPackageResourceCatalogAssociation = new AzureAD.AccessPackageResourceCatalogAssociation("example", new()
    {
        CatalogId = exampleCatalog.Id,
        ResourceOriginId = exampleGroup.ObjectId,
        ResourceOriginSystem = "AadGroup",
    });

});
Copy
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 example = new Group("example", 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(exampleCatalog.id())
            .resourceOriginId(exampleGroup.objectId())
            .resourceOriginSystem("AadGroup")
            .build());

    }
}
Copy
resources:
  example:
    type: azuread:Group
    properties:
      displayName: example-group
      securityEnabled: true
  exampleAccessPackageCatalog:
    type: azuread:AccessPackageCatalog
    name: example
    properties:
      displayName: example-catalog
      description: Example catalog
  exampleAccessPackageResourceCatalogAssociation:
    type: azuread:AccessPackageResourceCatalogAssociation
    name: example
    properties:
      catalogId: ${exampleCatalog.id}
      resourceOriginId: ${exampleGroup.objectId}
      resourceOriginSystem: AadGroup
Copy

Create AccessPackageResourceCatalogAssociation Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AccessPackageResourceCatalogAssociation(name: string, args: AccessPackageResourceCatalogAssociationArgs, opts?: CustomResourceOptions);
@overload
def AccessPackageResourceCatalogAssociation(resource_name: str,
                                            args: AccessPackageResourceCatalogAssociationArgs,
                                            opts: Optional[ResourceOptions] = None)

@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)
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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AccessPackageResourceCatalogAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. AccessPackageResourceCatalogAssociationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AccessPackageResourceCatalogAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AccessPackageResourceCatalogAssociationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var accessPackageResourceCatalogAssociationResource = new AzureAD.AccessPackageResourceCatalogAssociation("accessPackageResourceCatalogAssociationResource", new()
{
    CatalogId = "string",
    ResourceOriginId = "string",
    ResourceOriginSystem = "string",
});
Copy
example, err := azuread.NewAccessPackageResourceCatalogAssociation(ctx, "accessPackageResourceCatalogAssociationResource", &azuread.AccessPackageResourceCatalogAssociationArgs{
	CatalogId:            pulumi.String("string"),
	ResourceOriginId:     pulumi.String("string"),
	ResourceOriginSystem: pulumi.String("string"),
})
Copy
var accessPackageResourceCatalogAssociationResource = new AccessPackageResourceCatalogAssociation("accessPackageResourceCatalogAssociationResource", AccessPackageResourceCatalogAssociationArgs.builder()
    .catalogId("string")
    .resourceOriginId("string")
    .resourceOriginSystem("string")
    .build());
Copy
access_package_resource_catalog_association_resource = azuread.AccessPackageResourceCatalogAssociation("accessPackageResourceCatalogAssociationResource",
    catalog_id="string",
    resource_origin_id="string",
    resource_origin_system="string")
Copy
const accessPackageResourceCatalogAssociationResource = new azuread.AccessPackageResourceCatalogAssociation("accessPackageResourceCatalogAssociationResource", {
    catalogId: "string",
    resourceOriginId: "string",
    resourceOriginSystem: "string",
});
Copy
type: azuread:AccessPackageResourceCatalogAssociation
properties:
    catalogId: string
    resourceOriginId: string
    resourceOriginSystem: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AccessPackageResourceCatalogAssociation resource accepts the following input properties:

CatalogId
This property is required.
Changes to this property will trigger replacement.
string
The unique ID of the access package catalog. Changing this forces a new resource to be created.
ResourceOriginId
This property is required.
Changes to this property will trigger replacement.
string
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.
ResourceOriginSystem
This property is required.
Changes to this property will trigger replacement.
string
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. Changing this forces a new resource to be created.
CatalogId
This property is required.
Changes to this property will trigger replacement.
string
The unique ID of the access package catalog. Changing this forces a new resource to be created.
ResourceOriginId
This property is required.
Changes to this property will trigger replacement.
string
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.
ResourceOriginSystem
This property is required.
Changes to this property will trigger replacement.
string
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. Changing this forces a new resource to be created.
catalogId
This property is required.
Changes to this property will trigger replacement.
String
The unique ID of the access package catalog. Changing this forces a new resource to be created.
resourceOriginId
This property is required.
Changes to this property will trigger replacement.
String
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.
resourceOriginSystem
This property is required.
Changes to this property will trigger replacement.
String
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. Changing this forces a new resource to be created.
catalogId
This property is required.
Changes to this property will trigger replacement.
string
The unique ID of the access package catalog. Changing this forces a new resource to be created.
resourceOriginId
This property is required.
Changes to this property will trigger replacement.
string
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.
resourceOriginSystem
This property is required.
Changes to this property will trigger replacement.
string
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. Changing this forces a new resource to be created.
catalog_id
This property is required.
Changes to this property will trigger replacement.
str
The unique ID of the access package catalog. Changing this forces a new resource to be created.
resource_origin_id
This property is required.
Changes to this property will trigger replacement.
str
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_system
This property is required.
Changes to this property will trigger replacement.
str
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. Changing this forces a new resource to be created.
catalogId
This property is required.
Changes to this property will trigger replacement.
String
The unique ID of the access package catalog. Changing this forces a new resource to be created.
resourceOriginId
This property is required.
Changes to this property will trigger replacement.
String
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.
resourceOriginSystem
This property is required.
Changes to this property will trigger replacement.
String
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. 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)
resources:  _:    type: azuread:AccessPackageResourceCatalogAssociation    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
CatalogId Changes to this property will trigger replacement. string
The unique ID of the access package catalog. Changing this forces a new resource to be created.
ResourceOriginId Changes to this property will trigger replacement. string
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.
ResourceOriginSystem Changes to this property will trigger replacement. string
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. Changing this forces a new resource to be created.
CatalogId Changes to this property will trigger replacement. string
The unique ID of the access package catalog. Changing this forces a new resource to be created.
ResourceOriginId Changes to this property will trigger replacement. string
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.
ResourceOriginSystem Changes to this property will trigger replacement. string
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. Changing this forces a new resource to be created.
catalogId Changes to this property will trigger replacement. String
The unique ID of the access package catalog. Changing this forces a new resource to be created.
resourceOriginId Changes to this property will trigger replacement. String
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.
resourceOriginSystem Changes to this property will trigger replacement. String
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. Changing this forces a new resource to be created.
catalogId Changes to this property will trigger replacement. string
The unique ID of the access package catalog. Changing this forces a new resource to be created.
resourceOriginId Changes to this property will trigger replacement. string
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.
resourceOriginSystem Changes to this property will trigger replacement. string
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. Changing this forces a new resource to be created.
catalog_id Changes to this property will trigger replacement. str
The unique ID of the access package catalog. Changing this forces a new resource to be created.
resource_origin_id Changes to this property will trigger replacement. str
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_system Changes to this property will trigger replacement. str
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. Changing this forces a new resource to be created.
catalogId Changes to this property will trigger replacement. String
The unique ID of the access package catalog. Changing this forces a new resource to be created.
resourceOriginId Changes to this property will trigger replacement. String
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.
resourceOriginSystem Changes to this property will trigger replacement. String
The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. 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
Copy

-> This ID format is unique to Terraform and is composed of the Catalog ID and the Resource Origin ID in the format {CatalogID}/{ResourceOriginID}.

To learn more about importing existing cloud resources, see Importing resources.

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.
Azure Active Directory (Azure AD) v6.4.0 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azuread