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

azuread.getAccessPackageCatalog

Explore with Pulumi AI

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

i Use this resource to retrieve information for an existing access package catalog within Identity Governance in Azure Active Directory.

API Permissions

The following API permissions are required in order to use this data source.

When authenticated with a service principal, this data source requires one of the following application roles: EntitlementManagement.Read.All, or EntitlementManagement.ReadWrite.All.

When authenticated with a user principal, this data source requires one of the following directory roles: Catalog owner, Catalog reader, Global Reader, or Global Administrator.

Example Usage

Look up by ID

import * as pulumi from "@pulumi/pulumi";
import * as azuread from "@pulumi/azuread";

const example = azuread.getAccessPackageCatalog({
    objectId: "00000000-0000-0000-0000-000000000000",
});
Copy
import pulumi
import pulumi_azuread as azuread

example = azuread.get_access_package_catalog(object_id="00000000-0000-0000-0000-000000000000")
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.LookupAccessPackageCatalog(ctx, &azuread.LookupAccessPackageCatalogArgs{
			ObjectId: pulumi.StringRef("00000000-0000-0000-0000-000000000000"),
		}, nil)
		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 = AzureAD.GetAccessPackageCatalog.Invoke(new()
    {
        ObjectId = "00000000-0000-0000-0000-000000000000",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuread.AzureadFunctions;
import com.pulumi.azuread.inputs.GetAccessPackageCatalogArgs;
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) {
        final var example = AzureadFunctions.getAccessPackageCatalog(GetAccessPackageCatalogArgs.builder()
            .objectId("00000000-0000-0000-0000-000000000000")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azuread:getAccessPackageCatalog
      arguments:
        objectId: 00000000-0000-0000-0000-000000000000
Copy

Look up by DisplayName

import * as pulumi from "@pulumi/pulumi";
import * as azuread from "@pulumi/azuread";

const example = azuread.getAccessPackageCatalog({
    displayName: "My access package Catalog",
});
Copy
import pulumi
import pulumi_azuread as azuread

example = azuread.get_access_package_catalog(display_name="My access package Catalog")
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.LookupAccessPackageCatalog(ctx, &azuread.LookupAccessPackageCatalogArgs{
			DisplayName: pulumi.StringRef("My access package Catalog"),
		}, nil)
		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 = AzureAD.GetAccessPackageCatalog.Invoke(new()
    {
        DisplayName = "My access package Catalog",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuread.AzureadFunctions;
import com.pulumi.azuread.inputs.GetAccessPackageCatalogArgs;
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) {
        final var example = AzureadFunctions.getAccessPackageCatalog(GetAccessPackageCatalogArgs.builder()
            .displayName("My access package Catalog")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azuread:getAccessPackageCatalog
      arguments:
        displayName: My access package Catalog
Copy

Using getAccessPackageCatalog

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAccessPackageCatalog(args: GetAccessPackageCatalogArgs, opts?: InvokeOptions): Promise<GetAccessPackageCatalogResult>
function getAccessPackageCatalogOutput(args: GetAccessPackageCatalogOutputArgs, opts?: InvokeOptions): Output<GetAccessPackageCatalogResult>
Copy
def get_access_package_catalog(display_name: Optional[str] = None,
                               object_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetAccessPackageCatalogResult
def get_access_package_catalog_output(display_name: Optional[pulumi.Input[str]] = None,
                               object_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetAccessPackageCatalogResult]
Copy
func LookupAccessPackageCatalog(ctx *Context, args *LookupAccessPackageCatalogArgs, opts ...InvokeOption) (*LookupAccessPackageCatalogResult, error)
func LookupAccessPackageCatalogOutput(ctx *Context, args *LookupAccessPackageCatalogOutputArgs, opts ...InvokeOption) LookupAccessPackageCatalogResultOutput
Copy

> Note: This function is named LookupAccessPackageCatalog in the Go SDK.

public static class GetAccessPackageCatalog 
{
    public static Task<GetAccessPackageCatalogResult> InvokeAsync(GetAccessPackageCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessPackageCatalogResult> Invoke(GetAccessPackageCatalogInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAccessPackageCatalogResult> getAccessPackageCatalog(GetAccessPackageCatalogArgs args, InvokeOptions options)
public static Output<GetAccessPackageCatalogResult> getAccessPackageCatalog(GetAccessPackageCatalogArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azuread:index/getAccessPackageCatalog:getAccessPackageCatalog
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DisplayName string
The display name of the access package catalog.
ObjectId string

The ID of this access package catalog.

One of display_name or object_id must be specified.

DisplayName string
The display name of the access package catalog.
ObjectId string

The ID of this access package catalog.

One of display_name or object_id must be specified.

displayName String
The display name of the access package catalog.
objectId String

The ID of this access package catalog.

One of display_name or object_id must be specified.

displayName string
The display name of the access package catalog.
objectId string

The ID of this access package catalog.

One of display_name or object_id must be specified.

display_name str
The display name of the access package catalog.
object_id str

The ID of this access package catalog.

One of display_name or object_id must be specified.

displayName String
The display name of the access package catalog.
objectId String

The ID of this access package catalog.

One of display_name or object_id must be specified.

getAccessPackageCatalog Result

The following output properties are available:

Description string
The description of the access package catalog.
DisplayName string
ExternallyVisible bool
Whether the access packages in this catalog can be requested by users outside the tenant.
Id string
The provider-assigned unique ID for this managed resource.
ObjectId string
Published bool
Whether the access packages in this catalog are available for management.
Description string
The description of the access package catalog.
DisplayName string
ExternallyVisible bool
Whether the access packages in this catalog can be requested by users outside the tenant.
Id string
The provider-assigned unique ID for this managed resource.
ObjectId string
Published bool
Whether the access packages in this catalog are available for management.
description String
The description of the access package catalog.
displayName String
externallyVisible Boolean
Whether the access packages in this catalog can be requested by users outside the tenant.
id String
The provider-assigned unique ID for this managed resource.
objectId String
published Boolean
Whether the access packages in this catalog are available for management.
description string
The description of the access package catalog.
displayName string
externallyVisible boolean
Whether the access packages in this catalog can be requested by users outside the tenant.
id string
The provider-assigned unique ID for this managed resource.
objectId string
published boolean
Whether the access packages in this catalog are available for management.
description str
The description of the access package catalog.
display_name str
externally_visible bool
Whether the access packages in this catalog can be requested by users outside the tenant.
id str
The provider-assigned unique ID for this managed resource.
object_id str
published bool
Whether the access packages in this catalog are available for management.
description String
The description of the access package catalog.
displayName String
externallyVisible Boolean
Whether the access packages in this catalog can be requested by users outside the tenant.
id String
The provider-assigned unique ID for this managed resource.
objectId String
published Boolean
Whether the access packages in this catalog are available for management.

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