1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. getAccessPackageCatalog
Azure Active Directory (Azure AD) v5.47.2 published on Tuesday, Feb 27, 2024 by Pulumi

azuread.getAccessPackageCatalog

Explore with Pulumi AI

azuread logo
Azure Active Directory (Azure AD) v5.47.2 published on Tuesday, Feb 27, 2024 by Pulumi

    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

    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",
        });
    
    });
    
    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.LookupAccessPackageCatalog(ctx, &azuread.LookupAccessPackageCatalogArgs{
    			ObjectId: pulumi.StringRef("00000000-0000-0000-0000-000000000000"),
    		}, nil)
    		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.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());
    
        }
    }
    
    import pulumi
    import pulumi_azuread as azuread
    
    example = azuread.get_access_package_catalog(object_id="00000000-0000-0000-0000-000000000000")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azuread from "@pulumi/azuread";
    
    const example = azuread.getAccessPackageCatalog({
        objectId: "00000000-0000-0000-0000-000000000000",
    });
    
    variables:
      example:
        fn::invoke:
          Function: azuread:getAccessPackageCatalog
          Arguments:
            objectId: 00000000-0000-0000-0000-000000000000
    

    Look up by DisplayName

    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",
        });
    
    });
    
    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.LookupAccessPackageCatalog(ctx, &azuread.LookupAccessPackageCatalogArgs{
    			DisplayName: pulumi.StringRef("My access package Catalog"),
    		}, nil)
    		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.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());
    
        }
    }
    
    import pulumi
    import pulumi_azuread as azuread
    
    example = azuread.get_access_package_catalog(display_name="My access package Catalog")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azuread from "@pulumi/azuread";
    
    const example = azuread.getAccessPackageCatalog({
        displayName: "My access package Catalog",
    });
    
    variables:
      example:
        fn::invoke:
          Function: azuread:getAccessPackageCatalog
          Arguments:
            displayName: My access package Catalog
    

    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>
    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]
    func LookupAccessPackageCatalog(ctx *Context, args *LookupAccessPackageCatalogArgs, opts ...InvokeOption) (*LookupAccessPackageCatalogResult, error)
    func LookupAccessPackageCatalogOutput(ctx *Context, args *LookupAccessPackageCatalogOutputArgs, opts ...InvokeOption) LookupAccessPackageCatalogResultOutput

    > 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)
    }
    public static CompletableFuture<GetAccessPackageCatalogResult> getAccessPackageCatalog(GetAccessPackageCatalogArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azuread:index/getAccessPackageCatalog:getAccessPackageCatalog
      arguments:
        # arguments dictionary

    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.
    azuread logo
    Azure Active Directory (Azure AD) v5.47.2 published on Tuesday, Feb 27, 2024 by Pulumi