1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. getAccessPackageCatalogRole
Azure Active Directory (Azure AD) v6.2.0 published on Tuesday, Jan 21, 2025 by Pulumi

azuread.getAccessPackageCatalogRole

Explore with Pulumi AI

Gets information about an access package catalog role.

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 Directory.Read.All

When authenticated with a user principal, this data source does not require any additional roles.

Example Usage

By Group Display Name)

Look up by display name

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

const example = azuread.getAccessPackageCatalogRole({
    displayName: "Catalog owner",
});
Copy
import pulumi
import pulumi_azuread as azuread

example = azuread.get_access_package_catalog_role(display_name="Catalog owner")
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.GetAccessPackageCatalogRole(ctx, &azuread.GetAccessPackageCatalogRoleArgs{
			DisplayName: pulumi.StringRef("Catalog owner"),
		}, 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.GetAccessPackageCatalogRole.Invoke(new()
    {
        DisplayName = "Catalog owner",
    });

});
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.GetAccessPackageCatalogRoleArgs;
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.getAccessPackageCatalogRole(GetAccessPackageCatalogRoleArgs.builder()
            .displayName("Catalog owner")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azuread:getAccessPackageCatalogRole
      arguments:
        displayName: Catalog owner
Copy

Look up by object ID

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

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

example = azuread.get_access_package_catalog_role(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.GetAccessPackageCatalogRole(ctx, &azuread.GetAccessPackageCatalogRoleArgs{
			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.GetAccessPackageCatalogRole.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.GetAccessPackageCatalogRoleArgs;
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.getAccessPackageCatalogRole(GetAccessPackageCatalogRoleArgs.builder()
            .objectId("00000000-0000-0000-0000-000000000000")
            .build());

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

Using getAccessPackageCatalogRole

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 getAccessPackageCatalogRole(args: GetAccessPackageCatalogRoleArgs, opts?: InvokeOptions): Promise<GetAccessPackageCatalogRoleResult>
function getAccessPackageCatalogRoleOutput(args: GetAccessPackageCatalogRoleOutputArgs, opts?: InvokeOptions): Output<GetAccessPackageCatalogRoleResult>
Copy
def get_access_package_catalog_role(display_name: Optional[str] = None,
                                    object_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetAccessPackageCatalogRoleResult
def get_access_package_catalog_role_output(display_name: Optional[pulumi.Input[str]] = None,
                                    object_id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetAccessPackageCatalogRoleResult]
Copy
func GetAccessPackageCatalogRole(ctx *Context, args *GetAccessPackageCatalogRoleArgs, opts ...InvokeOption) (*GetAccessPackageCatalogRoleResult, error)
func GetAccessPackageCatalogRoleOutput(ctx *Context, args *GetAccessPackageCatalogRoleOutputArgs, opts ...InvokeOption) GetAccessPackageCatalogRoleResultOutput
Copy

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

public static class GetAccessPackageCatalogRole 
{
    public static Task<GetAccessPackageCatalogRoleResult> InvokeAsync(GetAccessPackageCatalogRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessPackageCatalogRoleResult> Invoke(GetAccessPackageCatalogRoleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAccessPackageCatalogRoleResult> getAccessPackageCatalogRole(GetAccessPackageCatalogRoleArgs args, InvokeOptions options)
public static Output<GetAccessPackageCatalogRoleResult> getAccessPackageCatalogRole(GetAccessPackageCatalogRoleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azuread:index/getAccessPackageCatalogRole:getAccessPackageCatalogRole
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DisplayName string
Specifies the display name of the role.
ObjectId string

Specifies the object ID of the role.

One of display_name or object_id must be specified.

DisplayName string
Specifies the display name of the role.
ObjectId string

Specifies the object ID of the role.

One of display_name or object_id must be specified.

displayName String
Specifies the display name of the role.
objectId String

Specifies the object ID of the role.

One of display_name or object_id must be specified.

displayName string
Specifies the display name of the role.
objectId string

Specifies the object ID of the role.

One of display_name or object_id must be specified.

display_name str
Specifies the display name of the role.
object_id str

Specifies the object ID of the role.

One of display_name or object_id must be specified.

displayName String
Specifies the display name of the role.
objectId String

Specifies the object ID of the role.

One of display_name or object_id must be specified.

getAccessPackageCatalogRole Result

The following output properties are available:

Description string
The description of the role.
DisplayName string
The display name of the role.
Id string
The provider-assigned unique ID for this managed resource.
ObjectId string
The object ID of the role.
TemplateId string
The object ID of the role.
Description string
The description of the role.
DisplayName string
The display name of the role.
Id string
The provider-assigned unique ID for this managed resource.
ObjectId string
The object ID of the role.
TemplateId string
The object ID of the role.
description String
The description of the role.
displayName String
The display name of the role.
id String
The provider-assigned unique ID for this managed resource.
objectId String
The object ID of the role.
templateId String
The object ID of the role.
description string
The description of the role.
displayName string
The display name of the role.
id string
The provider-assigned unique ID for this managed resource.
objectId string
The object ID of the role.
templateId string
The object ID of the role.
description str
The description of the role.
display_name str
The display name of the role.
id str
The provider-assigned unique ID for this managed resource.
object_id str
The object ID of the role.
template_id str
The object ID of the role.
description String
The description of the role.
displayName String
The display name of the role.
id String
The provider-assigned unique ID for this managed resource.
objectId String
The object ID of the role.
templateId String
The object ID of the role.

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.