Docs
Packagesazuread.AccessPackage
Explore with Pulumi AI
Manages an Access Package 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, Access package manager or Global Administrator
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureAD = Pulumi.AzureAD;
return await Deployment.RunAsync(() =>
{
var exampleAccessPackageCatalog = new AzureAD.AccessPackageCatalog("exampleAccessPackageCatalog", new()
{
DisplayName = "example-catalog",
Description = "Example catalog",
});
var exampleAccessPackage = new AzureAD.AccessPackage("exampleAccessPackage", new()
{
CatalogId = exampleAccessPackageCatalog.Id,
DisplayName = "access-package",
Description = "Access Package",
});
});
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 {
exampleAccessPackageCatalog, err := azuread.NewAccessPackageCatalog(ctx, "exampleAccessPackageCatalog", &azuread.AccessPackageCatalogArgs{
DisplayName: pulumi.String("example-catalog"),
Description: pulumi.String("Example catalog"),
})
if err != nil {
return err
}
_, err = azuread.NewAccessPackage(ctx, "exampleAccessPackage", &azuread.AccessPackageArgs{
CatalogId: exampleAccessPackageCatalog.ID(),
DisplayName: pulumi.String("access-package"),
Description: pulumi.String("Access Package"),
})
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.AccessPackageCatalog;
import com.pulumi.azuread.AccessPackageCatalogArgs;
import com.pulumi.azuread.AccessPackage;
import com.pulumi.azuread.AccessPackageArgs;
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 exampleAccessPackageCatalog = new AccessPackageCatalog("exampleAccessPackageCatalog", AccessPackageCatalogArgs.builder()
.displayName("example-catalog")
.description("Example catalog")
.build());
var exampleAccessPackage = new AccessPackage("exampleAccessPackage", AccessPackageArgs.builder()
.catalogId(exampleAccessPackageCatalog.id())
.displayName("access-package")
.description("Access Package")
.build());
}
}
import pulumi
import pulumi_azuread as azuread
example_access_package_catalog = azuread.AccessPackageCatalog("exampleAccessPackageCatalog",
display_name="example-catalog",
description="Example catalog")
example_access_package = azuread.AccessPackage("exampleAccessPackage",
catalog_id=example_access_package_catalog.id,
display_name="access-package",
description="Access Package")
import * as pulumi from "@pulumi/pulumi";
import * as azuread from "@pulumi/azuread";
const exampleAccessPackageCatalog = new azuread.AccessPackageCatalog("exampleAccessPackageCatalog", {
displayName: "example-catalog",
description: "Example catalog",
});
const exampleAccessPackage = new azuread.AccessPackage("exampleAccessPackage", {
catalogId: exampleAccessPackageCatalog.id,
displayName: "access-package",
description: "Access Package",
});
resources:
exampleAccessPackageCatalog:
type: azuread:AccessPackageCatalog
properties:
displayName: example-catalog
description: Example catalog
exampleAccessPackage:
type: azuread:AccessPackage
properties:
catalogId: ${exampleAccessPackageCatalog.id}
displayName: access-package
description: Access Package
Create AccessPackage Resource
new AccessPackage(name: string, args: AccessPackageArgs, opts?: CustomResourceOptions);@overload
def AccessPackage(resource_name: str,
opts: Optional[ResourceOptions] = None,
catalog_id: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
hidden: Optional[bool] = None)
@overload
def AccessPackage(resource_name: str,
args: AccessPackageArgs,
opts: Optional[ResourceOptions] = None)func NewAccessPackage(ctx *Context, name string, args AccessPackageArgs, opts ...ResourceOption) (*AccessPackage, error)public AccessPackage(string name, AccessPackageArgs args, CustomResourceOptions? opts = null)
public AccessPackage(String name, AccessPackageArgs args)
public AccessPackage(String name, AccessPackageArgs args, CustomResourceOptions options)
type: azuread:AccessPackage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AccessPackageArgs
- 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 AccessPackageArgs
- 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 AccessPackageArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AccessPackageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AccessPackageArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AccessPackage 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 AccessPackage resource accepts the following input properties:
- Catalog
Id string The ID of the Catalog this access package will be created in.
- Description string
The description of the access package.
- Display
Name string The display name of the access package.
- bool
Whether the access package is hidden from the requestor.
- Catalog
Id string The ID of the Catalog this access package will be created in.
- Description string
The description of the access package.
- Display
Name string The display name of the access package.
- bool
Whether the access package is hidden from the requestor.
- catalog
Id String The ID of the Catalog this access package will be created in.
- description String
The description of the access package.
- display
Name String The display name of the access package.
- Boolean
Whether the access package is hidden from the requestor.
- catalog
Id string The ID of the Catalog this access package will be created in.
- description string
The description of the access package.
- display
Name string The display name of the access package.
- boolean
Whether the access package is hidden from the requestor.
- catalog_
id str The ID of the Catalog this access package will be created in.
- description str
The description of the access package.
- display_
name str The display name of the access package.
- bool
Whether the access package is hidden from the requestor.
- catalog
Id String The ID of the Catalog this access package will be created in.
- description String
The description of the access package.
- display
Name String The display name of the access package.
- Boolean
Whether the access package is hidden from the requestor.
Outputs
All input properties are implicitly available as output properties. Additionally, the AccessPackage 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 AccessPackage Resource
Get an existing AccessPackage 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?: AccessPackageState, opts?: CustomResourceOptions): AccessPackage@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
catalog_id: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
hidden: Optional[bool] = None) -> AccessPackagefunc GetAccessPackage(ctx *Context, name string, id IDInput, state *AccessPackageState, opts ...ResourceOption) (*AccessPackage, error)public static AccessPackage Get(string name, Input<string> id, AccessPackageState? state, CustomResourceOptions? opts = null)public static AccessPackage get(String name, Output<String> id, AccessPackageState 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.
- Catalog
Id string The ID of the Catalog this access package will be created in.
- Description string
The description of the access package.
- Display
Name string The display name of the access package.
- bool
Whether the access package is hidden from the requestor.
- Catalog
Id string The ID of the Catalog this access package will be created in.
- Description string
The description of the access package.
- Display
Name string The display name of the access package.
- bool
Whether the access package is hidden from the requestor.
- catalog
Id String The ID of the Catalog this access package will be created in.
- description String
The description of the access package.
- display
Name String The display name of the access package.
- Boolean
Whether the access package is hidden from the requestor.
- catalog
Id string The ID of the Catalog this access package will be created in.
- description string
The description of the access package.
- display
Name string The display name of the access package.
- boolean
Whether the access package is hidden from the requestor.
- catalog_
id str The ID of the Catalog this access package will be created in.
- description str
The description of the access package.
- display_
name str The display name of the access package.
- bool
Whether the access package is hidden from the requestor.
- catalog
Id String The ID of the Catalog this access package will be created in.
- description String
The description of the access package.
- display
Name String The display name of the access package.
- Boolean
Whether the access package is hidden from the requestor.
Import
Access Packages can be imported using the id, e.g.
$ pulumi import azuread:index/accessPackage:AccessPackage example_package 00000000-0000-0000-0000-000000000000
Package Details
- Repository
- Azure Active Directory (Azure AD) pulumi/pulumi-azuread
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azureadTerraform Provider.