1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. AccessPackageCatalog
Azure Active Directory (Azure AD) v5.52.0 published on Friday, Jun 14, 2024 by Pulumi

azuread.AccessPackageCatalog

Explore with Pulumi AI

azuread logo
Azure Active Directory (Azure AD) v5.52.0 published on Friday, Jun 14, 2024 by Pulumi

    Manages an access package catalog 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, Catalog creator or Global Administrator

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azuread from "@pulumi/azuread";
    
    const example = new azuread.AccessPackageCatalog("example", {
        displayName: "example-access-package-catalog",
        description: "Example access package catalog",
    });
    
    import pulumi
    import pulumi_azuread as azuread
    
    example = azuread.AccessPackageCatalog("example",
        display_name="example-access-package-catalog",
        description="Example 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.NewAccessPackageCatalog(ctx, "example", &azuread.AccessPackageCatalogArgs{
    			DisplayName: pulumi.String("example-access-package-catalog"),
    			Description: pulumi.String("Example access package catalog"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureAD = Pulumi.AzureAD;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new AzureAD.AccessPackageCatalog("example", new()
        {
            DisplayName = "example-access-package-catalog",
            Description = "Example access package catalog",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azuread.AccessPackageCatalog;
    import com.pulumi.azuread.AccessPackageCatalogArgs;
    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 AccessPackageCatalog("example", AccessPackageCatalogArgs.builder()
                .displayName("example-access-package-catalog")
                .description("Example access package catalog")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azuread:AccessPackageCatalog
        properties:
          displayName: example-access-package-catalog
          description: Example access package catalog
    

    Create AccessPackageCatalog Resource

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

    Constructor syntax

    new AccessPackageCatalog(name: string, args: AccessPackageCatalogArgs, opts?: CustomResourceOptions);
    @overload
    def AccessPackageCatalog(resource_name: str,
                             args: AccessPackageCatalogArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def AccessPackageCatalog(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             description: Optional[str] = None,
                             display_name: Optional[str] = None,
                             externally_visible: Optional[bool] = None,
                             published: Optional[bool] = None)
    func NewAccessPackageCatalog(ctx *Context, name string, args AccessPackageCatalogArgs, opts ...ResourceOption) (*AccessPackageCatalog, error)
    public AccessPackageCatalog(string name, AccessPackageCatalogArgs args, CustomResourceOptions? opts = null)
    public AccessPackageCatalog(String name, AccessPackageCatalogArgs args)
    public AccessPackageCatalog(String name, AccessPackageCatalogArgs args, CustomResourceOptions options)
    
    type: azuread:AccessPackageCatalog
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AccessPackageCatalogArgs
    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 AccessPackageCatalogArgs
    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 AccessPackageCatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessPackageCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessPackageCatalogArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var accessPackageCatalogResource = new AzureAD.AccessPackageCatalog("accessPackageCatalogResource", new()
    {
        Description = "string",
        DisplayName = "string",
        ExternallyVisible = false,
        Published = false,
    });
    
    example, err := azuread.NewAccessPackageCatalog(ctx, "accessPackageCatalogResource", &azuread.AccessPackageCatalogArgs{
    	Description:       pulumi.String("string"),
    	DisplayName:       pulumi.String("string"),
    	ExternallyVisible: pulumi.Bool(false),
    	Published:         pulumi.Bool(false),
    })
    
    var accessPackageCatalogResource = new AccessPackageCatalog("accessPackageCatalogResource", AccessPackageCatalogArgs.builder()
        .description("string")
        .displayName("string")
        .externallyVisible(false)
        .published(false)
        .build());
    
    access_package_catalog_resource = azuread.AccessPackageCatalog("accessPackageCatalogResource",
        description="string",
        display_name="string",
        externally_visible=False,
        published=False)
    
    const accessPackageCatalogResource = new azuread.AccessPackageCatalog("accessPackageCatalogResource", {
        description: "string",
        displayName: "string",
        externallyVisible: false,
        published: false,
    });
    
    type: azuread:AccessPackageCatalog
    properties:
        description: string
        displayName: string
        externallyVisible: false
        published: false
    

    AccessPackageCatalog 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 AccessPackageCatalog resource accepts the following input properties:

    Description string
    The description of the access package catalog.
    DisplayName string
    The display name of the access package catalog.
    ExternallyVisible bool
    Whether the access packages in this catalog can be requested by users outside the tenant.
    Published bool
    Whether the access packages in this catalog are available for management.
    Description string
    The description of the access package catalog.
    DisplayName string
    The display name of the access package catalog.
    ExternallyVisible bool
    Whether the access packages in this catalog can be requested by users outside the tenant.
    Published bool
    Whether the access packages in this catalog are available for management.
    description String
    The description of the access package catalog.
    displayName String
    The display name of the access package catalog.
    externallyVisible Boolean
    Whether the access packages in this catalog can be requested by users outside the tenant.
    published Boolean
    Whether the access packages in this catalog are available for management.
    description string
    The description of the access package catalog.
    displayName string
    The display name of the access package catalog.
    externallyVisible boolean
    Whether the access packages in this catalog can be requested by users outside the tenant.
    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
    The display name of the access package catalog.
    externally_visible bool
    Whether the access packages in this catalog can be requested by users outside the tenant.
    published bool
    Whether the access packages in this catalog are available for management.
    description String
    The description of the access package catalog.
    displayName String
    The display name of the access package catalog.
    externallyVisible Boolean
    Whether the access packages in this catalog can be requested by users outside the tenant.
    published Boolean
    Whether the access packages in this catalog are available for management.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AccessPackageCatalog 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 AccessPackageCatalog Resource

    Get an existing AccessPackageCatalog 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?: AccessPackageCatalogState, opts?: CustomResourceOptions): AccessPackageCatalog
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            externally_visible: Optional[bool] = None,
            published: Optional[bool] = None) -> AccessPackageCatalog
    func GetAccessPackageCatalog(ctx *Context, name string, id IDInput, state *AccessPackageCatalogState, opts ...ResourceOption) (*AccessPackageCatalog, error)
    public static AccessPackageCatalog Get(string name, Input<string> id, AccessPackageCatalogState? state, CustomResourceOptions? opts = null)
    public static AccessPackageCatalog get(String name, Output<String> id, AccessPackageCatalogState 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.
    The following state arguments are supported:
    Description string
    The description of the access package catalog.
    DisplayName string
    The display name of the access package catalog.
    ExternallyVisible bool
    Whether the access packages in this catalog can be requested by users outside the tenant.
    Published bool
    Whether the access packages in this catalog are available for management.
    Description string
    The description of the access package catalog.
    DisplayName string
    The display name of the access package catalog.
    ExternallyVisible bool
    Whether the access packages in this catalog can be requested by users outside the tenant.
    Published bool
    Whether the access packages in this catalog are available for management.
    description String
    The description of the access package catalog.
    displayName String
    The display name of the access package catalog.
    externallyVisible Boolean
    Whether the access packages in this catalog can be requested by users outside the tenant.
    published Boolean
    Whether the access packages in this catalog are available for management.
    description string
    The description of the access package catalog.
    displayName string
    The display name of the access package catalog.
    externallyVisible boolean
    Whether the access packages in this catalog can be requested by users outside the tenant.
    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
    The display name of the access package catalog.
    externally_visible bool
    Whether the access packages in this catalog can be requested by users outside the tenant.
    published bool
    Whether the access packages in this catalog are available for management.
    description String
    The description of the access package catalog.
    displayName String
    The display name of the access package catalog.
    externallyVisible Boolean
    Whether the access packages in this catalog can be requested by users outside the tenant.
    published Boolean
    Whether the access packages in this catalog are available for management.

    Import

    An Access Package Catalog can be imported using the id, e.g.

    $ pulumi import azuread:index/accessPackageCatalog:AccessPackageCatalog example 00000000-0000-0000-0000-000000000000
    

    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.
    azuread logo
    Azure Active Directory (Azure AD) v5.52.0 published on Friday, Jun 14, 2024 by Pulumi