azuread

package
v5.48.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2024 License: Apache-2.0 Imports: 7 Imported by: 3

Documentation

Overview

A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPackage added in v5.37.0

type AccessPackage struct {
	pulumi.CustomResourceState

	// The ID of the Catalog this access package will be created in.
	CatalogId pulumi.StringOutput `pulumi:"catalogId"`
	// The description of the access package.
	Description pulumi.StringOutput `pulumi:"description"`
	// The display name of the access package.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Whether the access package is hidden from the requestor.
	Hidden pulumi.BoolPtrOutput `pulumi:"hidden"`
}

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

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewAccessPackageCatalog(ctx, "example", &azuread.AccessPackageCatalogArgs{
			DisplayName: pulumi.String("example-catalog"),
			Description: pulumi.String("Example catalog"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAccessPackage(ctx, "example", &azuread.AccessPackageArgs{
			CatalogId:   example.ID(),
			DisplayName: pulumi.String("access-package"),
			Description: pulumi.String("Access Package"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Access Packages can be imported using the `id`, e.g.

```sh $ pulumi import azuread:index/accessPackage:AccessPackage example_package 00000000-0000-0000-0000-000000000000 ```

func GetAccessPackage added in v5.37.0

func GetAccessPackage(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccessPackageState, opts ...pulumi.ResourceOption) (*AccessPackage, error)

GetAccessPackage gets an existing AccessPackage resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccessPackage added in v5.37.0

func NewAccessPackage(ctx *pulumi.Context,
	name string, args *AccessPackageArgs, opts ...pulumi.ResourceOption) (*AccessPackage, error)

NewAccessPackage registers a new resource with the given unique name, arguments, and options.

func (*AccessPackage) ElementType added in v5.37.0

func (*AccessPackage) ElementType() reflect.Type

func (*AccessPackage) ToAccessPackageOutput added in v5.37.0

func (i *AccessPackage) ToAccessPackageOutput() AccessPackageOutput

func (*AccessPackage) ToAccessPackageOutputWithContext added in v5.37.0

func (i *AccessPackage) ToAccessPackageOutputWithContext(ctx context.Context) AccessPackageOutput

type AccessPackageArgs added in v5.37.0

type AccessPackageArgs struct {
	// The ID of the Catalog this access package will be created in.
	CatalogId pulumi.StringInput
	// The description of the access package.
	Description pulumi.StringInput
	// The display name of the access package.
	DisplayName pulumi.StringInput
	// Whether the access package is hidden from the requestor.
	Hidden pulumi.BoolPtrInput
}

The set of arguments for constructing a AccessPackage resource.

func (AccessPackageArgs) ElementType added in v5.37.0

func (AccessPackageArgs) ElementType() reflect.Type

type AccessPackageArray added in v5.37.0

type AccessPackageArray []AccessPackageInput

func (AccessPackageArray) ElementType added in v5.37.0

func (AccessPackageArray) ElementType() reflect.Type

func (AccessPackageArray) ToAccessPackageArrayOutput added in v5.37.0

func (i AccessPackageArray) ToAccessPackageArrayOutput() AccessPackageArrayOutput

func (AccessPackageArray) ToAccessPackageArrayOutputWithContext added in v5.37.0

func (i AccessPackageArray) ToAccessPackageArrayOutputWithContext(ctx context.Context) AccessPackageArrayOutput

type AccessPackageArrayInput added in v5.37.0

type AccessPackageArrayInput interface {
	pulumi.Input

	ToAccessPackageArrayOutput() AccessPackageArrayOutput
	ToAccessPackageArrayOutputWithContext(context.Context) AccessPackageArrayOutput
}

AccessPackageArrayInput is an input type that accepts AccessPackageArray and AccessPackageArrayOutput values. You can construct a concrete instance of `AccessPackageArrayInput` via:

AccessPackageArray{ AccessPackageArgs{...} }

type AccessPackageArrayOutput added in v5.37.0

type AccessPackageArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageArrayOutput) ElementType added in v5.37.0

func (AccessPackageArrayOutput) ElementType() reflect.Type

func (AccessPackageArrayOutput) Index added in v5.37.0

func (AccessPackageArrayOutput) ToAccessPackageArrayOutput added in v5.37.0

func (o AccessPackageArrayOutput) ToAccessPackageArrayOutput() AccessPackageArrayOutput

func (AccessPackageArrayOutput) ToAccessPackageArrayOutputWithContext added in v5.37.0

func (o AccessPackageArrayOutput) ToAccessPackageArrayOutputWithContext(ctx context.Context) AccessPackageArrayOutput

type AccessPackageAssignmentPolicy added in v5.37.0

type AccessPackageAssignmentPolicy struct {
	pulumi.CustomResourceState

	// The ID of the access package that will contain the policy.
	AccessPackageId pulumi.StringOutput `pulumi:"accessPackageId"`
	// An `approvalSettings` block to specify whether approvals are required and how they are obtained, as documented below.
	ApprovalSettings AccessPackageAssignmentPolicyApprovalSettingsPtrOutput `pulumi:"approvalSettings"`
	// An `assignmentReviewSettings` block, to specify whether assignment review is needed and how it is conducted, as documented below.
	AssignmentReviewSettings AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput `pulumi:"assignmentReviewSettings"`
	// The description of the policy.
	Description pulumi.StringOutput `pulumi:"description"`
	// The display name of the policy.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// How many days this assignment is valid for.
	DurationInDays pulumi.IntPtrOutput `pulumi:"durationInDays"`
	// The date that this assignment expires, formatted as an RFC3339 date string in UTC(e.g. 2018-01-01T01:02:03Z).
	ExpirationDate pulumi.StringPtrOutput `pulumi:"expirationDate"`
	// Whether users will be able to request extension of their access to this package before their access expires.
	ExtensionEnabled pulumi.BoolPtrOutput `pulumi:"extensionEnabled"`
	// One or more `question` blocks for the requestor, as documented below.
	Questions AccessPackageAssignmentPolicyQuestionArrayOutput `pulumi:"questions"`
	// A `requestorSettings` block to configure the users who can request access, as documented below.
	RequestorSettings AccessPackageAssignmentPolicyRequestorSettingsPtrOutput `pulumi:"requestorSettings"`
}

Manages an assignment policy for 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 `Global Administrator` directory role, or one of the `Catalog Owner` and `Access Package Manager` role in Identity Governance.

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewGroup(ctx, "example", &azuread.GroupArgs{
			DisplayName:     pulumi.String("group-name"),
			SecurityEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleAccessPackageCatalog, err := azuread.NewAccessPackageCatalog(ctx, "example", &azuread.AccessPackageCatalogArgs{
			DisplayName: pulumi.String("example-catalog"),
			Description: pulumi.String("Example catalog"),
		})
		if err != nil {
			return err
		}
		exampleAccessPackage, err := azuread.NewAccessPackage(ctx, "example", &azuread.AccessPackageArgs{
			CatalogId:   exampleAccessPackageCatalog.ID(),
			DisplayName: pulumi.String("access-package"),
			Description: pulumi.String("Access Package"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAccessPackageAssignmentPolicy(ctx, "example", &azuread.AccessPackageAssignmentPolicyArgs{
			AccessPackageId: exampleAccessPackage.ID(),
			DisplayName:     pulumi.String("assignment-policy"),
			Description:     pulumi.String("My assignment policy"),
			DurationInDays:  pulumi.Int(90),
			RequestorSettings: &azuread.AccessPackageAssignmentPolicyRequestorSettingsArgs{
				ScopeType: pulumi.String("AllExistingDirectoryMemberUsers"),
			},
			ApprovalSettings: &azuread.AccessPackageAssignmentPolicyApprovalSettingsArgs{
				ApprovalRequired: pulumi.Bool(true),
				ApprovalStages: azuread.AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArray{
					&azuread.AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArgs{
						ApprovalTimeoutInDays: pulumi.Int(14),
						PrimaryApprovers: azuread.AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArray{
							&azuread.AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArgs{
								ObjectId:    example.ObjectId,
								SubjectType: pulumi.String("groupMembers"),
							},
						},
					},
				},
			},
			AssignmentReviewSettings: &azuread.AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs{
				Enabled:                     pulumi.Bool(true),
				ReviewFrequency:             pulumi.String("weekly"),
				DurationInDays:              pulumi.Int(3),
				ReviewType:                  pulumi.String("Self"),
				AccessReviewTimeoutBehavior: pulumi.String("keepAccess"),
			},
			Questions: azuread.AccessPackageAssignmentPolicyQuestionArray{
				&azuread.AccessPackageAssignmentPolicyQuestionArgs{
					Text: &azuread.AccessPackageAssignmentPolicyQuestionTextArgs{
						DefaultText: pulumi.String("hello, how are you?"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

An access package assignment policy can be imported using the ID, e.g.

```sh $ pulumi import azuread:index/accessPackageAssignmentPolicy:AccessPackageAssignmentPolicy example 00000000-0000-0000-0000-000000000000 ```

func GetAccessPackageAssignmentPolicy added in v5.37.0

func GetAccessPackageAssignmentPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccessPackageAssignmentPolicyState, opts ...pulumi.ResourceOption) (*AccessPackageAssignmentPolicy, error)

GetAccessPackageAssignmentPolicy gets an existing AccessPackageAssignmentPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccessPackageAssignmentPolicy added in v5.37.0

func NewAccessPackageAssignmentPolicy(ctx *pulumi.Context,
	name string, args *AccessPackageAssignmentPolicyArgs, opts ...pulumi.ResourceOption) (*AccessPackageAssignmentPolicy, error)

NewAccessPackageAssignmentPolicy registers a new resource with the given unique name, arguments, and options.

func (*AccessPackageAssignmentPolicy) ElementType added in v5.37.0

func (*AccessPackageAssignmentPolicy) ToAccessPackageAssignmentPolicyOutput added in v5.37.0

func (i *AccessPackageAssignmentPolicy) ToAccessPackageAssignmentPolicyOutput() AccessPackageAssignmentPolicyOutput

func (*AccessPackageAssignmentPolicy) ToAccessPackageAssignmentPolicyOutputWithContext added in v5.37.0

func (i *AccessPackageAssignmentPolicy) ToAccessPackageAssignmentPolicyOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyOutput

type AccessPackageAssignmentPolicyApprovalSettings added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettings struct {
	// Whether an approval is required.
	ApprovalRequired *bool `pulumi:"approvalRequired"`
	// Whether an approval is required to grant extension. Same approval settings used to approve initial access will apply.
	ApprovalRequiredForExtension *bool `pulumi:"approvalRequiredForExtension"`
	// An `approvalStage` block specifying the process to obtain an approval, as documented below.
	ApprovalStages []AccessPackageAssignmentPolicyApprovalSettingsApprovalStage `pulumi:"approvalStages"`
	// Whether a requestor is required to provide a justification to request an access package. Justification is visible to approvers and the requestor.
	RequestorJustificationRequired *bool `pulumi:"requestorJustificationRequired"`
}

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStage added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStage struct {
	// Whether alternative approvers are enabled.
	AlternativeApprovalEnabled *bool `pulumi:"alternativeApprovalEnabled"`
	// A block specifying alternative approvers when escalation is enabled and the primary approvers do not respond before the escalation time, as documented below.
	AlternativeApprovers []AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApprover `pulumi:"alternativeApprovers"`
	// Maximum number of days within which a request must be approved. If a request is not approved within this time period after it is made, it will be automatically rejected.
	ApprovalTimeoutInDays int `pulumi:"approvalTimeoutInDays"`
	// Whether an approver must provide a justification for their decision. Justification is visible to other approvers and the requestor.
	ApproverJustificationRequired *bool `pulumi:"approverJustificationRequired"`
	// Number of days before the request is forwarded to alternative approvers.
	EnableAlternativeApprovalInDays *int `pulumi:"enableAlternativeApprovalInDays"`
	// A block specifying the users who will be asked to approve requests, as documented below.
	PrimaryApprovers []AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApprover `pulumi:"primaryApprovers"`
}

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApprover added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApprover struct {
	// For a user in an approval stage, this property indicates whether the user is a backup fallback approver.
	Backup *bool `pulumi:"backup"`
	// The ID of the subject.
	ObjectId *string `pulumi:"objectId"`
	// Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.
	SubjectType string `pulumi:"subjectType"`
}

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArgs added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArgs struct {
	// For a user in an approval stage, this property indicates whether the user is a backup fallback approver.
	Backup pulumi.BoolPtrInput `pulumi:"backup"`
	// The ID of the subject.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
	// Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.
	SubjectType pulumi.StringInput `pulumi:"subjectType"`
}

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArgs) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArgs) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArray added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArray []AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverInput

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArray) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArray) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArray) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayInput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput() AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput
	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutputWithContext(context.Context) AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput
}

AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayInput is an input type that accepts AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArray and AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayInput` via:

AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArray{ AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArgs{...} }

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput) Index added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverInput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput() AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput
	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutputWithContext(context.Context) AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput
}

AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverInput is an input type that accepts AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArgs and AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverInput` via:

AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArgs{...}

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput) Backup added in v5.37.0

For a user in an approval stage, this property indicates whether the user is a backup fallback approver.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput) ObjectId added in v5.37.0

The ID of the subject.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput) SubjectType added in v5.37.0

Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArgs added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArgs struct {
	// Whether alternative approvers are enabled.
	AlternativeApprovalEnabled pulumi.BoolPtrInput `pulumi:"alternativeApprovalEnabled"`
	// A block specifying alternative approvers when escalation is enabled and the primary approvers do not respond before the escalation time, as documented below.
	AlternativeApprovers AccessPackageAssignmentPolicyApprovalSettingsApprovalStageAlternativeApproverArrayInput `pulumi:"alternativeApprovers"`
	// Maximum number of days within which a request must be approved. If a request is not approved within this time period after it is made, it will be automatically rejected.
	ApprovalTimeoutInDays pulumi.IntInput `pulumi:"approvalTimeoutInDays"`
	// Whether an approver must provide a justification for their decision. Justification is visible to other approvers and the requestor.
	ApproverJustificationRequired pulumi.BoolPtrInput `pulumi:"approverJustificationRequired"`
	// Number of days before the request is forwarded to alternative approvers.
	EnableAlternativeApprovalInDays pulumi.IntPtrInput `pulumi:"enableAlternativeApprovalInDays"`
	// A block specifying the users who will be asked to approve requests, as documented below.
	PrimaryApprovers AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayInput `pulumi:"primaryApprovers"`
}

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArgs) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArgs) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArgs) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArray added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArray []AccessPackageAssignmentPolicyApprovalSettingsApprovalStageInput

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArray) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArray) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArray) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArray) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayInput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput() AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput
	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutputWithContext(context.Context) AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput
}

AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayInput is an input type that accepts AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArray and AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayInput` via:

AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArray{ AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArgs{...} }

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput) Index added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayOutput

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageInput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput() AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput
	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutputWithContext(context.Context) AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput
}

AccessPackageAssignmentPolicyApprovalSettingsApprovalStageInput is an input type that accepts AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArgs and AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyApprovalSettingsApprovalStageInput` via:

AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArgs{...}

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput) AlternativeApprovalEnabled added in v5.37.0

Whether alternative approvers are enabled.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput) AlternativeApprovers added in v5.37.0

A block specifying alternative approvers when escalation is enabled and the primary approvers do not respond before the escalation time, as documented below.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput) ApprovalTimeoutInDays added in v5.37.0

Maximum number of days within which a request must be approved. If a request is not approved within this time period after it is made, it will be automatically rejected.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput) ApproverJustificationRequired added in v5.37.0

Whether an approver must provide a justification for their decision. Justification is visible to other approvers and the requestor.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput) EnableAlternativeApprovalInDays added in v5.37.0

Number of days before the request is forwarded to alternative approvers.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput) PrimaryApprovers added in v5.37.0

A block specifying the users who will be asked to approve requests, as documented below.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyApprovalSettingsApprovalStageOutput

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApprover added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApprover struct {
	// For a user in an approval stage, this property indicates whether the user is a backup fallback approver.
	Backup *bool `pulumi:"backup"`
	// The ID of the subject.
	ObjectId *string `pulumi:"objectId"`
	// Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.
	SubjectType string `pulumi:"subjectType"`
}

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArgs added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArgs struct {
	// For a user in an approval stage, this property indicates whether the user is a backup fallback approver.
	Backup pulumi.BoolPtrInput `pulumi:"backup"`
	// The ID of the subject.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
	// Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.
	SubjectType pulumi.StringInput `pulumi:"subjectType"`
}

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArgs) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArgs) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArray added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArray []AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverInput

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArray) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArray) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArray) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayInput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput() AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput
	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutputWithContext(context.Context) AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput
}

AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayInput is an input type that accepts AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArray and AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayInput` via:

AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArray{ AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArgs{...} }

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput) Index added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArrayOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverInput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput() AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput
	ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutputWithContext(context.Context) AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput
}

AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverInput is an input type that accepts AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArgs and AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverInput` via:

AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverArgs{...}

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput) Backup added in v5.37.0

For a user in an approval stage, this property indicates whether the user is a backup fallback approver.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput) ObjectId added in v5.37.0

The ID of the subject.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput) SubjectType added in v5.37.0

Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutput) ToAccessPackageAssignmentPolicyApprovalSettingsApprovalStagePrimaryApproverOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsArgs added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsArgs struct {
	// Whether an approval is required.
	ApprovalRequired pulumi.BoolPtrInput `pulumi:"approvalRequired"`
	// Whether an approval is required to grant extension. Same approval settings used to approve initial access will apply.
	ApprovalRequiredForExtension pulumi.BoolPtrInput `pulumi:"approvalRequiredForExtension"`
	// An `approvalStage` block specifying the process to obtain an approval, as documented below.
	ApprovalStages AccessPackageAssignmentPolicyApprovalSettingsApprovalStageArrayInput `pulumi:"approvalStages"`
	// Whether a requestor is required to provide a justification to request an access package. Justification is visible to approvers and the requestor.
	RequestorJustificationRequired pulumi.BoolPtrInput `pulumi:"requestorJustificationRequired"`
}

func (AccessPackageAssignmentPolicyApprovalSettingsArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsArgs) ToAccessPackageAssignmentPolicyApprovalSettingsOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyApprovalSettingsArgs) ToAccessPackageAssignmentPolicyApprovalSettingsOutput() AccessPackageAssignmentPolicyApprovalSettingsOutput

func (AccessPackageAssignmentPolicyApprovalSettingsArgs) ToAccessPackageAssignmentPolicyApprovalSettingsOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyApprovalSettingsArgs) ToAccessPackageAssignmentPolicyApprovalSettingsOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyApprovalSettingsOutput

func (AccessPackageAssignmentPolicyApprovalSettingsArgs) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyApprovalSettingsArgs) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutput() AccessPackageAssignmentPolicyApprovalSettingsPtrOutput

func (AccessPackageAssignmentPolicyApprovalSettingsArgs) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyApprovalSettingsArgs) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyApprovalSettingsPtrOutput

type AccessPackageAssignmentPolicyApprovalSettingsInput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyApprovalSettingsOutput() AccessPackageAssignmentPolicyApprovalSettingsOutput
	ToAccessPackageAssignmentPolicyApprovalSettingsOutputWithContext(context.Context) AccessPackageAssignmentPolicyApprovalSettingsOutput
}

AccessPackageAssignmentPolicyApprovalSettingsInput is an input type that accepts AccessPackageAssignmentPolicyApprovalSettingsArgs and AccessPackageAssignmentPolicyApprovalSettingsOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyApprovalSettingsInput` via:

AccessPackageAssignmentPolicyApprovalSettingsArgs{...}

type AccessPackageAssignmentPolicyApprovalSettingsOutput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyApprovalSettingsOutput) ApprovalRequired added in v5.37.0

Whether an approval is required.

func (AccessPackageAssignmentPolicyApprovalSettingsOutput) ApprovalRequiredForExtension added in v5.37.0

Whether an approval is required to grant extension. Same approval settings used to approve initial access will apply.

func (AccessPackageAssignmentPolicyApprovalSettingsOutput) ApprovalStages added in v5.37.0

An `approvalStage` block specifying the process to obtain an approval, as documented below.

func (AccessPackageAssignmentPolicyApprovalSettingsOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsOutput) RequestorJustificationRequired added in v5.37.0

Whether a requestor is required to provide a justification to request an access package. Justification is visible to approvers and the requestor.

func (AccessPackageAssignmentPolicyApprovalSettingsOutput) ToAccessPackageAssignmentPolicyApprovalSettingsOutput added in v5.37.0

func (o AccessPackageAssignmentPolicyApprovalSettingsOutput) ToAccessPackageAssignmentPolicyApprovalSettingsOutput() AccessPackageAssignmentPolicyApprovalSettingsOutput

func (AccessPackageAssignmentPolicyApprovalSettingsOutput) ToAccessPackageAssignmentPolicyApprovalSettingsOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyApprovalSettingsOutput) ToAccessPackageAssignmentPolicyApprovalSettingsOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyApprovalSettingsOutput

func (AccessPackageAssignmentPolicyApprovalSettingsOutput) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutput added in v5.37.0

func (o AccessPackageAssignmentPolicyApprovalSettingsOutput) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutput() AccessPackageAssignmentPolicyApprovalSettingsPtrOutput

func (AccessPackageAssignmentPolicyApprovalSettingsOutput) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyApprovalSettingsOutput) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyApprovalSettingsPtrOutput

type AccessPackageAssignmentPolicyApprovalSettingsPtrInput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsPtrInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutput() AccessPackageAssignmentPolicyApprovalSettingsPtrOutput
	ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutputWithContext(context.Context) AccessPackageAssignmentPolicyApprovalSettingsPtrOutput
}

AccessPackageAssignmentPolicyApprovalSettingsPtrInput is an input type that accepts AccessPackageAssignmentPolicyApprovalSettingsArgs, AccessPackageAssignmentPolicyApprovalSettingsPtr and AccessPackageAssignmentPolicyApprovalSettingsPtrOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyApprovalSettingsPtrInput` via:

        AccessPackageAssignmentPolicyApprovalSettingsArgs{...}

or:

        nil

type AccessPackageAssignmentPolicyApprovalSettingsPtrOutput added in v5.37.0

type AccessPackageAssignmentPolicyApprovalSettingsPtrOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyApprovalSettingsPtrOutput) ApprovalRequired added in v5.37.0

Whether an approval is required.

func (AccessPackageAssignmentPolicyApprovalSettingsPtrOutput) ApprovalRequiredForExtension added in v5.37.0

Whether an approval is required to grant extension. Same approval settings used to approve initial access will apply.

func (AccessPackageAssignmentPolicyApprovalSettingsPtrOutput) ApprovalStages added in v5.37.0

An `approvalStage` block specifying the process to obtain an approval, as documented below.

func (AccessPackageAssignmentPolicyApprovalSettingsPtrOutput) Elem added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsPtrOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsPtrOutput) RequestorJustificationRequired added in v5.37.0

Whether a requestor is required to provide a justification to request an access package. Justification is visible to approvers and the requestor.

func (AccessPackageAssignmentPolicyApprovalSettingsPtrOutput) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutput added in v5.37.0

func (AccessPackageAssignmentPolicyApprovalSettingsPtrOutput) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyApprovalSettingsPtrOutput) ToAccessPackageAssignmentPolicyApprovalSettingsPtrOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyApprovalSettingsPtrOutput

type AccessPackageAssignmentPolicyArgs added in v5.37.0

type AccessPackageAssignmentPolicyArgs struct {
	// The ID of the access package that will contain the policy.
	AccessPackageId pulumi.StringInput
	// An `approvalSettings` block to specify whether approvals are required and how they are obtained, as documented below.
	ApprovalSettings AccessPackageAssignmentPolicyApprovalSettingsPtrInput
	// An `assignmentReviewSettings` block, to specify whether assignment review is needed and how it is conducted, as documented below.
	AssignmentReviewSettings AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrInput
	// The description of the policy.
	Description pulumi.StringInput
	// The display name of the policy.
	DisplayName pulumi.StringInput
	// How many days this assignment is valid for.
	DurationInDays pulumi.IntPtrInput
	// The date that this assignment expires, formatted as an RFC3339 date string in UTC(e.g. 2018-01-01T01:02:03Z).
	ExpirationDate pulumi.StringPtrInput
	// Whether users will be able to request extension of their access to this package before their access expires.
	ExtensionEnabled pulumi.BoolPtrInput
	// One or more `question` blocks for the requestor, as documented below.
	Questions AccessPackageAssignmentPolicyQuestionArrayInput
	// A `requestorSettings` block to configure the users who can request access, as documented below.
	RequestorSettings AccessPackageAssignmentPolicyRequestorSettingsPtrInput
}

The set of arguments for constructing a AccessPackageAssignmentPolicy resource.

func (AccessPackageAssignmentPolicyArgs) ElementType added in v5.37.0

type AccessPackageAssignmentPolicyArray added in v5.37.0

type AccessPackageAssignmentPolicyArray []AccessPackageAssignmentPolicyInput

func (AccessPackageAssignmentPolicyArray) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyArray) ToAccessPackageAssignmentPolicyArrayOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyArray) ToAccessPackageAssignmentPolicyArrayOutput() AccessPackageAssignmentPolicyArrayOutput

func (AccessPackageAssignmentPolicyArray) ToAccessPackageAssignmentPolicyArrayOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyArray) ToAccessPackageAssignmentPolicyArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyArrayOutput

type AccessPackageAssignmentPolicyArrayInput added in v5.37.0

type AccessPackageAssignmentPolicyArrayInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyArrayOutput() AccessPackageAssignmentPolicyArrayOutput
	ToAccessPackageAssignmentPolicyArrayOutputWithContext(context.Context) AccessPackageAssignmentPolicyArrayOutput
}

AccessPackageAssignmentPolicyArrayInput is an input type that accepts AccessPackageAssignmentPolicyArray and AccessPackageAssignmentPolicyArrayOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyArrayInput` via:

AccessPackageAssignmentPolicyArray{ AccessPackageAssignmentPolicyArgs{...} }

type AccessPackageAssignmentPolicyArrayOutput added in v5.37.0

type AccessPackageAssignmentPolicyArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyArrayOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyArrayOutput) Index added in v5.37.0

func (AccessPackageAssignmentPolicyArrayOutput) ToAccessPackageAssignmentPolicyArrayOutput added in v5.37.0

func (o AccessPackageAssignmentPolicyArrayOutput) ToAccessPackageAssignmentPolicyArrayOutput() AccessPackageAssignmentPolicyArrayOutput

func (AccessPackageAssignmentPolicyArrayOutput) ToAccessPackageAssignmentPolicyArrayOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyArrayOutput) ToAccessPackageAssignmentPolicyArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyArrayOutput

type AccessPackageAssignmentPolicyAssignmentReviewSettings added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettings struct {
	// Whether to show the reviewer decision helpers. If enabled, system recommendations based on users' access information will be shown to the reviewers. The reviewer will be recommended to approve the review if the user has signed-in at least once during the last 30 days. The reviewer will be recommended to deny the review if the user has not signed-in during the last 30 days.
	AccessRecommendationEnabled *bool `pulumi:"accessRecommendationEnabled"`
	// Specifies the actions the system takes if reviewers don't respond in time. Valid values are `keepAccess`, `removeAccess`, or `acceptAccessRecommendation`.
	AccessReviewTimeoutBehavior *string `pulumi:"accessReviewTimeoutBehavior"`
	// Whether a reviewer needs to provide a justification for their decision. Justification is visible to other reviewers and the requestor.
	ApproverJustificationRequired *bool `pulumi:"approverJustificationRequired"`
	// How many days each occurrence of the access review series will run.
	DurationInDays *int `pulumi:"durationInDays"`
	// Whether to enable assignment review.
	Enabled *bool `pulumi:"enabled"`
	// This will determine how often the access review campaign runs, valid values are `weekly`, `monthly`, `quarterly`, `halfyearly`, or `annual`.
	ReviewFrequency *string `pulumi:"reviewFrequency"`
	// Self-review or specific reviewers. Valid values are `Manager`, `Reviewers`, or `Self`.
	ReviewType *string `pulumi:"reviewType"`
	// One or more `reviewer` blocks to specify the users who will be reviewers (when `reviewType` is `Reviewers`), as documented below.
	Reviewers []AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewer `pulumi:"reviewers"`
	// This is the date the access review campaign will start on, formatted as an RFC3339 date string in UTC(e.g. 2018-01-01T01:02:03Z), default is now. Once an access review has been created, you cannot update its start date
	StartingOn *string `pulumi:"startingOn"`
}

type AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs struct {
	// Whether to show the reviewer decision helpers. If enabled, system recommendations based on users' access information will be shown to the reviewers. The reviewer will be recommended to approve the review if the user has signed-in at least once during the last 30 days. The reviewer will be recommended to deny the review if the user has not signed-in during the last 30 days.
	AccessRecommendationEnabled pulumi.BoolPtrInput `pulumi:"accessRecommendationEnabled"`
	// Specifies the actions the system takes if reviewers don't respond in time. Valid values are `keepAccess`, `removeAccess`, or `acceptAccessRecommendation`.
	AccessReviewTimeoutBehavior pulumi.StringPtrInput `pulumi:"accessReviewTimeoutBehavior"`
	// Whether a reviewer needs to provide a justification for their decision. Justification is visible to other reviewers and the requestor.
	ApproverJustificationRequired pulumi.BoolPtrInput `pulumi:"approverJustificationRequired"`
	// How many days each occurrence of the access review series will run.
	DurationInDays pulumi.IntPtrInput `pulumi:"durationInDays"`
	// Whether to enable assignment review.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
	// This will determine how often the access review campaign runs, valid values are `weekly`, `monthly`, `quarterly`, `halfyearly`, or `annual`.
	ReviewFrequency pulumi.StringPtrInput `pulumi:"reviewFrequency"`
	// Self-review or specific reviewers. Valid values are `Manager`, `Reviewers`, or `Self`.
	ReviewType pulumi.StringPtrInput `pulumi:"reviewType"`
	// One or more `reviewer` blocks to specify the users who will be reviewers (when `reviewType` is `Reviewers`), as documented below.
	Reviewers AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayInput `pulumi:"reviewers"`
	// This is the date the access review campaign will start on, formatted as an RFC3339 date string in UTC(e.g. 2018-01-01T01:02:03Z), default is now. Once an access review has been created, you cannot update its start date
	StartingOn pulumi.StringPtrInput `pulumi:"startingOn"`
}

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsOutput added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput

type AccessPackageAssignmentPolicyAssignmentReviewSettingsInput added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyAssignmentReviewSettingsOutput() AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput
	ToAccessPackageAssignmentPolicyAssignmentReviewSettingsOutputWithContext(context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput
}

AccessPackageAssignmentPolicyAssignmentReviewSettingsInput is an input type that accepts AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs and AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyAssignmentReviewSettingsInput` via:

AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs{...}

type AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) AccessRecommendationEnabled added in v5.37.0

Whether to show the reviewer decision helpers. If enabled, system recommendations based on users' access information will be shown to the reviewers. The reviewer will be recommended to approve the review if the user has signed-in at least once during the last 30 days. The reviewer will be recommended to deny the review if the user has not signed-in during the last 30 days.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) AccessReviewTimeoutBehavior added in v5.37.0

Specifies the actions the system takes if reviewers don't respond in time. Valid values are `keepAccess`, `removeAccess`, or `acceptAccessRecommendation`.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) ApproverJustificationRequired added in v5.37.0

Whether a reviewer needs to provide a justification for their decision. Justification is visible to other reviewers and the requestor.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) DurationInDays added in v5.37.0

How many days each occurrence of the access review series will run.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) Enabled added in v5.37.0

Whether to enable assignment review.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) ReviewFrequency added in v5.37.0

This will determine how often the access review campaign runs, valid values are `weekly`, `monthly`, `quarterly`, `halfyearly`, or `annual`.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) ReviewType added in v5.37.0

Self-review or specific reviewers. Valid values are `Manager`, `Reviewers`, or `Self`.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) Reviewers added in v5.37.0

One or more `reviewer` blocks to specify the users who will be reviewers (when `reviewType` is `Reviewers`), as documented below.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) StartingOn added in v5.37.0

This is the date the access review campaign will start on, formatted as an RFC3339 date string in UTC(e.g. 2018-01-01T01:02:03Z), default is now. Once an access review has been created, you cannot update its start date

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsOutput added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyAssignmentReviewSettingsOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput

type AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrInput added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput() AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput
	ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutputWithContext(context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput
}

AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrInput is an input type that accepts AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs, AccessPackageAssignmentPolicyAssignmentReviewSettingsPtr and AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrInput` via:

        AccessPackageAssignmentPolicyAssignmentReviewSettingsArgs{...}

or:

        nil

type AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) AccessRecommendationEnabled added in v5.37.0

Whether to show the reviewer decision helpers. If enabled, system recommendations based on users' access information will be shown to the reviewers. The reviewer will be recommended to approve the review if the user has signed-in at least once during the last 30 days. The reviewer will be recommended to deny the review if the user has not signed-in during the last 30 days.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) AccessReviewTimeoutBehavior added in v5.37.0

Specifies the actions the system takes if reviewers don't respond in time. Valid values are `keepAccess`, `removeAccess`, or `acceptAccessRecommendation`.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) ApproverJustificationRequired added in v5.37.0

Whether a reviewer needs to provide a justification for their decision. Justification is visible to other reviewers and the requestor.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) DurationInDays added in v5.37.0

How many days each occurrence of the access review series will run.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) Elem added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) Enabled added in v5.37.0

Whether to enable assignment review.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) ReviewFrequency added in v5.37.0

This will determine how often the access review campaign runs, valid values are `weekly`, `monthly`, `quarterly`, `halfyearly`, or `annual`.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) ReviewType added in v5.37.0

Self-review or specific reviewers. Valid values are `Manager`, `Reviewers`, or `Self`.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) Reviewers added in v5.37.0

One or more `reviewer` blocks to specify the users who will be reviewers (when `reviewType` is `Reviewers`), as documented below.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) StartingOn added in v5.37.0

This is the date the access review campaign will start on, formatted as an RFC3339 date string in UTC(e.g. 2018-01-01T01:02:03Z), default is now. Once an access review has been created, you cannot update its start date

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrOutput

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewer added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewer struct {
	// For a user in an approval stage, this property indicates whether the user is a backup fallback approver.
	Backup *bool `pulumi:"backup"`
	// The ID of the subject.
	ObjectId *string `pulumi:"objectId"`
	// Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.
	SubjectType string `pulumi:"subjectType"`
}

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArgs added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArgs struct {
	// For a user in an approval stage, this property indicates whether the user is a backup fallback approver.
	Backup pulumi.BoolPtrInput `pulumi:"backup"`
	// The ID of the subject.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
	// Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.
	SubjectType pulumi.StringInput `pulumi:"subjectType"`
}

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArgs) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArgs) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArgs) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArray added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArray []AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerInput

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArray) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArray) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArray) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArray) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayInput added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput() AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput
	ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutputWithContext(context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput
}

AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayInput is an input type that accepts AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArray and AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayInput` via:

AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArray{ AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArgs{...} }

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput) Index added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArrayOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerInput added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput() AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput
	ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutputWithContext(context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput
}

AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerInput is an input type that accepts AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArgs and AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerInput` via:

AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerArgs{...}

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput added in v5.37.0

type AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput) Backup added in v5.37.0

For a user in an approval stage, this property indicates whether the user is a backup fallback approver.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput) ObjectId added in v5.37.0

The ID of the subject.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput) SubjectType added in v5.37.0

Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput added in v5.37.0

func (AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput) ToAccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyAssignmentReviewSettingsReviewerOutput

type AccessPackageAssignmentPolicyInput added in v5.37.0

type AccessPackageAssignmentPolicyInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyOutput() AccessPackageAssignmentPolicyOutput
	ToAccessPackageAssignmentPolicyOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyOutput
}

type AccessPackageAssignmentPolicyMap added in v5.37.0

type AccessPackageAssignmentPolicyMap map[string]AccessPackageAssignmentPolicyInput

func (AccessPackageAssignmentPolicyMap) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyMap) ToAccessPackageAssignmentPolicyMapOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyMap) ToAccessPackageAssignmentPolicyMapOutput() AccessPackageAssignmentPolicyMapOutput

func (AccessPackageAssignmentPolicyMap) ToAccessPackageAssignmentPolicyMapOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyMap) ToAccessPackageAssignmentPolicyMapOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyMapOutput

type AccessPackageAssignmentPolicyMapInput added in v5.37.0

type AccessPackageAssignmentPolicyMapInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyMapOutput() AccessPackageAssignmentPolicyMapOutput
	ToAccessPackageAssignmentPolicyMapOutputWithContext(context.Context) AccessPackageAssignmentPolicyMapOutput
}

AccessPackageAssignmentPolicyMapInput is an input type that accepts AccessPackageAssignmentPolicyMap and AccessPackageAssignmentPolicyMapOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyMapInput` via:

AccessPackageAssignmentPolicyMap{ "key": AccessPackageAssignmentPolicyArgs{...} }

type AccessPackageAssignmentPolicyMapOutput added in v5.37.0

type AccessPackageAssignmentPolicyMapOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyMapOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyMapOutput) MapIndex added in v5.37.0

func (AccessPackageAssignmentPolicyMapOutput) ToAccessPackageAssignmentPolicyMapOutput added in v5.37.0

func (o AccessPackageAssignmentPolicyMapOutput) ToAccessPackageAssignmentPolicyMapOutput() AccessPackageAssignmentPolicyMapOutput

func (AccessPackageAssignmentPolicyMapOutput) ToAccessPackageAssignmentPolicyMapOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyMapOutput) ToAccessPackageAssignmentPolicyMapOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyMapOutput

type AccessPackageAssignmentPolicyOutput added in v5.37.0

type AccessPackageAssignmentPolicyOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyOutput) AccessPackageId added in v5.37.0

The ID of the access package that will contain the policy.

func (AccessPackageAssignmentPolicyOutput) ApprovalSettings added in v5.37.0

An `approvalSettings` block to specify whether approvals are required and how they are obtained, as documented below.

func (AccessPackageAssignmentPolicyOutput) AssignmentReviewSettings added in v5.37.0

An `assignmentReviewSettings` block, to specify whether assignment review is needed and how it is conducted, as documented below.

func (AccessPackageAssignmentPolicyOutput) Description added in v5.37.0

The description of the policy.

func (AccessPackageAssignmentPolicyOutput) DisplayName added in v5.37.0

The display name of the policy.

func (AccessPackageAssignmentPolicyOutput) DurationInDays added in v5.37.0

How many days this assignment is valid for.

func (AccessPackageAssignmentPolicyOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyOutput) ExpirationDate added in v5.37.0

The date that this assignment expires, formatted as an RFC3339 date string in UTC(e.g. 2018-01-01T01:02:03Z).

func (AccessPackageAssignmentPolicyOutput) ExtensionEnabled added in v5.37.0

Whether users will be able to request extension of their access to this package before their access expires.

func (AccessPackageAssignmentPolicyOutput) Questions added in v5.37.0

One or more `question` blocks for the requestor, as documented below.

func (AccessPackageAssignmentPolicyOutput) RequestorSettings added in v5.37.0

A `requestorSettings` block to configure the users who can request access, as documented below.

func (AccessPackageAssignmentPolicyOutput) ToAccessPackageAssignmentPolicyOutput added in v5.37.0

func (o AccessPackageAssignmentPolicyOutput) ToAccessPackageAssignmentPolicyOutput() AccessPackageAssignmentPolicyOutput

func (AccessPackageAssignmentPolicyOutput) ToAccessPackageAssignmentPolicyOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyOutput) ToAccessPackageAssignmentPolicyOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyOutput

type AccessPackageAssignmentPolicyQuestion added in v5.37.0

type AccessPackageAssignmentPolicyQuestion struct {
	// One or more blocks configuring a choice to the question, as documented below.
	Choices []AccessPackageAssignmentPolicyQuestionChoice `pulumi:"choices"`
	// Whether this question is required.
	Required *bool `pulumi:"required"`
	// The sequence number of this question.
	Sequence *int `pulumi:"sequence"`
	// A block describing the content of this question, as documented below.
	Text AccessPackageAssignmentPolicyQuestionText `pulumi:"text"`
}

type AccessPackageAssignmentPolicyQuestionArgs added in v5.37.0

type AccessPackageAssignmentPolicyQuestionArgs struct {
	// One or more blocks configuring a choice to the question, as documented below.
	Choices AccessPackageAssignmentPolicyQuestionChoiceArrayInput `pulumi:"choices"`
	// Whether this question is required.
	Required pulumi.BoolPtrInput `pulumi:"required"`
	// The sequence number of this question.
	Sequence pulumi.IntPtrInput `pulumi:"sequence"`
	// A block describing the content of this question, as documented below.
	Text AccessPackageAssignmentPolicyQuestionTextInput `pulumi:"text"`
}

func (AccessPackageAssignmentPolicyQuestionArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionArgs) ToAccessPackageAssignmentPolicyQuestionOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionArgs) ToAccessPackageAssignmentPolicyQuestionOutput() AccessPackageAssignmentPolicyQuestionOutput

func (AccessPackageAssignmentPolicyQuestionArgs) ToAccessPackageAssignmentPolicyQuestionOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionArgs) ToAccessPackageAssignmentPolicyQuestionOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionOutput

type AccessPackageAssignmentPolicyQuestionArray added in v5.37.0

type AccessPackageAssignmentPolicyQuestionArray []AccessPackageAssignmentPolicyQuestionInput

func (AccessPackageAssignmentPolicyQuestionArray) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionArray) ToAccessPackageAssignmentPolicyQuestionArrayOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionArray) ToAccessPackageAssignmentPolicyQuestionArrayOutput() AccessPackageAssignmentPolicyQuestionArrayOutput

func (AccessPackageAssignmentPolicyQuestionArray) ToAccessPackageAssignmentPolicyQuestionArrayOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionArray) ToAccessPackageAssignmentPolicyQuestionArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionArrayOutput

type AccessPackageAssignmentPolicyQuestionArrayInput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionArrayInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyQuestionArrayOutput() AccessPackageAssignmentPolicyQuestionArrayOutput
	ToAccessPackageAssignmentPolicyQuestionArrayOutputWithContext(context.Context) AccessPackageAssignmentPolicyQuestionArrayOutput
}

AccessPackageAssignmentPolicyQuestionArrayInput is an input type that accepts AccessPackageAssignmentPolicyQuestionArray and AccessPackageAssignmentPolicyQuestionArrayOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyQuestionArrayInput` via:

AccessPackageAssignmentPolicyQuestionArray{ AccessPackageAssignmentPolicyQuestionArgs{...} }

type AccessPackageAssignmentPolicyQuestionArrayOutput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyQuestionArrayOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionArrayOutput) Index added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionArrayOutput) ToAccessPackageAssignmentPolicyQuestionArrayOutput added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionArrayOutput) ToAccessPackageAssignmentPolicyQuestionArrayOutput() AccessPackageAssignmentPolicyQuestionArrayOutput

func (AccessPackageAssignmentPolicyQuestionArrayOutput) ToAccessPackageAssignmentPolicyQuestionArrayOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionArrayOutput) ToAccessPackageAssignmentPolicyQuestionArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionArrayOutput

type AccessPackageAssignmentPolicyQuestionChoice added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoice struct {
	// The actual value of this choice.
	ActualValue string `pulumi:"actualValue"`
	// A block describing the display text of this choice, as documented below.
	DisplayValue AccessPackageAssignmentPolicyQuestionChoiceDisplayValue `pulumi:"displayValue"`
}

type AccessPackageAssignmentPolicyQuestionChoiceArgs added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceArgs struct {
	// The actual value of this choice.
	ActualValue pulumi.StringInput `pulumi:"actualValue"`
	// A block describing the display text of this choice, as documented below.
	DisplayValue AccessPackageAssignmentPolicyQuestionChoiceDisplayValueInput `pulumi:"displayValue"`
}

func (AccessPackageAssignmentPolicyQuestionChoiceArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceArgs) ToAccessPackageAssignmentPolicyQuestionChoiceOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionChoiceArgs) ToAccessPackageAssignmentPolicyQuestionChoiceOutput() AccessPackageAssignmentPolicyQuestionChoiceOutput

func (AccessPackageAssignmentPolicyQuestionChoiceArgs) ToAccessPackageAssignmentPolicyQuestionChoiceOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionChoiceArgs) ToAccessPackageAssignmentPolicyQuestionChoiceOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionChoiceOutput

type AccessPackageAssignmentPolicyQuestionChoiceArray added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceArray []AccessPackageAssignmentPolicyQuestionChoiceInput

func (AccessPackageAssignmentPolicyQuestionChoiceArray) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceArray) ToAccessPackageAssignmentPolicyQuestionChoiceArrayOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionChoiceArray) ToAccessPackageAssignmentPolicyQuestionChoiceArrayOutput() AccessPackageAssignmentPolicyQuestionChoiceArrayOutput

func (AccessPackageAssignmentPolicyQuestionChoiceArray) ToAccessPackageAssignmentPolicyQuestionChoiceArrayOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionChoiceArray) ToAccessPackageAssignmentPolicyQuestionChoiceArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionChoiceArrayOutput

type AccessPackageAssignmentPolicyQuestionChoiceArrayInput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceArrayInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyQuestionChoiceArrayOutput() AccessPackageAssignmentPolicyQuestionChoiceArrayOutput
	ToAccessPackageAssignmentPolicyQuestionChoiceArrayOutputWithContext(context.Context) AccessPackageAssignmentPolicyQuestionChoiceArrayOutput
}

AccessPackageAssignmentPolicyQuestionChoiceArrayInput is an input type that accepts AccessPackageAssignmentPolicyQuestionChoiceArray and AccessPackageAssignmentPolicyQuestionChoiceArrayOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyQuestionChoiceArrayInput` via:

AccessPackageAssignmentPolicyQuestionChoiceArray{ AccessPackageAssignmentPolicyQuestionChoiceArgs{...} }

type AccessPackageAssignmentPolicyQuestionChoiceArrayOutput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyQuestionChoiceArrayOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceArrayOutput) Index added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceArrayOutput) ToAccessPackageAssignmentPolicyQuestionChoiceArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceArrayOutput) ToAccessPackageAssignmentPolicyQuestionChoiceArrayOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionChoiceArrayOutput) ToAccessPackageAssignmentPolicyQuestionChoiceArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionChoiceArrayOutput

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValue added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValue struct {
	// The default text of this question choice.
	DefaultText string `pulumi:"defaultText"`
	// One or more blocks describing localized text of this question choice, as documented below.
	LocalizedTexts []AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedText `pulumi:"localizedTexts"`
}

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueArgs added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueArgs struct {
	// The default text of this question choice.
	DefaultText pulumi.StringInput `pulumi:"defaultText"`
	// One or more blocks describing localized text of this question choice, as documented below.
	LocalizedTexts AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayInput `pulumi:"localizedTexts"`
}

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueArgs) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueArgs) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionChoiceDisplayValueArgs) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueInput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput() AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput
	ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutputWithContext(context.Context) AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput
}

AccessPackageAssignmentPolicyQuestionChoiceDisplayValueInput is an input type that accepts AccessPackageAssignmentPolicyQuestionChoiceDisplayValueArgs and AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyQuestionChoiceDisplayValueInput` via:

AccessPackageAssignmentPolicyQuestionChoiceDisplayValueArgs{...}

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedText added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedText struct {
	// The localized content of this question choice.
	Content string `pulumi:"content"`
	// The ISO 639 language code for this question choice content.
	LanguageCode string `pulumi:"languageCode"`
}

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArgs added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArgs struct {
	// The localized content of this question choice.
	Content pulumi.StringInput `pulumi:"content"`
	// The ISO 639 language code for this question choice content.
	LanguageCode pulumi.StringInput `pulumi:"languageCode"`
}

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArgs) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArgs) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArgs) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArray added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArray []AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextInput

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArray) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArray) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArray) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArray) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayInput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput() AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput
	ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutputWithContext(context.Context) AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput
}

AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayInput is an input type that accepts AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArray and AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayInput` via:

AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArray{ AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArgs{...} }

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput) Index added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutput) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArrayOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextInput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput() AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput
	ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutputWithContext(context.Context) AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput
}

AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextInput is an input type that accepts AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArgs and AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextInput` via:

AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextArgs{...}

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput) Content added in v5.37.0

The localized content of this question choice.

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput) LanguageCode added in v5.37.0

The ISO 639 language code for this question choice content.

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutput) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueLocalizedTextOutputWithContext added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput) DefaultText added in v5.37.0

The default text of this question choice.

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput) LocalizedTexts added in v5.37.0

One or more blocks describing localized text of this question choice, as documented below.

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput) ToAccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionChoiceDisplayValueOutput

type AccessPackageAssignmentPolicyQuestionChoiceInput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyQuestionChoiceOutput() AccessPackageAssignmentPolicyQuestionChoiceOutput
	ToAccessPackageAssignmentPolicyQuestionChoiceOutputWithContext(context.Context) AccessPackageAssignmentPolicyQuestionChoiceOutput
}

AccessPackageAssignmentPolicyQuestionChoiceInput is an input type that accepts AccessPackageAssignmentPolicyQuestionChoiceArgs and AccessPackageAssignmentPolicyQuestionChoiceOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyQuestionChoiceInput` via:

AccessPackageAssignmentPolicyQuestionChoiceArgs{...}

type AccessPackageAssignmentPolicyQuestionChoiceOutput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionChoiceOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyQuestionChoiceOutput) ActualValue added in v5.37.0

The actual value of this choice.

func (AccessPackageAssignmentPolicyQuestionChoiceOutput) DisplayValue added in v5.37.0

A block describing the display text of this choice, as documented below.

func (AccessPackageAssignmentPolicyQuestionChoiceOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionChoiceOutput) ToAccessPackageAssignmentPolicyQuestionChoiceOutput added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionChoiceOutput) ToAccessPackageAssignmentPolicyQuestionChoiceOutput() AccessPackageAssignmentPolicyQuestionChoiceOutput

func (AccessPackageAssignmentPolicyQuestionChoiceOutput) ToAccessPackageAssignmentPolicyQuestionChoiceOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionChoiceOutput) ToAccessPackageAssignmentPolicyQuestionChoiceOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionChoiceOutput

type AccessPackageAssignmentPolicyQuestionInput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyQuestionOutput() AccessPackageAssignmentPolicyQuestionOutput
	ToAccessPackageAssignmentPolicyQuestionOutputWithContext(context.Context) AccessPackageAssignmentPolicyQuestionOutput
}

AccessPackageAssignmentPolicyQuestionInput is an input type that accepts AccessPackageAssignmentPolicyQuestionArgs and AccessPackageAssignmentPolicyQuestionOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyQuestionInput` via:

AccessPackageAssignmentPolicyQuestionArgs{...}

type AccessPackageAssignmentPolicyQuestionOutput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyQuestionOutput) Choices added in v5.37.0

One or more blocks configuring a choice to the question, as documented below.

func (AccessPackageAssignmentPolicyQuestionOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionOutput) Required added in v5.37.0

Whether this question is required.

func (AccessPackageAssignmentPolicyQuestionOutput) Sequence added in v5.37.0

The sequence number of this question.

func (AccessPackageAssignmentPolicyQuestionOutput) Text added in v5.37.0

A block describing the content of this question, as documented below.

func (AccessPackageAssignmentPolicyQuestionOutput) ToAccessPackageAssignmentPolicyQuestionOutput added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionOutput) ToAccessPackageAssignmentPolicyQuestionOutput() AccessPackageAssignmentPolicyQuestionOutput

func (AccessPackageAssignmentPolicyQuestionOutput) ToAccessPackageAssignmentPolicyQuestionOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionOutput) ToAccessPackageAssignmentPolicyQuestionOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionOutput

type AccessPackageAssignmentPolicyQuestionText added in v5.37.0

type AccessPackageAssignmentPolicyQuestionText struct {
	// The default text of this question choice.
	DefaultText string `pulumi:"defaultText"`
	// One or more blocks describing localized text of this question choice, as documented below.
	LocalizedTexts []AccessPackageAssignmentPolicyQuestionTextLocalizedText `pulumi:"localizedTexts"`
}

type AccessPackageAssignmentPolicyQuestionTextArgs added in v5.37.0

type AccessPackageAssignmentPolicyQuestionTextArgs struct {
	// The default text of this question choice.
	DefaultText pulumi.StringInput `pulumi:"defaultText"`
	// One or more blocks describing localized text of this question choice, as documented below.
	LocalizedTexts AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayInput `pulumi:"localizedTexts"`
}

func (AccessPackageAssignmentPolicyQuestionTextArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextArgs) ToAccessPackageAssignmentPolicyQuestionTextOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionTextArgs) ToAccessPackageAssignmentPolicyQuestionTextOutput() AccessPackageAssignmentPolicyQuestionTextOutput

func (AccessPackageAssignmentPolicyQuestionTextArgs) ToAccessPackageAssignmentPolicyQuestionTextOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionTextArgs) ToAccessPackageAssignmentPolicyQuestionTextOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionTextOutput

type AccessPackageAssignmentPolicyQuestionTextInput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionTextInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyQuestionTextOutput() AccessPackageAssignmentPolicyQuestionTextOutput
	ToAccessPackageAssignmentPolicyQuestionTextOutputWithContext(context.Context) AccessPackageAssignmentPolicyQuestionTextOutput
}

AccessPackageAssignmentPolicyQuestionTextInput is an input type that accepts AccessPackageAssignmentPolicyQuestionTextArgs and AccessPackageAssignmentPolicyQuestionTextOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyQuestionTextInput` via:

AccessPackageAssignmentPolicyQuestionTextArgs{...}

type AccessPackageAssignmentPolicyQuestionTextLocalizedText added in v5.37.0

type AccessPackageAssignmentPolicyQuestionTextLocalizedText struct {
	// The localized content of this question choice.
	Content string `pulumi:"content"`
	// The ISO 639 language code for this question choice content.
	LanguageCode string `pulumi:"languageCode"`
}

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextArgs added in v5.37.0

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextArgs struct {
	// The localized content of this question choice.
	Content pulumi.StringInput `pulumi:"content"`
	// The ISO 639 language code for this question choice content.
	LanguageCode pulumi.StringInput `pulumi:"languageCode"`
}

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextArgs) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextArgs) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionTextLocalizedTextArgs) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextArray added in v5.37.0

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextArray []AccessPackageAssignmentPolicyQuestionTextLocalizedTextInput

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextArray) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextArray) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextArray) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyQuestionTextLocalizedTextArray) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayInput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput() AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput
	ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutputWithContext(context.Context) AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput
}

AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayInput is an input type that accepts AccessPackageAssignmentPolicyQuestionTextLocalizedTextArray and AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayInput` via:

AccessPackageAssignmentPolicyQuestionTextLocalizedTextArray{ AccessPackageAssignmentPolicyQuestionTextLocalizedTextArgs{...} }

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput) Index added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionTextLocalizedTextArrayOutput

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextInput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput() AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput
	ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextOutputWithContext(context.Context) AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput
}

AccessPackageAssignmentPolicyQuestionTextLocalizedTextInput is an input type that accepts AccessPackageAssignmentPolicyQuestionTextLocalizedTextArgs and AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyQuestionTextLocalizedTextInput` via:

AccessPackageAssignmentPolicyQuestionTextLocalizedTextArgs{...}

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput) Content added in v5.37.0

The localized content of this question choice.

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput) LanguageCode added in v5.37.0

The ISO 639 language code for this question choice content.

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput) ToAccessPackageAssignmentPolicyQuestionTextLocalizedTextOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionTextLocalizedTextOutput

type AccessPackageAssignmentPolicyQuestionTextOutput added in v5.37.0

type AccessPackageAssignmentPolicyQuestionTextOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyQuestionTextOutput) DefaultText added in v5.37.0

The default text of this question choice.

func (AccessPackageAssignmentPolicyQuestionTextOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyQuestionTextOutput) LocalizedTexts added in v5.37.0

One or more blocks describing localized text of this question choice, as documented below.

func (AccessPackageAssignmentPolicyQuestionTextOutput) ToAccessPackageAssignmentPolicyQuestionTextOutput added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionTextOutput) ToAccessPackageAssignmentPolicyQuestionTextOutput() AccessPackageAssignmentPolicyQuestionTextOutput

func (AccessPackageAssignmentPolicyQuestionTextOutput) ToAccessPackageAssignmentPolicyQuestionTextOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyQuestionTextOutput) ToAccessPackageAssignmentPolicyQuestionTextOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyQuestionTextOutput

type AccessPackageAssignmentPolicyRequestorSettings added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettings struct {
	// A block specifying the users who are allowed to request on this policy, as documented below.
	Requestors []AccessPackageAssignmentPolicyRequestorSettingsRequestor `pulumi:"requestors"`
	// Whether to accept requests using this policy. When `false`, no new requests can be made using this policy.
	RequestsAccepted *bool `pulumi:"requestsAccepted"`
	// Specifies the scopes of the requestors. Valid values are `AllConfiguredConnectedOrganizationSubjects`, `AllExistingConnectedOrganizationSubjects`, `AllExistingDirectoryMemberUsers`, `AllExistingDirectorySubjects`, `AllExternalSubjects`, `NoSubjects`, `SpecificConnectedOrganizationSubjects`, or `SpecificDirectorySubjects`.
	ScopeType *string `pulumi:"scopeType"`
}

type AccessPackageAssignmentPolicyRequestorSettingsArgs added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsArgs struct {
	// A block specifying the users who are allowed to request on this policy, as documented below.
	Requestors AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayInput `pulumi:"requestors"`
	// Whether to accept requests using this policy. When `false`, no new requests can be made using this policy.
	RequestsAccepted pulumi.BoolPtrInput `pulumi:"requestsAccepted"`
	// Specifies the scopes of the requestors. Valid values are `AllConfiguredConnectedOrganizationSubjects`, `AllExistingConnectedOrganizationSubjects`, `AllExistingDirectoryMemberUsers`, `AllExistingDirectorySubjects`, `AllExternalSubjects`, `NoSubjects`, `SpecificConnectedOrganizationSubjects`, or `SpecificDirectorySubjects`.
	ScopeType pulumi.StringPtrInput `pulumi:"scopeType"`
}

func (AccessPackageAssignmentPolicyRequestorSettingsArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsArgs) ToAccessPackageAssignmentPolicyRequestorSettingsOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyRequestorSettingsArgs) ToAccessPackageAssignmentPolicyRequestorSettingsOutput() AccessPackageAssignmentPolicyRequestorSettingsOutput

func (AccessPackageAssignmentPolicyRequestorSettingsArgs) ToAccessPackageAssignmentPolicyRequestorSettingsOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyRequestorSettingsArgs) ToAccessPackageAssignmentPolicyRequestorSettingsOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyRequestorSettingsOutput

func (AccessPackageAssignmentPolicyRequestorSettingsArgs) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutput added in v5.37.0

func (i AccessPackageAssignmentPolicyRequestorSettingsArgs) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutput() AccessPackageAssignmentPolicyRequestorSettingsPtrOutput

func (AccessPackageAssignmentPolicyRequestorSettingsArgs) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyRequestorSettingsArgs) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyRequestorSettingsPtrOutput

type AccessPackageAssignmentPolicyRequestorSettingsInput added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyRequestorSettingsOutput() AccessPackageAssignmentPolicyRequestorSettingsOutput
	ToAccessPackageAssignmentPolicyRequestorSettingsOutputWithContext(context.Context) AccessPackageAssignmentPolicyRequestorSettingsOutput
}

AccessPackageAssignmentPolicyRequestorSettingsInput is an input type that accepts AccessPackageAssignmentPolicyRequestorSettingsArgs and AccessPackageAssignmentPolicyRequestorSettingsOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyRequestorSettingsInput` via:

AccessPackageAssignmentPolicyRequestorSettingsArgs{...}

type AccessPackageAssignmentPolicyRequestorSettingsOutput added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyRequestorSettingsOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsOutput) Requestors added in v5.37.0

A block specifying the users who are allowed to request on this policy, as documented below.

func (AccessPackageAssignmentPolicyRequestorSettingsOutput) RequestsAccepted added in v5.37.0

Whether to accept requests using this policy. When `false`, no new requests can be made using this policy.

func (AccessPackageAssignmentPolicyRequestorSettingsOutput) ScopeType added in v5.37.0

Specifies the scopes of the requestors. Valid values are `AllConfiguredConnectedOrganizationSubjects`, `AllExistingConnectedOrganizationSubjects`, `AllExistingDirectoryMemberUsers`, `AllExistingDirectorySubjects`, `AllExternalSubjects`, `NoSubjects`, `SpecificConnectedOrganizationSubjects`, or `SpecificDirectorySubjects`.

func (AccessPackageAssignmentPolicyRequestorSettingsOutput) ToAccessPackageAssignmentPolicyRequestorSettingsOutput added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsOutput) ToAccessPackageAssignmentPolicyRequestorSettingsOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyRequestorSettingsOutput) ToAccessPackageAssignmentPolicyRequestorSettingsOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyRequestorSettingsOutput

func (AccessPackageAssignmentPolicyRequestorSettingsOutput) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutput added in v5.37.0

func (o AccessPackageAssignmentPolicyRequestorSettingsOutput) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutput() AccessPackageAssignmentPolicyRequestorSettingsPtrOutput

func (AccessPackageAssignmentPolicyRequestorSettingsOutput) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyRequestorSettingsOutput) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyRequestorSettingsPtrOutput

type AccessPackageAssignmentPolicyRequestorSettingsPtrInput added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsPtrInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutput() AccessPackageAssignmentPolicyRequestorSettingsPtrOutput
	ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutputWithContext(context.Context) AccessPackageAssignmentPolicyRequestorSettingsPtrOutput
}

AccessPackageAssignmentPolicyRequestorSettingsPtrInput is an input type that accepts AccessPackageAssignmentPolicyRequestorSettingsArgs, AccessPackageAssignmentPolicyRequestorSettingsPtr and AccessPackageAssignmentPolicyRequestorSettingsPtrOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyRequestorSettingsPtrInput` via:

        AccessPackageAssignmentPolicyRequestorSettingsArgs{...}

or:

        nil

type AccessPackageAssignmentPolicyRequestorSettingsPtrOutput added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsPtrOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyRequestorSettingsPtrOutput) Elem added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsPtrOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsPtrOutput) Requestors added in v5.37.0

A block specifying the users who are allowed to request on this policy, as documented below.

func (AccessPackageAssignmentPolicyRequestorSettingsPtrOutput) RequestsAccepted added in v5.37.0

Whether to accept requests using this policy. When `false`, no new requests can be made using this policy.

func (AccessPackageAssignmentPolicyRequestorSettingsPtrOutput) ScopeType added in v5.37.0

Specifies the scopes of the requestors. Valid values are `AllConfiguredConnectedOrganizationSubjects`, `AllExistingConnectedOrganizationSubjects`, `AllExistingDirectoryMemberUsers`, `AllExistingDirectorySubjects`, `AllExternalSubjects`, `NoSubjects`, `SpecificConnectedOrganizationSubjects`, or `SpecificDirectorySubjects`.

func (AccessPackageAssignmentPolicyRequestorSettingsPtrOutput) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutput added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsPtrOutput) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyRequestorSettingsPtrOutput) ToAccessPackageAssignmentPolicyRequestorSettingsPtrOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyRequestorSettingsPtrOutput

type AccessPackageAssignmentPolicyRequestorSettingsRequestor added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsRequestor struct {
	// For a user in an approval stage, this property indicates whether the user is a backup fallback approver.
	Backup *bool `pulumi:"backup"`
	// The ID of the subject.
	ObjectId *string `pulumi:"objectId"`
	// Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.
	SubjectType string `pulumi:"subjectType"`
}

type AccessPackageAssignmentPolicyRequestorSettingsRequestorArgs added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsRequestorArgs struct {
	// For a user in an approval stage, this property indicates whether the user is a backup fallback approver.
	Backup pulumi.BoolPtrInput `pulumi:"backup"`
	// The ID of the subject.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
	// Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.
	SubjectType pulumi.StringInput `pulumi:"subjectType"`
}

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorArgs) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorArgs) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorOutput added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorArgs) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyRequestorSettingsRequestorArgs) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput

type AccessPackageAssignmentPolicyRequestorSettingsRequestorArray added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsRequestorArray []AccessPackageAssignmentPolicyRequestorSettingsRequestorInput

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorArray) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorArray) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorArray) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutputWithContext added in v5.37.0

func (i AccessPackageAssignmentPolicyRequestorSettingsRequestorArray) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput

type AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayInput added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput() AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput
	ToAccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutputWithContext(context.Context) AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput
}

AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayInput is an input type that accepts AccessPackageAssignmentPolicyRequestorSettingsRequestorArray and AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayInput` via:

AccessPackageAssignmentPolicyRequestorSettingsRequestorArray{ AccessPackageAssignmentPolicyRequestorSettingsRequestorArgs{...} }

type AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput) Index added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyRequestorSettingsRequestorArrayOutput

type AccessPackageAssignmentPolicyRequestorSettingsRequestorInput added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsRequestorInput interface {
	pulumi.Input

	ToAccessPackageAssignmentPolicyRequestorSettingsRequestorOutput() AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput
	ToAccessPackageAssignmentPolicyRequestorSettingsRequestorOutputWithContext(context.Context) AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput
}

AccessPackageAssignmentPolicyRequestorSettingsRequestorInput is an input type that accepts AccessPackageAssignmentPolicyRequestorSettingsRequestorArgs and AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput values. You can construct a concrete instance of `AccessPackageAssignmentPolicyRequestorSettingsRequestorInput` via:

AccessPackageAssignmentPolicyRequestorSettingsRequestorArgs{...}

type AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput added in v5.37.0

type AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput struct{ *pulumi.OutputState }

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput) Backup added in v5.37.0

For a user in an approval stage, this property indicates whether the user is a backup fallback approver.

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput) ElementType added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput) ObjectId added in v5.37.0

The ID of the subject.

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput) SubjectType added in v5.37.0

Specifies the type of users. Valid values are `singleUser`, `groupMembers`, `connectedOrganizationMembers`, `requestorManager`, `internalSponsors`, or `externalSponsors`.

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorOutput added in v5.37.0

func (AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorOutputWithContext added in v5.37.0

func (o AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput) ToAccessPackageAssignmentPolicyRequestorSettingsRequestorOutputWithContext(ctx context.Context) AccessPackageAssignmentPolicyRequestorSettingsRequestorOutput

type AccessPackageAssignmentPolicyState added in v5.37.0

type AccessPackageAssignmentPolicyState struct {
	// The ID of the access package that will contain the policy.
	AccessPackageId pulumi.StringPtrInput
	// An `approvalSettings` block to specify whether approvals are required and how they are obtained, as documented below.
	ApprovalSettings AccessPackageAssignmentPolicyApprovalSettingsPtrInput
	// An `assignmentReviewSettings` block, to specify whether assignment review is needed and how it is conducted, as documented below.
	AssignmentReviewSettings AccessPackageAssignmentPolicyAssignmentReviewSettingsPtrInput
	// The description of the policy.
	Description pulumi.StringPtrInput
	// The display name of the policy.
	DisplayName pulumi.StringPtrInput
	// How many days this assignment is valid for.
	DurationInDays pulumi.IntPtrInput
	// The date that this assignment expires, formatted as an RFC3339 date string in UTC(e.g. 2018-01-01T01:02:03Z).
	ExpirationDate pulumi.StringPtrInput
	// Whether users will be able to request extension of their access to this package before their access expires.
	ExtensionEnabled pulumi.BoolPtrInput
	// One or more `question` blocks for the requestor, as documented below.
	Questions AccessPackageAssignmentPolicyQuestionArrayInput
	// A `requestorSettings` block to configure the users who can request access, as documented below.
	RequestorSettings AccessPackageAssignmentPolicyRequestorSettingsPtrInput
}

func (AccessPackageAssignmentPolicyState) ElementType added in v5.37.0

type AccessPackageCatalog added in v5.37.0

type AccessPackageCatalog struct {
	pulumi.CustomResourceState

	// The description of the access package catalog.
	Description pulumi.StringOutput `pulumi:"description"`
	// The display name of the access package catalog.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Whether the access packages in this catalog can be requested by users outside the tenant.
	ExternallyVisible pulumi.BoolPtrOutput `pulumi:"externallyVisible"`
	// Whether the access packages in this catalog are available for management.
	Published pulumi.BoolPtrOutput `pulumi:"published"`
}

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

<!--Start PulumiCodeChooser --> ```go 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
	})
}

``` <!--End PulumiCodeChooser -->

## Import

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

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

func GetAccessPackageCatalog added in v5.37.0

func GetAccessPackageCatalog(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccessPackageCatalogState, opts ...pulumi.ResourceOption) (*AccessPackageCatalog, error)

GetAccessPackageCatalog gets an existing AccessPackageCatalog resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccessPackageCatalog added in v5.37.0

func NewAccessPackageCatalog(ctx *pulumi.Context,
	name string, args *AccessPackageCatalogArgs, opts ...pulumi.ResourceOption) (*AccessPackageCatalog, error)

NewAccessPackageCatalog registers a new resource with the given unique name, arguments, and options.

func (*AccessPackageCatalog) ElementType added in v5.37.0

func (*AccessPackageCatalog) ElementType() reflect.Type

func (*AccessPackageCatalog) ToAccessPackageCatalogOutput added in v5.37.0

func (i *AccessPackageCatalog) ToAccessPackageCatalogOutput() AccessPackageCatalogOutput

func (*AccessPackageCatalog) ToAccessPackageCatalogOutputWithContext added in v5.37.0

func (i *AccessPackageCatalog) ToAccessPackageCatalogOutputWithContext(ctx context.Context) AccessPackageCatalogOutput

type AccessPackageCatalogArgs added in v5.37.0

type AccessPackageCatalogArgs struct {
	// The description of the access package catalog.
	Description pulumi.StringInput
	// The display name of the access package catalog.
	DisplayName pulumi.StringInput
	// Whether the access packages in this catalog can be requested by users outside the tenant.
	ExternallyVisible pulumi.BoolPtrInput
	// Whether the access packages in this catalog are available for management.
	Published pulumi.BoolPtrInput
}

The set of arguments for constructing a AccessPackageCatalog resource.

func (AccessPackageCatalogArgs) ElementType added in v5.37.0

func (AccessPackageCatalogArgs) ElementType() reflect.Type

type AccessPackageCatalogArray added in v5.37.0

type AccessPackageCatalogArray []AccessPackageCatalogInput

func (AccessPackageCatalogArray) ElementType added in v5.37.0

func (AccessPackageCatalogArray) ElementType() reflect.Type

func (AccessPackageCatalogArray) ToAccessPackageCatalogArrayOutput added in v5.37.0

func (i AccessPackageCatalogArray) ToAccessPackageCatalogArrayOutput() AccessPackageCatalogArrayOutput

func (AccessPackageCatalogArray) ToAccessPackageCatalogArrayOutputWithContext added in v5.37.0

func (i AccessPackageCatalogArray) ToAccessPackageCatalogArrayOutputWithContext(ctx context.Context) AccessPackageCatalogArrayOutput

type AccessPackageCatalogArrayInput added in v5.37.0

type AccessPackageCatalogArrayInput interface {
	pulumi.Input

	ToAccessPackageCatalogArrayOutput() AccessPackageCatalogArrayOutput
	ToAccessPackageCatalogArrayOutputWithContext(context.Context) AccessPackageCatalogArrayOutput
}

AccessPackageCatalogArrayInput is an input type that accepts AccessPackageCatalogArray and AccessPackageCatalogArrayOutput values. You can construct a concrete instance of `AccessPackageCatalogArrayInput` via:

AccessPackageCatalogArray{ AccessPackageCatalogArgs{...} }

type AccessPackageCatalogArrayOutput added in v5.37.0

type AccessPackageCatalogArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageCatalogArrayOutput) ElementType added in v5.37.0

func (AccessPackageCatalogArrayOutput) Index added in v5.37.0

func (AccessPackageCatalogArrayOutput) ToAccessPackageCatalogArrayOutput added in v5.37.0

func (o AccessPackageCatalogArrayOutput) ToAccessPackageCatalogArrayOutput() AccessPackageCatalogArrayOutput

func (AccessPackageCatalogArrayOutput) ToAccessPackageCatalogArrayOutputWithContext added in v5.37.0

func (o AccessPackageCatalogArrayOutput) ToAccessPackageCatalogArrayOutputWithContext(ctx context.Context) AccessPackageCatalogArrayOutput

type AccessPackageCatalogInput added in v5.37.0

type AccessPackageCatalogInput interface {
	pulumi.Input

	ToAccessPackageCatalogOutput() AccessPackageCatalogOutput
	ToAccessPackageCatalogOutputWithContext(ctx context.Context) AccessPackageCatalogOutput
}

type AccessPackageCatalogMap added in v5.37.0

type AccessPackageCatalogMap map[string]AccessPackageCatalogInput

func (AccessPackageCatalogMap) ElementType added in v5.37.0

func (AccessPackageCatalogMap) ElementType() reflect.Type

func (AccessPackageCatalogMap) ToAccessPackageCatalogMapOutput added in v5.37.0

func (i AccessPackageCatalogMap) ToAccessPackageCatalogMapOutput() AccessPackageCatalogMapOutput

func (AccessPackageCatalogMap) ToAccessPackageCatalogMapOutputWithContext added in v5.37.0

func (i AccessPackageCatalogMap) ToAccessPackageCatalogMapOutputWithContext(ctx context.Context) AccessPackageCatalogMapOutput

type AccessPackageCatalogMapInput added in v5.37.0

type AccessPackageCatalogMapInput interface {
	pulumi.Input

	ToAccessPackageCatalogMapOutput() AccessPackageCatalogMapOutput
	ToAccessPackageCatalogMapOutputWithContext(context.Context) AccessPackageCatalogMapOutput
}

AccessPackageCatalogMapInput is an input type that accepts AccessPackageCatalogMap and AccessPackageCatalogMapOutput values. You can construct a concrete instance of `AccessPackageCatalogMapInput` via:

AccessPackageCatalogMap{ "key": AccessPackageCatalogArgs{...} }

type AccessPackageCatalogMapOutput added in v5.37.0

type AccessPackageCatalogMapOutput struct{ *pulumi.OutputState }

func (AccessPackageCatalogMapOutput) ElementType added in v5.37.0

func (AccessPackageCatalogMapOutput) MapIndex added in v5.37.0

func (AccessPackageCatalogMapOutput) ToAccessPackageCatalogMapOutput added in v5.37.0

func (o AccessPackageCatalogMapOutput) ToAccessPackageCatalogMapOutput() AccessPackageCatalogMapOutput

func (AccessPackageCatalogMapOutput) ToAccessPackageCatalogMapOutputWithContext added in v5.37.0

func (o AccessPackageCatalogMapOutput) ToAccessPackageCatalogMapOutputWithContext(ctx context.Context) AccessPackageCatalogMapOutput

type AccessPackageCatalogOutput added in v5.37.0

type AccessPackageCatalogOutput struct{ *pulumi.OutputState }

func (AccessPackageCatalogOutput) Description added in v5.37.0

The description of the access package catalog.

func (AccessPackageCatalogOutput) DisplayName added in v5.37.0

The display name of the access package catalog.

func (AccessPackageCatalogOutput) ElementType added in v5.37.0

func (AccessPackageCatalogOutput) ElementType() reflect.Type

func (AccessPackageCatalogOutput) ExternallyVisible added in v5.37.0

func (o AccessPackageCatalogOutput) ExternallyVisible() pulumi.BoolPtrOutput

Whether the access packages in this catalog can be requested by users outside the tenant.

func (AccessPackageCatalogOutput) Published added in v5.37.0

Whether the access packages in this catalog are available for management.

func (AccessPackageCatalogOutput) ToAccessPackageCatalogOutput added in v5.37.0

func (o AccessPackageCatalogOutput) ToAccessPackageCatalogOutput() AccessPackageCatalogOutput

func (AccessPackageCatalogOutput) ToAccessPackageCatalogOutputWithContext added in v5.37.0

func (o AccessPackageCatalogOutput) ToAccessPackageCatalogOutputWithContext(ctx context.Context) AccessPackageCatalogOutput

type AccessPackageCatalogRoleAssignment added in v5.38.0

type AccessPackageCatalogRoleAssignment struct {
	pulumi.CustomResourceState

	// The ID of the Catalog this role assignment will be scoped to. Changing this forces a new resource to be created.
	CatalogId pulumi.StringOutput `pulumi:"catalogId"`
	// The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	PrincipalObjectId pulumi.StringOutput `pulumi:"principalObjectId"`
	// The object ID of the catalog role you want to assign. Changing this forces a new resource to be created.
	RoleId pulumi.StringOutput `pulumi:"roleId"`
}

Manages a single catalog role assignment within 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 one of the following application roles: `EntitlementManagement.ReadWrite.All` or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Identity Governance administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.LookupUser(ctx, &azuread.LookupUserArgs{
			UserPrincipalName: pulumi.StringRef("jdoe@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetAccessPackageCatalogRole, err := azuread.GetAccessPackageCatalogRole(ctx, &azuread.GetAccessPackageCatalogRoleArgs{
			DisplayName: pulumi.StringRef("Catalog owner"),
		}, nil)
		if err != nil {
			return err
		}
		exampleAccessPackageCatalog, 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
		}
		_, err = azuread.NewAccessPackageCatalogRoleAssignment(ctx, "example", &azuread.AccessPackageCatalogRoleAssignmentArgs{
			RoleId:            pulumi.String(exampleGetAccessPackageCatalogRole.ObjectId),
			PrincipalObjectId: pulumi.String(example.ObjectId),
			CatalogId:         exampleAccessPackageCatalog.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Catalog role assignments can be imported using the ID of the assignment, e.g.

```sh $ pulumi import azuread:index/accessPackageCatalogRoleAssignment:AccessPackageCatalogRoleAssignment example 00000000-0000-0000-0000-000000000000 ```

func GetAccessPackageCatalogRoleAssignment added in v5.38.0

func GetAccessPackageCatalogRoleAssignment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccessPackageCatalogRoleAssignmentState, opts ...pulumi.ResourceOption) (*AccessPackageCatalogRoleAssignment, error)

GetAccessPackageCatalogRoleAssignment gets an existing AccessPackageCatalogRoleAssignment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccessPackageCatalogRoleAssignment added in v5.38.0

func NewAccessPackageCatalogRoleAssignment(ctx *pulumi.Context,
	name string, args *AccessPackageCatalogRoleAssignmentArgs, opts ...pulumi.ResourceOption) (*AccessPackageCatalogRoleAssignment, error)

NewAccessPackageCatalogRoleAssignment registers a new resource with the given unique name, arguments, and options.

func (*AccessPackageCatalogRoleAssignment) ElementType added in v5.38.0

func (*AccessPackageCatalogRoleAssignment) ToAccessPackageCatalogRoleAssignmentOutput added in v5.38.0

func (i *AccessPackageCatalogRoleAssignment) ToAccessPackageCatalogRoleAssignmentOutput() AccessPackageCatalogRoleAssignmentOutput

func (*AccessPackageCatalogRoleAssignment) ToAccessPackageCatalogRoleAssignmentOutputWithContext added in v5.38.0

func (i *AccessPackageCatalogRoleAssignment) ToAccessPackageCatalogRoleAssignmentOutputWithContext(ctx context.Context) AccessPackageCatalogRoleAssignmentOutput

type AccessPackageCatalogRoleAssignmentArgs added in v5.38.0

type AccessPackageCatalogRoleAssignmentArgs struct {
	// The ID of the Catalog this role assignment will be scoped to. Changing this forces a new resource to be created.
	CatalogId pulumi.StringInput
	// The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	PrincipalObjectId pulumi.StringInput
	// The object ID of the catalog role you want to assign. Changing this forces a new resource to be created.
	RoleId pulumi.StringInput
}

The set of arguments for constructing a AccessPackageCatalogRoleAssignment resource.

func (AccessPackageCatalogRoleAssignmentArgs) ElementType added in v5.38.0

type AccessPackageCatalogRoleAssignmentArray added in v5.38.0

type AccessPackageCatalogRoleAssignmentArray []AccessPackageCatalogRoleAssignmentInput

func (AccessPackageCatalogRoleAssignmentArray) ElementType added in v5.38.0

func (AccessPackageCatalogRoleAssignmentArray) ToAccessPackageCatalogRoleAssignmentArrayOutput added in v5.38.0

func (i AccessPackageCatalogRoleAssignmentArray) ToAccessPackageCatalogRoleAssignmentArrayOutput() AccessPackageCatalogRoleAssignmentArrayOutput

func (AccessPackageCatalogRoleAssignmentArray) ToAccessPackageCatalogRoleAssignmentArrayOutputWithContext added in v5.38.0

func (i AccessPackageCatalogRoleAssignmentArray) ToAccessPackageCatalogRoleAssignmentArrayOutputWithContext(ctx context.Context) AccessPackageCatalogRoleAssignmentArrayOutput

type AccessPackageCatalogRoleAssignmentArrayInput added in v5.38.0

type AccessPackageCatalogRoleAssignmentArrayInput interface {
	pulumi.Input

	ToAccessPackageCatalogRoleAssignmentArrayOutput() AccessPackageCatalogRoleAssignmentArrayOutput
	ToAccessPackageCatalogRoleAssignmentArrayOutputWithContext(context.Context) AccessPackageCatalogRoleAssignmentArrayOutput
}

AccessPackageCatalogRoleAssignmentArrayInput is an input type that accepts AccessPackageCatalogRoleAssignmentArray and AccessPackageCatalogRoleAssignmentArrayOutput values. You can construct a concrete instance of `AccessPackageCatalogRoleAssignmentArrayInput` via:

AccessPackageCatalogRoleAssignmentArray{ AccessPackageCatalogRoleAssignmentArgs{...} }

type AccessPackageCatalogRoleAssignmentArrayOutput added in v5.38.0

type AccessPackageCatalogRoleAssignmentArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageCatalogRoleAssignmentArrayOutput) ElementType added in v5.38.0

func (AccessPackageCatalogRoleAssignmentArrayOutput) Index added in v5.38.0

func (AccessPackageCatalogRoleAssignmentArrayOutput) ToAccessPackageCatalogRoleAssignmentArrayOutput added in v5.38.0

func (o AccessPackageCatalogRoleAssignmentArrayOutput) ToAccessPackageCatalogRoleAssignmentArrayOutput() AccessPackageCatalogRoleAssignmentArrayOutput

func (AccessPackageCatalogRoleAssignmentArrayOutput) ToAccessPackageCatalogRoleAssignmentArrayOutputWithContext added in v5.38.0

func (o AccessPackageCatalogRoleAssignmentArrayOutput) ToAccessPackageCatalogRoleAssignmentArrayOutputWithContext(ctx context.Context) AccessPackageCatalogRoleAssignmentArrayOutput

type AccessPackageCatalogRoleAssignmentInput added in v5.38.0

type AccessPackageCatalogRoleAssignmentInput interface {
	pulumi.Input

	ToAccessPackageCatalogRoleAssignmentOutput() AccessPackageCatalogRoleAssignmentOutput
	ToAccessPackageCatalogRoleAssignmentOutputWithContext(ctx context.Context) AccessPackageCatalogRoleAssignmentOutput
}

type AccessPackageCatalogRoleAssignmentMap added in v5.38.0

type AccessPackageCatalogRoleAssignmentMap map[string]AccessPackageCatalogRoleAssignmentInput

func (AccessPackageCatalogRoleAssignmentMap) ElementType added in v5.38.0

func (AccessPackageCatalogRoleAssignmentMap) ToAccessPackageCatalogRoleAssignmentMapOutput added in v5.38.0

func (i AccessPackageCatalogRoleAssignmentMap) ToAccessPackageCatalogRoleAssignmentMapOutput() AccessPackageCatalogRoleAssignmentMapOutput

func (AccessPackageCatalogRoleAssignmentMap) ToAccessPackageCatalogRoleAssignmentMapOutputWithContext added in v5.38.0

func (i AccessPackageCatalogRoleAssignmentMap) ToAccessPackageCatalogRoleAssignmentMapOutputWithContext(ctx context.Context) AccessPackageCatalogRoleAssignmentMapOutput

type AccessPackageCatalogRoleAssignmentMapInput added in v5.38.0

type AccessPackageCatalogRoleAssignmentMapInput interface {
	pulumi.Input

	ToAccessPackageCatalogRoleAssignmentMapOutput() AccessPackageCatalogRoleAssignmentMapOutput
	ToAccessPackageCatalogRoleAssignmentMapOutputWithContext(context.Context) AccessPackageCatalogRoleAssignmentMapOutput
}

AccessPackageCatalogRoleAssignmentMapInput is an input type that accepts AccessPackageCatalogRoleAssignmentMap and AccessPackageCatalogRoleAssignmentMapOutput values. You can construct a concrete instance of `AccessPackageCatalogRoleAssignmentMapInput` via:

AccessPackageCatalogRoleAssignmentMap{ "key": AccessPackageCatalogRoleAssignmentArgs{...} }

type AccessPackageCatalogRoleAssignmentMapOutput added in v5.38.0

type AccessPackageCatalogRoleAssignmentMapOutput struct{ *pulumi.OutputState }

func (AccessPackageCatalogRoleAssignmentMapOutput) ElementType added in v5.38.0

func (AccessPackageCatalogRoleAssignmentMapOutput) MapIndex added in v5.38.0

func (AccessPackageCatalogRoleAssignmentMapOutput) ToAccessPackageCatalogRoleAssignmentMapOutput added in v5.38.0

func (o AccessPackageCatalogRoleAssignmentMapOutput) ToAccessPackageCatalogRoleAssignmentMapOutput() AccessPackageCatalogRoleAssignmentMapOutput

func (AccessPackageCatalogRoleAssignmentMapOutput) ToAccessPackageCatalogRoleAssignmentMapOutputWithContext added in v5.38.0

func (o AccessPackageCatalogRoleAssignmentMapOutput) ToAccessPackageCatalogRoleAssignmentMapOutputWithContext(ctx context.Context) AccessPackageCatalogRoleAssignmentMapOutput

type AccessPackageCatalogRoleAssignmentOutput added in v5.38.0

type AccessPackageCatalogRoleAssignmentOutput struct{ *pulumi.OutputState }

func (AccessPackageCatalogRoleAssignmentOutput) CatalogId added in v5.38.0

The ID of the Catalog this role assignment will be scoped to. Changing this forces a new resource to be created.

func (AccessPackageCatalogRoleAssignmentOutput) ElementType added in v5.38.0

func (AccessPackageCatalogRoleAssignmentOutput) PrincipalObjectId added in v5.38.0

The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.

func (AccessPackageCatalogRoleAssignmentOutput) RoleId added in v5.38.0

The object ID of the catalog role you want to assign. Changing this forces a new resource to be created.

func (AccessPackageCatalogRoleAssignmentOutput) ToAccessPackageCatalogRoleAssignmentOutput added in v5.38.0

func (o AccessPackageCatalogRoleAssignmentOutput) ToAccessPackageCatalogRoleAssignmentOutput() AccessPackageCatalogRoleAssignmentOutput

func (AccessPackageCatalogRoleAssignmentOutput) ToAccessPackageCatalogRoleAssignmentOutputWithContext added in v5.38.0

func (o AccessPackageCatalogRoleAssignmentOutput) ToAccessPackageCatalogRoleAssignmentOutputWithContext(ctx context.Context) AccessPackageCatalogRoleAssignmentOutput

type AccessPackageCatalogRoleAssignmentState added in v5.38.0

type AccessPackageCatalogRoleAssignmentState struct {
	// The ID of the Catalog this role assignment will be scoped to. Changing this forces a new resource to be created.
	CatalogId pulumi.StringPtrInput
	// The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	PrincipalObjectId pulumi.StringPtrInput
	// The object ID of the catalog role you want to assign. Changing this forces a new resource to be created.
	RoleId pulumi.StringPtrInput
}

func (AccessPackageCatalogRoleAssignmentState) ElementType added in v5.38.0

type AccessPackageCatalogState added in v5.37.0

type AccessPackageCatalogState struct {
	// The description of the access package catalog.
	Description pulumi.StringPtrInput
	// The display name of the access package catalog.
	DisplayName pulumi.StringPtrInput
	// Whether the access packages in this catalog can be requested by users outside the tenant.
	ExternallyVisible pulumi.BoolPtrInput
	// Whether the access packages in this catalog are available for management.
	Published pulumi.BoolPtrInput
}

func (AccessPackageCatalogState) ElementType added in v5.37.0

func (AccessPackageCatalogState) ElementType() reflect.Type

type AccessPackageInput added in v5.37.0

type AccessPackageInput interface {
	pulumi.Input

	ToAccessPackageOutput() AccessPackageOutput
	ToAccessPackageOutputWithContext(ctx context.Context) AccessPackageOutput
}

type AccessPackageMap added in v5.37.0

type AccessPackageMap map[string]AccessPackageInput

func (AccessPackageMap) ElementType added in v5.37.0

func (AccessPackageMap) ElementType() reflect.Type

func (AccessPackageMap) ToAccessPackageMapOutput added in v5.37.0

func (i AccessPackageMap) ToAccessPackageMapOutput() AccessPackageMapOutput

func (AccessPackageMap) ToAccessPackageMapOutputWithContext added in v5.37.0

func (i AccessPackageMap) ToAccessPackageMapOutputWithContext(ctx context.Context) AccessPackageMapOutput

type AccessPackageMapInput added in v5.37.0

type AccessPackageMapInput interface {
	pulumi.Input

	ToAccessPackageMapOutput() AccessPackageMapOutput
	ToAccessPackageMapOutputWithContext(context.Context) AccessPackageMapOutput
}

AccessPackageMapInput is an input type that accepts AccessPackageMap and AccessPackageMapOutput values. You can construct a concrete instance of `AccessPackageMapInput` via:

AccessPackageMap{ "key": AccessPackageArgs{...} }

type AccessPackageMapOutput added in v5.37.0

type AccessPackageMapOutput struct{ *pulumi.OutputState }

func (AccessPackageMapOutput) ElementType added in v5.37.0

func (AccessPackageMapOutput) ElementType() reflect.Type

func (AccessPackageMapOutput) MapIndex added in v5.37.0

func (AccessPackageMapOutput) ToAccessPackageMapOutput added in v5.37.0

func (o AccessPackageMapOutput) ToAccessPackageMapOutput() AccessPackageMapOutput

func (AccessPackageMapOutput) ToAccessPackageMapOutputWithContext added in v5.37.0

func (o AccessPackageMapOutput) ToAccessPackageMapOutputWithContext(ctx context.Context) AccessPackageMapOutput

type AccessPackageOutput added in v5.37.0

type AccessPackageOutput struct{ *pulumi.OutputState }

func (AccessPackageOutput) CatalogId added in v5.37.0

func (o AccessPackageOutput) CatalogId() pulumi.StringOutput

The ID of the Catalog this access package will be created in.

func (AccessPackageOutput) Description added in v5.37.0

func (o AccessPackageOutput) Description() pulumi.StringOutput

The description of the access package.

func (AccessPackageOutput) DisplayName added in v5.37.0

func (o AccessPackageOutput) DisplayName() pulumi.StringOutput

The display name of the access package.

func (AccessPackageOutput) ElementType added in v5.37.0

func (AccessPackageOutput) ElementType() reflect.Type

func (AccessPackageOutput) Hidden added in v5.37.0

Whether the access package is hidden from the requestor.

func (AccessPackageOutput) ToAccessPackageOutput added in v5.37.0

func (o AccessPackageOutput) ToAccessPackageOutput() AccessPackageOutput

func (AccessPackageOutput) ToAccessPackageOutputWithContext added in v5.37.0

func (o AccessPackageOutput) ToAccessPackageOutputWithContext(ctx context.Context) AccessPackageOutput

type AccessPackageResourceCatalogAssociation added in v5.37.0

type AccessPackageResourceCatalogAssociation struct {
	pulumi.CustomResourceState

	// The unique ID of the access package catalog. Changing this forces a new resource to be created.
	CatalogId pulumi.StringOutput `pulumi:"catalogId"`
	// The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
	ResourceOriginId pulumi.StringOutput `pulumi:"resourceOriginId"`
	// The type of the resource in the origin system, such as `SharePointOnline`, `AadApplication` or `AadGroup`. Changing this forces a new resource to be created.
	ResourceOriginSystem pulumi.StringOutput `pulumi:"resourceOriginSystem"`
}

Manages the resources added to access package catalogs 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` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.NewGroup(ctx, "example", &azuread.GroupArgs{
			DisplayName:     pulumi.String("example-group"),
			SecurityEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAccessPackageCatalog(ctx, "example", &azuread.AccessPackageCatalogArgs{
			DisplayName: pulumi.String("example-catalog"),
			Description: pulumi.String("Example catalog"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAccessPackageResourceCatalogAssociation(ctx, "example", &azuread.AccessPackageResourceCatalogAssociationArgs{
			CatalogId:            pulumi.Any(exampleCatalog.Id),
			ResourceOriginId:     pulumi.Any(exampleGroup.ObjectId),
			ResourceOriginSystem: pulumi.String("AadGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

The resource and catalog association can be imported using the catalog ID and the resource origin ID, e.g.

```sh $ pulumi import azuread:index/accessPackageResourceCatalogAssociation:AccessPackageResourceCatalogAssociation example 00000000-0000-0000-0000-000000000000/11111111-1111-1111-1111-111111111111 ```

-> This ID format is unique to Terraform and is composed of the Catalog ID and the Resource Origin ID in the format `{CatalogID}/{ResourceOriginID}`.

func GetAccessPackageResourceCatalogAssociation added in v5.37.0

func GetAccessPackageResourceCatalogAssociation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccessPackageResourceCatalogAssociationState, opts ...pulumi.ResourceOption) (*AccessPackageResourceCatalogAssociation, error)

GetAccessPackageResourceCatalogAssociation gets an existing AccessPackageResourceCatalogAssociation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccessPackageResourceCatalogAssociation added in v5.37.0

func NewAccessPackageResourceCatalogAssociation(ctx *pulumi.Context,
	name string, args *AccessPackageResourceCatalogAssociationArgs, opts ...pulumi.ResourceOption) (*AccessPackageResourceCatalogAssociation, error)

NewAccessPackageResourceCatalogAssociation registers a new resource with the given unique name, arguments, and options.

func (*AccessPackageResourceCatalogAssociation) ElementType added in v5.37.0

func (*AccessPackageResourceCatalogAssociation) ToAccessPackageResourceCatalogAssociationOutput added in v5.37.0

func (i *AccessPackageResourceCatalogAssociation) ToAccessPackageResourceCatalogAssociationOutput() AccessPackageResourceCatalogAssociationOutput

func (*AccessPackageResourceCatalogAssociation) ToAccessPackageResourceCatalogAssociationOutputWithContext added in v5.37.0

func (i *AccessPackageResourceCatalogAssociation) ToAccessPackageResourceCatalogAssociationOutputWithContext(ctx context.Context) AccessPackageResourceCatalogAssociationOutput

type AccessPackageResourceCatalogAssociationArgs added in v5.37.0

type AccessPackageResourceCatalogAssociationArgs struct {
	// The unique ID of the access package catalog. Changing this forces a new resource to be created.
	CatalogId pulumi.StringInput
	// The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
	ResourceOriginId pulumi.StringInput
	// The type of the resource in the origin system, such as `SharePointOnline`, `AadApplication` or `AadGroup`. Changing this forces a new resource to be created.
	ResourceOriginSystem pulumi.StringInput
}

The set of arguments for constructing a AccessPackageResourceCatalogAssociation resource.

func (AccessPackageResourceCatalogAssociationArgs) ElementType added in v5.37.0

type AccessPackageResourceCatalogAssociationArray added in v5.37.0

type AccessPackageResourceCatalogAssociationArray []AccessPackageResourceCatalogAssociationInput

func (AccessPackageResourceCatalogAssociationArray) ElementType added in v5.37.0

func (AccessPackageResourceCatalogAssociationArray) ToAccessPackageResourceCatalogAssociationArrayOutput added in v5.37.0

func (i AccessPackageResourceCatalogAssociationArray) ToAccessPackageResourceCatalogAssociationArrayOutput() AccessPackageResourceCatalogAssociationArrayOutput

func (AccessPackageResourceCatalogAssociationArray) ToAccessPackageResourceCatalogAssociationArrayOutputWithContext added in v5.37.0

func (i AccessPackageResourceCatalogAssociationArray) ToAccessPackageResourceCatalogAssociationArrayOutputWithContext(ctx context.Context) AccessPackageResourceCatalogAssociationArrayOutput

type AccessPackageResourceCatalogAssociationArrayInput added in v5.37.0

type AccessPackageResourceCatalogAssociationArrayInput interface {
	pulumi.Input

	ToAccessPackageResourceCatalogAssociationArrayOutput() AccessPackageResourceCatalogAssociationArrayOutput
	ToAccessPackageResourceCatalogAssociationArrayOutputWithContext(context.Context) AccessPackageResourceCatalogAssociationArrayOutput
}

AccessPackageResourceCatalogAssociationArrayInput is an input type that accepts AccessPackageResourceCatalogAssociationArray and AccessPackageResourceCatalogAssociationArrayOutput values. You can construct a concrete instance of `AccessPackageResourceCatalogAssociationArrayInput` via:

AccessPackageResourceCatalogAssociationArray{ AccessPackageResourceCatalogAssociationArgs{...} }

type AccessPackageResourceCatalogAssociationArrayOutput added in v5.37.0

type AccessPackageResourceCatalogAssociationArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageResourceCatalogAssociationArrayOutput) ElementType added in v5.37.0

func (AccessPackageResourceCatalogAssociationArrayOutput) Index added in v5.37.0

func (AccessPackageResourceCatalogAssociationArrayOutput) ToAccessPackageResourceCatalogAssociationArrayOutput added in v5.37.0

func (o AccessPackageResourceCatalogAssociationArrayOutput) ToAccessPackageResourceCatalogAssociationArrayOutput() AccessPackageResourceCatalogAssociationArrayOutput

func (AccessPackageResourceCatalogAssociationArrayOutput) ToAccessPackageResourceCatalogAssociationArrayOutputWithContext added in v5.37.0

func (o AccessPackageResourceCatalogAssociationArrayOutput) ToAccessPackageResourceCatalogAssociationArrayOutputWithContext(ctx context.Context) AccessPackageResourceCatalogAssociationArrayOutput

type AccessPackageResourceCatalogAssociationInput added in v5.37.0

type AccessPackageResourceCatalogAssociationInput interface {
	pulumi.Input

	ToAccessPackageResourceCatalogAssociationOutput() AccessPackageResourceCatalogAssociationOutput
	ToAccessPackageResourceCatalogAssociationOutputWithContext(ctx context.Context) AccessPackageResourceCatalogAssociationOutput
}

type AccessPackageResourceCatalogAssociationMap added in v5.37.0

type AccessPackageResourceCatalogAssociationMap map[string]AccessPackageResourceCatalogAssociationInput

func (AccessPackageResourceCatalogAssociationMap) ElementType added in v5.37.0

func (AccessPackageResourceCatalogAssociationMap) ToAccessPackageResourceCatalogAssociationMapOutput added in v5.37.0

func (i AccessPackageResourceCatalogAssociationMap) ToAccessPackageResourceCatalogAssociationMapOutput() AccessPackageResourceCatalogAssociationMapOutput

func (AccessPackageResourceCatalogAssociationMap) ToAccessPackageResourceCatalogAssociationMapOutputWithContext added in v5.37.0

func (i AccessPackageResourceCatalogAssociationMap) ToAccessPackageResourceCatalogAssociationMapOutputWithContext(ctx context.Context) AccessPackageResourceCatalogAssociationMapOutput

type AccessPackageResourceCatalogAssociationMapInput added in v5.37.0

type AccessPackageResourceCatalogAssociationMapInput interface {
	pulumi.Input

	ToAccessPackageResourceCatalogAssociationMapOutput() AccessPackageResourceCatalogAssociationMapOutput
	ToAccessPackageResourceCatalogAssociationMapOutputWithContext(context.Context) AccessPackageResourceCatalogAssociationMapOutput
}

AccessPackageResourceCatalogAssociationMapInput is an input type that accepts AccessPackageResourceCatalogAssociationMap and AccessPackageResourceCatalogAssociationMapOutput values. You can construct a concrete instance of `AccessPackageResourceCatalogAssociationMapInput` via:

AccessPackageResourceCatalogAssociationMap{ "key": AccessPackageResourceCatalogAssociationArgs{...} }

type AccessPackageResourceCatalogAssociationMapOutput added in v5.37.0

type AccessPackageResourceCatalogAssociationMapOutput struct{ *pulumi.OutputState }

func (AccessPackageResourceCatalogAssociationMapOutput) ElementType added in v5.37.0

func (AccessPackageResourceCatalogAssociationMapOutput) MapIndex added in v5.37.0

func (AccessPackageResourceCatalogAssociationMapOutput) ToAccessPackageResourceCatalogAssociationMapOutput added in v5.37.0

func (o AccessPackageResourceCatalogAssociationMapOutput) ToAccessPackageResourceCatalogAssociationMapOutput() AccessPackageResourceCatalogAssociationMapOutput

func (AccessPackageResourceCatalogAssociationMapOutput) ToAccessPackageResourceCatalogAssociationMapOutputWithContext added in v5.37.0

func (o AccessPackageResourceCatalogAssociationMapOutput) ToAccessPackageResourceCatalogAssociationMapOutputWithContext(ctx context.Context) AccessPackageResourceCatalogAssociationMapOutput

type AccessPackageResourceCatalogAssociationOutput added in v5.37.0

type AccessPackageResourceCatalogAssociationOutput struct{ *pulumi.OutputState }

func (AccessPackageResourceCatalogAssociationOutput) CatalogId added in v5.37.0

The unique ID of the access package catalog. Changing this forces a new resource to be created.

func (AccessPackageResourceCatalogAssociationOutput) ElementType added in v5.37.0

func (AccessPackageResourceCatalogAssociationOutput) ResourceOriginId added in v5.37.0

The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.

func (AccessPackageResourceCatalogAssociationOutput) ResourceOriginSystem added in v5.37.0

The type of the resource in the origin system, such as `SharePointOnline`, `AadApplication` or `AadGroup`. Changing this forces a new resource to be created.

func (AccessPackageResourceCatalogAssociationOutput) ToAccessPackageResourceCatalogAssociationOutput added in v5.37.0

func (o AccessPackageResourceCatalogAssociationOutput) ToAccessPackageResourceCatalogAssociationOutput() AccessPackageResourceCatalogAssociationOutput

func (AccessPackageResourceCatalogAssociationOutput) ToAccessPackageResourceCatalogAssociationOutputWithContext added in v5.37.0

func (o AccessPackageResourceCatalogAssociationOutput) ToAccessPackageResourceCatalogAssociationOutputWithContext(ctx context.Context) AccessPackageResourceCatalogAssociationOutput

type AccessPackageResourceCatalogAssociationState added in v5.37.0

type AccessPackageResourceCatalogAssociationState struct {
	// The unique ID of the access package catalog. Changing this forces a new resource to be created.
	CatalogId pulumi.StringPtrInput
	// The unique identifier of the resource in the origin system. In the case of an Azure AD group, this is the identifier of the group. Changing this forces a new resource to be created.
	ResourceOriginId pulumi.StringPtrInput
	// The type of the resource in the origin system, such as `SharePointOnline`, `AadApplication` or `AadGroup`. Changing this forces a new resource to be created.
	ResourceOriginSystem pulumi.StringPtrInput
}

func (AccessPackageResourceCatalogAssociationState) ElementType added in v5.37.0

type AccessPackageResourcePackageAssociation added in v5.37.0

type AccessPackageResourcePackageAssociation struct {
	pulumi.CustomResourceState

	// The ID of access package this resource association is configured to. Changing this forces a new resource to be created.
	AccessPackageId pulumi.StringOutput `pulumi:"accessPackageId"`
	// The role of access type to the specified resource. Valid values are `Member`, or `Owner` The default is `Member`. Changing this forces a new resource to be created.
	AccessType pulumi.StringPtrOutput `pulumi:"accessType"`
	// The ID of the catalog association from the `AccessPackageResourceCatalogAssociation` resource. Changing this forces a new resource to be created.
	CatalogResourceAssociationId pulumi.StringOutput `pulumi:"catalogResourceAssociationId"`
}

Manages the resources added to access packages 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

<!--Start PulumiCodeChooser --> ```go 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.NewGroup(ctx, "example", &azuread.GroupArgs{
			DisplayName:     pulumi.String("example-group"),
			SecurityEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAccessPackageCatalog(ctx, "example", &azuread.AccessPackageCatalogArgs{
			DisplayName: pulumi.String("example-catalog"),
			Description: pulumi.String("Example catalog"),
		})
		if err != nil {
			return err
		}
		exampleAccessPackageResourceCatalogAssociation, err := azuread.NewAccessPackageResourceCatalogAssociation(ctx, "example", &azuread.AccessPackageResourceCatalogAssociationArgs{
			CatalogId:            pulumi.Any(exampleCatalog.Id),
			ResourceOriginId:     pulumi.Any(exampleGroup.ObjectId),
			ResourceOriginSystem: pulumi.String("AadGroup"),
		})
		if err != nil {
			return err
		}
		exampleAccessPackage, err := azuread.NewAccessPackage(ctx, "example", &azuread.AccessPackageArgs{
			DisplayName: pulumi.String("example-package"),
			Description: pulumi.String("Example Package"),
			CatalogId:   pulumi.Any(exampleCatalog.Id),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAccessPackageResourcePackageAssociation(ctx, "example", &azuread.AccessPackageResourcePackageAssociationArgs{
			AccessPackageId:              exampleAccessPackage.ID(),
			CatalogResourceAssociationId: exampleAccessPackageResourceCatalogAssociation.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

The resource and catalog association can be imported using the access package ID, the access package ResourceRoleScope, the resource origin ID, and the access type, e.g.

```sh $ pulumi import azuread:index/accessPackageResourcePackageAssociation:AccessPackageResourcePackageAssociation example 00000000-0000-0000-0000-000000000000/11111111-1111-1111-1111-111111111111_22222222-2222-2222-2222-22222222/33333333-3333-3333-3333-33333333/Member ```

-> This ID format is unique to Terraform and is composed of the Access Package ID, the access package ResourceRoleScope (in the format Role_Scope), the Resource Origin ID, and the Access Type, in the format `{AccessPackageID}/{ResourceRoleScope}/{ResourceOriginID}/{AccessType}`.

func GetAccessPackageResourcePackageAssociation added in v5.37.0

func GetAccessPackageResourcePackageAssociation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccessPackageResourcePackageAssociationState, opts ...pulumi.ResourceOption) (*AccessPackageResourcePackageAssociation, error)

GetAccessPackageResourcePackageAssociation gets an existing AccessPackageResourcePackageAssociation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccessPackageResourcePackageAssociation added in v5.37.0

func NewAccessPackageResourcePackageAssociation(ctx *pulumi.Context,
	name string, args *AccessPackageResourcePackageAssociationArgs, opts ...pulumi.ResourceOption) (*AccessPackageResourcePackageAssociation, error)

NewAccessPackageResourcePackageAssociation registers a new resource with the given unique name, arguments, and options.

func (*AccessPackageResourcePackageAssociation) ElementType added in v5.37.0

func (*AccessPackageResourcePackageAssociation) ToAccessPackageResourcePackageAssociationOutput added in v5.37.0

func (i *AccessPackageResourcePackageAssociation) ToAccessPackageResourcePackageAssociationOutput() AccessPackageResourcePackageAssociationOutput

func (*AccessPackageResourcePackageAssociation) ToAccessPackageResourcePackageAssociationOutputWithContext added in v5.37.0

func (i *AccessPackageResourcePackageAssociation) ToAccessPackageResourcePackageAssociationOutputWithContext(ctx context.Context) AccessPackageResourcePackageAssociationOutput

type AccessPackageResourcePackageAssociationArgs added in v5.37.0

type AccessPackageResourcePackageAssociationArgs struct {
	// The ID of access package this resource association is configured to. Changing this forces a new resource to be created.
	AccessPackageId pulumi.StringInput
	// The role of access type to the specified resource. Valid values are `Member`, or `Owner` The default is `Member`. Changing this forces a new resource to be created.
	AccessType pulumi.StringPtrInput
	// The ID of the catalog association from the `AccessPackageResourceCatalogAssociation` resource. Changing this forces a new resource to be created.
	CatalogResourceAssociationId pulumi.StringInput
}

The set of arguments for constructing a AccessPackageResourcePackageAssociation resource.

func (AccessPackageResourcePackageAssociationArgs) ElementType added in v5.37.0

type AccessPackageResourcePackageAssociationArray added in v5.37.0

type AccessPackageResourcePackageAssociationArray []AccessPackageResourcePackageAssociationInput

func (AccessPackageResourcePackageAssociationArray) ElementType added in v5.37.0

func (AccessPackageResourcePackageAssociationArray) ToAccessPackageResourcePackageAssociationArrayOutput added in v5.37.0

func (i AccessPackageResourcePackageAssociationArray) ToAccessPackageResourcePackageAssociationArrayOutput() AccessPackageResourcePackageAssociationArrayOutput

func (AccessPackageResourcePackageAssociationArray) ToAccessPackageResourcePackageAssociationArrayOutputWithContext added in v5.37.0

func (i AccessPackageResourcePackageAssociationArray) ToAccessPackageResourcePackageAssociationArrayOutputWithContext(ctx context.Context) AccessPackageResourcePackageAssociationArrayOutput

type AccessPackageResourcePackageAssociationArrayInput added in v5.37.0

type AccessPackageResourcePackageAssociationArrayInput interface {
	pulumi.Input

	ToAccessPackageResourcePackageAssociationArrayOutput() AccessPackageResourcePackageAssociationArrayOutput
	ToAccessPackageResourcePackageAssociationArrayOutputWithContext(context.Context) AccessPackageResourcePackageAssociationArrayOutput
}

AccessPackageResourcePackageAssociationArrayInput is an input type that accepts AccessPackageResourcePackageAssociationArray and AccessPackageResourcePackageAssociationArrayOutput values. You can construct a concrete instance of `AccessPackageResourcePackageAssociationArrayInput` via:

AccessPackageResourcePackageAssociationArray{ AccessPackageResourcePackageAssociationArgs{...} }

type AccessPackageResourcePackageAssociationArrayOutput added in v5.37.0

type AccessPackageResourcePackageAssociationArrayOutput struct{ *pulumi.OutputState }

func (AccessPackageResourcePackageAssociationArrayOutput) ElementType added in v5.37.0

func (AccessPackageResourcePackageAssociationArrayOutput) Index added in v5.37.0

func (AccessPackageResourcePackageAssociationArrayOutput) ToAccessPackageResourcePackageAssociationArrayOutput added in v5.37.0

func (o AccessPackageResourcePackageAssociationArrayOutput) ToAccessPackageResourcePackageAssociationArrayOutput() AccessPackageResourcePackageAssociationArrayOutput

func (AccessPackageResourcePackageAssociationArrayOutput) ToAccessPackageResourcePackageAssociationArrayOutputWithContext added in v5.37.0

func (o AccessPackageResourcePackageAssociationArrayOutput) ToAccessPackageResourcePackageAssociationArrayOutputWithContext(ctx context.Context) AccessPackageResourcePackageAssociationArrayOutput

type AccessPackageResourcePackageAssociationInput added in v5.37.0

type AccessPackageResourcePackageAssociationInput interface {
	pulumi.Input

	ToAccessPackageResourcePackageAssociationOutput() AccessPackageResourcePackageAssociationOutput
	ToAccessPackageResourcePackageAssociationOutputWithContext(ctx context.Context) AccessPackageResourcePackageAssociationOutput
}

type AccessPackageResourcePackageAssociationMap added in v5.37.0

type AccessPackageResourcePackageAssociationMap map[string]AccessPackageResourcePackageAssociationInput

func (AccessPackageResourcePackageAssociationMap) ElementType added in v5.37.0

func (AccessPackageResourcePackageAssociationMap) ToAccessPackageResourcePackageAssociationMapOutput added in v5.37.0

func (i AccessPackageResourcePackageAssociationMap) ToAccessPackageResourcePackageAssociationMapOutput() AccessPackageResourcePackageAssociationMapOutput

func (AccessPackageResourcePackageAssociationMap) ToAccessPackageResourcePackageAssociationMapOutputWithContext added in v5.37.0

func (i AccessPackageResourcePackageAssociationMap) ToAccessPackageResourcePackageAssociationMapOutputWithContext(ctx context.Context) AccessPackageResourcePackageAssociationMapOutput

type AccessPackageResourcePackageAssociationMapInput added in v5.37.0

type AccessPackageResourcePackageAssociationMapInput interface {
	pulumi.Input

	ToAccessPackageResourcePackageAssociationMapOutput() AccessPackageResourcePackageAssociationMapOutput
	ToAccessPackageResourcePackageAssociationMapOutputWithContext(context.Context) AccessPackageResourcePackageAssociationMapOutput
}

AccessPackageResourcePackageAssociationMapInput is an input type that accepts AccessPackageResourcePackageAssociationMap and AccessPackageResourcePackageAssociationMapOutput values. You can construct a concrete instance of `AccessPackageResourcePackageAssociationMapInput` via:

AccessPackageResourcePackageAssociationMap{ "key": AccessPackageResourcePackageAssociationArgs{...} }

type AccessPackageResourcePackageAssociationMapOutput added in v5.37.0

type AccessPackageResourcePackageAssociationMapOutput struct{ *pulumi.OutputState }

func (AccessPackageResourcePackageAssociationMapOutput) ElementType added in v5.37.0

func (AccessPackageResourcePackageAssociationMapOutput) MapIndex added in v5.37.0

func (AccessPackageResourcePackageAssociationMapOutput) ToAccessPackageResourcePackageAssociationMapOutput added in v5.37.0

func (o AccessPackageResourcePackageAssociationMapOutput) ToAccessPackageResourcePackageAssociationMapOutput() AccessPackageResourcePackageAssociationMapOutput

func (AccessPackageResourcePackageAssociationMapOutput) ToAccessPackageResourcePackageAssociationMapOutputWithContext added in v5.37.0

func (o AccessPackageResourcePackageAssociationMapOutput) ToAccessPackageResourcePackageAssociationMapOutputWithContext(ctx context.Context) AccessPackageResourcePackageAssociationMapOutput

type AccessPackageResourcePackageAssociationOutput added in v5.37.0

type AccessPackageResourcePackageAssociationOutput struct{ *pulumi.OutputState }

func (AccessPackageResourcePackageAssociationOutput) AccessPackageId added in v5.37.0

The ID of access package this resource association is configured to. Changing this forces a new resource to be created.

func (AccessPackageResourcePackageAssociationOutput) AccessType added in v5.37.0

The role of access type to the specified resource. Valid values are `Member`, or `Owner` The default is `Member`. Changing this forces a new resource to be created.

func (AccessPackageResourcePackageAssociationOutput) CatalogResourceAssociationId added in v5.37.0

func (o AccessPackageResourcePackageAssociationOutput) CatalogResourceAssociationId() pulumi.StringOutput

The ID of the catalog association from the `AccessPackageResourceCatalogAssociation` resource. Changing this forces a new resource to be created.

func (AccessPackageResourcePackageAssociationOutput) ElementType added in v5.37.0

func (AccessPackageResourcePackageAssociationOutput) ToAccessPackageResourcePackageAssociationOutput added in v5.37.0

func (o AccessPackageResourcePackageAssociationOutput) ToAccessPackageResourcePackageAssociationOutput() AccessPackageResourcePackageAssociationOutput

func (AccessPackageResourcePackageAssociationOutput) ToAccessPackageResourcePackageAssociationOutputWithContext added in v5.37.0

func (o AccessPackageResourcePackageAssociationOutput) ToAccessPackageResourcePackageAssociationOutputWithContext(ctx context.Context) AccessPackageResourcePackageAssociationOutput

type AccessPackageResourcePackageAssociationState added in v5.37.0

type AccessPackageResourcePackageAssociationState struct {
	// The ID of access package this resource association is configured to. Changing this forces a new resource to be created.
	AccessPackageId pulumi.StringPtrInput
	// The role of access type to the specified resource. Valid values are `Member`, or `Owner` The default is `Member`. Changing this forces a new resource to be created.
	AccessType pulumi.StringPtrInput
	// The ID of the catalog association from the `AccessPackageResourceCatalogAssociation` resource. Changing this forces a new resource to be created.
	CatalogResourceAssociationId pulumi.StringPtrInput
}

func (AccessPackageResourcePackageAssociationState) ElementType added in v5.37.0

type AccessPackageState added in v5.37.0

type AccessPackageState struct {
	// The ID of the Catalog this access package will be created in.
	CatalogId pulumi.StringPtrInput
	// The description of the access package.
	Description pulumi.StringPtrInput
	// The display name of the access package.
	DisplayName pulumi.StringPtrInput
	// Whether the access package is hidden from the requestor.
	Hidden pulumi.BoolPtrInput
}

func (AccessPackageState) ElementType added in v5.37.0

func (AccessPackageState) ElementType() reflect.Type

type AdministrativeUnit added in v5.10.0

type AdministrativeUnit struct {
	pulumi.CustomResourceState

	// The description of the administrative unit.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The display name of the administrative unit.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Whether the administrative unit and its members are hidden or publicly viewable in the directory.
	HiddenMembershipEnabled pulumi.BoolPtrOutput `pulumi:"hiddenMembershipEnabled"`
	// A set of object IDs of members who should be present in this administrative unit. Supported object types are Users or Groups.
	//
	// !> **Warning** Do not use the `members` property at the same time as the AdministrativeUnitMember resource for the same administrative unit. Doing so will cause a conflict and administrative unit members will be removed.
	Members pulumi.StringArrayOutput `pulumi:"members"`
	// The object ID of the administrative unit.
	ObjectId pulumi.StringOutput `pulumi:"objectId"`
	// If `true`, will return an error if an existing administrative unit is found with the same name
	PreventDuplicateNames pulumi.BoolPtrOutput `pulumi:"preventDuplicateNames"`
}

Manages an Administrative Unit within 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 one of the following application roles: `AdministrativeUnit.ReadWrite.All` or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Privileged Role Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.NewAdministrativeUnit(ctx, "example", &azuread.AdministrativeUnitArgs{
			DisplayName:             pulumi.String("Example-AU"),
			Description:             pulumi.String("Just an example"),
			HiddenMembershipEnabled: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Administrative units can be imported using their object ID, e.g.

```sh $ pulumi import azuread:index/administrativeUnit:AdministrativeUnit example 00000000-0000-0000-0000-000000000000 ```

func GetAdministrativeUnit added in v5.10.0

func GetAdministrativeUnit(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AdministrativeUnitState, opts ...pulumi.ResourceOption) (*AdministrativeUnit, error)

GetAdministrativeUnit gets an existing AdministrativeUnit resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAdministrativeUnit added in v5.10.0

func NewAdministrativeUnit(ctx *pulumi.Context,
	name string, args *AdministrativeUnitArgs, opts ...pulumi.ResourceOption) (*AdministrativeUnit, error)

NewAdministrativeUnit registers a new resource with the given unique name, arguments, and options.

func (*AdministrativeUnit) ElementType added in v5.10.0

func (*AdministrativeUnit) ElementType() reflect.Type

func (*AdministrativeUnit) ToAdministrativeUnitOutput added in v5.10.0

func (i *AdministrativeUnit) ToAdministrativeUnitOutput() AdministrativeUnitOutput

func (*AdministrativeUnit) ToAdministrativeUnitOutputWithContext added in v5.10.0

func (i *AdministrativeUnit) ToAdministrativeUnitOutputWithContext(ctx context.Context) AdministrativeUnitOutput

type AdministrativeUnitArgs added in v5.10.0

type AdministrativeUnitArgs struct {
	// The description of the administrative unit.
	Description pulumi.StringPtrInput
	// The display name of the administrative unit.
	DisplayName pulumi.StringInput
	// Whether the administrative unit and its members are hidden or publicly viewable in the directory.
	HiddenMembershipEnabled pulumi.BoolPtrInput
	// A set of object IDs of members who should be present in this administrative unit. Supported object types are Users or Groups.
	//
	// !> **Warning** Do not use the `members` property at the same time as the AdministrativeUnitMember resource for the same administrative unit. Doing so will cause a conflict and administrative unit members will be removed.
	Members pulumi.StringArrayInput
	// If `true`, will return an error if an existing administrative unit is found with the same name
	PreventDuplicateNames pulumi.BoolPtrInput
}

The set of arguments for constructing a AdministrativeUnit resource.

func (AdministrativeUnitArgs) ElementType added in v5.10.0

func (AdministrativeUnitArgs) ElementType() reflect.Type

type AdministrativeUnitArray added in v5.10.0

type AdministrativeUnitArray []AdministrativeUnitInput

func (AdministrativeUnitArray) ElementType added in v5.10.0

func (AdministrativeUnitArray) ElementType() reflect.Type

func (AdministrativeUnitArray) ToAdministrativeUnitArrayOutput added in v5.10.0

func (i AdministrativeUnitArray) ToAdministrativeUnitArrayOutput() AdministrativeUnitArrayOutput

func (AdministrativeUnitArray) ToAdministrativeUnitArrayOutputWithContext added in v5.10.0

func (i AdministrativeUnitArray) ToAdministrativeUnitArrayOutputWithContext(ctx context.Context) AdministrativeUnitArrayOutput

type AdministrativeUnitArrayInput added in v5.10.0

type AdministrativeUnitArrayInput interface {
	pulumi.Input

	ToAdministrativeUnitArrayOutput() AdministrativeUnitArrayOutput
	ToAdministrativeUnitArrayOutputWithContext(context.Context) AdministrativeUnitArrayOutput
}

AdministrativeUnitArrayInput is an input type that accepts AdministrativeUnitArray and AdministrativeUnitArrayOutput values. You can construct a concrete instance of `AdministrativeUnitArrayInput` via:

AdministrativeUnitArray{ AdministrativeUnitArgs{...} }

type AdministrativeUnitArrayOutput added in v5.10.0

type AdministrativeUnitArrayOutput struct{ *pulumi.OutputState }

func (AdministrativeUnitArrayOutput) ElementType added in v5.10.0

func (AdministrativeUnitArrayOutput) Index added in v5.10.0

func (AdministrativeUnitArrayOutput) ToAdministrativeUnitArrayOutput added in v5.10.0

func (o AdministrativeUnitArrayOutput) ToAdministrativeUnitArrayOutput() AdministrativeUnitArrayOutput

func (AdministrativeUnitArrayOutput) ToAdministrativeUnitArrayOutputWithContext added in v5.10.0

func (o AdministrativeUnitArrayOutput) ToAdministrativeUnitArrayOutputWithContext(ctx context.Context) AdministrativeUnitArrayOutput

type AdministrativeUnitInput added in v5.10.0

type AdministrativeUnitInput interface {
	pulumi.Input

	ToAdministrativeUnitOutput() AdministrativeUnitOutput
	ToAdministrativeUnitOutputWithContext(ctx context.Context) AdministrativeUnitOutput
}

type AdministrativeUnitMap added in v5.10.0

type AdministrativeUnitMap map[string]AdministrativeUnitInput

func (AdministrativeUnitMap) ElementType added in v5.10.0

func (AdministrativeUnitMap) ElementType() reflect.Type

func (AdministrativeUnitMap) ToAdministrativeUnitMapOutput added in v5.10.0

func (i AdministrativeUnitMap) ToAdministrativeUnitMapOutput() AdministrativeUnitMapOutput

func (AdministrativeUnitMap) ToAdministrativeUnitMapOutputWithContext added in v5.10.0

func (i AdministrativeUnitMap) ToAdministrativeUnitMapOutputWithContext(ctx context.Context) AdministrativeUnitMapOutput

type AdministrativeUnitMapInput added in v5.10.0

type AdministrativeUnitMapInput interface {
	pulumi.Input

	ToAdministrativeUnitMapOutput() AdministrativeUnitMapOutput
	ToAdministrativeUnitMapOutputWithContext(context.Context) AdministrativeUnitMapOutput
}

AdministrativeUnitMapInput is an input type that accepts AdministrativeUnitMap and AdministrativeUnitMapOutput values. You can construct a concrete instance of `AdministrativeUnitMapInput` via:

AdministrativeUnitMap{ "key": AdministrativeUnitArgs{...} }

type AdministrativeUnitMapOutput added in v5.10.0

type AdministrativeUnitMapOutput struct{ *pulumi.OutputState }

func (AdministrativeUnitMapOutput) ElementType added in v5.10.0

func (AdministrativeUnitMapOutput) MapIndex added in v5.10.0

func (AdministrativeUnitMapOutput) ToAdministrativeUnitMapOutput added in v5.10.0

func (o AdministrativeUnitMapOutput) ToAdministrativeUnitMapOutput() AdministrativeUnitMapOutput

func (AdministrativeUnitMapOutput) ToAdministrativeUnitMapOutputWithContext added in v5.10.0

func (o AdministrativeUnitMapOutput) ToAdministrativeUnitMapOutputWithContext(ctx context.Context) AdministrativeUnitMapOutput

type AdministrativeUnitMember added in v5.10.0

type AdministrativeUnitMember struct {
	pulumi.CustomResourceState

	// The object ID of the administrative unit you want to add the member to. Changing this forces a new resource to be created.
	AdministrativeUnitObjectId pulumi.StringPtrOutput `pulumi:"administrativeUnitObjectId"`
	// The object ID of the user or group you want to add as a member of the administrative unit. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringPtrOutput `pulumi:"memberObjectId"`
}

Manages a single administrative unit membership within Azure Active Directory.

> **Warning** Do not use this resource at the same time as the `members` property of the `AdministrativeUnit` resource for the same administrative unit. Doing so will cause a conflict and administrative unit members will be removed.

## API Permissions

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

When authenticated with a service principal, this resource requires one of the following application roles: `AdministrativeUnit.ReadWrite.All` or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Privileged Role Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.LookupUser(ctx, &azuread.LookupUserArgs{
			UserPrincipalName: pulumi.StringRef("jdoe@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		exampleAdministrativeUnit, err := azuread.NewAdministrativeUnit(ctx, "example", &azuread.AdministrativeUnitArgs{
			DisplayName: pulumi.String("Example-AU"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAdministrativeUnitMember(ctx, "example", &azuread.AdministrativeUnitMemberArgs{
			AdministrativeUnitObjectId: exampleAdministrativeUnit.ID(),
			MemberObjectId:             pulumi.String(example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Administrative unit members can be imported using the object ID of the administrative unit and the object ID of the member, e.g.

```sh $ pulumi import azuread:index/administrativeUnitMember:AdministrativeUnitMember example 00000000-0000-0000-0000-000000000000/member/11111111-1111-1111-1111-111111111111 ```

-> This ID format is unique to Terraform and is composed of the Administrative Unit Object ID and the target Member Object ID in the format `{AdministrativeUnitObjectID}/member/{MemberObjectID}`.

func GetAdministrativeUnitMember added in v5.10.0

func GetAdministrativeUnitMember(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AdministrativeUnitMemberState, opts ...pulumi.ResourceOption) (*AdministrativeUnitMember, error)

GetAdministrativeUnitMember gets an existing AdministrativeUnitMember resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAdministrativeUnitMember added in v5.10.0

func NewAdministrativeUnitMember(ctx *pulumi.Context,
	name string, args *AdministrativeUnitMemberArgs, opts ...pulumi.ResourceOption) (*AdministrativeUnitMember, error)

NewAdministrativeUnitMember registers a new resource with the given unique name, arguments, and options.

func (*AdministrativeUnitMember) ElementType added in v5.10.0

func (*AdministrativeUnitMember) ElementType() reflect.Type

func (*AdministrativeUnitMember) ToAdministrativeUnitMemberOutput added in v5.10.0

func (i *AdministrativeUnitMember) ToAdministrativeUnitMemberOutput() AdministrativeUnitMemberOutput

func (*AdministrativeUnitMember) ToAdministrativeUnitMemberOutputWithContext added in v5.10.0

func (i *AdministrativeUnitMember) ToAdministrativeUnitMemberOutputWithContext(ctx context.Context) AdministrativeUnitMemberOutput

type AdministrativeUnitMemberArgs added in v5.10.0

type AdministrativeUnitMemberArgs struct {
	// The object ID of the administrative unit you want to add the member to. Changing this forces a new resource to be created.
	AdministrativeUnitObjectId pulumi.StringPtrInput
	// The object ID of the user or group you want to add as a member of the administrative unit. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringPtrInput
}

The set of arguments for constructing a AdministrativeUnitMember resource.

func (AdministrativeUnitMemberArgs) ElementType added in v5.10.0

type AdministrativeUnitMemberArray added in v5.10.0

type AdministrativeUnitMemberArray []AdministrativeUnitMemberInput

func (AdministrativeUnitMemberArray) ElementType added in v5.10.0

func (AdministrativeUnitMemberArray) ToAdministrativeUnitMemberArrayOutput added in v5.10.0

func (i AdministrativeUnitMemberArray) ToAdministrativeUnitMemberArrayOutput() AdministrativeUnitMemberArrayOutput

func (AdministrativeUnitMemberArray) ToAdministrativeUnitMemberArrayOutputWithContext added in v5.10.0

func (i AdministrativeUnitMemberArray) ToAdministrativeUnitMemberArrayOutputWithContext(ctx context.Context) AdministrativeUnitMemberArrayOutput

type AdministrativeUnitMemberArrayInput added in v5.10.0

type AdministrativeUnitMemberArrayInput interface {
	pulumi.Input

	ToAdministrativeUnitMemberArrayOutput() AdministrativeUnitMemberArrayOutput
	ToAdministrativeUnitMemberArrayOutputWithContext(context.Context) AdministrativeUnitMemberArrayOutput
}

AdministrativeUnitMemberArrayInput is an input type that accepts AdministrativeUnitMemberArray and AdministrativeUnitMemberArrayOutput values. You can construct a concrete instance of `AdministrativeUnitMemberArrayInput` via:

AdministrativeUnitMemberArray{ AdministrativeUnitMemberArgs{...} }

type AdministrativeUnitMemberArrayOutput added in v5.10.0

type AdministrativeUnitMemberArrayOutput struct{ *pulumi.OutputState }

func (AdministrativeUnitMemberArrayOutput) ElementType added in v5.10.0

func (AdministrativeUnitMemberArrayOutput) Index added in v5.10.0

func (AdministrativeUnitMemberArrayOutput) ToAdministrativeUnitMemberArrayOutput added in v5.10.0

func (o AdministrativeUnitMemberArrayOutput) ToAdministrativeUnitMemberArrayOutput() AdministrativeUnitMemberArrayOutput

func (AdministrativeUnitMemberArrayOutput) ToAdministrativeUnitMemberArrayOutputWithContext added in v5.10.0

func (o AdministrativeUnitMemberArrayOutput) ToAdministrativeUnitMemberArrayOutputWithContext(ctx context.Context) AdministrativeUnitMemberArrayOutput

type AdministrativeUnitMemberInput added in v5.10.0

type AdministrativeUnitMemberInput interface {
	pulumi.Input

	ToAdministrativeUnitMemberOutput() AdministrativeUnitMemberOutput
	ToAdministrativeUnitMemberOutputWithContext(ctx context.Context) AdministrativeUnitMemberOutput
}

type AdministrativeUnitMemberMap added in v5.10.0

type AdministrativeUnitMemberMap map[string]AdministrativeUnitMemberInput

func (AdministrativeUnitMemberMap) ElementType added in v5.10.0

func (AdministrativeUnitMemberMap) ToAdministrativeUnitMemberMapOutput added in v5.10.0

func (i AdministrativeUnitMemberMap) ToAdministrativeUnitMemberMapOutput() AdministrativeUnitMemberMapOutput

func (AdministrativeUnitMemberMap) ToAdministrativeUnitMemberMapOutputWithContext added in v5.10.0

func (i AdministrativeUnitMemberMap) ToAdministrativeUnitMemberMapOutputWithContext(ctx context.Context) AdministrativeUnitMemberMapOutput

type AdministrativeUnitMemberMapInput added in v5.10.0

type AdministrativeUnitMemberMapInput interface {
	pulumi.Input

	ToAdministrativeUnitMemberMapOutput() AdministrativeUnitMemberMapOutput
	ToAdministrativeUnitMemberMapOutputWithContext(context.Context) AdministrativeUnitMemberMapOutput
}

AdministrativeUnitMemberMapInput is an input type that accepts AdministrativeUnitMemberMap and AdministrativeUnitMemberMapOutput values. You can construct a concrete instance of `AdministrativeUnitMemberMapInput` via:

AdministrativeUnitMemberMap{ "key": AdministrativeUnitMemberArgs{...} }

type AdministrativeUnitMemberMapOutput added in v5.10.0

type AdministrativeUnitMemberMapOutput struct{ *pulumi.OutputState }

func (AdministrativeUnitMemberMapOutput) ElementType added in v5.10.0

func (AdministrativeUnitMemberMapOutput) MapIndex added in v5.10.0

func (AdministrativeUnitMemberMapOutput) ToAdministrativeUnitMemberMapOutput added in v5.10.0

func (o AdministrativeUnitMemberMapOutput) ToAdministrativeUnitMemberMapOutput() AdministrativeUnitMemberMapOutput

func (AdministrativeUnitMemberMapOutput) ToAdministrativeUnitMemberMapOutputWithContext added in v5.10.0

func (o AdministrativeUnitMemberMapOutput) ToAdministrativeUnitMemberMapOutputWithContext(ctx context.Context) AdministrativeUnitMemberMapOutput

type AdministrativeUnitMemberOutput added in v5.10.0

type AdministrativeUnitMemberOutput struct{ *pulumi.OutputState }

func (AdministrativeUnitMemberOutput) AdministrativeUnitObjectId added in v5.22.0

func (o AdministrativeUnitMemberOutput) AdministrativeUnitObjectId() pulumi.StringPtrOutput

The object ID of the administrative unit you want to add the member to. Changing this forces a new resource to be created.

func (AdministrativeUnitMemberOutput) ElementType added in v5.10.0

func (AdministrativeUnitMemberOutput) MemberObjectId added in v5.22.0

The object ID of the user or group you want to add as a member of the administrative unit. Changing this forces a new resource to be created.

func (AdministrativeUnitMemberOutput) ToAdministrativeUnitMemberOutput added in v5.10.0

func (o AdministrativeUnitMemberOutput) ToAdministrativeUnitMemberOutput() AdministrativeUnitMemberOutput

func (AdministrativeUnitMemberOutput) ToAdministrativeUnitMemberOutputWithContext added in v5.10.0

func (o AdministrativeUnitMemberOutput) ToAdministrativeUnitMemberOutputWithContext(ctx context.Context) AdministrativeUnitMemberOutput

type AdministrativeUnitMemberState added in v5.10.0

type AdministrativeUnitMemberState struct {
	// The object ID of the administrative unit you want to add the member to. Changing this forces a new resource to be created.
	AdministrativeUnitObjectId pulumi.StringPtrInput
	// The object ID of the user or group you want to add as a member of the administrative unit. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringPtrInput
}

func (AdministrativeUnitMemberState) ElementType added in v5.10.0

type AdministrativeUnitOutput added in v5.10.0

type AdministrativeUnitOutput struct{ *pulumi.OutputState }

func (AdministrativeUnitOutput) Description added in v5.22.0

The description of the administrative unit.

func (AdministrativeUnitOutput) DisplayName added in v5.22.0

The display name of the administrative unit.

func (AdministrativeUnitOutput) ElementType added in v5.10.0

func (AdministrativeUnitOutput) ElementType() reflect.Type

func (AdministrativeUnitOutput) HiddenMembershipEnabled added in v5.22.0

func (o AdministrativeUnitOutput) HiddenMembershipEnabled() pulumi.BoolPtrOutput

Whether the administrative unit and its members are hidden or publicly viewable in the directory.

func (AdministrativeUnitOutput) Members added in v5.22.0

A set of object IDs of members who should be present in this administrative unit. Supported object types are Users or Groups.

!> **Warning** Do not use the `members` property at the same time as the AdministrativeUnitMember resource for the same administrative unit. Doing so will cause a conflict and administrative unit members will be removed.

func (AdministrativeUnitOutput) ObjectId added in v5.22.0

The object ID of the administrative unit.

func (AdministrativeUnitOutput) PreventDuplicateNames added in v5.22.0

func (o AdministrativeUnitOutput) PreventDuplicateNames() pulumi.BoolPtrOutput

If `true`, will return an error if an existing administrative unit is found with the same name

func (AdministrativeUnitOutput) ToAdministrativeUnitOutput added in v5.10.0

func (o AdministrativeUnitOutput) ToAdministrativeUnitOutput() AdministrativeUnitOutput

func (AdministrativeUnitOutput) ToAdministrativeUnitOutputWithContext added in v5.10.0

func (o AdministrativeUnitOutput) ToAdministrativeUnitOutputWithContext(ctx context.Context) AdministrativeUnitOutput

type AdministrativeUnitRoleMember added in v5.37.0

type AdministrativeUnitRoleMember struct {
	pulumi.CustomResourceState

	// The object ID of the administrative unit you want to add the member to. Changing this forces a new resource to be created.
	AdministrativeUnitObjectId pulumi.StringOutput `pulumi:"administrativeUnitObjectId"`
	// The object ID of the user, group or service principal you want to add as a member of the administrative unit. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringOutput `pulumi:"memberObjectId"`
	// The object ID of the directory role you want to assign. Changing this forces a new resource to be created.
	RoleObjectId pulumi.StringOutput `pulumi:"roleObjectId"`
}

Manages a single directory role assignment scoped to an administrative unit within 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 one of the following application roles: `AdministrativeUnit.ReadWrite.All` and `RoleManagement.ReadWrite.Directory`, or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Privileged Role Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.LookupUser(ctx, &azuread.LookupUserArgs{
			UserPrincipalName: pulumi.StringRef("jdoe@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		exampleAdministrativeUnit, err := azuread.NewAdministrativeUnit(ctx, "example", &azuread.AdministrativeUnitArgs{
			DisplayName: pulumi.String("Example-AU"),
		})
		if err != nil {
			return err
		}
		exampleDirectoryRole, err := azuread.NewDirectoryRole(ctx, "example", &azuread.DirectoryRoleArgs{
			DisplayName: pulumi.String("Security administrator"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAdministrativeUnitRoleMember(ctx, "example", &azuread.AdministrativeUnitRoleMemberArgs{
			RoleObjectId:               exampleDirectoryRole.ObjectId,
			AdministrativeUnitObjectId: exampleAdministrativeUnit.ID(),
			MemberObjectId:             pulumi.String(example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Administrative unit role members can be imported using the object ID of the administrative unit and the unique ID of the role assignment, e.g.

```sh $ pulumi import azuread:index/administrativeUnitRoleMember:AdministrativeUnitRoleMember example 00000000-0000-0000-0000-000000000000/roleMember/zX37MRLyF0uvE-xf2WH4B7x-6CPLfudNnxFGj800htpBXqkxW7bITqGb6Rj4kuTuS ```

-> This ID format is unique to Terraform and is composed of the Administrative Unit Object ID and the role assignment ID in the format `{AdministrativeUnitObjectID}/roleMember/{RoleAssignmentID}`.

func GetAdministrativeUnitRoleMember added in v5.37.0

func GetAdministrativeUnitRoleMember(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AdministrativeUnitRoleMemberState, opts ...pulumi.ResourceOption) (*AdministrativeUnitRoleMember, error)

GetAdministrativeUnitRoleMember gets an existing AdministrativeUnitRoleMember resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAdministrativeUnitRoleMember added in v5.37.0

func NewAdministrativeUnitRoleMember(ctx *pulumi.Context,
	name string, args *AdministrativeUnitRoleMemberArgs, opts ...pulumi.ResourceOption) (*AdministrativeUnitRoleMember, error)

NewAdministrativeUnitRoleMember registers a new resource with the given unique name, arguments, and options.

func (*AdministrativeUnitRoleMember) ElementType added in v5.37.0

func (*AdministrativeUnitRoleMember) ElementType() reflect.Type

func (*AdministrativeUnitRoleMember) ToAdministrativeUnitRoleMemberOutput added in v5.37.0

func (i *AdministrativeUnitRoleMember) ToAdministrativeUnitRoleMemberOutput() AdministrativeUnitRoleMemberOutput

func (*AdministrativeUnitRoleMember) ToAdministrativeUnitRoleMemberOutputWithContext added in v5.37.0

func (i *AdministrativeUnitRoleMember) ToAdministrativeUnitRoleMemberOutputWithContext(ctx context.Context) AdministrativeUnitRoleMemberOutput

type AdministrativeUnitRoleMemberArgs added in v5.37.0

type AdministrativeUnitRoleMemberArgs struct {
	// The object ID of the administrative unit you want to add the member to. Changing this forces a new resource to be created.
	AdministrativeUnitObjectId pulumi.StringInput
	// The object ID of the user, group or service principal you want to add as a member of the administrative unit. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringInput
	// The object ID of the directory role you want to assign. Changing this forces a new resource to be created.
	RoleObjectId pulumi.StringInput
}

The set of arguments for constructing a AdministrativeUnitRoleMember resource.

func (AdministrativeUnitRoleMemberArgs) ElementType added in v5.37.0

type AdministrativeUnitRoleMemberArray added in v5.37.0

type AdministrativeUnitRoleMemberArray []AdministrativeUnitRoleMemberInput

func (AdministrativeUnitRoleMemberArray) ElementType added in v5.37.0

func (AdministrativeUnitRoleMemberArray) ToAdministrativeUnitRoleMemberArrayOutput added in v5.37.0

func (i AdministrativeUnitRoleMemberArray) ToAdministrativeUnitRoleMemberArrayOutput() AdministrativeUnitRoleMemberArrayOutput

func (AdministrativeUnitRoleMemberArray) ToAdministrativeUnitRoleMemberArrayOutputWithContext added in v5.37.0

func (i AdministrativeUnitRoleMemberArray) ToAdministrativeUnitRoleMemberArrayOutputWithContext(ctx context.Context) AdministrativeUnitRoleMemberArrayOutput

type AdministrativeUnitRoleMemberArrayInput added in v5.37.0

type AdministrativeUnitRoleMemberArrayInput interface {
	pulumi.Input

	ToAdministrativeUnitRoleMemberArrayOutput() AdministrativeUnitRoleMemberArrayOutput
	ToAdministrativeUnitRoleMemberArrayOutputWithContext(context.Context) AdministrativeUnitRoleMemberArrayOutput
}

AdministrativeUnitRoleMemberArrayInput is an input type that accepts AdministrativeUnitRoleMemberArray and AdministrativeUnitRoleMemberArrayOutput values. You can construct a concrete instance of `AdministrativeUnitRoleMemberArrayInput` via:

AdministrativeUnitRoleMemberArray{ AdministrativeUnitRoleMemberArgs{...} }

type AdministrativeUnitRoleMemberArrayOutput added in v5.37.0

type AdministrativeUnitRoleMemberArrayOutput struct{ *pulumi.OutputState }

func (AdministrativeUnitRoleMemberArrayOutput) ElementType added in v5.37.0

func (AdministrativeUnitRoleMemberArrayOutput) Index added in v5.37.0

func (AdministrativeUnitRoleMemberArrayOutput) ToAdministrativeUnitRoleMemberArrayOutput added in v5.37.0

func (o AdministrativeUnitRoleMemberArrayOutput) ToAdministrativeUnitRoleMemberArrayOutput() AdministrativeUnitRoleMemberArrayOutput

func (AdministrativeUnitRoleMemberArrayOutput) ToAdministrativeUnitRoleMemberArrayOutputWithContext added in v5.37.0

func (o AdministrativeUnitRoleMemberArrayOutput) ToAdministrativeUnitRoleMemberArrayOutputWithContext(ctx context.Context) AdministrativeUnitRoleMemberArrayOutput

type AdministrativeUnitRoleMemberInput added in v5.37.0

type AdministrativeUnitRoleMemberInput interface {
	pulumi.Input

	ToAdministrativeUnitRoleMemberOutput() AdministrativeUnitRoleMemberOutput
	ToAdministrativeUnitRoleMemberOutputWithContext(ctx context.Context) AdministrativeUnitRoleMemberOutput
}

type AdministrativeUnitRoleMemberMap added in v5.37.0

type AdministrativeUnitRoleMemberMap map[string]AdministrativeUnitRoleMemberInput

func (AdministrativeUnitRoleMemberMap) ElementType added in v5.37.0

func (AdministrativeUnitRoleMemberMap) ToAdministrativeUnitRoleMemberMapOutput added in v5.37.0

func (i AdministrativeUnitRoleMemberMap) ToAdministrativeUnitRoleMemberMapOutput() AdministrativeUnitRoleMemberMapOutput

func (AdministrativeUnitRoleMemberMap) ToAdministrativeUnitRoleMemberMapOutputWithContext added in v5.37.0

func (i AdministrativeUnitRoleMemberMap) ToAdministrativeUnitRoleMemberMapOutputWithContext(ctx context.Context) AdministrativeUnitRoleMemberMapOutput

type AdministrativeUnitRoleMemberMapInput added in v5.37.0

type AdministrativeUnitRoleMemberMapInput interface {
	pulumi.Input

	ToAdministrativeUnitRoleMemberMapOutput() AdministrativeUnitRoleMemberMapOutput
	ToAdministrativeUnitRoleMemberMapOutputWithContext(context.Context) AdministrativeUnitRoleMemberMapOutput
}

AdministrativeUnitRoleMemberMapInput is an input type that accepts AdministrativeUnitRoleMemberMap and AdministrativeUnitRoleMemberMapOutput values. You can construct a concrete instance of `AdministrativeUnitRoleMemberMapInput` via:

AdministrativeUnitRoleMemberMap{ "key": AdministrativeUnitRoleMemberArgs{...} }

type AdministrativeUnitRoleMemberMapOutput added in v5.37.0

type AdministrativeUnitRoleMemberMapOutput struct{ *pulumi.OutputState }

func (AdministrativeUnitRoleMemberMapOutput) ElementType added in v5.37.0

func (AdministrativeUnitRoleMemberMapOutput) MapIndex added in v5.37.0

func (AdministrativeUnitRoleMemberMapOutput) ToAdministrativeUnitRoleMemberMapOutput added in v5.37.0

func (o AdministrativeUnitRoleMemberMapOutput) ToAdministrativeUnitRoleMemberMapOutput() AdministrativeUnitRoleMemberMapOutput

func (AdministrativeUnitRoleMemberMapOutput) ToAdministrativeUnitRoleMemberMapOutputWithContext added in v5.37.0

func (o AdministrativeUnitRoleMemberMapOutput) ToAdministrativeUnitRoleMemberMapOutputWithContext(ctx context.Context) AdministrativeUnitRoleMemberMapOutput

type AdministrativeUnitRoleMemberOutput added in v5.37.0

type AdministrativeUnitRoleMemberOutput struct{ *pulumi.OutputState }

func (AdministrativeUnitRoleMemberOutput) AdministrativeUnitObjectId added in v5.37.0

func (o AdministrativeUnitRoleMemberOutput) AdministrativeUnitObjectId() pulumi.StringOutput

The object ID of the administrative unit you want to add the member to. Changing this forces a new resource to be created.

func (AdministrativeUnitRoleMemberOutput) ElementType added in v5.37.0

func (AdministrativeUnitRoleMemberOutput) MemberObjectId added in v5.37.0

The object ID of the user, group or service principal you want to add as a member of the administrative unit. Changing this forces a new resource to be created.

func (AdministrativeUnitRoleMemberOutput) RoleObjectId added in v5.37.0

The object ID of the directory role you want to assign. Changing this forces a new resource to be created.

func (AdministrativeUnitRoleMemberOutput) ToAdministrativeUnitRoleMemberOutput added in v5.37.0

func (o AdministrativeUnitRoleMemberOutput) ToAdministrativeUnitRoleMemberOutput() AdministrativeUnitRoleMemberOutput

func (AdministrativeUnitRoleMemberOutput) ToAdministrativeUnitRoleMemberOutputWithContext added in v5.37.0

func (o AdministrativeUnitRoleMemberOutput) ToAdministrativeUnitRoleMemberOutputWithContext(ctx context.Context) AdministrativeUnitRoleMemberOutput

type AdministrativeUnitRoleMemberState added in v5.37.0

type AdministrativeUnitRoleMemberState struct {
	// The object ID of the administrative unit you want to add the member to. Changing this forces a new resource to be created.
	AdministrativeUnitObjectId pulumi.StringPtrInput
	// The object ID of the user, group or service principal you want to add as a member of the administrative unit. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringPtrInput
	// The object ID of the directory role you want to assign. Changing this forces a new resource to be created.
	RoleObjectId pulumi.StringPtrInput
}

func (AdministrativeUnitRoleMemberState) ElementType added in v5.37.0

type AdministrativeUnitState added in v5.10.0

type AdministrativeUnitState struct {
	// The description of the administrative unit.
	Description pulumi.StringPtrInput
	// The display name of the administrative unit.
	DisplayName pulumi.StringPtrInput
	// Whether the administrative unit and its members are hidden or publicly viewable in the directory.
	HiddenMembershipEnabled pulumi.BoolPtrInput
	// A set of object IDs of members who should be present in this administrative unit. Supported object types are Users or Groups.
	//
	// !> **Warning** Do not use the `members` property at the same time as the AdministrativeUnitMember resource for the same administrative unit. Doing so will cause a conflict and administrative unit members will be removed.
	Members pulumi.StringArrayInput
	// The object ID of the administrative unit.
	ObjectId pulumi.StringPtrInput
	// If `true`, will return an error if an existing administrative unit is found with the same name
	PreventDuplicateNames pulumi.BoolPtrInput
}

func (AdministrativeUnitState) ElementType added in v5.10.0

func (AdministrativeUnitState) ElementType() reflect.Type

type AppRoleAssignment added in v5.3.0

type AppRoleAssignment struct {
	pulumi.CustomResourceState

	// The ID of the app role to be assigned, or the default role ID `00000000-0000-0000-0000-000000000000`. Changing this forces a new resource to be created.
	AppRoleId pulumi.StringOutput `pulumi:"appRoleId"`
	// The display name of the principal to which the app role is assigned.
	PrincipalDisplayName pulumi.StringOutput `pulumi:"principalDisplayName"`
	// The object ID of the user, group or service principal to be assigned this app role. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	PrincipalObjectId pulumi.StringOutput `pulumi:"principalObjectId"`
	// The object type of the principal to which the app role is assigned.
	PrincipalType pulumi.StringOutput `pulumi:"principalType"`
	// The display name of the application representing the resource.
	ResourceDisplayName pulumi.StringOutput `pulumi:"resourceDisplayName"`
	// The object ID of the service principal representing the resource. Changing this forces a new resource to be created.
	ResourceObjectId pulumi.StringOutput `pulumi:"resourceObjectId"`
}

Manages an app role assignment for a group, user or service principal. Can be used to grant admin consent for application permissions.

## API Permissions

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

When authenticated with a service principal, this resource requires one of the following application roles: `AppRoleAssignment.ReadWrite.All` and `Application.Read.All`, or `AppRoleAssignment.ReadWrite.All` and `Directory.Read.All`, or `Application.ReadWrite.All`, or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Application Administrator` or `Global Administrator`

## Example Usage

*App role assignment for accessing Microsoft Graph*

<!--Start PulumiCodeChooser --> ```go 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 {
		wellKnown, err := azuread.GetApplicationPublishedAppIds(ctx, nil, nil)
		if err != nil {
			return err
		}
		msgraph, err := azuread.NewServicePrincipal(ctx, "msgraph", &azuread.ServicePrincipalArgs{
			ApplicationId: pulumi.String(wellKnown.Result.MicrosoftGraph),
			UseExisting:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			RequiredResourceAccesses: azuread.ApplicationRequiredResourceAccessArray{
				&azuread.ApplicationRequiredResourceAccessArgs{
					ResourceAppId: pulumi.String(wellKnown.Result.MicrosoftGraph),
					ResourceAccesses: azuread.ApplicationRequiredResourceAccessResourceAccessArray{
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id: msgraph.AppRoleIds.ApplyT(func(appRoleIds map[string]string) (string, error) {
								return appRoleIds.User.Read.All, nil
							}).(pulumi.StringOutput),
							Type: pulumi.String("Role"),
						},
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id: msgraph.Oauth2PermissionScopeIds.ApplyT(func(oauth2PermissionScopeIds map[string]string) (string, error) {
								return oauth2PermissionScopeIds.User.ReadWrite, nil
							}).(pulumi.StringOutput),
							Type: pulumi.String("Scope"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ApplicationId: example.ApplicationId,
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAppRoleAssignment(ctx, "example", &azuread.AppRoleAssignmentArgs{
			AppRoleId: msgraph.AppRoleIds.ApplyT(func(appRoleIds map[string]string) (string, error) {
				return appRoleIds.User.Read.All, nil
			}).(pulumi.StringOutput),
			PrincipalObjectId: exampleServicePrincipal.ObjectId,
			ResourceObjectId:  msgraph.ObjectId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*App role assignment for internal application*

<!--Start PulumiCodeChooser --> ```go 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 {
		internal, err := azuread.NewApplication(ctx, "internal", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("internal"),
			AppRoles: azuread.ApplicationAppRoleTypeArray{
				&azuread.ApplicationAppRoleTypeArgs{
					AllowedMemberTypes: pulumi.StringArray{
						pulumi.String("Application"),
					},
					Description: pulumi.String("Apps can query the database"),
					DisplayName: pulumi.String("Query"),
					Enabled:     pulumi.Bool(true),
					Id:          pulumi.String("00000000-0000-0000-0000-111111111111"),
					Value:       pulumi.String("Query.All"),
				},
			},
		})
		if err != nil {
			return err
		}
		internalServicePrincipal, err := azuread.NewServicePrincipal(ctx, "internal", &azuread.ServicePrincipalArgs{
			ApplicationId: internal.ApplicationId,
		})
		if err != nil {
			return err
		}
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			RequiredResourceAccesses: azuread.ApplicationRequiredResourceAccessArray{
				&azuread.ApplicationRequiredResourceAccessArgs{
					ResourceAppId: internal.ApplicationId,
					ResourceAccesses: azuread.ApplicationRequiredResourceAccessResourceAccessArray{
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id: internalServicePrincipal.AppRoleIds.ApplyT(func(appRoleIds map[string]string) (string, error) {
								return appRoleIds.Query.All, nil
							}).(pulumi.StringOutput),
							Type: pulumi.String("Role"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ApplicationId: example.ApplicationId,
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAppRoleAssignment(ctx, "example", &azuread.AppRoleAssignmentArgs{
			AppRoleId: internalServicePrincipal.AppRoleIds.ApplyT(func(appRoleIds map[string]string) (string, error) {
				return appRoleIds.Query.All, nil
			}).(pulumi.StringOutput),
			PrincipalObjectId: exampleServicePrincipal.ObjectId,
			ResourceObjectId:  internalServicePrincipal.ObjectId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Assign a user and group to an internal application*

## Import

App role assignments can be imported using the object ID of the service principal representing the resource and the ID of the app role assignment (note: _not_ the ID of the app role), e.g.

```sh $ pulumi import azuread:index/appRoleAssignment:AppRoleAssignment example 00000000-0000-0000-0000-000000000000/appRoleAssignment/aaBBcDDeFG6h5JKLMN2PQrrssTTUUvWWxxxxxyyyzzz ```

-> This ID format is unique to Terraform and is composed of the Resource Service Principal Object ID and the ID of the App Role Assignment in the format `{ResourcePrincipalID}/appRoleAssignment/{AppRoleAssignmentID}`.

func GetAppRoleAssignment added in v5.3.0

func GetAppRoleAssignment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AppRoleAssignmentState, opts ...pulumi.ResourceOption) (*AppRoleAssignment, error)

GetAppRoleAssignment gets an existing AppRoleAssignment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAppRoleAssignment added in v5.3.0

func NewAppRoleAssignment(ctx *pulumi.Context,
	name string, args *AppRoleAssignmentArgs, opts ...pulumi.ResourceOption) (*AppRoleAssignment, error)

NewAppRoleAssignment registers a new resource with the given unique name, arguments, and options.

func (*AppRoleAssignment) ElementType added in v5.3.0

func (*AppRoleAssignment) ElementType() reflect.Type

func (*AppRoleAssignment) ToAppRoleAssignmentOutput added in v5.3.0

func (i *AppRoleAssignment) ToAppRoleAssignmentOutput() AppRoleAssignmentOutput

func (*AppRoleAssignment) ToAppRoleAssignmentOutputWithContext added in v5.3.0

func (i *AppRoleAssignment) ToAppRoleAssignmentOutputWithContext(ctx context.Context) AppRoleAssignmentOutput

type AppRoleAssignmentArgs added in v5.3.0

type AppRoleAssignmentArgs struct {
	// The ID of the app role to be assigned, or the default role ID `00000000-0000-0000-0000-000000000000`. Changing this forces a new resource to be created.
	AppRoleId pulumi.StringInput
	// The object ID of the user, group or service principal to be assigned this app role. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	PrincipalObjectId pulumi.StringInput
	// The object ID of the service principal representing the resource. Changing this forces a new resource to be created.
	ResourceObjectId pulumi.StringInput
}

The set of arguments for constructing a AppRoleAssignment resource.

func (AppRoleAssignmentArgs) ElementType added in v5.3.0

func (AppRoleAssignmentArgs) ElementType() reflect.Type

type AppRoleAssignmentArray added in v5.3.0

type AppRoleAssignmentArray []AppRoleAssignmentInput

func (AppRoleAssignmentArray) ElementType added in v5.3.0

func (AppRoleAssignmentArray) ElementType() reflect.Type

func (AppRoleAssignmentArray) ToAppRoleAssignmentArrayOutput added in v5.3.0

func (i AppRoleAssignmentArray) ToAppRoleAssignmentArrayOutput() AppRoleAssignmentArrayOutput

func (AppRoleAssignmentArray) ToAppRoleAssignmentArrayOutputWithContext added in v5.3.0

func (i AppRoleAssignmentArray) ToAppRoleAssignmentArrayOutputWithContext(ctx context.Context) AppRoleAssignmentArrayOutput

type AppRoleAssignmentArrayInput added in v5.3.0

type AppRoleAssignmentArrayInput interface {
	pulumi.Input

	ToAppRoleAssignmentArrayOutput() AppRoleAssignmentArrayOutput
	ToAppRoleAssignmentArrayOutputWithContext(context.Context) AppRoleAssignmentArrayOutput
}

AppRoleAssignmentArrayInput is an input type that accepts AppRoleAssignmentArray and AppRoleAssignmentArrayOutput values. You can construct a concrete instance of `AppRoleAssignmentArrayInput` via:

AppRoleAssignmentArray{ AppRoleAssignmentArgs{...} }

type AppRoleAssignmentArrayOutput added in v5.3.0

type AppRoleAssignmentArrayOutput struct{ *pulumi.OutputState }

func (AppRoleAssignmentArrayOutput) ElementType added in v5.3.0

func (AppRoleAssignmentArrayOutput) Index added in v5.3.0

func (AppRoleAssignmentArrayOutput) ToAppRoleAssignmentArrayOutput added in v5.3.0

func (o AppRoleAssignmentArrayOutput) ToAppRoleAssignmentArrayOutput() AppRoleAssignmentArrayOutput

func (AppRoleAssignmentArrayOutput) ToAppRoleAssignmentArrayOutputWithContext added in v5.3.0

func (o AppRoleAssignmentArrayOutput) ToAppRoleAssignmentArrayOutputWithContext(ctx context.Context) AppRoleAssignmentArrayOutput

type AppRoleAssignmentInput added in v5.3.0

type AppRoleAssignmentInput interface {
	pulumi.Input

	ToAppRoleAssignmentOutput() AppRoleAssignmentOutput
	ToAppRoleAssignmentOutputWithContext(ctx context.Context) AppRoleAssignmentOutput
}

type AppRoleAssignmentMap added in v5.3.0

type AppRoleAssignmentMap map[string]AppRoleAssignmentInput

func (AppRoleAssignmentMap) ElementType added in v5.3.0

func (AppRoleAssignmentMap) ElementType() reflect.Type

func (AppRoleAssignmentMap) ToAppRoleAssignmentMapOutput added in v5.3.0

func (i AppRoleAssignmentMap) ToAppRoleAssignmentMapOutput() AppRoleAssignmentMapOutput

func (AppRoleAssignmentMap) ToAppRoleAssignmentMapOutputWithContext added in v5.3.0

func (i AppRoleAssignmentMap) ToAppRoleAssignmentMapOutputWithContext(ctx context.Context) AppRoleAssignmentMapOutput

type AppRoleAssignmentMapInput added in v5.3.0

type AppRoleAssignmentMapInput interface {
	pulumi.Input

	ToAppRoleAssignmentMapOutput() AppRoleAssignmentMapOutput
	ToAppRoleAssignmentMapOutputWithContext(context.Context) AppRoleAssignmentMapOutput
}

AppRoleAssignmentMapInput is an input type that accepts AppRoleAssignmentMap and AppRoleAssignmentMapOutput values. You can construct a concrete instance of `AppRoleAssignmentMapInput` via:

AppRoleAssignmentMap{ "key": AppRoleAssignmentArgs{...} }

type AppRoleAssignmentMapOutput added in v5.3.0

type AppRoleAssignmentMapOutput struct{ *pulumi.OutputState }

func (AppRoleAssignmentMapOutput) ElementType added in v5.3.0

func (AppRoleAssignmentMapOutput) ElementType() reflect.Type

func (AppRoleAssignmentMapOutput) MapIndex added in v5.3.0

func (AppRoleAssignmentMapOutput) ToAppRoleAssignmentMapOutput added in v5.3.0

func (o AppRoleAssignmentMapOutput) ToAppRoleAssignmentMapOutput() AppRoleAssignmentMapOutput

func (AppRoleAssignmentMapOutput) ToAppRoleAssignmentMapOutputWithContext added in v5.3.0

func (o AppRoleAssignmentMapOutput) ToAppRoleAssignmentMapOutputWithContext(ctx context.Context) AppRoleAssignmentMapOutput

type AppRoleAssignmentOutput added in v5.3.0

type AppRoleAssignmentOutput struct{ *pulumi.OutputState }

func (AppRoleAssignmentOutput) AppRoleId added in v5.22.0

The ID of the app role to be assigned, or the default role ID `00000000-0000-0000-0000-000000000000`. Changing this forces a new resource to be created.

func (AppRoleAssignmentOutput) ElementType added in v5.3.0

func (AppRoleAssignmentOutput) ElementType() reflect.Type

func (AppRoleAssignmentOutput) PrincipalDisplayName added in v5.22.0

func (o AppRoleAssignmentOutput) PrincipalDisplayName() pulumi.StringOutput

The display name of the principal to which the app role is assigned.

func (AppRoleAssignmentOutput) PrincipalObjectId added in v5.22.0

func (o AppRoleAssignmentOutput) PrincipalObjectId() pulumi.StringOutput

The object ID of the user, group or service principal to be assigned this app role. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.

func (AppRoleAssignmentOutput) PrincipalType added in v5.22.0

func (o AppRoleAssignmentOutput) PrincipalType() pulumi.StringOutput

The object type of the principal to which the app role is assigned.

func (AppRoleAssignmentOutput) ResourceDisplayName added in v5.22.0

func (o AppRoleAssignmentOutput) ResourceDisplayName() pulumi.StringOutput

The display name of the application representing the resource.

func (AppRoleAssignmentOutput) ResourceObjectId added in v5.22.0

func (o AppRoleAssignmentOutput) ResourceObjectId() pulumi.StringOutput

The object ID of the service principal representing the resource. Changing this forces a new resource to be created.

func (AppRoleAssignmentOutput) ToAppRoleAssignmentOutput added in v5.3.0

func (o AppRoleAssignmentOutput) ToAppRoleAssignmentOutput() AppRoleAssignmentOutput

func (AppRoleAssignmentOutput) ToAppRoleAssignmentOutputWithContext added in v5.3.0

func (o AppRoleAssignmentOutput) ToAppRoleAssignmentOutputWithContext(ctx context.Context) AppRoleAssignmentOutput

type AppRoleAssignmentState added in v5.3.0

type AppRoleAssignmentState struct {
	// The ID of the app role to be assigned, or the default role ID `00000000-0000-0000-0000-000000000000`. Changing this forces a new resource to be created.
	AppRoleId pulumi.StringPtrInput
	// The display name of the principal to which the app role is assigned.
	PrincipalDisplayName pulumi.StringPtrInput
	// The object ID of the user, group or service principal to be assigned this app role. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	PrincipalObjectId pulumi.StringPtrInput
	// The object type of the principal to which the app role is assigned.
	PrincipalType pulumi.StringPtrInput
	// The display name of the application representing the resource.
	ResourceDisplayName pulumi.StringPtrInput
	// The object ID of the service principal representing the resource. Changing this forces a new resource to be created.
	ResourceObjectId pulumi.StringPtrInput
}

func (AppRoleAssignmentState) ElementType added in v5.3.0

func (AppRoleAssignmentState) ElementType() reflect.Type

type Application

type Application struct {
	pulumi.CustomResourceState

	// An `api` block as documented below, which configures API related settings for this application.
	Api ApplicationApiPtrOutput `pulumi:"api"`
	// A mapping of app role values to app role IDs, intended to be useful when referencing app roles in other resources in your configuration.
	AppRoleIds pulumi.StringMapOutput `pulumi:"appRoleIds"`
	// A collection of `appRole` blocks as documented below. For more information see [official documentation on Application Roles](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).
	AppRoles ApplicationAppRoleTypeArrayOutput `pulumi:"appRoles"`
	// The Application ID (also called Client ID)
	//
	// Deprecated: The `applicationId` attribute has been replaced by the `clientId` attribute and will be removed in version 3.0 of the AzureAD provider
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The Client ID for the application.
	ClientId pulumi.StringOutput `pulumi:"clientId"`
	// A description of the application, as shown to end users.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies whether this application supports device authentication without a user. Defaults to `false`.
	DeviceOnlyAuthEnabled pulumi.BoolPtrOutput `pulumi:"deviceOnlyAuthEnabled"`
	// Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. `DisabledDueToViolationOfServicesAgreement`
	DisabledByMicrosoft pulumi.StringOutput `pulumi:"disabledByMicrosoft"`
	// The display name for the application.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Specifies whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI. Defaults to `false`.
	FallbackPublicClientEnabled pulumi.BoolPtrOutput `pulumi:"fallbackPublicClientEnabled"`
	// A `featureTags` block as described below. Cannot be used together with the `tags` property.
	//
	// > **Features and Tags** Features are configured for an application using tags, and are provided as a shortcut to set the corresponding magic tag value for each feature. You cannot configure `featureTags` and `tags` for an application at the same time, so if you need to assign additional custom tags it's recommended to use the `tags` property instead. Tag values also propagate to any linked service principals.
	FeatureTags ApplicationFeatureTagArrayOutput `pulumi:"featureTags"`
	// Configures the `groups` claim issued in a user or OAuth 2.0 access token that the app expects. Possible values are `None`, `SecurityGroup`, `DirectoryRole`, `ApplicationGroup` or `All`.
	GroupMembershipClaims pulumi.StringArrayOutput `pulumi:"groupMembershipClaims"`
	// A set of user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant.
	IdentifierUris pulumi.StringArrayOutput `pulumi:"identifierUris"`
	// A logo image to upload for the application, as a raw base64-encoded string. The image should be in gif, jpeg or png format. Note that once an image has been uploaded, it is not possible to remove it without replacing it with another image.
	LogoImage pulumi.StringPtrOutput `pulumi:"logoImage"`
	// CDN URL to the application's logo, as uploaded with the `logoImage` property.
	LogoUrl pulumi.StringOutput `pulumi:"logoUrl"`
	// URL of the application's marketing page.
	MarketingUrl pulumi.StringPtrOutput `pulumi:"marketingUrl"`
	// User-specified notes relevant for the management of the application.
	Notes pulumi.StringPtrOutput `pulumi:"notes"`
	// A mapping of OAuth2.0 permission scope values to scope IDs, intended to be useful when referencing permission scopes in other resources in your configuration.
	Oauth2PermissionScopeIds pulumi.StringMapOutput `pulumi:"oauth2PermissionScopeIds"`
	// Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. Defaults to `false`, which specifies that only GET requests are allowed.
	Oauth2PostResponseRequired pulumi.BoolPtrOutput `pulumi:"oauth2PostResponseRequired"`
	// The application's object ID.
	ObjectId pulumi.StringOutput `pulumi:"objectId"`
	// An `optionalClaims` block as documented below.
	OptionalClaims ApplicationOptionalClaimsTypePtrOutput `pulumi:"optionalClaims"`
	// A list of object IDs of principals that will be granted ownership of the application
	Owners pulumi.StringArrayOutput `pulumi:"owners"`
	// If `true`, will return an error if an existing application is found with the same name. Defaults to `false`.
	PreventDuplicateNames pulumi.BoolPtrOutput `pulumi:"preventDuplicateNames"`
	// URL of the application's privacy statement.
	PrivacyStatementUrl pulumi.StringPtrOutput `pulumi:"privacyStatementUrl"`
	// A `publicClient` block as documented below, which configures non-web app or non-web API application settings, for example mobile or other public clients such as an installed application running on a desktop device.
	PublicClient ApplicationPublicClientPtrOutput `pulumi:"publicClient"`
	// The verified publisher domain for the application.
	PublisherDomain pulumi.StringOutput `pulumi:"publisherDomain"`
	// A collection of `requiredResourceAccess` blocks as documented below.
	RequiredResourceAccesses ApplicationRequiredResourceAccessArrayOutput `pulumi:"requiredResourceAccesses"`
	// References application context information from a Service or Asset Management database.
	ServiceManagementReference pulumi.StringPtrOutput `pulumi:"serviceManagementReference"`
	// The Microsoft account types that are supported for the current application. Must be one of `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`. Defaults to `AzureADMyOrg`.
	//
	// > **Changing `signInAudience` for existing applications** When updating an existing application to use a `signInAudience` value of `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`, your configuration may no longer be valid. Refer to [official documentation](https://docs.microsoft.com/en-gb/azure/active-directory/develop/supported-accounts-validation) to understand the differences in supported configurations. Where possible, the provider will attempt to validate your configuration and try to avoid applying unsupported settings to your application.
	SignInAudience pulumi.StringPtrOutput `pulumi:"signInAudience"`
	// A `singlePageApplication` block as documented below, which configures single-page application (SPA) related settings for this application.
	SinglePageApplication ApplicationSinglePageApplicationPtrOutput `pulumi:"singlePageApplication"`
	// URL of the application's support page.
	SupportUrl pulumi.StringPtrOutput `pulumi:"supportUrl"`
	// A set of tags to apply to the application for configuring specific behaviours of the application and linked service principals. Note that these are not provided for use by practitioners. Cannot be used together with the `featureTags` block.
	//
	// > **Tags and Features** Azure Active Directory uses special tag values to configure the behavior of applications. These can be specified using either the `tags` property or with the `featureTags` block. If you need to set any custom tag values not supported by the `featureTags` block, it's recommended to use the `tags` property. Tag values also propagate to any linked service principals.
	Tags pulumi.StringArrayOutput `pulumi:"tags"`
	// Unique ID for a templated application in the Azure AD App Gallery, from which to create the application. Changing this forces a new resource to be created.
	//
	// > **Tip for Gallery Applications** This resource can  be used to instantiate a gallery application, however it will also attempt to manage the properties of the resulting application. If this is not desired, consider using the ApplicationRegistration resource instead.
	TemplateId pulumi.StringOutput `pulumi:"templateId"`
	// URL of the application's terms of service statement.
	TermsOfServiceUrl pulumi.StringPtrOutput `pulumi:"termsOfServiceUrl"`
	// A `web` block as documented below, which configures web related settings for this application.
	//
	// > **Application Name Uniqueness** Application names are not unique within Azure Active Directory. Use the `preventDuplicateNames` argument to check for existing applications if you want to avoid name collisions.
	Web ApplicationWebPtrOutput `pulumi:"web"`
}

## Example Usage

*Create an application*

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := azuread.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
			Input: "/path/to/logo.png",
		}, nil)
		if err != nil {
			return err
		}
		_, err = azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			IdentifierUris: pulumi.StringArray{
				pulumi.String("api://example-app"),
			},
			LogoImage: invokeFilebase64.Result,
			Owners: pulumi.StringArray{
				pulumi.String(current.ObjectId),
			},
			SignInAudience: pulumi.String("AzureADMultipleOrgs"),
			Api: &azuread.ApplicationApiArgs{
				MappedClaimsEnabled:         pulumi.Bool(true),
				RequestedAccessTokenVersion: pulumi.Int(2),
				KnownClientApplications: pulumi.StringArray{
					known1.ApplicationId,
					known2.ApplicationId,
				},
				Oauth2PermissionScopes: azuread.ApplicationApiOauth2PermissionScopeArray{
					&azuread.ApplicationApiOauth2PermissionScopeArgs{
						AdminConsentDescription: pulumi.String("Allow the application to access example on behalf of the signed-in user."),
						AdminConsentDisplayName: pulumi.String("Access example"),
						Enabled:                 pulumi.Bool(true),
						Id:                      pulumi.String("96183846-204b-4b43-82e1-5d2222eb4b9b"),
						Type:                    pulumi.String("User"),
						UserConsentDescription:  pulumi.String("Allow the application to access example on your behalf."),
						UserConsentDisplayName:  pulumi.String("Access example"),
						Value:                   pulumi.String("user_impersonation"),
					},
					&azuread.ApplicationApiOauth2PermissionScopeArgs{
						AdminConsentDescription: pulumi.String("Administer the example application"),
						AdminConsentDisplayName: pulumi.String("Administer"),
						Enabled:                 pulumi.Bool(true),
						Id:                      pulumi.String("be98fa3e-ab5b-4b11-83d9-04ba2b7946bc"),
						Type:                    pulumi.String("Admin"),
						Value:                   pulumi.String("administer"),
					},
				},
			},
			AppRoles: azuread.ApplicationAppRoleTypeArray{
				&azuread.ApplicationAppRoleTypeArgs{
					AllowedMemberTypes: pulumi.StringArray{
						pulumi.String("User"),
						pulumi.String("Application"),
					},
					Description: pulumi.String("Admins can manage roles and perform all task actions"),
					DisplayName: pulumi.String("Admin"),
					Enabled:     pulumi.Bool(true),
					Id:          pulumi.String("1b19509b-32b1-4e9f-b71d-4992aa991967"),
					Value:       pulumi.String("admin"),
				},
				&azuread.ApplicationAppRoleTypeArgs{
					AllowedMemberTypes: pulumi.StringArray{
						pulumi.String("User"),
					},
					Description: pulumi.String("ReadOnly roles have limited query access"),
					DisplayName: pulumi.String("ReadOnly"),
					Enabled:     pulumi.Bool(true),
					Id:          pulumi.String("497406e4-012a-4267-bf18-45a1cb148a01"),
					Value:       pulumi.String("User"),
				},
			},
			FeatureTags: azuread.ApplicationFeatureTagArray{
				&azuread.ApplicationFeatureTagArgs{
					Enterprise: pulumi.Bool(true),
					Gallery:    pulumi.Bool(true),
				},
			},
			OptionalClaims: &azuread.ApplicationOptionalClaimsTypeArgs{
				AccessTokens: azuread.ApplicationOptionalClaimsAccessTokenArray{
					&azuread.ApplicationOptionalClaimsAccessTokenArgs{
						Name: pulumi.String("myclaim"),
					},
					&azuread.ApplicationOptionalClaimsAccessTokenArgs{
						Name: pulumi.String("otherclaim"),
					},
				},
				IdTokens: azuread.ApplicationOptionalClaimsIdTokenArray{
					&azuread.ApplicationOptionalClaimsIdTokenArgs{
						Name:      pulumi.String("userclaim"),
						Source:    pulumi.String("user"),
						Essential: pulumi.Bool(true),
						AdditionalProperties: pulumi.StringArray{
							pulumi.String("emit_as_roles"),
						},
					},
				},
				Saml2Tokens: azuread.ApplicationOptionalClaimsSaml2TokenArray{
					&azuread.ApplicationOptionalClaimsSaml2TokenArgs{
						Name: pulumi.String("samlexample"),
					},
				},
			},
			RequiredResourceAccesses: azuread.ApplicationRequiredResourceAccessArray{
				&azuread.ApplicationRequiredResourceAccessArgs{
					ResourceAppId: pulumi.String("00000003-0000-0000-c000-000000000000"),
					ResourceAccesses: azuread.ApplicationRequiredResourceAccessResourceAccessArray{
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id:   pulumi.String("df021288-bdef-4463-88db-98f22de89214"),
							Type: pulumi.String("Role"),
						},
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id:   pulumi.String("b4e74841-8e56-480b-be8b-910348b18b4c"),
							Type: pulumi.String("Scope"),
						},
					},
				},
				&azuread.ApplicationRequiredResourceAccessArgs{
					ResourceAppId: pulumi.String("c5393580-f805-4401-95e8-94b7a6ef2fc2"),
					ResourceAccesses: azuread.ApplicationRequiredResourceAccessResourceAccessArray{
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id:   pulumi.String("594c1fb6-4f81-4475-ae41-0c394909246c"),
							Type: pulumi.String("Role"),
						},
					},
				},
			},
			Web: &azuread.ApplicationWebArgs{
				HomepageUrl: pulumi.String("https://app.example.net"),
				LogoutUrl:   pulumi.String("https://app.example.net/logout"),
				RedirectUris: pulumi.StringArray{
					pulumi.String("https://app.example.net/account"),
				},
				ImplicitGrant: &azuread.ApplicationWebImplicitGrantArgs{
					AccessTokenIssuanceEnabled: pulumi.Bool(true),
					IdTokenIssuanceEnabled:     pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Create application from a gallery template*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.GetApplicationTemplate(ctx, &azuread.GetApplicationTemplateArgs{
			DisplayName: pulumi.StringRef("Marketo"),
		}, nil)
		if err != nil {
			return err
		}
		exampleApplication, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			TemplateId:  pulumi.String(example.TemplateId),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ApplicationId: exampleApplication.ApplicationId,
			UseExisting:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Applications can be imported using the object ID of the application, in the following format.

```sh $ pulumi import azuread:index/application:Application example /applications/00000000-0000-0000-0000-000000000000 ```

func GetApplication

func GetApplication(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationState, opts ...pulumi.ResourceOption) (*Application, error)

GetApplication gets an existing Application resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplication

func NewApplication(ctx *pulumi.Context,
	name string, args *ApplicationArgs, opts ...pulumi.ResourceOption) (*Application, error)

NewApplication registers a new resource with the given unique name, arguments, and options.

func (*Application) ElementType

func (*Application) ElementType() reflect.Type

func (*Application) ToApplicationOutput

func (i *Application) ToApplicationOutput() ApplicationOutput

func (*Application) ToApplicationOutputWithContext

func (i *Application) ToApplicationOutputWithContext(ctx context.Context) ApplicationOutput

type ApplicationApi

type ApplicationApi struct {
	// A set of application IDs (client IDs), used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.
	KnownClientApplications []string `pulumi:"knownClientApplications"`
	// Allows an application to use claims mapping without specifying a custom signing key. Defaults to `false`.
	MappedClaimsEnabled *bool `pulumi:"mappedClaimsEnabled"`
	// One or more `oauth2PermissionScope` blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.
	Oauth2PermissionScopes []ApplicationApiOauth2PermissionScope `pulumi:"oauth2PermissionScopes"`
	// The access token version expected by this resource. Must be one of `1` or `2`, and must be `2` when `signInAudience` is either `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount` Defaults to `1`.
	RequestedAccessTokenVersion *int `pulumi:"requestedAccessTokenVersion"`
}

type ApplicationApiAccess added in v5.43.0

type ApplicationApiAccess struct {
	pulumi.CustomResourceState

	// The client ID of the API to which access is being granted. Changing this forces a new resource to be created.
	ApiClientId pulumi.StringOutput `pulumi:"apiClientId"`
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// A set of role IDs to be granted to the application, as published by the API.
	RoleIds pulumi.StringArrayOutput `pulumi:"roleIds"`
	// A set of scope IDs to be granted to the application, as published by the API.
	//
	// > At least one of `roleIds` or `scopeIds` must be specified.
	ScopeIds pulumi.StringArrayOutput `pulumi:"scopeIds"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		wellKnown, err := azuread.GetApplicationPublishedAppIds(ctx, nil, nil)
		if err != nil {
			return err
		}
		msgraph, err := azuread.LookupServicePrincipal(ctx, &azuread.LookupServicePrincipalArgs{
			ClientId: pulumi.StringRef(wellKnown.Result.MicrosoftGraph),
		}, nil)
		if err != nil {
			return err
		}
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationApiAccess(ctx, "example_msgraph", &azuread.ApplicationApiAccessArgs{
			ApplicationId: example.ID(),
			ApiClientId:   pulumi.String(wellKnown.Result.MicrosoftGraph),
			RoleIds: pulumi.StringArray{
				pulumi.String(msgraph.AppRoleIds.Group.Read.All),
				pulumi.String(msgraph.AppRoleIds.User.Read.All),
			},
			ScopeIds: pulumi.StringArray{
				pulumi.String(msgraph.Oauth2PermissionScopeIds.User.ReadWrite),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

> **Tip** For managing permissions for an additional API, create another instance of this resource

*Usage with Application resource*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationApiAccess(ctx, "example", &azuread.ApplicationApiAccessArgs{
			ApplicationId: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Application API Access can be imported using the object ID of the application and the client ID of the API, in the following format.

```sh $ pulumi import azuread:index/applicationApiAccess:ApplicationApiAccess example /applications/00000000-0000-0000-0000-000000000000/apiAccess/11111111-1111-1111-1111-111111111111 ```

func GetApplicationApiAccess added in v5.43.0

func GetApplicationApiAccess(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationApiAccessState, opts ...pulumi.ResourceOption) (*ApplicationApiAccess, error)

GetApplicationApiAccess gets an existing ApplicationApiAccess resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationApiAccess added in v5.43.0

func NewApplicationApiAccess(ctx *pulumi.Context,
	name string, args *ApplicationApiAccessArgs, opts ...pulumi.ResourceOption) (*ApplicationApiAccess, error)

NewApplicationApiAccess registers a new resource with the given unique name, arguments, and options.

func (*ApplicationApiAccess) ElementType added in v5.43.0

func (*ApplicationApiAccess) ElementType() reflect.Type

func (*ApplicationApiAccess) ToApplicationApiAccessOutput added in v5.43.0

func (i *ApplicationApiAccess) ToApplicationApiAccessOutput() ApplicationApiAccessOutput

func (*ApplicationApiAccess) ToApplicationApiAccessOutputWithContext added in v5.43.0

func (i *ApplicationApiAccess) ToApplicationApiAccessOutputWithContext(ctx context.Context) ApplicationApiAccessOutput

type ApplicationApiAccessArgs added in v5.43.0

type ApplicationApiAccessArgs struct {
	// The client ID of the API to which access is being granted. Changing this forces a new resource to be created.
	ApiClientId pulumi.StringInput
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringInput
	// A set of role IDs to be granted to the application, as published by the API.
	RoleIds pulumi.StringArrayInput
	// A set of scope IDs to be granted to the application, as published by the API.
	//
	// > At least one of `roleIds` or `scopeIds` must be specified.
	ScopeIds pulumi.StringArrayInput
}

The set of arguments for constructing a ApplicationApiAccess resource.

func (ApplicationApiAccessArgs) ElementType added in v5.43.0

func (ApplicationApiAccessArgs) ElementType() reflect.Type

type ApplicationApiAccessArray added in v5.43.0

type ApplicationApiAccessArray []ApplicationApiAccessInput

func (ApplicationApiAccessArray) ElementType added in v5.43.0

func (ApplicationApiAccessArray) ElementType() reflect.Type

func (ApplicationApiAccessArray) ToApplicationApiAccessArrayOutput added in v5.43.0

func (i ApplicationApiAccessArray) ToApplicationApiAccessArrayOutput() ApplicationApiAccessArrayOutput

func (ApplicationApiAccessArray) ToApplicationApiAccessArrayOutputWithContext added in v5.43.0

func (i ApplicationApiAccessArray) ToApplicationApiAccessArrayOutputWithContext(ctx context.Context) ApplicationApiAccessArrayOutput

type ApplicationApiAccessArrayInput added in v5.43.0

type ApplicationApiAccessArrayInput interface {
	pulumi.Input

	ToApplicationApiAccessArrayOutput() ApplicationApiAccessArrayOutput
	ToApplicationApiAccessArrayOutputWithContext(context.Context) ApplicationApiAccessArrayOutput
}

ApplicationApiAccessArrayInput is an input type that accepts ApplicationApiAccessArray and ApplicationApiAccessArrayOutput values. You can construct a concrete instance of `ApplicationApiAccessArrayInput` via:

ApplicationApiAccessArray{ ApplicationApiAccessArgs{...} }

type ApplicationApiAccessArrayOutput added in v5.43.0

type ApplicationApiAccessArrayOutput struct{ *pulumi.OutputState }

func (ApplicationApiAccessArrayOutput) ElementType added in v5.43.0

func (ApplicationApiAccessArrayOutput) Index added in v5.43.0

func (ApplicationApiAccessArrayOutput) ToApplicationApiAccessArrayOutput added in v5.43.0

func (o ApplicationApiAccessArrayOutput) ToApplicationApiAccessArrayOutput() ApplicationApiAccessArrayOutput

func (ApplicationApiAccessArrayOutput) ToApplicationApiAccessArrayOutputWithContext added in v5.43.0

func (o ApplicationApiAccessArrayOutput) ToApplicationApiAccessArrayOutputWithContext(ctx context.Context) ApplicationApiAccessArrayOutput

type ApplicationApiAccessInput added in v5.43.0

type ApplicationApiAccessInput interface {
	pulumi.Input

	ToApplicationApiAccessOutput() ApplicationApiAccessOutput
	ToApplicationApiAccessOutputWithContext(ctx context.Context) ApplicationApiAccessOutput
}

type ApplicationApiAccessMap added in v5.43.0

type ApplicationApiAccessMap map[string]ApplicationApiAccessInput

func (ApplicationApiAccessMap) ElementType added in v5.43.0

func (ApplicationApiAccessMap) ElementType() reflect.Type

func (ApplicationApiAccessMap) ToApplicationApiAccessMapOutput added in v5.43.0

func (i ApplicationApiAccessMap) ToApplicationApiAccessMapOutput() ApplicationApiAccessMapOutput

func (ApplicationApiAccessMap) ToApplicationApiAccessMapOutputWithContext added in v5.43.0

func (i ApplicationApiAccessMap) ToApplicationApiAccessMapOutputWithContext(ctx context.Context) ApplicationApiAccessMapOutput

type ApplicationApiAccessMapInput added in v5.43.0

type ApplicationApiAccessMapInput interface {
	pulumi.Input

	ToApplicationApiAccessMapOutput() ApplicationApiAccessMapOutput
	ToApplicationApiAccessMapOutputWithContext(context.Context) ApplicationApiAccessMapOutput
}

ApplicationApiAccessMapInput is an input type that accepts ApplicationApiAccessMap and ApplicationApiAccessMapOutput values. You can construct a concrete instance of `ApplicationApiAccessMapInput` via:

ApplicationApiAccessMap{ "key": ApplicationApiAccessArgs{...} }

type ApplicationApiAccessMapOutput added in v5.43.0

type ApplicationApiAccessMapOutput struct{ *pulumi.OutputState }

func (ApplicationApiAccessMapOutput) ElementType added in v5.43.0

func (ApplicationApiAccessMapOutput) MapIndex added in v5.43.0

func (ApplicationApiAccessMapOutput) ToApplicationApiAccessMapOutput added in v5.43.0

func (o ApplicationApiAccessMapOutput) ToApplicationApiAccessMapOutput() ApplicationApiAccessMapOutput

func (ApplicationApiAccessMapOutput) ToApplicationApiAccessMapOutputWithContext added in v5.43.0

func (o ApplicationApiAccessMapOutput) ToApplicationApiAccessMapOutputWithContext(ctx context.Context) ApplicationApiAccessMapOutput

type ApplicationApiAccessOutput added in v5.43.0

type ApplicationApiAccessOutput struct{ *pulumi.OutputState }

func (ApplicationApiAccessOutput) ApiClientId added in v5.43.0

The client ID of the API to which access is being granted. Changing this forces a new resource to be created.

func (ApplicationApiAccessOutput) ApplicationId added in v5.43.0

The resource ID of the application registration. Changing this forces a new resource to be created.

func (ApplicationApiAccessOutput) ElementType added in v5.43.0

func (ApplicationApiAccessOutput) ElementType() reflect.Type

func (ApplicationApiAccessOutput) RoleIds added in v5.43.0

A set of role IDs to be granted to the application, as published by the API.

func (ApplicationApiAccessOutput) ScopeIds added in v5.43.0

A set of scope IDs to be granted to the application, as published by the API.

> At least one of `roleIds` or `scopeIds` must be specified.

func (ApplicationApiAccessOutput) ToApplicationApiAccessOutput added in v5.43.0

func (o ApplicationApiAccessOutput) ToApplicationApiAccessOutput() ApplicationApiAccessOutput

func (ApplicationApiAccessOutput) ToApplicationApiAccessOutputWithContext added in v5.43.0

func (o ApplicationApiAccessOutput) ToApplicationApiAccessOutputWithContext(ctx context.Context) ApplicationApiAccessOutput

type ApplicationApiAccessState added in v5.43.0

type ApplicationApiAccessState struct {
	// The client ID of the API to which access is being granted. Changing this forces a new resource to be created.
	ApiClientId pulumi.StringPtrInput
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// A set of role IDs to be granted to the application, as published by the API.
	RoleIds pulumi.StringArrayInput
	// A set of scope IDs to be granted to the application, as published by the API.
	//
	// > At least one of `roleIds` or `scopeIds` must be specified.
	ScopeIds pulumi.StringArrayInput
}

func (ApplicationApiAccessState) ElementType added in v5.43.0

func (ApplicationApiAccessState) ElementType() reflect.Type

type ApplicationApiArgs

type ApplicationApiArgs struct {
	// A set of application IDs (client IDs), used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.
	KnownClientApplications pulumi.StringArrayInput `pulumi:"knownClientApplications"`
	// Allows an application to use claims mapping without specifying a custom signing key. Defaults to `false`.
	MappedClaimsEnabled pulumi.BoolPtrInput `pulumi:"mappedClaimsEnabled"`
	// One or more `oauth2PermissionScope` blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.
	Oauth2PermissionScopes ApplicationApiOauth2PermissionScopeArrayInput `pulumi:"oauth2PermissionScopes"`
	// The access token version expected by this resource. Must be one of `1` or `2`, and must be `2` when `signInAudience` is either `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount` Defaults to `1`.
	RequestedAccessTokenVersion pulumi.IntPtrInput `pulumi:"requestedAccessTokenVersion"`
}

func (ApplicationApiArgs) ElementType

func (ApplicationApiArgs) ElementType() reflect.Type

func (ApplicationApiArgs) ToApplicationApiOutput

func (i ApplicationApiArgs) ToApplicationApiOutput() ApplicationApiOutput

func (ApplicationApiArgs) ToApplicationApiOutputWithContext

func (i ApplicationApiArgs) ToApplicationApiOutputWithContext(ctx context.Context) ApplicationApiOutput

func (ApplicationApiArgs) ToApplicationApiPtrOutput

func (i ApplicationApiArgs) ToApplicationApiPtrOutput() ApplicationApiPtrOutput

func (ApplicationApiArgs) ToApplicationApiPtrOutputWithContext

func (i ApplicationApiArgs) ToApplicationApiPtrOutputWithContext(ctx context.Context) ApplicationApiPtrOutput

type ApplicationApiInput

type ApplicationApiInput interface {
	pulumi.Input

	ToApplicationApiOutput() ApplicationApiOutput
	ToApplicationApiOutputWithContext(context.Context) ApplicationApiOutput
}

ApplicationApiInput is an input type that accepts ApplicationApiArgs and ApplicationApiOutput values. You can construct a concrete instance of `ApplicationApiInput` via:

ApplicationApiArgs{...}

type ApplicationApiOauth2PermissionScope

type ApplicationApiOauth2PermissionScope struct {
	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription *string `pulumi:"adminConsentDescription"`
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName *string `pulumi:"adminConsentDisplayName"`
	// Determines if the permission scope is enabled. Defaults to `true`.
	Enabled *bool `pulumi:"enabled"`
	// The unique identifier of the delegated permission. Must be a valid UUID.
	//
	// > **Tip: Generating a UUID for the `id` field** To generate a value for the `id` field in cases where the actual UUID is not important, you can use the `randomUuid` resource. See the application example in the provider repository.
	Id string `pulumi:"id"`
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Defaults to `User`. Possible values are `User` or `Admin`.
	Type *string `pulumi:"type"`
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription *string `pulumi:"userConsentDescription"`
	// Display name for the delegated permission that appears in the end user consent experience.
	UserConsentDisplayName *string `pulumi:"userConsentDisplayName"`
	// The value that is used for the `scp` claim in OAuth 2.0 access tokens
	Value *string `pulumi:"value"`
}

type ApplicationApiOauth2PermissionScopeArgs

type ApplicationApiOauth2PermissionScopeArgs struct {
	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription pulumi.StringPtrInput `pulumi:"adminConsentDescription"`
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName pulumi.StringPtrInput `pulumi:"adminConsentDisplayName"`
	// Determines if the permission scope is enabled. Defaults to `true`.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
	// The unique identifier of the delegated permission. Must be a valid UUID.
	//
	// > **Tip: Generating a UUID for the `id` field** To generate a value for the `id` field in cases where the actual UUID is not important, you can use the `randomUuid` resource. See the application example in the provider repository.
	Id pulumi.StringInput `pulumi:"id"`
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Defaults to `User`. Possible values are `User` or `Admin`.
	Type pulumi.StringPtrInput `pulumi:"type"`
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription pulumi.StringPtrInput `pulumi:"userConsentDescription"`
	// Display name for the delegated permission that appears in the end user consent experience.
	UserConsentDisplayName pulumi.StringPtrInput `pulumi:"userConsentDisplayName"`
	// The value that is used for the `scp` claim in OAuth 2.0 access tokens
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (ApplicationApiOauth2PermissionScopeArgs) ElementType

func (ApplicationApiOauth2PermissionScopeArgs) ToApplicationApiOauth2PermissionScopeOutput

func (i ApplicationApiOauth2PermissionScopeArgs) ToApplicationApiOauth2PermissionScopeOutput() ApplicationApiOauth2PermissionScopeOutput

func (ApplicationApiOauth2PermissionScopeArgs) ToApplicationApiOauth2PermissionScopeOutputWithContext

func (i ApplicationApiOauth2PermissionScopeArgs) ToApplicationApiOauth2PermissionScopeOutputWithContext(ctx context.Context) ApplicationApiOauth2PermissionScopeOutput

type ApplicationApiOauth2PermissionScopeArray

type ApplicationApiOauth2PermissionScopeArray []ApplicationApiOauth2PermissionScopeInput

func (ApplicationApiOauth2PermissionScopeArray) ElementType

func (ApplicationApiOauth2PermissionScopeArray) ToApplicationApiOauth2PermissionScopeArrayOutput

func (i ApplicationApiOauth2PermissionScopeArray) ToApplicationApiOauth2PermissionScopeArrayOutput() ApplicationApiOauth2PermissionScopeArrayOutput

func (ApplicationApiOauth2PermissionScopeArray) ToApplicationApiOauth2PermissionScopeArrayOutputWithContext

func (i ApplicationApiOauth2PermissionScopeArray) ToApplicationApiOauth2PermissionScopeArrayOutputWithContext(ctx context.Context) ApplicationApiOauth2PermissionScopeArrayOutput

type ApplicationApiOauth2PermissionScopeArrayInput

type ApplicationApiOauth2PermissionScopeArrayInput interface {
	pulumi.Input

	ToApplicationApiOauth2PermissionScopeArrayOutput() ApplicationApiOauth2PermissionScopeArrayOutput
	ToApplicationApiOauth2PermissionScopeArrayOutputWithContext(context.Context) ApplicationApiOauth2PermissionScopeArrayOutput
}

ApplicationApiOauth2PermissionScopeArrayInput is an input type that accepts ApplicationApiOauth2PermissionScopeArray and ApplicationApiOauth2PermissionScopeArrayOutput values. You can construct a concrete instance of `ApplicationApiOauth2PermissionScopeArrayInput` via:

ApplicationApiOauth2PermissionScopeArray{ ApplicationApiOauth2PermissionScopeArgs{...} }

type ApplicationApiOauth2PermissionScopeArrayOutput

type ApplicationApiOauth2PermissionScopeArrayOutput struct{ *pulumi.OutputState }

func (ApplicationApiOauth2PermissionScopeArrayOutput) ElementType

func (ApplicationApiOauth2PermissionScopeArrayOutput) Index

func (ApplicationApiOauth2PermissionScopeArrayOutput) ToApplicationApiOauth2PermissionScopeArrayOutput

func (o ApplicationApiOauth2PermissionScopeArrayOutput) ToApplicationApiOauth2PermissionScopeArrayOutput() ApplicationApiOauth2PermissionScopeArrayOutput

func (ApplicationApiOauth2PermissionScopeArrayOutput) ToApplicationApiOauth2PermissionScopeArrayOutputWithContext

func (o ApplicationApiOauth2PermissionScopeArrayOutput) ToApplicationApiOauth2PermissionScopeArrayOutputWithContext(ctx context.Context) ApplicationApiOauth2PermissionScopeArrayOutput

type ApplicationApiOauth2PermissionScopeInput

type ApplicationApiOauth2PermissionScopeInput interface {
	pulumi.Input

	ToApplicationApiOauth2PermissionScopeOutput() ApplicationApiOauth2PermissionScopeOutput
	ToApplicationApiOauth2PermissionScopeOutputWithContext(context.Context) ApplicationApiOauth2PermissionScopeOutput
}

ApplicationApiOauth2PermissionScopeInput is an input type that accepts ApplicationApiOauth2PermissionScopeArgs and ApplicationApiOauth2PermissionScopeOutput values. You can construct a concrete instance of `ApplicationApiOauth2PermissionScopeInput` via:

ApplicationApiOauth2PermissionScopeArgs{...}

type ApplicationApiOauth2PermissionScopeOutput

type ApplicationApiOauth2PermissionScopeOutput struct{ *pulumi.OutputState }

func (ApplicationApiOauth2PermissionScopeOutput) AdminConsentDescription

Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.

func (ApplicationApiOauth2PermissionScopeOutput) AdminConsentDisplayName

Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.

func (ApplicationApiOauth2PermissionScopeOutput) ElementType

func (ApplicationApiOauth2PermissionScopeOutput) Enabled

Determines if the permission scope is enabled. Defaults to `true`.

func (ApplicationApiOauth2PermissionScopeOutput) Id

The unique identifier of the delegated permission. Must be a valid UUID.

> **Tip: Generating a UUID for the `id` field** To generate a value for the `id` field in cases where the actual UUID is not important, you can use the `randomUuid` resource. See the application example in the provider repository.

func (ApplicationApiOauth2PermissionScopeOutput) ToApplicationApiOauth2PermissionScopeOutput

func (o ApplicationApiOauth2PermissionScopeOutput) ToApplicationApiOauth2PermissionScopeOutput() ApplicationApiOauth2PermissionScopeOutput

func (ApplicationApiOauth2PermissionScopeOutput) ToApplicationApiOauth2PermissionScopeOutputWithContext

func (o ApplicationApiOauth2PermissionScopeOutput) ToApplicationApiOauth2PermissionScopeOutputWithContext(ctx context.Context) ApplicationApiOauth2PermissionScopeOutput

func (ApplicationApiOauth2PermissionScopeOutput) Type

Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Defaults to `User`. Possible values are `User` or `Admin`.

func (ApplicationApiOauth2PermissionScopeOutput) UserConsentDescription

Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.

func (ApplicationApiOauth2PermissionScopeOutput) UserConsentDisplayName

Display name for the delegated permission that appears in the end user consent experience.

func (ApplicationApiOauth2PermissionScopeOutput) Value

The value that is used for the `scp` claim in OAuth 2.0 access tokens

type ApplicationApiOutput

type ApplicationApiOutput struct{ *pulumi.OutputState }

func (ApplicationApiOutput) ElementType

func (ApplicationApiOutput) ElementType() reflect.Type

func (ApplicationApiOutput) KnownClientApplications

func (o ApplicationApiOutput) KnownClientApplications() pulumi.StringArrayOutput

A set of application IDs (client IDs), used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.

func (ApplicationApiOutput) MappedClaimsEnabled

func (o ApplicationApiOutput) MappedClaimsEnabled() pulumi.BoolPtrOutput

Allows an application to use claims mapping without specifying a custom signing key. Defaults to `false`.

func (ApplicationApiOutput) Oauth2PermissionScopes

One or more `oauth2PermissionScope` blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.

func (ApplicationApiOutput) RequestedAccessTokenVersion

func (o ApplicationApiOutput) RequestedAccessTokenVersion() pulumi.IntPtrOutput

The access token version expected by this resource. Must be one of `1` or `2`, and must be `2` when `signInAudience` is either `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount` Defaults to `1`.

func (ApplicationApiOutput) ToApplicationApiOutput

func (o ApplicationApiOutput) ToApplicationApiOutput() ApplicationApiOutput

func (ApplicationApiOutput) ToApplicationApiOutputWithContext

func (o ApplicationApiOutput) ToApplicationApiOutputWithContext(ctx context.Context) ApplicationApiOutput

func (ApplicationApiOutput) ToApplicationApiPtrOutput

func (o ApplicationApiOutput) ToApplicationApiPtrOutput() ApplicationApiPtrOutput

func (ApplicationApiOutput) ToApplicationApiPtrOutputWithContext

func (o ApplicationApiOutput) ToApplicationApiPtrOutputWithContext(ctx context.Context) ApplicationApiPtrOutput

type ApplicationApiPtrInput

type ApplicationApiPtrInput interface {
	pulumi.Input

	ToApplicationApiPtrOutput() ApplicationApiPtrOutput
	ToApplicationApiPtrOutputWithContext(context.Context) ApplicationApiPtrOutput
}

ApplicationApiPtrInput is an input type that accepts ApplicationApiArgs, ApplicationApiPtr and ApplicationApiPtrOutput values. You can construct a concrete instance of `ApplicationApiPtrInput` via:

        ApplicationApiArgs{...}

or:

        nil

type ApplicationApiPtrOutput

type ApplicationApiPtrOutput struct{ *pulumi.OutputState }

func (ApplicationApiPtrOutput) Elem

func (ApplicationApiPtrOutput) ElementType

func (ApplicationApiPtrOutput) ElementType() reflect.Type

func (ApplicationApiPtrOutput) KnownClientApplications

func (o ApplicationApiPtrOutput) KnownClientApplications() pulumi.StringArrayOutput

A set of application IDs (client IDs), used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.

func (ApplicationApiPtrOutput) MappedClaimsEnabled

func (o ApplicationApiPtrOutput) MappedClaimsEnabled() pulumi.BoolPtrOutput

Allows an application to use claims mapping without specifying a custom signing key. Defaults to `false`.

func (ApplicationApiPtrOutput) Oauth2PermissionScopes

One or more `oauth2PermissionScope` blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.

func (ApplicationApiPtrOutput) RequestedAccessTokenVersion

func (o ApplicationApiPtrOutput) RequestedAccessTokenVersion() pulumi.IntPtrOutput

The access token version expected by this resource. Must be one of `1` or `2`, and must be `2` when `signInAudience` is either `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount` Defaults to `1`.

func (ApplicationApiPtrOutput) ToApplicationApiPtrOutput

func (o ApplicationApiPtrOutput) ToApplicationApiPtrOutput() ApplicationApiPtrOutput

func (ApplicationApiPtrOutput) ToApplicationApiPtrOutputWithContext

func (o ApplicationApiPtrOutput) ToApplicationApiPtrOutputWithContext(ctx context.Context) ApplicationApiPtrOutput

type ApplicationAppRole

type ApplicationAppRole struct {
	pulumi.CustomResourceState

	// A set of values to specify whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications by setting to `Application`, or to both.
	AllowedMemberTypes pulumi.StringArrayOutput `pulumi:"allowedMemberTypes"`
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// Description of the app role that appears when the role is being assigned, and if the role functions as an application permissions, during the consent experiences.
	Description pulumi.StringOutput `pulumi:"description"`
	// Display name for the app role that appears during app role assignment and in consent experiences.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The unique identifier of the app role
	RoleId pulumi.StringOutput `pulumi:"roleId"`
	// The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal.
	//
	// > **Roles and Permission Scopes** In Azure Active Directory, application roles and permission scopes exported by an application share the same namespace and cannot contain duplicate values.
	Value pulumi.StringPtrOutput `pulumi:"value"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi-random/sdk/v4/go/random"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleAdministrator, err := random.NewRandomUuid(ctx, "example_administrator", nil)
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationAppRole(ctx, "example_administer", &azuread.ApplicationAppRoleArgs{
			ApplicationId: example.ID(),
			RoleId:        exampleAdministrator.ID(),
			AllowedMemberTypes: pulumi.StringArray{
				pulumi.String("User"),
			},
			Description: pulumi.String("My role description"),
			DisplayName: pulumi.String("Administer"),
			Value:       pulumi.String("admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

> **Tip** For managing more app roles, create additional instances of this resource

*Usage with Application resource*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationAppRole(ctx, "example_administer", &azuread.ApplicationAppRoleArgs{
			ApplicationId: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Application App Roles can be imported using the object ID of the application and the ID of the app role, in the following format.

```sh $ pulumi import azuread:index/applicationAppRole:ApplicationAppRole example /applications/00000000-0000-0000-0000-000000000000/appRoles/11111111-1111-1111-1111-111111111111 ```

func GetApplicationAppRole

func GetApplicationAppRole(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationAppRoleState, opts ...pulumi.ResourceOption) (*ApplicationAppRole, error)

GetApplicationAppRole gets an existing ApplicationAppRole resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationAppRole added in v5.43.0

func NewApplicationAppRole(ctx *pulumi.Context,
	name string, args *ApplicationAppRoleArgs, opts ...pulumi.ResourceOption) (*ApplicationAppRole, error)

NewApplicationAppRole registers a new resource with the given unique name, arguments, and options.

func (*ApplicationAppRole) ElementType added in v5.43.0

func (*ApplicationAppRole) ElementType() reflect.Type

func (*ApplicationAppRole) ToApplicationAppRoleOutput added in v5.43.0

func (i *ApplicationAppRole) ToApplicationAppRoleOutput() ApplicationAppRoleOutput

func (*ApplicationAppRole) ToApplicationAppRoleOutputWithContext added in v5.43.0

func (i *ApplicationAppRole) ToApplicationAppRoleOutputWithContext(ctx context.Context) ApplicationAppRoleOutput

type ApplicationAppRoleArgs

type ApplicationAppRoleArgs struct {
	// A set of values to specify whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications by setting to `Application`, or to both.
	AllowedMemberTypes pulumi.StringArrayInput
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringInput
	// Description of the app role that appears when the role is being assigned, and if the role functions as an application permissions, during the consent experiences.
	Description pulumi.StringInput
	// Display name for the app role that appears during app role assignment and in consent experiences.
	DisplayName pulumi.StringInput
	// The unique identifier of the app role
	RoleId pulumi.StringInput
	// The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal.
	//
	// > **Roles and Permission Scopes** In Azure Active Directory, application roles and permission scopes exported by an application share the same namespace and cannot contain duplicate values.
	Value pulumi.StringPtrInput
}

The set of arguments for constructing a ApplicationAppRole resource.

func (ApplicationAppRoleArgs) ElementType

func (ApplicationAppRoleArgs) ElementType() reflect.Type

type ApplicationAppRoleArray

type ApplicationAppRoleArray []ApplicationAppRoleInput

func (ApplicationAppRoleArray) ElementType

func (ApplicationAppRoleArray) ElementType() reflect.Type

func (ApplicationAppRoleArray) ToApplicationAppRoleArrayOutput

func (i ApplicationAppRoleArray) ToApplicationAppRoleArrayOutput() ApplicationAppRoleArrayOutput

func (ApplicationAppRoleArray) ToApplicationAppRoleArrayOutputWithContext

func (i ApplicationAppRoleArray) ToApplicationAppRoleArrayOutputWithContext(ctx context.Context) ApplicationAppRoleArrayOutput

type ApplicationAppRoleArrayInput

type ApplicationAppRoleArrayInput interface {
	pulumi.Input

	ToApplicationAppRoleArrayOutput() ApplicationAppRoleArrayOutput
	ToApplicationAppRoleArrayOutputWithContext(context.Context) ApplicationAppRoleArrayOutput
}

ApplicationAppRoleArrayInput is an input type that accepts ApplicationAppRoleArray and ApplicationAppRoleArrayOutput values. You can construct a concrete instance of `ApplicationAppRoleArrayInput` via:

ApplicationAppRoleArray{ ApplicationAppRoleArgs{...} }

type ApplicationAppRoleArrayOutput

type ApplicationAppRoleArrayOutput struct{ *pulumi.OutputState }

func (ApplicationAppRoleArrayOutput) ElementType

func (ApplicationAppRoleArrayOutput) Index

func (ApplicationAppRoleArrayOutput) ToApplicationAppRoleArrayOutput

func (o ApplicationAppRoleArrayOutput) ToApplicationAppRoleArrayOutput() ApplicationAppRoleArrayOutput

func (ApplicationAppRoleArrayOutput) ToApplicationAppRoleArrayOutputWithContext

func (o ApplicationAppRoleArrayOutput) ToApplicationAppRoleArrayOutputWithContext(ctx context.Context) ApplicationAppRoleArrayOutput

type ApplicationAppRoleInput

type ApplicationAppRoleInput interface {
	pulumi.Input

	ToApplicationAppRoleOutput() ApplicationAppRoleOutput
	ToApplicationAppRoleOutputWithContext(ctx context.Context) ApplicationAppRoleOutput
}

type ApplicationAppRoleMap added in v5.43.0

type ApplicationAppRoleMap map[string]ApplicationAppRoleInput

func (ApplicationAppRoleMap) ElementType added in v5.43.0

func (ApplicationAppRoleMap) ElementType() reflect.Type

func (ApplicationAppRoleMap) ToApplicationAppRoleMapOutput added in v5.43.0

func (i ApplicationAppRoleMap) ToApplicationAppRoleMapOutput() ApplicationAppRoleMapOutput

func (ApplicationAppRoleMap) ToApplicationAppRoleMapOutputWithContext added in v5.43.0

func (i ApplicationAppRoleMap) ToApplicationAppRoleMapOutputWithContext(ctx context.Context) ApplicationAppRoleMapOutput

type ApplicationAppRoleMapInput added in v5.43.0

type ApplicationAppRoleMapInput interface {
	pulumi.Input

	ToApplicationAppRoleMapOutput() ApplicationAppRoleMapOutput
	ToApplicationAppRoleMapOutputWithContext(context.Context) ApplicationAppRoleMapOutput
}

ApplicationAppRoleMapInput is an input type that accepts ApplicationAppRoleMap and ApplicationAppRoleMapOutput values. You can construct a concrete instance of `ApplicationAppRoleMapInput` via:

ApplicationAppRoleMap{ "key": ApplicationAppRoleArgs{...} }

type ApplicationAppRoleMapOutput added in v5.43.0

type ApplicationAppRoleMapOutput struct{ *pulumi.OutputState }

func (ApplicationAppRoleMapOutput) ElementType added in v5.43.0

func (ApplicationAppRoleMapOutput) MapIndex added in v5.43.0

func (ApplicationAppRoleMapOutput) ToApplicationAppRoleMapOutput added in v5.43.0

func (o ApplicationAppRoleMapOutput) ToApplicationAppRoleMapOutput() ApplicationAppRoleMapOutput

func (ApplicationAppRoleMapOutput) ToApplicationAppRoleMapOutputWithContext added in v5.43.0

func (o ApplicationAppRoleMapOutput) ToApplicationAppRoleMapOutputWithContext(ctx context.Context) ApplicationAppRoleMapOutput

type ApplicationAppRoleOutput

type ApplicationAppRoleOutput struct{ *pulumi.OutputState }

func (ApplicationAppRoleOutput) AllowedMemberTypes

func (o ApplicationAppRoleOutput) AllowedMemberTypes() pulumi.StringArrayOutput

A set of values to specify whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications by setting to `Application`, or to both.

func (ApplicationAppRoleOutput) ApplicationId added in v5.43.0

func (o ApplicationAppRoleOutput) ApplicationId() pulumi.StringOutput

The resource ID of the application registration. Changing this forces a new resource to be created.

func (ApplicationAppRoleOutput) Description

Description of the app role that appears when the role is being assigned, and if the role functions as an application permissions, during the consent experiences.

func (ApplicationAppRoleOutput) DisplayName

Display name for the app role that appears during app role assignment and in consent experiences.

func (ApplicationAppRoleOutput) ElementType

func (ApplicationAppRoleOutput) ElementType() reflect.Type

func (ApplicationAppRoleOutput) RoleId added in v5.43.0

The unique identifier of the app role

func (ApplicationAppRoleOutput) ToApplicationAppRoleOutput

func (o ApplicationAppRoleOutput) ToApplicationAppRoleOutput() ApplicationAppRoleOutput

func (ApplicationAppRoleOutput) ToApplicationAppRoleOutputWithContext

func (o ApplicationAppRoleOutput) ToApplicationAppRoleOutputWithContext(ctx context.Context) ApplicationAppRoleOutput

func (ApplicationAppRoleOutput) Value

The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal.

> **Roles and Permission Scopes** In Azure Active Directory, application roles and permission scopes exported by an application share the same namespace and cannot contain duplicate values.

type ApplicationAppRoleState added in v5.43.0

type ApplicationAppRoleState struct {
	// A set of values to specify whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications by setting to `Application`, or to both.
	AllowedMemberTypes pulumi.StringArrayInput
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// Description of the app role that appears when the role is being assigned, and if the role functions as an application permissions, during the consent experiences.
	Description pulumi.StringPtrInput
	// Display name for the app role that appears during app role assignment and in consent experiences.
	DisplayName pulumi.StringPtrInput
	// The unique identifier of the app role
	RoleId pulumi.StringPtrInput
	// The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal.
	//
	// > **Roles and Permission Scopes** In Azure Active Directory, application roles and permission scopes exported by an application share the same namespace and cannot contain duplicate values.
	Value pulumi.StringPtrInput
}

func (ApplicationAppRoleState) ElementType added in v5.43.0

func (ApplicationAppRoleState) ElementType() reflect.Type

type ApplicationAppRoleType added in v5.43.0

type ApplicationAppRoleType struct {
	// Specifies whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications (that are accessing this application in a standalone scenario) by setting to `Application`, or to both.
	AllowedMemberTypes []string `pulumi:"allowedMemberTypes"`
	// Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences.
	Description string `pulumi:"description"`
	// Display name for the app role that appears during app role assignment and in consent experiences.
	DisplayName string `pulumi:"displayName"`
	// Determines if the app role is enabled. Defaults to `true`.
	Enabled *bool `pulumi:"enabled"`
	// The unique identifier of the app role. Must be a valid UUID.
	//
	// > **Tip: Generating a UUID for the `id` field** To generate a value for the `id` field in cases where the actual UUID is not important, you can use the `randomUuid` resource. See the application example in the provider repository.
	Id string `pulumi:"id"`
	// The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal
	Value *string `pulumi:"value"`
}

type ApplicationAppRoleTypeArgs added in v5.43.0

type ApplicationAppRoleTypeArgs struct {
	// Specifies whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications (that are accessing this application in a standalone scenario) by setting to `Application`, or to both.
	AllowedMemberTypes pulumi.StringArrayInput `pulumi:"allowedMemberTypes"`
	// Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences.
	Description pulumi.StringInput `pulumi:"description"`
	// Display name for the app role that appears during app role assignment and in consent experiences.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Determines if the app role is enabled. Defaults to `true`.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
	// The unique identifier of the app role. Must be a valid UUID.
	//
	// > **Tip: Generating a UUID for the `id` field** To generate a value for the `id` field in cases where the actual UUID is not important, you can use the `randomUuid` resource. See the application example in the provider repository.
	Id pulumi.StringInput `pulumi:"id"`
	// The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (ApplicationAppRoleTypeArgs) ElementType added in v5.43.0

func (ApplicationAppRoleTypeArgs) ElementType() reflect.Type

func (ApplicationAppRoleTypeArgs) ToApplicationAppRoleTypeOutput added in v5.43.0

func (i ApplicationAppRoleTypeArgs) ToApplicationAppRoleTypeOutput() ApplicationAppRoleTypeOutput

func (ApplicationAppRoleTypeArgs) ToApplicationAppRoleTypeOutputWithContext added in v5.43.0

func (i ApplicationAppRoleTypeArgs) ToApplicationAppRoleTypeOutputWithContext(ctx context.Context) ApplicationAppRoleTypeOutput

type ApplicationAppRoleTypeArray added in v5.43.0

type ApplicationAppRoleTypeArray []ApplicationAppRoleTypeInput

func (ApplicationAppRoleTypeArray) ElementType added in v5.43.0

func (ApplicationAppRoleTypeArray) ToApplicationAppRoleTypeArrayOutput added in v5.43.0

func (i ApplicationAppRoleTypeArray) ToApplicationAppRoleTypeArrayOutput() ApplicationAppRoleTypeArrayOutput

func (ApplicationAppRoleTypeArray) ToApplicationAppRoleTypeArrayOutputWithContext added in v5.43.0

func (i ApplicationAppRoleTypeArray) ToApplicationAppRoleTypeArrayOutputWithContext(ctx context.Context) ApplicationAppRoleTypeArrayOutput

type ApplicationAppRoleTypeArrayInput added in v5.43.0

type ApplicationAppRoleTypeArrayInput interface {
	pulumi.Input

	ToApplicationAppRoleTypeArrayOutput() ApplicationAppRoleTypeArrayOutput
	ToApplicationAppRoleTypeArrayOutputWithContext(context.Context) ApplicationAppRoleTypeArrayOutput
}

ApplicationAppRoleTypeArrayInput is an input type that accepts ApplicationAppRoleTypeArray and ApplicationAppRoleTypeArrayOutput values. You can construct a concrete instance of `ApplicationAppRoleTypeArrayInput` via:

ApplicationAppRoleTypeArray{ ApplicationAppRoleTypeArgs{...} }

type ApplicationAppRoleTypeArrayOutput added in v5.43.0

type ApplicationAppRoleTypeArrayOutput struct{ *pulumi.OutputState }

func (ApplicationAppRoleTypeArrayOutput) ElementType added in v5.43.0

func (ApplicationAppRoleTypeArrayOutput) Index added in v5.43.0

func (ApplicationAppRoleTypeArrayOutput) ToApplicationAppRoleTypeArrayOutput added in v5.43.0

func (o ApplicationAppRoleTypeArrayOutput) ToApplicationAppRoleTypeArrayOutput() ApplicationAppRoleTypeArrayOutput

func (ApplicationAppRoleTypeArrayOutput) ToApplicationAppRoleTypeArrayOutputWithContext added in v5.43.0

func (o ApplicationAppRoleTypeArrayOutput) ToApplicationAppRoleTypeArrayOutputWithContext(ctx context.Context) ApplicationAppRoleTypeArrayOutput

type ApplicationAppRoleTypeInput added in v5.43.0

type ApplicationAppRoleTypeInput interface {
	pulumi.Input

	ToApplicationAppRoleTypeOutput() ApplicationAppRoleTypeOutput
	ToApplicationAppRoleTypeOutputWithContext(context.Context) ApplicationAppRoleTypeOutput
}

ApplicationAppRoleTypeInput is an input type that accepts ApplicationAppRoleTypeArgs and ApplicationAppRoleTypeOutput values. You can construct a concrete instance of `ApplicationAppRoleTypeInput` via:

ApplicationAppRoleTypeArgs{...}

type ApplicationAppRoleTypeOutput added in v5.43.0

type ApplicationAppRoleTypeOutput struct{ *pulumi.OutputState }

func (ApplicationAppRoleTypeOutput) AllowedMemberTypes added in v5.43.0

func (o ApplicationAppRoleTypeOutput) AllowedMemberTypes() pulumi.StringArrayOutput

Specifies whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications (that are accessing this application in a standalone scenario) by setting to `Application`, or to both.

func (ApplicationAppRoleTypeOutput) Description added in v5.43.0

Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences.

func (ApplicationAppRoleTypeOutput) DisplayName added in v5.43.0

Display name for the app role that appears during app role assignment and in consent experiences.

func (ApplicationAppRoleTypeOutput) ElementType added in v5.43.0

func (ApplicationAppRoleTypeOutput) Enabled added in v5.43.0

Determines if the app role is enabled. Defaults to `true`.

func (ApplicationAppRoleTypeOutput) Id added in v5.43.0

The unique identifier of the app role. Must be a valid UUID.

> **Tip: Generating a UUID for the `id` field** To generate a value for the `id` field in cases where the actual UUID is not important, you can use the `randomUuid` resource. See the application example in the provider repository.

func (ApplicationAppRoleTypeOutput) ToApplicationAppRoleTypeOutput added in v5.43.0

func (o ApplicationAppRoleTypeOutput) ToApplicationAppRoleTypeOutput() ApplicationAppRoleTypeOutput

func (ApplicationAppRoleTypeOutput) ToApplicationAppRoleTypeOutputWithContext added in v5.43.0

func (o ApplicationAppRoleTypeOutput) ToApplicationAppRoleTypeOutputWithContext(ctx context.Context) ApplicationAppRoleTypeOutput

func (ApplicationAppRoleTypeOutput) Value added in v5.43.0

The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal

type ApplicationArgs

type ApplicationArgs struct {
	// An `api` block as documented below, which configures API related settings for this application.
	Api ApplicationApiPtrInput
	// A collection of `appRole` blocks as documented below. For more information see [official documentation on Application Roles](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).
	AppRoles ApplicationAppRoleTypeArrayInput
	// A description of the application, as shown to end users.
	Description pulumi.StringPtrInput
	// Specifies whether this application supports device authentication without a user. Defaults to `false`.
	DeviceOnlyAuthEnabled pulumi.BoolPtrInput
	// The display name for the application.
	DisplayName pulumi.StringInput
	// Specifies whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI. Defaults to `false`.
	FallbackPublicClientEnabled pulumi.BoolPtrInput
	// A `featureTags` block as described below. Cannot be used together with the `tags` property.
	//
	// > **Features and Tags** Features are configured for an application using tags, and are provided as a shortcut to set the corresponding magic tag value for each feature. You cannot configure `featureTags` and `tags` for an application at the same time, so if you need to assign additional custom tags it's recommended to use the `tags` property instead. Tag values also propagate to any linked service principals.
	FeatureTags ApplicationFeatureTagArrayInput
	// Configures the `groups` claim issued in a user or OAuth 2.0 access token that the app expects. Possible values are `None`, `SecurityGroup`, `DirectoryRole`, `ApplicationGroup` or `All`.
	GroupMembershipClaims pulumi.StringArrayInput
	// A set of user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant.
	IdentifierUris pulumi.StringArrayInput
	// A logo image to upload for the application, as a raw base64-encoded string. The image should be in gif, jpeg or png format. Note that once an image has been uploaded, it is not possible to remove it without replacing it with another image.
	LogoImage pulumi.StringPtrInput
	// URL of the application's marketing page.
	MarketingUrl pulumi.StringPtrInput
	// User-specified notes relevant for the management of the application.
	Notes pulumi.StringPtrInput
	// Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. Defaults to `false`, which specifies that only GET requests are allowed.
	Oauth2PostResponseRequired pulumi.BoolPtrInput
	// An `optionalClaims` block as documented below.
	OptionalClaims ApplicationOptionalClaimsTypePtrInput
	// A list of object IDs of principals that will be granted ownership of the application
	Owners pulumi.StringArrayInput
	// If `true`, will return an error if an existing application is found with the same name. Defaults to `false`.
	PreventDuplicateNames pulumi.BoolPtrInput
	// URL of the application's privacy statement.
	PrivacyStatementUrl pulumi.StringPtrInput
	// A `publicClient` block as documented below, which configures non-web app or non-web API application settings, for example mobile or other public clients such as an installed application running on a desktop device.
	PublicClient ApplicationPublicClientPtrInput
	// A collection of `requiredResourceAccess` blocks as documented below.
	RequiredResourceAccesses ApplicationRequiredResourceAccessArrayInput
	// References application context information from a Service or Asset Management database.
	ServiceManagementReference pulumi.StringPtrInput
	// The Microsoft account types that are supported for the current application. Must be one of `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`. Defaults to `AzureADMyOrg`.
	//
	// > **Changing `signInAudience` for existing applications** When updating an existing application to use a `signInAudience` value of `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`, your configuration may no longer be valid. Refer to [official documentation](https://docs.microsoft.com/en-gb/azure/active-directory/develop/supported-accounts-validation) to understand the differences in supported configurations. Where possible, the provider will attempt to validate your configuration and try to avoid applying unsupported settings to your application.
	SignInAudience pulumi.StringPtrInput
	// A `singlePageApplication` block as documented below, which configures single-page application (SPA) related settings for this application.
	SinglePageApplication ApplicationSinglePageApplicationPtrInput
	// URL of the application's support page.
	SupportUrl pulumi.StringPtrInput
	// A set of tags to apply to the application for configuring specific behaviours of the application and linked service principals. Note that these are not provided for use by practitioners. Cannot be used together with the `featureTags` block.
	//
	// > **Tags and Features** Azure Active Directory uses special tag values to configure the behavior of applications. These can be specified using either the `tags` property or with the `featureTags` block. If you need to set any custom tag values not supported by the `featureTags` block, it's recommended to use the `tags` property. Tag values also propagate to any linked service principals.
	Tags pulumi.StringArrayInput
	// Unique ID for a templated application in the Azure AD App Gallery, from which to create the application. Changing this forces a new resource to be created.
	//
	// > **Tip for Gallery Applications** This resource can  be used to instantiate a gallery application, however it will also attempt to manage the properties of the resulting application. If this is not desired, consider using the ApplicationRegistration resource instead.
	TemplateId pulumi.StringPtrInput
	// URL of the application's terms of service statement.
	TermsOfServiceUrl pulumi.StringPtrInput
	// A `web` block as documented below, which configures web related settings for this application.
	//
	// > **Application Name Uniqueness** Application names are not unique within Azure Active Directory. Use the `preventDuplicateNames` argument to check for existing applications if you want to avoid name collisions.
	Web ApplicationWebPtrInput
}

The set of arguments for constructing a Application resource.

func (ApplicationArgs) ElementType

func (ApplicationArgs) ElementType() reflect.Type

type ApplicationArray

type ApplicationArray []ApplicationInput

func (ApplicationArray) ElementType

func (ApplicationArray) ElementType() reflect.Type

func (ApplicationArray) ToApplicationArrayOutput

func (i ApplicationArray) ToApplicationArrayOutput() ApplicationArrayOutput

func (ApplicationArray) ToApplicationArrayOutputWithContext

func (i ApplicationArray) ToApplicationArrayOutputWithContext(ctx context.Context) ApplicationArrayOutput

type ApplicationArrayInput

type ApplicationArrayInput interface {
	pulumi.Input

	ToApplicationArrayOutput() ApplicationArrayOutput
	ToApplicationArrayOutputWithContext(context.Context) ApplicationArrayOutput
}

ApplicationArrayInput is an input type that accepts ApplicationArray and ApplicationArrayOutput values. You can construct a concrete instance of `ApplicationArrayInput` via:

ApplicationArray{ ApplicationArgs{...} }

type ApplicationArrayOutput

type ApplicationArrayOutput struct{ *pulumi.OutputState }

func (ApplicationArrayOutput) ElementType

func (ApplicationArrayOutput) ElementType() reflect.Type

func (ApplicationArrayOutput) Index

func (ApplicationArrayOutput) ToApplicationArrayOutput

func (o ApplicationArrayOutput) ToApplicationArrayOutput() ApplicationArrayOutput

func (ApplicationArrayOutput) ToApplicationArrayOutputWithContext

func (o ApplicationArrayOutput) ToApplicationArrayOutputWithContext(ctx context.Context) ApplicationArrayOutput

type ApplicationCertificate

type ApplicationCertificate struct {
	pulumi.CustomResourceState

	// The resource ID of the application for which this certificate should be created. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The object ID of the application for which this certificate should be created
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringOutput `pulumi:"applicationObjectId"`
	// Specifies the encoding used for the supplied certificate data. Must be one of `pem`, `base64` or `hex`. Defaults to `pem`.
	//
	// > **Tip for Azure Key Vault** The `hex` encoding option is useful for consuming certificate data from the azurermKeyVaultCertificate resource.
	Encoding pulumi.StringPtrOutput `pulumi:"encoding"`
	// The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If omitted, the API will decide a suitable expiry date, which is typically around 2 years from the start date. Changing this field forces a new resource to be created.
	EndDate pulumi.StringOutput `pulumi:"endDate"`
	// A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.
	//
	// > One of `endDate` or `endDateRelative` must be specified. The maximum allowed duration is determined by Azure AD and is typically around 2 years from the creation date.
	EndDateRelative pulumi.StringPtrOutput `pulumi:"endDateRelative"`
	// A UUID used to uniquely identify this certificate. If omitted, a random UUID will be automatically generated. Changing this field forces a new resource to be created.
	KeyId pulumi.StringOutput `pulumi:"keyId"`
	// The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the value is determined by Azure Active Directory and is usually the start date of the certificate for asymmetric keys, or the current timestamp for symmetric keys. Changing this field forces a new resource to be created.
	StartDate pulumi.StringOutput `pulumi:"startDate"`
	// The type of key/certificate. Must be one of `AsymmetricX509Cert` or `Symmetric`. Changing this fields forces a new resource to be created.
	Type pulumi.StringPtrOutput `pulumi:"type"`
	// The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argument.
	Value pulumi.StringOutput `pulumi:"value"`
}

## Example Usage

*Using a PEM certificate*

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "cert.pem",
		}, nil)
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationCertificate(ctx, "example", &azuread.ApplicationCertificateArgs{
			ApplicationId: example.ID(),
			Type:          pulumi.String("AsymmetricX509Cert"),
			Value:         invokeFile.Result,
			EndDate:       pulumi.String("2021-05-01T01:02:03Z"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Using a DER certificate*

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) func main() { pulumi.Run(func(ctx *pulumi.Context) error { example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{ DisplayName: pulumi.String("example"), }) if err != nil { return err } invokeBase64encode, err := std.Base64encode(ctx, invokeFile1, err := std.File(ctx, &std.FileArgs{ Input: "cert.der", }, nil) if err != nil { return err } &std.Base64encodeArgs{ Input: invokeFile1.Result, }, nil) if err != nil { return err } _, err = azuread.NewApplicationCertificate(ctx, "example", &azuread.ApplicationCertificateArgs{ ApplicationId: example.ID(), Type: pulumi.String("AsymmetricX509Cert"), Encoding: pulumi.String("base64"), Value: invokeBase64encode.Result, EndDate: pulumi.String("2021-05-01T01:02:03Z"), }) if err != nil { return err } return nil }) } ``` <!--End PulumiCodeChooser -->

### Using a certificate from Azure Key Vault

<!--Start PulumiCodeChooser --> ```go package main

import (

"fmt"

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/keyvault"
"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 {
		exampleApplication, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		example, err := keyvault.NewCertificate(ctx, "example", &keyvault.CertificateArgs{
			Name:       pulumi.String("generated-cert"),
			KeyVaultId: pulumi.Any(exampleAzurermKeyVault.Id),
			CertificatePolicy: &keyvault.CertificateCertificatePolicyArgs{
				IssuerParameters: &keyvault.CertificateCertificatePolicyIssuerParametersArgs{
					Name: pulumi.String("Self"),
				},
				KeyProperties: &keyvault.CertificateCertificatePolicyKeyPropertiesArgs{
					Exportable: pulumi.Bool(true),
					KeySize:    pulumi.Int(2048),
					KeyType:    pulumi.String("RSA"),
					ReuseKey:   pulumi.Bool(true),
				},
				LifetimeActions: keyvault.CertificateCertificatePolicyLifetimeActionArray{
					&keyvault.CertificateCertificatePolicyLifetimeActionArgs{
						Action: &keyvault.CertificateCertificatePolicyLifetimeActionActionArgs{
							ActionType: pulumi.String("AutoRenew"),
						},
						Trigger: &keyvault.CertificateCertificatePolicyLifetimeActionTriggerArgs{
							DaysBeforeExpiry: pulumi.Int(30),
						},
					},
				},
				SecretProperties: &keyvault.CertificateCertificatePolicySecretPropertiesArgs{
					ContentType: pulumi.String("application/x-pkcs12"),
				},
				X509CertificateProperties: &keyvault.CertificateCertificatePolicyX509CertificatePropertiesArgs{
					ExtendedKeyUsages: pulumi.StringArray{
						pulumi.String("1.3.6.1.5.5.7.3.2"),
					},
					KeyUsages: pulumi.StringArray{
						pulumi.String("dataEncipherment"),
						pulumi.String("digitalSignature"),
						pulumi.String("keyCertSign"),
						pulumi.String("keyEncipherment"),
					},
					SubjectAlternativeNames: &keyvault.CertificateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNamesArgs{
						DnsNames: pulumi.StringArray{
							pulumi.String("internal.contoso.com"),
							pulumi.String("domain.hello.world"),
						},
					},
					Subject:          pulumi.String(fmt.Sprintf("CN=%v", exampleApplication.Name)),
					ValidityInMonths: pulumi.Int(12),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationCertificate(ctx, "example", &azuread.ApplicationCertificateArgs{
			ApplicationId: exampleApplication.ID(),
			Type:          pulumi.String("AsymmetricX509Cert"),
			Encoding:      pulumi.String("hex"),
			Value:         example.CertificateData,
			EndDate: example.CertificateAttributes.ApplyT(func(certificateAttributes []keyvault.CertificateCertificateAttribute) (*string, error) {
				return &certificateAttributes[0].Expires, nil
			}).(pulumi.StringPtrOutput),
			StartDate: example.CertificateAttributes.ApplyT(func(certificateAttributes []keyvault.CertificateCertificateAttribute) (*string, error) {
				return &certificateAttributes[0].NotBefore, nil
			}).(pulumi.StringPtrOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Certificates can be imported using the object ID of the associated application and the key ID of the certificate credential, e.g.

```sh $ pulumi import azuread:index/applicationCertificate:ApplicationCertificate example 00000000-0000-0000-0000-000000000000/certificate/11111111-1111-1111-1111-111111111111 ```

-> This ID format is unique to Terraform and is composed of the application's object ID, the string "certificate" and the certificate's key ID in the format `{ObjectId}/certificate/{CertificateKeyId}`.

func GetApplicationCertificate

func GetApplicationCertificate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationCertificateState, opts ...pulumi.ResourceOption) (*ApplicationCertificate, error)

GetApplicationCertificate gets an existing ApplicationCertificate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationCertificate

func NewApplicationCertificate(ctx *pulumi.Context,
	name string, args *ApplicationCertificateArgs, opts ...pulumi.ResourceOption) (*ApplicationCertificate, error)

NewApplicationCertificate registers a new resource with the given unique name, arguments, and options.

func (*ApplicationCertificate) ElementType

func (*ApplicationCertificate) ElementType() reflect.Type

func (*ApplicationCertificate) ToApplicationCertificateOutput

func (i *ApplicationCertificate) ToApplicationCertificateOutput() ApplicationCertificateOutput

func (*ApplicationCertificate) ToApplicationCertificateOutputWithContext

func (i *ApplicationCertificate) ToApplicationCertificateOutputWithContext(ctx context.Context) ApplicationCertificateOutput

type ApplicationCertificateArgs

type ApplicationCertificateArgs struct {
	// The resource ID of the application for which this certificate should be created. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The object ID of the application for which this certificate should be created
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringPtrInput
	// Specifies the encoding used for the supplied certificate data. Must be one of `pem`, `base64` or `hex`. Defaults to `pem`.
	//
	// > **Tip for Azure Key Vault** The `hex` encoding option is useful for consuming certificate data from the azurermKeyVaultCertificate resource.
	Encoding pulumi.StringPtrInput
	// The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If omitted, the API will decide a suitable expiry date, which is typically around 2 years from the start date. Changing this field forces a new resource to be created.
	EndDate pulumi.StringPtrInput
	// A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.
	//
	// > One of `endDate` or `endDateRelative` must be specified. The maximum allowed duration is determined by Azure AD and is typically around 2 years from the creation date.
	EndDateRelative pulumi.StringPtrInput
	// A UUID used to uniquely identify this certificate. If omitted, a random UUID will be automatically generated. Changing this field forces a new resource to be created.
	KeyId pulumi.StringPtrInput
	// The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the value is determined by Azure Active Directory and is usually the start date of the certificate for asymmetric keys, or the current timestamp for symmetric keys. Changing this field forces a new resource to be created.
	StartDate pulumi.StringPtrInput
	// The type of key/certificate. Must be one of `AsymmetricX509Cert` or `Symmetric`. Changing this fields forces a new resource to be created.
	Type pulumi.StringPtrInput
	// The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argument.
	Value pulumi.StringInput
}

The set of arguments for constructing a ApplicationCertificate resource.

func (ApplicationCertificateArgs) ElementType

func (ApplicationCertificateArgs) ElementType() reflect.Type

type ApplicationCertificateArray

type ApplicationCertificateArray []ApplicationCertificateInput

func (ApplicationCertificateArray) ElementType

func (ApplicationCertificateArray) ToApplicationCertificateArrayOutput

func (i ApplicationCertificateArray) ToApplicationCertificateArrayOutput() ApplicationCertificateArrayOutput

func (ApplicationCertificateArray) ToApplicationCertificateArrayOutputWithContext

func (i ApplicationCertificateArray) ToApplicationCertificateArrayOutputWithContext(ctx context.Context) ApplicationCertificateArrayOutput

type ApplicationCertificateArrayInput

type ApplicationCertificateArrayInput interface {
	pulumi.Input

	ToApplicationCertificateArrayOutput() ApplicationCertificateArrayOutput
	ToApplicationCertificateArrayOutputWithContext(context.Context) ApplicationCertificateArrayOutput
}

ApplicationCertificateArrayInput is an input type that accepts ApplicationCertificateArray and ApplicationCertificateArrayOutput values. You can construct a concrete instance of `ApplicationCertificateArrayInput` via:

ApplicationCertificateArray{ ApplicationCertificateArgs{...} }

type ApplicationCertificateArrayOutput

type ApplicationCertificateArrayOutput struct{ *pulumi.OutputState }

func (ApplicationCertificateArrayOutput) ElementType

func (ApplicationCertificateArrayOutput) Index

func (ApplicationCertificateArrayOutput) ToApplicationCertificateArrayOutput

func (o ApplicationCertificateArrayOutput) ToApplicationCertificateArrayOutput() ApplicationCertificateArrayOutput

func (ApplicationCertificateArrayOutput) ToApplicationCertificateArrayOutputWithContext

func (o ApplicationCertificateArrayOutput) ToApplicationCertificateArrayOutputWithContext(ctx context.Context) ApplicationCertificateArrayOutput

type ApplicationCertificateInput

type ApplicationCertificateInput interface {
	pulumi.Input

	ToApplicationCertificateOutput() ApplicationCertificateOutput
	ToApplicationCertificateOutputWithContext(ctx context.Context) ApplicationCertificateOutput
}

type ApplicationCertificateMap

type ApplicationCertificateMap map[string]ApplicationCertificateInput

func (ApplicationCertificateMap) ElementType

func (ApplicationCertificateMap) ElementType() reflect.Type

func (ApplicationCertificateMap) ToApplicationCertificateMapOutput

func (i ApplicationCertificateMap) ToApplicationCertificateMapOutput() ApplicationCertificateMapOutput

func (ApplicationCertificateMap) ToApplicationCertificateMapOutputWithContext

func (i ApplicationCertificateMap) ToApplicationCertificateMapOutputWithContext(ctx context.Context) ApplicationCertificateMapOutput

type ApplicationCertificateMapInput

type ApplicationCertificateMapInput interface {
	pulumi.Input

	ToApplicationCertificateMapOutput() ApplicationCertificateMapOutput
	ToApplicationCertificateMapOutputWithContext(context.Context) ApplicationCertificateMapOutput
}

ApplicationCertificateMapInput is an input type that accepts ApplicationCertificateMap and ApplicationCertificateMapOutput values. You can construct a concrete instance of `ApplicationCertificateMapInput` via:

ApplicationCertificateMap{ "key": ApplicationCertificateArgs{...} }

type ApplicationCertificateMapOutput

type ApplicationCertificateMapOutput struct{ *pulumi.OutputState }

func (ApplicationCertificateMapOutput) ElementType

func (ApplicationCertificateMapOutput) MapIndex

func (ApplicationCertificateMapOutput) ToApplicationCertificateMapOutput

func (o ApplicationCertificateMapOutput) ToApplicationCertificateMapOutput() ApplicationCertificateMapOutput

func (ApplicationCertificateMapOutput) ToApplicationCertificateMapOutputWithContext

func (o ApplicationCertificateMapOutput) ToApplicationCertificateMapOutputWithContext(ctx context.Context) ApplicationCertificateMapOutput

type ApplicationCertificateOutput

type ApplicationCertificateOutput struct{ *pulumi.OutputState }

func (ApplicationCertificateOutput) ApplicationId added in v5.43.0

The resource ID of the application for which this certificate should be created. Changing this field forces a new resource to be created.

func (ApplicationCertificateOutput) ApplicationObjectId deprecated added in v5.22.0

func (o ApplicationCertificateOutput) ApplicationObjectId() pulumi.StringOutput

The object ID of the application for which this certificate should be created

Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider

func (ApplicationCertificateOutput) ElementType

func (ApplicationCertificateOutput) Encoding added in v5.22.0

Specifies the encoding used for the supplied certificate data. Must be one of `pem`, `base64` or `hex`. Defaults to `pem`.

> **Tip for Azure Key Vault** The `hex` encoding option is useful for consuming certificate data from the azurermKeyVaultCertificate resource.

func (ApplicationCertificateOutput) EndDate added in v5.22.0

The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If omitted, the API will decide a suitable expiry date, which is typically around 2 years from the start date. Changing this field forces a new resource to be created.

func (ApplicationCertificateOutput) EndDateRelative added in v5.22.0

A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.

> One of `endDate` or `endDateRelative` must be specified. The maximum allowed duration is determined by Azure AD and is typically around 2 years from the creation date.

func (ApplicationCertificateOutput) KeyId added in v5.22.0

A UUID used to uniquely identify this certificate. If omitted, a random UUID will be automatically generated. Changing this field forces a new resource to be created.

func (ApplicationCertificateOutput) StartDate added in v5.22.0

The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the value is determined by Azure Active Directory and is usually the start date of the certificate for asymmetric keys, or the current timestamp for symmetric keys. Changing this field forces a new resource to be created.

func (ApplicationCertificateOutput) ToApplicationCertificateOutput

func (o ApplicationCertificateOutput) ToApplicationCertificateOutput() ApplicationCertificateOutput

func (ApplicationCertificateOutput) ToApplicationCertificateOutputWithContext

func (o ApplicationCertificateOutput) ToApplicationCertificateOutputWithContext(ctx context.Context) ApplicationCertificateOutput

func (ApplicationCertificateOutput) Type added in v5.22.0

The type of key/certificate. Must be one of `AsymmetricX509Cert` or `Symmetric`. Changing this fields forces a new resource to be created.

func (ApplicationCertificateOutput) Value added in v5.22.0

The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argument.

type ApplicationCertificateState

type ApplicationCertificateState struct {
	// The resource ID of the application for which this certificate should be created. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The object ID of the application for which this certificate should be created
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringPtrInput
	// Specifies the encoding used for the supplied certificate data. Must be one of `pem`, `base64` or `hex`. Defaults to `pem`.
	//
	// > **Tip for Azure Key Vault** The `hex` encoding option is useful for consuming certificate data from the azurermKeyVaultCertificate resource.
	Encoding pulumi.StringPtrInput
	// The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If omitted, the API will decide a suitable expiry date, which is typically around 2 years from the start date. Changing this field forces a new resource to be created.
	EndDate pulumi.StringPtrInput
	// A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.
	//
	// > One of `endDate` or `endDateRelative` must be specified. The maximum allowed duration is determined by Azure AD and is typically around 2 years from the creation date.
	EndDateRelative pulumi.StringPtrInput
	// A UUID used to uniquely identify this certificate. If omitted, a random UUID will be automatically generated. Changing this field forces a new resource to be created.
	KeyId pulumi.StringPtrInput
	// The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the value is determined by Azure Active Directory and is usually the start date of the certificate for asymmetric keys, or the current timestamp for symmetric keys. Changing this field forces a new resource to be created.
	StartDate pulumi.StringPtrInput
	// The type of key/certificate. Must be one of `AsymmetricX509Cert` or `Symmetric`. Changing this fields forces a new resource to be created.
	Type pulumi.StringPtrInput
	// The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argument.
	Value pulumi.StringPtrInput
}

func (ApplicationCertificateState) ElementType

type ApplicationFallbackPublicClient added in v5.43.0

type ApplicationFallbackPublicClient struct {
	pulumi.CustomResourceState

	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// Whether to enable the application as a fallback public client.
	//
	// > Some configurations may require the Fallback Public Client setting to be `null`, for this case simply destroy this resource (or don't use it)
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationFallbackPublicClient(ctx, "example", &azuread.ApplicationFallbackPublicClientArgs{
			ApplicationId: example.ID(),
			Enabled:       pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

The Application Fallback Public Client setting can be imported using the object ID of the application, in the following format.

```sh $ pulumi import azuread:index/applicationFallbackPublicClient:ApplicationFallbackPublicClient example /applications/00000000-0000-0000-0000-000000000000/fallbackPublicClient ```

func GetApplicationFallbackPublicClient added in v5.43.0

func GetApplicationFallbackPublicClient(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationFallbackPublicClientState, opts ...pulumi.ResourceOption) (*ApplicationFallbackPublicClient, error)

GetApplicationFallbackPublicClient gets an existing ApplicationFallbackPublicClient resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationFallbackPublicClient added in v5.43.0

func NewApplicationFallbackPublicClient(ctx *pulumi.Context,
	name string, args *ApplicationFallbackPublicClientArgs, opts ...pulumi.ResourceOption) (*ApplicationFallbackPublicClient, error)

NewApplicationFallbackPublicClient registers a new resource with the given unique name, arguments, and options.

func (*ApplicationFallbackPublicClient) ElementType added in v5.43.0

func (*ApplicationFallbackPublicClient) ToApplicationFallbackPublicClientOutput added in v5.43.0

func (i *ApplicationFallbackPublicClient) ToApplicationFallbackPublicClientOutput() ApplicationFallbackPublicClientOutput

func (*ApplicationFallbackPublicClient) ToApplicationFallbackPublicClientOutputWithContext added in v5.43.0

func (i *ApplicationFallbackPublicClient) ToApplicationFallbackPublicClientOutputWithContext(ctx context.Context) ApplicationFallbackPublicClientOutput

type ApplicationFallbackPublicClientArgs added in v5.43.0

type ApplicationFallbackPublicClientArgs struct {
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringInput
	// Whether to enable the application as a fallback public client.
	//
	// > Some configurations may require the Fallback Public Client setting to be `null`, for this case simply destroy this resource (or don't use it)
	Enabled pulumi.BoolPtrInput
}

The set of arguments for constructing a ApplicationFallbackPublicClient resource.

func (ApplicationFallbackPublicClientArgs) ElementType added in v5.43.0

type ApplicationFallbackPublicClientArray added in v5.43.0

type ApplicationFallbackPublicClientArray []ApplicationFallbackPublicClientInput

func (ApplicationFallbackPublicClientArray) ElementType added in v5.43.0

func (ApplicationFallbackPublicClientArray) ToApplicationFallbackPublicClientArrayOutput added in v5.43.0

func (i ApplicationFallbackPublicClientArray) ToApplicationFallbackPublicClientArrayOutput() ApplicationFallbackPublicClientArrayOutput

func (ApplicationFallbackPublicClientArray) ToApplicationFallbackPublicClientArrayOutputWithContext added in v5.43.0

func (i ApplicationFallbackPublicClientArray) ToApplicationFallbackPublicClientArrayOutputWithContext(ctx context.Context) ApplicationFallbackPublicClientArrayOutput

type ApplicationFallbackPublicClientArrayInput added in v5.43.0

type ApplicationFallbackPublicClientArrayInput interface {
	pulumi.Input

	ToApplicationFallbackPublicClientArrayOutput() ApplicationFallbackPublicClientArrayOutput
	ToApplicationFallbackPublicClientArrayOutputWithContext(context.Context) ApplicationFallbackPublicClientArrayOutput
}

ApplicationFallbackPublicClientArrayInput is an input type that accepts ApplicationFallbackPublicClientArray and ApplicationFallbackPublicClientArrayOutput values. You can construct a concrete instance of `ApplicationFallbackPublicClientArrayInput` via:

ApplicationFallbackPublicClientArray{ ApplicationFallbackPublicClientArgs{...} }

type ApplicationFallbackPublicClientArrayOutput added in v5.43.0

type ApplicationFallbackPublicClientArrayOutput struct{ *pulumi.OutputState }

func (ApplicationFallbackPublicClientArrayOutput) ElementType added in v5.43.0

func (ApplicationFallbackPublicClientArrayOutput) Index added in v5.43.0

func (ApplicationFallbackPublicClientArrayOutput) ToApplicationFallbackPublicClientArrayOutput added in v5.43.0

func (o ApplicationFallbackPublicClientArrayOutput) ToApplicationFallbackPublicClientArrayOutput() ApplicationFallbackPublicClientArrayOutput

func (ApplicationFallbackPublicClientArrayOutput) ToApplicationFallbackPublicClientArrayOutputWithContext added in v5.43.0

func (o ApplicationFallbackPublicClientArrayOutput) ToApplicationFallbackPublicClientArrayOutputWithContext(ctx context.Context) ApplicationFallbackPublicClientArrayOutput

type ApplicationFallbackPublicClientInput added in v5.43.0

type ApplicationFallbackPublicClientInput interface {
	pulumi.Input

	ToApplicationFallbackPublicClientOutput() ApplicationFallbackPublicClientOutput
	ToApplicationFallbackPublicClientOutputWithContext(ctx context.Context) ApplicationFallbackPublicClientOutput
}

type ApplicationFallbackPublicClientMap added in v5.43.0

type ApplicationFallbackPublicClientMap map[string]ApplicationFallbackPublicClientInput

func (ApplicationFallbackPublicClientMap) ElementType added in v5.43.0

func (ApplicationFallbackPublicClientMap) ToApplicationFallbackPublicClientMapOutput added in v5.43.0

func (i ApplicationFallbackPublicClientMap) ToApplicationFallbackPublicClientMapOutput() ApplicationFallbackPublicClientMapOutput

func (ApplicationFallbackPublicClientMap) ToApplicationFallbackPublicClientMapOutputWithContext added in v5.43.0

func (i ApplicationFallbackPublicClientMap) ToApplicationFallbackPublicClientMapOutputWithContext(ctx context.Context) ApplicationFallbackPublicClientMapOutput

type ApplicationFallbackPublicClientMapInput added in v5.43.0

type ApplicationFallbackPublicClientMapInput interface {
	pulumi.Input

	ToApplicationFallbackPublicClientMapOutput() ApplicationFallbackPublicClientMapOutput
	ToApplicationFallbackPublicClientMapOutputWithContext(context.Context) ApplicationFallbackPublicClientMapOutput
}

ApplicationFallbackPublicClientMapInput is an input type that accepts ApplicationFallbackPublicClientMap and ApplicationFallbackPublicClientMapOutput values. You can construct a concrete instance of `ApplicationFallbackPublicClientMapInput` via:

ApplicationFallbackPublicClientMap{ "key": ApplicationFallbackPublicClientArgs{...} }

type ApplicationFallbackPublicClientMapOutput added in v5.43.0

type ApplicationFallbackPublicClientMapOutput struct{ *pulumi.OutputState }

func (ApplicationFallbackPublicClientMapOutput) ElementType added in v5.43.0

func (ApplicationFallbackPublicClientMapOutput) MapIndex added in v5.43.0

func (ApplicationFallbackPublicClientMapOutput) ToApplicationFallbackPublicClientMapOutput added in v5.43.0

func (o ApplicationFallbackPublicClientMapOutput) ToApplicationFallbackPublicClientMapOutput() ApplicationFallbackPublicClientMapOutput

func (ApplicationFallbackPublicClientMapOutput) ToApplicationFallbackPublicClientMapOutputWithContext added in v5.43.0

func (o ApplicationFallbackPublicClientMapOutput) ToApplicationFallbackPublicClientMapOutputWithContext(ctx context.Context) ApplicationFallbackPublicClientMapOutput

type ApplicationFallbackPublicClientOutput added in v5.43.0

type ApplicationFallbackPublicClientOutput struct{ *pulumi.OutputState }

func (ApplicationFallbackPublicClientOutput) ApplicationId added in v5.43.0

The resource ID of the application registration. Changing this forces a new resource to be created.

func (ApplicationFallbackPublicClientOutput) ElementType added in v5.43.0

func (ApplicationFallbackPublicClientOutput) Enabled added in v5.43.0

Whether to enable the application as a fallback public client.

> Some configurations may require the Fallback Public Client setting to be `null`, for this case simply destroy this resource (or don't use it)

func (ApplicationFallbackPublicClientOutput) ToApplicationFallbackPublicClientOutput added in v5.43.0

func (o ApplicationFallbackPublicClientOutput) ToApplicationFallbackPublicClientOutput() ApplicationFallbackPublicClientOutput

func (ApplicationFallbackPublicClientOutput) ToApplicationFallbackPublicClientOutputWithContext added in v5.43.0

func (o ApplicationFallbackPublicClientOutput) ToApplicationFallbackPublicClientOutputWithContext(ctx context.Context) ApplicationFallbackPublicClientOutput

type ApplicationFallbackPublicClientState added in v5.43.0

type ApplicationFallbackPublicClientState struct {
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// Whether to enable the application as a fallback public client.
	//
	// > Some configurations may require the Fallback Public Client setting to be `null`, for this case simply destroy this resource (or don't use it)
	Enabled pulumi.BoolPtrInput
}

func (ApplicationFallbackPublicClientState) ElementType added in v5.43.0

type ApplicationFeatureTag added in v5.6.0

type ApplicationFeatureTag struct {
	// Whether this application represents a custom SAML application for linked service principals. Enabling this will assign the `WindowsAzureActiveDirectoryCustomSingleSignOnApplication` tag. Defaults to `false`.
	CustomSingleSignOn *bool `pulumi:"customSingleSignOn"`
	// Whether this application represents an Enterprise Application for linked service principals. Enabling this will assign the `WindowsAzureActiveDirectoryIntegratedApp` tag. Defaults to `false`.
	Enterprise *bool `pulumi:"enterprise"`
	// Whether this application represents a gallery application for linked service principals. Enabling this will assign the `WindowsAzureActiveDirectoryGalleryApplicationNonPrimaryV1` tag. Defaults to `false`.
	Gallery *bool `pulumi:"gallery"`
	// Whether this app is invisible to users in My Apps and Office 365 Launcher. Enabling this will assign the `HideApp` tag. Defaults to `false`.
	Hide *bool `pulumi:"hide"`
}

type ApplicationFeatureTagArgs added in v5.6.0

type ApplicationFeatureTagArgs struct {
	// Whether this application represents a custom SAML application for linked service principals. Enabling this will assign the `WindowsAzureActiveDirectoryCustomSingleSignOnApplication` tag. Defaults to `false`.
	CustomSingleSignOn pulumi.BoolPtrInput `pulumi:"customSingleSignOn"`
	// Whether this application represents an Enterprise Application for linked service principals. Enabling this will assign the `WindowsAzureActiveDirectoryIntegratedApp` tag. Defaults to `false`.
	Enterprise pulumi.BoolPtrInput `pulumi:"enterprise"`
	// Whether this application represents a gallery application for linked service principals. Enabling this will assign the `WindowsAzureActiveDirectoryGalleryApplicationNonPrimaryV1` tag. Defaults to `false`.
	Gallery pulumi.BoolPtrInput `pulumi:"gallery"`
	// Whether this app is invisible to users in My Apps and Office 365 Launcher. Enabling this will assign the `HideApp` tag. Defaults to `false`.
	Hide pulumi.BoolPtrInput `pulumi:"hide"`
}

func (ApplicationFeatureTagArgs) ElementType added in v5.6.0

func (ApplicationFeatureTagArgs) ElementType() reflect.Type

func (ApplicationFeatureTagArgs) ToApplicationFeatureTagOutput added in v5.6.0

func (i ApplicationFeatureTagArgs) ToApplicationFeatureTagOutput() ApplicationFeatureTagOutput

func (ApplicationFeatureTagArgs) ToApplicationFeatureTagOutputWithContext added in v5.6.0

func (i ApplicationFeatureTagArgs) ToApplicationFeatureTagOutputWithContext(ctx context.Context) ApplicationFeatureTagOutput

type ApplicationFeatureTagArray added in v5.6.0

type ApplicationFeatureTagArray []ApplicationFeatureTagInput

func (ApplicationFeatureTagArray) ElementType added in v5.6.0

func (ApplicationFeatureTagArray) ElementType() reflect.Type

func (ApplicationFeatureTagArray) ToApplicationFeatureTagArrayOutput added in v5.6.0

func (i ApplicationFeatureTagArray) ToApplicationFeatureTagArrayOutput() ApplicationFeatureTagArrayOutput

func (ApplicationFeatureTagArray) ToApplicationFeatureTagArrayOutputWithContext added in v5.6.0

func (i ApplicationFeatureTagArray) ToApplicationFeatureTagArrayOutputWithContext(ctx context.Context) ApplicationFeatureTagArrayOutput

type ApplicationFeatureTagArrayInput added in v5.6.0

type ApplicationFeatureTagArrayInput interface {
	pulumi.Input

	ToApplicationFeatureTagArrayOutput() ApplicationFeatureTagArrayOutput
	ToApplicationFeatureTagArrayOutputWithContext(context.Context) ApplicationFeatureTagArrayOutput
}

ApplicationFeatureTagArrayInput is an input type that accepts ApplicationFeatureTagArray and ApplicationFeatureTagArrayOutput values. You can construct a concrete instance of `ApplicationFeatureTagArrayInput` via:

ApplicationFeatureTagArray{ ApplicationFeatureTagArgs{...} }

type ApplicationFeatureTagArrayOutput added in v5.6.0

type ApplicationFeatureTagArrayOutput struct{ *pulumi.OutputState }

func (ApplicationFeatureTagArrayOutput) ElementType added in v5.6.0

func (ApplicationFeatureTagArrayOutput) Index added in v5.6.0

func (ApplicationFeatureTagArrayOutput) ToApplicationFeatureTagArrayOutput added in v5.6.0

func (o ApplicationFeatureTagArrayOutput) ToApplicationFeatureTagArrayOutput() ApplicationFeatureTagArrayOutput

func (ApplicationFeatureTagArrayOutput) ToApplicationFeatureTagArrayOutputWithContext added in v5.6.0

func (o ApplicationFeatureTagArrayOutput) ToApplicationFeatureTagArrayOutputWithContext(ctx context.Context) ApplicationFeatureTagArrayOutput

type ApplicationFeatureTagInput added in v5.6.0

type ApplicationFeatureTagInput interface {
	pulumi.Input

	ToApplicationFeatureTagOutput() ApplicationFeatureTagOutput
	ToApplicationFeatureTagOutputWithContext(context.Context) ApplicationFeatureTagOutput
}

ApplicationFeatureTagInput is an input type that accepts ApplicationFeatureTagArgs and ApplicationFeatureTagOutput values. You can construct a concrete instance of `ApplicationFeatureTagInput` via:

ApplicationFeatureTagArgs{...}

type ApplicationFeatureTagOutput added in v5.6.0

type ApplicationFeatureTagOutput struct{ *pulumi.OutputState }

func (ApplicationFeatureTagOutput) CustomSingleSignOn added in v5.6.0

func (o ApplicationFeatureTagOutput) CustomSingleSignOn() pulumi.BoolPtrOutput

Whether this application represents a custom SAML application for linked service principals. Enabling this will assign the `WindowsAzureActiveDirectoryCustomSingleSignOnApplication` tag. Defaults to `false`.

func (ApplicationFeatureTagOutput) ElementType added in v5.6.0

func (ApplicationFeatureTagOutput) Enterprise added in v5.6.0

Whether this application represents an Enterprise Application for linked service principals. Enabling this will assign the `WindowsAzureActiveDirectoryIntegratedApp` tag. Defaults to `false`.

func (ApplicationFeatureTagOutput) Gallery added in v5.6.0

Whether this application represents a gallery application for linked service principals. Enabling this will assign the `WindowsAzureActiveDirectoryGalleryApplicationNonPrimaryV1` tag. Defaults to `false`.

func (ApplicationFeatureTagOutput) Hide added in v5.6.0

Whether this app is invisible to users in My Apps and Office 365 Launcher. Enabling this will assign the `HideApp` tag. Defaults to `false`.

func (ApplicationFeatureTagOutput) ToApplicationFeatureTagOutput added in v5.6.0

func (o ApplicationFeatureTagOutput) ToApplicationFeatureTagOutput() ApplicationFeatureTagOutput

func (ApplicationFeatureTagOutput) ToApplicationFeatureTagOutputWithContext added in v5.6.0

func (o ApplicationFeatureTagOutput) ToApplicationFeatureTagOutputWithContext(ctx context.Context) ApplicationFeatureTagOutput

type ApplicationFederatedIdentityCredential added in v5.15.0

type ApplicationFederatedIdentityCredential struct {
	pulumi.CustomResourceState

	// The resource ID of the application for which this federated identity credential should be created. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The object ID of the application for which this federated identity credential should be created
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringOutput `pulumi:"applicationObjectId"`
	// List of audiences that can appear in the external token. This specifies what should be accepted in the `aud` claim of incoming tokens.
	Audiences pulumi.StringArrayOutput `pulumi:"audiences"`
	// A UUID used to uniquely identify this federated identity credential.
	CredentialId pulumi.StringOutput `pulumi:"credentialId"`
	// A description for the federated identity credential.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// A unique display name for the federated identity credential. Changing this forces a new resource to be created.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app.
	Issuer pulumi.StringOutput `pulumi:"issuer"`
	// The identifier of the external software workload within the external identity provider. The combination of issuer and subject must be unique on the app.
	Subject pulumi.StringOutput `pulumi:"subject"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationFederatedIdentityCredential(ctx, "example", &azuread.ApplicationFederatedIdentityCredentialArgs{
			ApplicationId: example.ID(),
			DisplayName:   pulumi.String("my-repo-deploy"),
			Description:   pulumi.String("Deployments for my-repo"),
			Audiences: pulumi.StringArray{
				pulumi.String("api://AzureADTokenExchange"),
			},
			Issuer:  pulumi.String("https://token.actions.githubusercontent.com"),
			Subject: pulumi.String("repo:my-organization/my-repo:environment:prod"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Federated Identity Credentials can be imported using the object ID of the associated application and the ID of the federated identity credential, e.g.

```sh $ pulumi import azuread:index/applicationFederatedIdentityCredential:ApplicationFederatedIdentityCredential example 00000000-0000-0000-0000-000000000000/federatedIdentityCredential/11111111-1111-1111-1111-111111111111 ```

-> This ID format is unique to Terraform and is composed of the application's object ID, the string "federatedIdentityCredential" and the credential ID in the format `{ObjectId}/federatedIdentityCredential/{CredentialId}`.

func GetApplicationFederatedIdentityCredential added in v5.15.0

func GetApplicationFederatedIdentityCredential(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationFederatedIdentityCredentialState, opts ...pulumi.ResourceOption) (*ApplicationFederatedIdentityCredential, error)

GetApplicationFederatedIdentityCredential gets an existing ApplicationFederatedIdentityCredential resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationFederatedIdentityCredential added in v5.15.0

func NewApplicationFederatedIdentityCredential(ctx *pulumi.Context,
	name string, args *ApplicationFederatedIdentityCredentialArgs, opts ...pulumi.ResourceOption) (*ApplicationFederatedIdentityCredential, error)

NewApplicationFederatedIdentityCredential registers a new resource with the given unique name, arguments, and options.

func (*ApplicationFederatedIdentityCredential) ElementType added in v5.15.0

func (*ApplicationFederatedIdentityCredential) ToApplicationFederatedIdentityCredentialOutput added in v5.15.0

func (i *ApplicationFederatedIdentityCredential) ToApplicationFederatedIdentityCredentialOutput() ApplicationFederatedIdentityCredentialOutput

func (*ApplicationFederatedIdentityCredential) ToApplicationFederatedIdentityCredentialOutputWithContext added in v5.15.0

func (i *ApplicationFederatedIdentityCredential) ToApplicationFederatedIdentityCredentialOutputWithContext(ctx context.Context) ApplicationFederatedIdentityCredentialOutput

type ApplicationFederatedIdentityCredentialArgs added in v5.15.0

type ApplicationFederatedIdentityCredentialArgs struct {
	// The resource ID of the application for which this federated identity credential should be created. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The object ID of the application for which this federated identity credential should be created
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringPtrInput
	// List of audiences that can appear in the external token. This specifies what should be accepted in the `aud` claim of incoming tokens.
	Audiences pulumi.StringArrayInput
	// A description for the federated identity credential.
	Description pulumi.StringPtrInput
	// A unique display name for the federated identity credential. Changing this forces a new resource to be created.
	DisplayName pulumi.StringInput
	// The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app.
	Issuer pulumi.StringInput
	// The identifier of the external software workload within the external identity provider. The combination of issuer and subject must be unique on the app.
	Subject pulumi.StringInput
}

The set of arguments for constructing a ApplicationFederatedIdentityCredential resource.

func (ApplicationFederatedIdentityCredentialArgs) ElementType added in v5.15.0

type ApplicationFederatedIdentityCredentialArray added in v5.15.0

type ApplicationFederatedIdentityCredentialArray []ApplicationFederatedIdentityCredentialInput

func (ApplicationFederatedIdentityCredentialArray) ElementType added in v5.15.0

func (ApplicationFederatedIdentityCredentialArray) ToApplicationFederatedIdentityCredentialArrayOutput added in v5.15.0

func (i ApplicationFederatedIdentityCredentialArray) ToApplicationFederatedIdentityCredentialArrayOutput() ApplicationFederatedIdentityCredentialArrayOutput

func (ApplicationFederatedIdentityCredentialArray) ToApplicationFederatedIdentityCredentialArrayOutputWithContext added in v5.15.0

func (i ApplicationFederatedIdentityCredentialArray) ToApplicationFederatedIdentityCredentialArrayOutputWithContext(ctx context.Context) ApplicationFederatedIdentityCredentialArrayOutput

type ApplicationFederatedIdentityCredentialArrayInput added in v5.15.0

type ApplicationFederatedIdentityCredentialArrayInput interface {
	pulumi.Input

	ToApplicationFederatedIdentityCredentialArrayOutput() ApplicationFederatedIdentityCredentialArrayOutput
	ToApplicationFederatedIdentityCredentialArrayOutputWithContext(context.Context) ApplicationFederatedIdentityCredentialArrayOutput
}

ApplicationFederatedIdentityCredentialArrayInput is an input type that accepts ApplicationFederatedIdentityCredentialArray and ApplicationFederatedIdentityCredentialArrayOutput values. You can construct a concrete instance of `ApplicationFederatedIdentityCredentialArrayInput` via:

ApplicationFederatedIdentityCredentialArray{ ApplicationFederatedIdentityCredentialArgs{...} }

type ApplicationFederatedIdentityCredentialArrayOutput added in v5.15.0

type ApplicationFederatedIdentityCredentialArrayOutput struct{ *pulumi.OutputState }

func (ApplicationFederatedIdentityCredentialArrayOutput) ElementType added in v5.15.0

func (ApplicationFederatedIdentityCredentialArrayOutput) Index added in v5.15.0

func (ApplicationFederatedIdentityCredentialArrayOutput) ToApplicationFederatedIdentityCredentialArrayOutput added in v5.15.0

func (o ApplicationFederatedIdentityCredentialArrayOutput) ToApplicationFederatedIdentityCredentialArrayOutput() ApplicationFederatedIdentityCredentialArrayOutput

func (ApplicationFederatedIdentityCredentialArrayOutput) ToApplicationFederatedIdentityCredentialArrayOutputWithContext added in v5.15.0

func (o ApplicationFederatedIdentityCredentialArrayOutput) ToApplicationFederatedIdentityCredentialArrayOutputWithContext(ctx context.Context) ApplicationFederatedIdentityCredentialArrayOutput

type ApplicationFederatedIdentityCredentialInput added in v5.15.0

type ApplicationFederatedIdentityCredentialInput interface {
	pulumi.Input

	ToApplicationFederatedIdentityCredentialOutput() ApplicationFederatedIdentityCredentialOutput
	ToApplicationFederatedIdentityCredentialOutputWithContext(ctx context.Context) ApplicationFederatedIdentityCredentialOutput
}

type ApplicationFederatedIdentityCredentialMap added in v5.15.0

type ApplicationFederatedIdentityCredentialMap map[string]ApplicationFederatedIdentityCredentialInput

func (ApplicationFederatedIdentityCredentialMap) ElementType added in v5.15.0

func (ApplicationFederatedIdentityCredentialMap) ToApplicationFederatedIdentityCredentialMapOutput added in v5.15.0

func (i ApplicationFederatedIdentityCredentialMap) ToApplicationFederatedIdentityCredentialMapOutput() ApplicationFederatedIdentityCredentialMapOutput

func (ApplicationFederatedIdentityCredentialMap) ToApplicationFederatedIdentityCredentialMapOutputWithContext added in v5.15.0

func (i ApplicationFederatedIdentityCredentialMap) ToApplicationFederatedIdentityCredentialMapOutputWithContext(ctx context.Context) ApplicationFederatedIdentityCredentialMapOutput

type ApplicationFederatedIdentityCredentialMapInput added in v5.15.0

type ApplicationFederatedIdentityCredentialMapInput interface {
	pulumi.Input

	ToApplicationFederatedIdentityCredentialMapOutput() ApplicationFederatedIdentityCredentialMapOutput
	ToApplicationFederatedIdentityCredentialMapOutputWithContext(context.Context) ApplicationFederatedIdentityCredentialMapOutput
}

ApplicationFederatedIdentityCredentialMapInput is an input type that accepts ApplicationFederatedIdentityCredentialMap and ApplicationFederatedIdentityCredentialMapOutput values. You can construct a concrete instance of `ApplicationFederatedIdentityCredentialMapInput` via:

ApplicationFederatedIdentityCredentialMap{ "key": ApplicationFederatedIdentityCredentialArgs{...} }

type ApplicationFederatedIdentityCredentialMapOutput added in v5.15.0

type ApplicationFederatedIdentityCredentialMapOutput struct{ *pulumi.OutputState }

func (ApplicationFederatedIdentityCredentialMapOutput) ElementType added in v5.15.0

func (ApplicationFederatedIdentityCredentialMapOutput) MapIndex added in v5.15.0

func (ApplicationFederatedIdentityCredentialMapOutput) ToApplicationFederatedIdentityCredentialMapOutput added in v5.15.0

func (o ApplicationFederatedIdentityCredentialMapOutput) ToApplicationFederatedIdentityCredentialMapOutput() ApplicationFederatedIdentityCredentialMapOutput

func (ApplicationFederatedIdentityCredentialMapOutput) ToApplicationFederatedIdentityCredentialMapOutputWithContext added in v5.15.0

func (o ApplicationFederatedIdentityCredentialMapOutput) ToApplicationFederatedIdentityCredentialMapOutputWithContext(ctx context.Context) ApplicationFederatedIdentityCredentialMapOutput

type ApplicationFederatedIdentityCredentialOutput added in v5.15.0

type ApplicationFederatedIdentityCredentialOutput struct{ *pulumi.OutputState }

func (ApplicationFederatedIdentityCredentialOutput) ApplicationId added in v5.43.0

The resource ID of the application for which this federated identity credential should be created. Changing this field forces a new resource to be created.

func (ApplicationFederatedIdentityCredentialOutput) ApplicationObjectId deprecated added in v5.22.0

The object ID of the application for which this federated identity credential should be created

Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider

func (ApplicationFederatedIdentityCredentialOutput) Audiences added in v5.22.0

List of audiences that can appear in the external token. This specifies what should be accepted in the `aud` claim of incoming tokens.

func (ApplicationFederatedIdentityCredentialOutput) CredentialId added in v5.22.0

A UUID used to uniquely identify this federated identity credential.

func (ApplicationFederatedIdentityCredentialOutput) Description added in v5.22.0

A description for the federated identity credential.

func (ApplicationFederatedIdentityCredentialOutput) DisplayName added in v5.22.0

A unique display name for the federated identity credential. Changing this forces a new resource to be created.

func (ApplicationFederatedIdentityCredentialOutput) ElementType added in v5.15.0

func (ApplicationFederatedIdentityCredentialOutput) Issuer added in v5.22.0

The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app.

func (ApplicationFederatedIdentityCredentialOutput) Subject added in v5.22.0

The identifier of the external software workload within the external identity provider. The combination of issuer and subject must be unique on the app.

func (ApplicationFederatedIdentityCredentialOutput) ToApplicationFederatedIdentityCredentialOutput added in v5.15.0

func (o ApplicationFederatedIdentityCredentialOutput) ToApplicationFederatedIdentityCredentialOutput() ApplicationFederatedIdentityCredentialOutput

func (ApplicationFederatedIdentityCredentialOutput) ToApplicationFederatedIdentityCredentialOutputWithContext added in v5.15.0

func (o ApplicationFederatedIdentityCredentialOutput) ToApplicationFederatedIdentityCredentialOutputWithContext(ctx context.Context) ApplicationFederatedIdentityCredentialOutput

type ApplicationFederatedIdentityCredentialState added in v5.15.0

type ApplicationFederatedIdentityCredentialState struct {
	// The resource ID of the application for which this federated identity credential should be created. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The object ID of the application for which this federated identity credential should be created
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringPtrInput
	// List of audiences that can appear in the external token. This specifies what should be accepted in the `aud` claim of incoming tokens.
	Audiences pulumi.StringArrayInput
	// A UUID used to uniquely identify this federated identity credential.
	CredentialId pulumi.StringPtrInput
	// A description for the federated identity credential.
	Description pulumi.StringPtrInput
	// A unique display name for the federated identity credential. Changing this forces a new resource to be created.
	DisplayName pulumi.StringPtrInput
	// The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app.
	Issuer pulumi.StringPtrInput
	// The identifier of the external software workload within the external identity provider. The combination of issuer and subject must be unique on the app.
	Subject pulumi.StringPtrInput
}

func (ApplicationFederatedIdentityCredentialState) ElementType added in v5.15.0

type ApplicationFromTemplate added in v5.43.0

type ApplicationFromTemplate struct {
	pulumi.CustomResourceState

	// The resource ID for the application.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The object ID for the application.
	ApplicationObjectId pulumi.StringOutput `pulumi:"applicationObjectId"`
	// The display name for the application.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The resource ID for the service principal.
	ServicePrincipalId pulumi.StringOutput `pulumi:"servicePrincipalId"`
	// The object ID for the service principal.
	ServicePrincipalObjectId pulumi.StringOutput `pulumi:"servicePrincipalObjectId"`
	// Unique ID for a templated application in the Azure AD App Gallery, from which to create the application. Changing this forces a new resource to be created.
	TemplateId pulumi.StringOutput `pulumi:"templateId"`
}

Creates an application registration and associated service principal from a gallery template.

> The Application resource can also be used to instantiate a gallery application, however unlike the `Application` resource, this resource does not attempt to manage any properties of the resulting application.

## API Permissions

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

When authenticated with a service principal, this resource requires one of the following application roles: `Application.ReadWrite.OwnedBy` or `Application.ReadWrite.All`

When authenticated with a user principal, this resource may require one of the following directory roles: `Application Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.GetApplicationTemplate(ctx, &azuread.GetApplicationTemplateArgs{
			DisplayName: pulumi.StringRef("Marketo"),
		}, nil)
		if err != nil {
			return err
		}
		exampleApplicationFromTemplate, err := azuread.NewApplicationFromTemplate(ctx, "example", &azuread.ApplicationFromTemplateArgs{
			DisplayName: pulumi.String("Example Application"),
			TemplateId:  pulumi.String(example.TemplateId),
		})
		if err != nil {
			return err
		}
		_ = azuread.LookupApplicationOutput(ctx, azuread.GetApplicationOutputArgs{
			ObjectId: exampleApplicationFromTemplate.ApplicationObjectId,
		}, nil)
		_ = azuread.LookupServicePrincipalOutput(ctx, azuread.GetServicePrincipalOutputArgs{
			ObjectId: exampleApplicationFromTemplate.ServicePrincipalObjectId,
		}, nil)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Templated Applications can be imported using the template ID, the object ID of the application, and the object ID of the service principal, in the following format.

```sh $ pulumi import azuread:index/applicationFromTemplate:ApplicationFromTemplate example /applicationTemplates/00000000-0000-0000-0000-000000000000/instantiate/11111111-1111-1111-1111-111111111111/22222222-2222-2222-2222-222222222222 ```

func GetApplicationFromTemplate added in v5.43.0

func GetApplicationFromTemplate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationFromTemplateState, opts ...pulumi.ResourceOption) (*ApplicationFromTemplate, error)

GetApplicationFromTemplate gets an existing ApplicationFromTemplate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationFromTemplate added in v5.43.0

func NewApplicationFromTemplate(ctx *pulumi.Context,
	name string, args *ApplicationFromTemplateArgs, opts ...pulumi.ResourceOption) (*ApplicationFromTemplate, error)

NewApplicationFromTemplate registers a new resource with the given unique name, arguments, and options.

func (*ApplicationFromTemplate) ElementType added in v5.43.0

func (*ApplicationFromTemplate) ElementType() reflect.Type

func (*ApplicationFromTemplate) ToApplicationFromTemplateOutput added in v5.43.0

func (i *ApplicationFromTemplate) ToApplicationFromTemplateOutput() ApplicationFromTemplateOutput

func (*ApplicationFromTemplate) ToApplicationFromTemplateOutputWithContext added in v5.43.0

func (i *ApplicationFromTemplate) ToApplicationFromTemplateOutputWithContext(ctx context.Context) ApplicationFromTemplateOutput

type ApplicationFromTemplateArgs added in v5.43.0

type ApplicationFromTemplateArgs struct {
	// The display name for the application.
	DisplayName pulumi.StringInput
	// Unique ID for a templated application in the Azure AD App Gallery, from which to create the application. Changing this forces a new resource to be created.
	TemplateId pulumi.StringInput
}

The set of arguments for constructing a ApplicationFromTemplate resource.

func (ApplicationFromTemplateArgs) ElementType added in v5.43.0

type ApplicationFromTemplateArray added in v5.43.0

type ApplicationFromTemplateArray []ApplicationFromTemplateInput

func (ApplicationFromTemplateArray) ElementType added in v5.43.0

func (ApplicationFromTemplateArray) ToApplicationFromTemplateArrayOutput added in v5.43.0

func (i ApplicationFromTemplateArray) ToApplicationFromTemplateArrayOutput() ApplicationFromTemplateArrayOutput

func (ApplicationFromTemplateArray) ToApplicationFromTemplateArrayOutputWithContext added in v5.43.0

func (i ApplicationFromTemplateArray) ToApplicationFromTemplateArrayOutputWithContext(ctx context.Context) ApplicationFromTemplateArrayOutput

type ApplicationFromTemplateArrayInput added in v5.43.0

type ApplicationFromTemplateArrayInput interface {
	pulumi.Input

	ToApplicationFromTemplateArrayOutput() ApplicationFromTemplateArrayOutput
	ToApplicationFromTemplateArrayOutputWithContext(context.Context) ApplicationFromTemplateArrayOutput
}

ApplicationFromTemplateArrayInput is an input type that accepts ApplicationFromTemplateArray and ApplicationFromTemplateArrayOutput values. You can construct a concrete instance of `ApplicationFromTemplateArrayInput` via:

ApplicationFromTemplateArray{ ApplicationFromTemplateArgs{...} }

type ApplicationFromTemplateArrayOutput added in v5.43.0

type ApplicationFromTemplateArrayOutput struct{ *pulumi.OutputState }

func (ApplicationFromTemplateArrayOutput) ElementType added in v5.43.0

func (ApplicationFromTemplateArrayOutput) Index added in v5.43.0

func (ApplicationFromTemplateArrayOutput) ToApplicationFromTemplateArrayOutput added in v5.43.0

func (o ApplicationFromTemplateArrayOutput) ToApplicationFromTemplateArrayOutput() ApplicationFromTemplateArrayOutput

func (ApplicationFromTemplateArrayOutput) ToApplicationFromTemplateArrayOutputWithContext added in v5.43.0

func (o ApplicationFromTemplateArrayOutput) ToApplicationFromTemplateArrayOutputWithContext(ctx context.Context) ApplicationFromTemplateArrayOutput

type ApplicationFromTemplateInput added in v5.43.0

type ApplicationFromTemplateInput interface {
	pulumi.Input

	ToApplicationFromTemplateOutput() ApplicationFromTemplateOutput
	ToApplicationFromTemplateOutputWithContext(ctx context.Context) ApplicationFromTemplateOutput
}

type ApplicationFromTemplateMap added in v5.43.0

type ApplicationFromTemplateMap map[string]ApplicationFromTemplateInput

func (ApplicationFromTemplateMap) ElementType added in v5.43.0

func (ApplicationFromTemplateMap) ElementType() reflect.Type

func (ApplicationFromTemplateMap) ToApplicationFromTemplateMapOutput added in v5.43.0

func (i ApplicationFromTemplateMap) ToApplicationFromTemplateMapOutput() ApplicationFromTemplateMapOutput

func (ApplicationFromTemplateMap) ToApplicationFromTemplateMapOutputWithContext added in v5.43.0

func (i ApplicationFromTemplateMap) ToApplicationFromTemplateMapOutputWithContext(ctx context.Context) ApplicationFromTemplateMapOutput

type ApplicationFromTemplateMapInput added in v5.43.0

type ApplicationFromTemplateMapInput interface {
	pulumi.Input

	ToApplicationFromTemplateMapOutput() ApplicationFromTemplateMapOutput
	ToApplicationFromTemplateMapOutputWithContext(context.Context) ApplicationFromTemplateMapOutput
}

ApplicationFromTemplateMapInput is an input type that accepts ApplicationFromTemplateMap and ApplicationFromTemplateMapOutput values. You can construct a concrete instance of `ApplicationFromTemplateMapInput` via:

ApplicationFromTemplateMap{ "key": ApplicationFromTemplateArgs{...} }

type ApplicationFromTemplateMapOutput added in v5.43.0

type ApplicationFromTemplateMapOutput struct{ *pulumi.OutputState }

func (ApplicationFromTemplateMapOutput) ElementType added in v5.43.0

func (ApplicationFromTemplateMapOutput) MapIndex added in v5.43.0

func (ApplicationFromTemplateMapOutput) ToApplicationFromTemplateMapOutput added in v5.43.0

func (o ApplicationFromTemplateMapOutput) ToApplicationFromTemplateMapOutput() ApplicationFromTemplateMapOutput

func (ApplicationFromTemplateMapOutput) ToApplicationFromTemplateMapOutputWithContext added in v5.43.0

func (o ApplicationFromTemplateMapOutput) ToApplicationFromTemplateMapOutputWithContext(ctx context.Context) ApplicationFromTemplateMapOutput

type ApplicationFromTemplateOutput added in v5.43.0

type ApplicationFromTemplateOutput struct{ *pulumi.OutputState }

func (ApplicationFromTemplateOutput) ApplicationId added in v5.43.0

The resource ID for the application.

func (ApplicationFromTemplateOutput) ApplicationObjectId added in v5.43.0

func (o ApplicationFromTemplateOutput) ApplicationObjectId() pulumi.StringOutput

The object ID for the application.

func (ApplicationFromTemplateOutput) DisplayName added in v5.43.0

The display name for the application.

func (ApplicationFromTemplateOutput) ElementType added in v5.43.0

func (ApplicationFromTemplateOutput) ServicePrincipalId added in v5.43.0

func (o ApplicationFromTemplateOutput) ServicePrincipalId() pulumi.StringOutput

The resource ID for the service principal.

func (ApplicationFromTemplateOutput) ServicePrincipalObjectId added in v5.43.0

func (o ApplicationFromTemplateOutput) ServicePrincipalObjectId() pulumi.StringOutput

The object ID for the service principal.

func (ApplicationFromTemplateOutput) TemplateId added in v5.43.0

Unique ID for a templated application in the Azure AD App Gallery, from which to create the application. Changing this forces a new resource to be created.

func (ApplicationFromTemplateOutput) ToApplicationFromTemplateOutput added in v5.43.0

func (o ApplicationFromTemplateOutput) ToApplicationFromTemplateOutput() ApplicationFromTemplateOutput

func (ApplicationFromTemplateOutput) ToApplicationFromTemplateOutputWithContext added in v5.43.0

func (o ApplicationFromTemplateOutput) ToApplicationFromTemplateOutputWithContext(ctx context.Context) ApplicationFromTemplateOutput

type ApplicationFromTemplateState added in v5.43.0

type ApplicationFromTemplateState struct {
	// The resource ID for the application.
	ApplicationId pulumi.StringPtrInput
	// The object ID for the application.
	ApplicationObjectId pulumi.StringPtrInput
	// The display name for the application.
	DisplayName pulumi.StringPtrInput
	// The resource ID for the service principal.
	ServicePrincipalId pulumi.StringPtrInput
	// The object ID for the service principal.
	ServicePrincipalObjectId pulumi.StringPtrInput
	// Unique ID for a templated application in the Azure AD App Gallery, from which to create the application. Changing this forces a new resource to be created.
	TemplateId pulumi.StringPtrInput
}

func (ApplicationFromTemplateState) ElementType added in v5.43.0

type ApplicationIdentifierUri added in v5.43.0

type ApplicationIdentifierUri struct {
	pulumi.CustomResourceState

	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. Changing this forces a new resource to be created.
	IdentifierUri pulumi.StringOutput `pulumi:"identifierUri"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationIdentifierUri(ctx, "example", &azuread.ApplicationIdentifierUriArgs{
			ApplicationId: example.ID(),
			IdentifierUri: pulumi.String("https://app.hashitown.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

> **Tip** For managing multiple identifier URIs for the same application, create another instance of this resource

*Usage with Application resource*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationIdentifierUri(ctx, "example", &azuread.ApplicationIdentifierUriArgs{
			ApplicationId: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Application Identifier URIs can be imported using the object ID of the application and the base64-encoded identifier URI, in the following format.

```sh $ pulumi import azuread:index/applicationIdentifierUri:ApplicationIdentifierUri example /applications/00000000-0000-0000-0000-000000000000/identifierUris/aHR0cHM6Ly9leGFtcGxlLm5ldC8= ```

func GetApplicationIdentifierUri added in v5.43.0

func GetApplicationIdentifierUri(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationIdentifierUriState, opts ...pulumi.ResourceOption) (*ApplicationIdentifierUri, error)

GetApplicationIdentifierUri gets an existing ApplicationIdentifierUri resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationIdentifierUri added in v5.43.0

func NewApplicationIdentifierUri(ctx *pulumi.Context,
	name string, args *ApplicationIdentifierUriArgs, opts ...pulumi.ResourceOption) (*ApplicationIdentifierUri, error)

NewApplicationIdentifierUri registers a new resource with the given unique name, arguments, and options.

func (*ApplicationIdentifierUri) ElementType added in v5.43.0

func (*ApplicationIdentifierUri) ElementType() reflect.Type

func (*ApplicationIdentifierUri) ToApplicationIdentifierUriOutput added in v5.43.0

func (i *ApplicationIdentifierUri) ToApplicationIdentifierUriOutput() ApplicationIdentifierUriOutput

func (*ApplicationIdentifierUri) ToApplicationIdentifierUriOutputWithContext added in v5.43.0

func (i *ApplicationIdentifierUri) ToApplicationIdentifierUriOutputWithContext(ctx context.Context) ApplicationIdentifierUriOutput

type ApplicationIdentifierUriArgs added in v5.43.0

type ApplicationIdentifierUriArgs struct {
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringInput
	// The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. Changing this forces a new resource to be created.
	IdentifierUri pulumi.StringInput
}

The set of arguments for constructing a ApplicationIdentifierUri resource.

func (ApplicationIdentifierUriArgs) ElementType added in v5.43.0

type ApplicationIdentifierUriArray added in v5.43.0

type ApplicationIdentifierUriArray []ApplicationIdentifierUriInput

func (ApplicationIdentifierUriArray) ElementType added in v5.43.0

func (ApplicationIdentifierUriArray) ToApplicationIdentifierUriArrayOutput added in v5.43.0

func (i ApplicationIdentifierUriArray) ToApplicationIdentifierUriArrayOutput() ApplicationIdentifierUriArrayOutput

func (ApplicationIdentifierUriArray) ToApplicationIdentifierUriArrayOutputWithContext added in v5.43.0

func (i ApplicationIdentifierUriArray) ToApplicationIdentifierUriArrayOutputWithContext(ctx context.Context) ApplicationIdentifierUriArrayOutput

type ApplicationIdentifierUriArrayInput added in v5.43.0

type ApplicationIdentifierUriArrayInput interface {
	pulumi.Input

	ToApplicationIdentifierUriArrayOutput() ApplicationIdentifierUriArrayOutput
	ToApplicationIdentifierUriArrayOutputWithContext(context.Context) ApplicationIdentifierUriArrayOutput
}

ApplicationIdentifierUriArrayInput is an input type that accepts ApplicationIdentifierUriArray and ApplicationIdentifierUriArrayOutput values. You can construct a concrete instance of `ApplicationIdentifierUriArrayInput` via:

ApplicationIdentifierUriArray{ ApplicationIdentifierUriArgs{...} }

type ApplicationIdentifierUriArrayOutput added in v5.43.0

type ApplicationIdentifierUriArrayOutput struct{ *pulumi.OutputState }

func (ApplicationIdentifierUriArrayOutput) ElementType added in v5.43.0

func (ApplicationIdentifierUriArrayOutput) Index added in v5.43.0

func (ApplicationIdentifierUriArrayOutput) ToApplicationIdentifierUriArrayOutput added in v5.43.0

func (o ApplicationIdentifierUriArrayOutput) ToApplicationIdentifierUriArrayOutput() ApplicationIdentifierUriArrayOutput

func (ApplicationIdentifierUriArrayOutput) ToApplicationIdentifierUriArrayOutputWithContext added in v5.43.0

func (o ApplicationIdentifierUriArrayOutput) ToApplicationIdentifierUriArrayOutputWithContext(ctx context.Context) ApplicationIdentifierUriArrayOutput

type ApplicationIdentifierUriInput added in v5.43.0

type ApplicationIdentifierUriInput interface {
	pulumi.Input

	ToApplicationIdentifierUriOutput() ApplicationIdentifierUriOutput
	ToApplicationIdentifierUriOutputWithContext(ctx context.Context) ApplicationIdentifierUriOutput
}

type ApplicationIdentifierUriMap added in v5.43.0

type ApplicationIdentifierUriMap map[string]ApplicationIdentifierUriInput

func (ApplicationIdentifierUriMap) ElementType added in v5.43.0

func (ApplicationIdentifierUriMap) ToApplicationIdentifierUriMapOutput added in v5.43.0

func (i ApplicationIdentifierUriMap) ToApplicationIdentifierUriMapOutput() ApplicationIdentifierUriMapOutput

func (ApplicationIdentifierUriMap) ToApplicationIdentifierUriMapOutputWithContext added in v5.43.0

func (i ApplicationIdentifierUriMap) ToApplicationIdentifierUriMapOutputWithContext(ctx context.Context) ApplicationIdentifierUriMapOutput

type ApplicationIdentifierUriMapInput added in v5.43.0

type ApplicationIdentifierUriMapInput interface {
	pulumi.Input

	ToApplicationIdentifierUriMapOutput() ApplicationIdentifierUriMapOutput
	ToApplicationIdentifierUriMapOutputWithContext(context.Context) ApplicationIdentifierUriMapOutput
}

ApplicationIdentifierUriMapInput is an input type that accepts ApplicationIdentifierUriMap and ApplicationIdentifierUriMapOutput values. You can construct a concrete instance of `ApplicationIdentifierUriMapInput` via:

ApplicationIdentifierUriMap{ "key": ApplicationIdentifierUriArgs{...} }

type ApplicationIdentifierUriMapOutput added in v5.43.0

type ApplicationIdentifierUriMapOutput struct{ *pulumi.OutputState }

func (ApplicationIdentifierUriMapOutput) ElementType added in v5.43.0

func (ApplicationIdentifierUriMapOutput) MapIndex added in v5.43.0

func (ApplicationIdentifierUriMapOutput) ToApplicationIdentifierUriMapOutput added in v5.43.0

func (o ApplicationIdentifierUriMapOutput) ToApplicationIdentifierUriMapOutput() ApplicationIdentifierUriMapOutput

func (ApplicationIdentifierUriMapOutput) ToApplicationIdentifierUriMapOutputWithContext added in v5.43.0

func (o ApplicationIdentifierUriMapOutput) ToApplicationIdentifierUriMapOutputWithContext(ctx context.Context) ApplicationIdentifierUriMapOutput

type ApplicationIdentifierUriOutput added in v5.43.0

type ApplicationIdentifierUriOutput struct{ *pulumi.OutputState }

func (ApplicationIdentifierUriOutput) ApplicationId added in v5.43.0

The resource ID of the application registration. Changing this forces a new resource to be created.

func (ApplicationIdentifierUriOutput) ElementType added in v5.43.0

func (ApplicationIdentifierUriOutput) IdentifierUri added in v5.43.0

The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. Changing this forces a new resource to be created.

func (ApplicationIdentifierUriOutput) ToApplicationIdentifierUriOutput added in v5.43.0

func (o ApplicationIdentifierUriOutput) ToApplicationIdentifierUriOutput() ApplicationIdentifierUriOutput

func (ApplicationIdentifierUriOutput) ToApplicationIdentifierUriOutputWithContext added in v5.43.0

func (o ApplicationIdentifierUriOutput) ToApplicationIdentifierUriOutputWithContext(ctx context.Context) ApplicationIdentifierUriOutput

type ApplicationIdentifierUriState added in v5.43.0

type ApplicationIdentifierUriState struct {
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. Changing this forces a new resource to be created.
	IdentifierUri pulumi.StringPtrInput
}

func (ApplicationIdentifierUriState) ElementType added in v5.43.0

type ApplicationInput

type ApplicationInput interface {
	pulumi.Input

	ToApplicationOutput() ApplicationOutput
	ToApplicationOutputWithContext(ctx context.Context) ApplicationOutput
}

type ApplicationKnownClients added in v5.43.0

type ApplicationKnownClients struct {
	pulumi.CustomResourceState

	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// A set of client IDs for the known applications.
	KnownClientIds pulumi.StringArrayOutput `pulumi:"knownClientIds"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		client, err := azuread.NewApplicationRegistration(ctx, "client", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example client"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationKnownClients(ctx, "example", &azuread.ApplicationKnownClientsArgs{
			ApplicationId: example.ID(),
			KnownClientIds: pulumi.StringArray{
				client.ClientId,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Application Known Clients can be imported using the object ID of the application in the following format.

```sh $ pulumi import azuread:index/applicationKnownClients:ApplicationKnownClients example /applications/00000000-0000-0000-0000-000000000000/knownClients ```

func GetApplicationKnownClients added in v5.43.0

func GetApplicationKnownClients(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationKnownClientsState, opts ...pulumi.ResourceOption) (*ApplicationKnownClients, error)

GetApplicationKnownClients gets an existing ApplicationKnownClients resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationKnownClients added in v5.43.0

func NewApplicationKnownClients(ctx *pulumi.Context,
	name string, args *ApplicationKnownClientsArgs, opts ...pulumi.ResourceOption) (*ApplicationKnownClients, error)

NewApplicationKnownClients registers a new resource with the given unique name, arguments, and options.

func (*ApplicationKnownClients) ElementType added in v5.43.0

func (*ApplicationKnownClients) ElementType() reflect.Type

func (*ApplicationKnownClients) ToApplicationKnownClientsOutput added in v5.43.0

func (i *ApplicationKnownClients) ToApplicationKnownClientsOutput() ApplicationKnownClientsOutput

func (*ApplicationKnownClients) ToApplicationKnownClientsOutputWithContext added in v5.43.0

func (i *ApplicationKnownClients) ToApplicationKnownClientsOutputWithContext(ctx context.Context) ApplicationKnownClientsOutput

type ApplicationKnownClientsArgs added in v5.43.0

type ApplicationKnownClientsArgs struct {
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringInput
	// A set of client IDs for the known applications.
	KnownClientIds pulumi.StringArrayInput
}

The set of arguments for constructing a ApplicationKnownClients resource.

func (ApplicationKnownClientsArgs) ElementType added in v5.43.0

type ApplicationKnownClientsArray added in v5.43.0

type ApplicationKnownClientsArray []ApplicationKnownClientsInput

func (ApplicationKnownClientsArray) ElementType added in v5.43.0

func (ApplicationKnownClientsArray) ToApplicationKnownClientsArrayOutput added in v5.43.0

func (i ApplicationKnownClientsArray) ToApplicationKnownClientsArrayOutput() ApplicationKnownClientsArrayOutput

func (ApplicationKnownClientsArray) ToApplicationKnownClientsArrayOutputWithContext added in v5.43.0

func (i ApplicationKnownClientsArray) ToApplicationKnownClientsArrayOutputWithContext(ctx context.Context) ApplicationKnownClientsArrayOutput

type ApplicationKnownClientsArrayInput added in v5.43.0

type ApplicationKnownClientsArrayInput interface {
	pulumi.Input

	ToApplicationKnownClientsArrayOutput() ApplicationKnownClientsArrayOutput
	ToApplicationKnownClientsArrayOutputWithContext(context.Context) ApplicationKnownClientsArrayOutput
}

ApplicationKnownClientsArrayInput is an input type that accepts ApplicationKnownClientsArray and ApplicationKnownClientsArrayOutput values. You can construct a concrete instance of `ApplicationKnownClientsArrayInput` via:

ApplicationKnownClientsArray{ ApplicationKnownClientsArgs{...} }

type ApplicationKnownClientsArrayOutput added in v5.43.0

type ApplicationKnownClientsArrayOutput struct{ *pulumi.OutputState }

func (ApplicationKnownClientsArrayOutput) ElementType added in v5.43.0

func (ApplicationKnownClientsArrayOutput) Index added in v5.43.0

func (ApplicationKnownClientsArrayOutput) ToApplicationKnownClientsArrayOutput added in v5.43.0

func (o ApplicationKnownClientsArrayOutput) ToApplicationKnownClientsArrayOutput() ApplicationKnownClientsArrayOutput

func (ApplicationKnownClientsArrayOutput) ToApplicationKnownClientsArrayOutputWithContext added in v5.43.0

func (o ApplicationKnownClientsArrayOutput) ToApplicationKnownClientsArrayOutputWithContext(ctx context.Context) ApplicationKnownClientsArrayOutput

type ApplicationKnownClientsInput added in v5.43.0

type ApplicationKnownClientsInput interface {
	pulumi.Input

	ToApplicationKnownClientsOutput() ApplicationKnownClientsOutput
	ToApplicationKnownClientsOutputWithContext(ctx context.Context) ApplicationKnownClientsOutput
}

type ApplicationKnownClientsMap added in v5.43.0

type ApplicationKnownClientsMap map[string]ApplicationKnownClientsInput

func (ApplicationKnownClientsMap) ElementType added in v5.43.0

func (ApplicationKnownClientsMap) ElementType() reflect.Type

func (ApplicationKnownClientsMap) ToApplicationKnownClientsMapOutput added in v5.43.0

func (i ApplicationKnownClientsMap) ToApplicationKnownClientsMapOutput() ApplicationKnownClientsMapOutput

func (ApplicationKnownClientsMap) ToApplicationKnownClientsMapOutputWithContext added in v5.43.0

func (i ApplicationKnownClientsMap) ToApplicationKnownClientsMapOutputWithContext(ctx context.Context) ApplicationKnownClientsMapOutput

type ApplicationKnownClientsMapInput added in v5.43.0

type ApplicationKnownClientsMapInput interface {
	pulumi.Input

	ToApplicationKnownClientsMapOutput() ApplicationKnownClientsMapOutput
	ToApplicationKnownClientsMapOutputWithContext(context.Context) ApplicationKnownClientsMapOutput
}

ApplicationKnownClientsMapInput is an input type that accepts ApplicationKnownClientsMap and ApplicationKnownClientsMapOutput values. You can construct a concrete instance of `ApplicationKnownClientsMapInput` via:

ApplicationKnownClientsMap{ "key": ApplicationKnownClientsArgs{...} }

type ApplicationKnownClientsMapOutput added in v5.43.0

type ApplicationKnownClientsMapOutput struct{ *pulumi.OutputState }

func (ApplicationKnownClientsMapOutput) ElementType added in v5.43.0

func (ApplicationKnownClientsMapOutput) MapIndex added in v5.43.0

func (ApplicationKnownClientsMapOutput) ToApplicationKnownClientsMapOutput added in v5.43.0

func (o ApplicationKnownClientsMapOutput) ToApplicationKnownClientsMapOutput() ApplicationKnownClientsMapOutput

func (ApplicationKnownClientsMapOutput) ToApplicationKnownClientsMapOutputWithContext added in v5.43.0

func (o ApplicationKnownClientsMapOutput) ToApplicationKnownClientsMapOutputWithContext(ctx context.Context) ApplicationKnownClientsMapOutput

type ApplicationKnownClientsOutput added in v5.43.0

type ApplicationKnownClientsOutput struct{ *pulumi.OutputState }

func (ApplicationKnownClientsOutput) ApplicationId added in v5.43.0

The resource ID of the application registration. Changing this forces a new resource to be created.

func (ApplicationKnownClientsOutput) ElementType added in v5.43.0

func (ApplicationKnownClientsOutput) KnownClientIds added in v5.43.0

A set of client IDs for the known applications.

func (ApplicationKnownClientsOutput) ToApplicationKnownClientsOutput added in v5.43.0

func (o ApplicationKnownClientsOutput) ToApplicationKnownClientsOutput() ApplicationKnownClientsOutput

func (ApplicationKnownClientsOutput) ToApplicationKnownClientsOutputWithContext added in v5.43.0

func (o ApplicationKnownClientsOutput) ToApplicationKnownClientsOutputWithContext(ctx context.Context) ApplicationKnownClientsOutput

type ApplicationKnownClientsState added in v5.43.0

type ApplicationKnownClientsState struct {
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// A set of client IDs for the known applications.
	KnownClientIds pulumi.StringArrayInput
}

func (ApplicationKnownClientsState) ElementType added in v5.43.0

type ApplicationMap

type ApplicationMap map[string]ApplicationInput

func (ApplicationMap) ElementType

func (ApplicationMap) ElementType() reflect.Type

func (ApplicationMap) ToApplicationMapOutput

func (i ApplicationMap) ToApplicationMapOutput() ApplicationMapOutput

func (ApplicationMap) ToApplicationMapOutputWithContext

func (i ApplicationMap) ToApplicationMapOutputWithContext(ctx context.Context) ApplicationMapOutput

type ApplicationMapInput

type ApplicationMapInput interface {
	pulumi.Input

	ToApplicationMapOutput() ApplicationMapOutput
	ToApplicationMapOutputWithContext(context.Context) ApplicationMapOutput
}

ApplicationMapInput is an input type that accepts ApplicationMap and ApplicationMapOutput values. You can construct a concrete instance of `ApplicationMapInput` via:

ApplicationMap{ "key": ApplicationArgs{...} }

type ApplicationMapOutput

type ApplicationMapOutput struct{ *pulumi.OutputState }

func (ApplicationMapOutput) ElementType

func (ApplicationMapOutput) ElementType() reflect.Type

func (ApplicationMapOutput) MapIndex

func (ApplicationMapOutput) ToApplicationMapOutput

func (o ApplicationMapOutput) ToApplicationMapOutput() ApplicationMapOutput

func (ApplicationMapOutput) ToApplicationMapOutputWithContext

func (o ApplicationMapOutput) ToApplicationMapOutputWithContext(ctx context.Context) ApplicationMapOutput

type ApplicationOptionalClaims

type ApplicationOptionalClaims struct {
	pulumi.CustomResourceState

	// One or more `accessToken` blocks as documented below.
	AccessTokens ApplicationOptionalClaimsAccessTokenArrayOutput `pulumi:"accessTokens"`
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// One or more `idToken` blocks as documented below.
	IdTokens ApplicationOptionalClaimsIdTokenArrayOutput `pulumi:"idTokens"`
	// One or more `saml2Token` blocks as documented below.
	//
	// > At least one of `accessToken`, `idToken` or `saml2Token` must be specified
	Saml2Tokens ApplicationOptionalClaimsSaml2TokenArrayOutput `pulumi:"saml2Tokens"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationOptionalClaims(ctx, "example", &azuread.ApplicationOptionalClaimsArgs{
			ApplicationId: example.ID(),
			AccessTokens: azuread.ApplicationOptionalClaimsAccessTokenArray{
				&azuread.ApplicationOptionalClaimsAccessTokenArgs{
					Name: pulumi.String("myclaim"),
				},
				&azuread.ApplicationOptionalClaimsAccessTokenArgs{
					Name: pulumi.String("otherclaim"),
				},
			},
			IdTokens: azuread.ApplicationOptionalClaimsIdTokenArray{
				&azuread.ApplicationOptionalClaimsIdTokenArgs{
					Name:      pulumi.String("userclaim"),
					Source:    pulumi.String("user"),
					Essential: pulumi.Bool(true),
					AdditionalProperties: pulumi.StringArray{
						pulumi.String("emit_as_roles"),
					},
				},
			},
			Saml2Tokens: azuread.ApplicationOptionalClaimsSaml2TokenArray{
				&azuread.ApplicationOptionalClaimsSaml2TokenArgs{
					Name: pulumi.String("samlexample"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Application Optional Claims can be imported using the object ID of the application, in the following format.

```sh $ pulumi import azuread:index/applicationOptionalClaims:ApplicationOptionalClaims example /applications/00000000-0000-0000-0000-000000000000 ```

func GetApplicationOptionalClaims added in v5.44.0

func GetApplicationOptionalClaims(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationOptionalClaimsState, opts ...pulumi.ResourceOption) (*ApplicationOptionalClaims, error)

GetApplicationOptionalClaims gets an existing ApplicationOptionalClaims resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationOptionalClaims added in v5.44.0

func NewApplicationOptionalClaims(ctx *pulumi.Context,
	name string, args *ApplicationOptionalClaimsArgs, opts ...pulumi.ResourceOption) (*ApplicationOptionalClaims, error)

NewApplicationOptionalClaims registers a new resource with the given unique name, arguments, and options.

func (*ApplicationOptionalClaims) ElementType added in v5.44.0

func (*ApplicationOptionalClaims) ElementType() reflect.Type

func (*ApplicationOptionalClaims) ToApplicationOptionalClaimsOutput added in v5.44.0

func (i *ApplicationOptionalClaims) ToApplicationOptionalClaimsOutput() ApplicationOptionalClaimsOutput

func (*ApplicationOptionalClaims) ToApplicationOptionalClaimsOutputWithContext added in v5.44.0

func (i *ApplicationOptionalClaims) ToApplicationOptionalClaimsOutputWithContext(ctx context.Context) ApplicationOptionalClaimsOutput

type ApplicationOptionalClaimsAccessToken

type ApplicationOptionalClaimsAccessToken struct {
	// List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: `cloudDisplayname`, `dnsDomainAndSamAccountName`, `emitAsRoles`, `includeExternallyAuthenticatedUpnWithoutHash`, `includeExternallyAuthenticatedUpn`, `maxSizeLimit`, `netbiosDomainAndSamAccountName`, `onPremiseSecurityIdentifier`, `samAccountName`, and `useGuid`.
	AdditionalProperties []string `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential *bool `pulumi:"essential"`
	// The name of the optional claim.
	Name string `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source *string `pulumi:"source"`
}

type ApplicationOptionalClaimsAccessTokenArgs

type ApplicationOptionalClaimsAccessTokenArgs struct {
	// List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: `cloudDisplayname`, `dnsDomainAndSamAccountName`, `emitAsRoles`, `includeExternallyAuthenticatedUpnWithoutHash`, `includeExternallyAuthenticatedUpn`, `maxSizeLimit`, `netbiosDomainAndSamAccountName`, `onPremiseSecurityIdentifier`, `samAccountName`, and `useGuid`.
	AdditionalProperties pulumi.StringArrayInput `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential pulumi.BoolPtrInput `pulumi:"essential"`
	// The name of the optional claim.
	Name pulumi.StringInput `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source pulumi.StringPtrInput `pulumi:"source"`
}

func (ApplicationOptionalClaimsAccessTokenArgs) ElementType

func (ApplicationOptionalClaimsAccessTokenArgs) ToApplicationOptionalClaimsAccessTokenOutput

func (i ApplicationOptionalClaimsAccessTokenArgs) ToApplicationOptionalClaimsAccessTokenOutput() ApplicationOptionalClaimsAccessTokenOutput

func (ApplicationOptionalClaimsAccessTokenArgs) ToApplicationOptionalClaimsAccessTokenOutputWithContext

func (i ApplicationOptionalClaimsAccessTokenArgs) ToApplicationOptionalClaimsAccessTokenOutputWithContext(ctx context.Context) ApplicationOptionalClaimsAccessTokenOutput

type ApplicationOptionalClaimsAccessTokenArray

type ApplicationOptionalClaimsAccessTokenArray []ApplicationOptionalClaimsAccessTokenInput

func (ApplicationOptionalClaimsAccessTokenArray) ElementType

func (ApplicationOptionalClaimsAccessTokenArray) ToApplicationOptionalClaimsAccessTokenArrayOutput

func (i ApplicationOptionalClaimsAccessTokenArray) ToApplicationOptionalClaimsAccessTokenArrayOutput() ApplicationOptionalClaimsAccessTokenArrayOutput

func (ApplicationOptionalClaimsAccessTokenArray) ToApplicationOptionalClaimsAccessTokenArrayOutputWithContext

func (i ApplicationOptionalClaimsAccessTokenArray) ToApplicationOptionalClaimsAccessTokenArrayOutputWithContext(ctx context.Context) ApplicationOptionalClaimsAccessTokenArrayOutput

type ApplicationOptionalClaimsAccessTokenArrayInput

type ApplicationOptionalClaimsAccessTokenArrayInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsAccessTokenArrayOutput() ApplicationOptionalClaimsAccessTokenArrayOutput
	ToApplicationOptionalClaimsAccessTokenArrayOutputWithContext(context.Context) ApplicationOptionalClaimsAccessTokenArrayOutput
}

ApplicationOptionalClaimsAccessTokenArrayInput is an input type that accepts ApplicationOptionalClaimsAccessTokenArray and ApplicationOptionalClaimsAccessTokenArrayOutput values. You can construct a concrete instance of `ApplicationOptionalClaimsAccessTokenArrayInput` via:

ApplicationOptionalClaimsAccessTokenArray{ ApplicationOptionalClaimsAccessTokenArgs{...} }

type ApplicationOptionalClaimsAccessTokenArrayOutput

type ApplicationOptionalClaimsAccessTokenArrayOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsAccessTokenArrayOutput) ElementType

func (ApplicationOptionalClaimsAccessTokenArrayOutput) Index

func (ApplicationOptionalClaimsAccessTokenArrayOutput) ToApplicationOptionalClaimsAccessTokenArrayOutput

func (o ApplicationOptionalClaimsAccessTokenArrayOutput) ToApplicationOptionalClaimsAccessTokenArrayOutput() ApplicationOptionalClaimsAccessTokenArrayOutput

func (ApplicationOptionalClaimsAccessTokenArrayOutput) ToApplicationOptionalClaimsAccessTokenArrayOutputWithContext

func (o ApplicationOptionalClaimsAccessTokenArrayOutput) ToApplicationOptionalClaimsAccessTokenArrayOutputWithContext(ctx context.Context) ApplicationOptionalClaimsAccessTokenArrayOutput

type ApplicationOptionalClaimsAccessTokenInput

type ApplicationOptionalClaimsAccessTokenInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsAccessTokenOutput() ApplicationOptionalClaimsAccessTokenOutput
	ToApplicationOptionalClaimsAccessTokenOutputWithContext(context.Context) ApplicationOptionalClaimsAccessTokenOutput
}

ApplicationOptionalClaimsAccessTokenInput is an input type that accepts ApplicationOptionalClaimsAccessTokenArgs and ApplicationOptionalClaimsAccessTokenOutput values. You can construct a concrete instance of `ApplicationOptionalClaimsAccessTokenInput` via:

ApplicationOptionalClaimsAccessTokenArgs{...}

type ApplicationOptionalClaimsAccessTokenOutput

type ApplicationOptionalClaimsAccessTokenOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsAccessTokenOutput) AdditionalProperties

List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: `cloudDisplayname`, `dnsDomainAndSamAccountName`, `emitAsRoles`, `includeExternallyAuthenticatedUpnWithoutHash`, `includeExternallyAuthenticatedUpn`, `maxSizeLimit`, `netbiosDomainAndSamAccountName`, `onPremiseSecurityIdentifier`, `samAccountName`, and `useGuid`.

func (ApplicationOptionalClaimsAccessTokenOutput) ElementType

func (ApplicationOptionalClaimsAccessTokenOutput) Essential

Whether the claim specified by the client is necessary to ensure a smooth authorization experience.

func (ApplicationOptionalClaimsAccessTokenOutput) Name

The name of the optional claim.

func (ApplicationOptionalClaimsAccessTokenOutput) Source

The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.

func (ApplicationOptionalClaimsAccessTokenOutput) ToApplicationOptionalClaimsAccessTokenOutput

func (o ApplicationOptionalClaimsAccessTokenOutput) ToApplicationOptionalClaimsAccessTokenOutput() ApplicationOptionalClaimsAccessTokenOutput

func (ApplicationOptionalClaimsAccessTokenOutput) ToApplicationOptionalClaimsAccessTokenOutputWithContext

func (o ApplicationOptionalClaimsAccessTokenOutput) ToApplicationOptionalClaimsAccessTokenOutputWithContext(ctx context.Context) ApplicationOptionalClaimsAccessTokenOutput

type ApplicationOptionalClaimsArgs

type ApplicationOptionalClaimsArgs struct {
	// One or more `accessToken` blocks as documented below.
	AccessTokens ApplicationOptionalClaimsAccessTokenArrayInput
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringInput
	// One or more `idToken` blocks as documented below.
	IdTokens ApplicationOptionalClaimsIdTokenArrayInput
	// One or more `saml2Token` blocks as documented below.
	//
	// > At least one of `accessToken`, `idToken` or `saml2Token` must be specified
	Saml2Tokens ApplicationOptionalClaimsSaml2TokenArrayInput
}

The set of arguments for constructing a ApplicationOptionalClaims resource.

func (ApplicationOptionalClaimsArgs) ElementType

type ApplicationOptionalClaimsArray added in v5.44.0

type ApplicationOptionalClaimsArray []ApplicationOptionalClaimsInput

func (ApplicationOptionalClaimsArray) ElementType added in v5.44.0

func (ApplicationOptionalClaimsArray) ToApplicationOptionalClaimsArrayOutput added in v5.44.0

func (i ApplicationOptionalClaimsArray) ToApplicationOptionalClaimsArrayOutput() ApplicationOptionalClaimsArrayOutput

func (ApplicationOptionalClaimsArray) ToApplicationOptionalClaimsArrayOutputWithContext added in v5.44.0

func (i ApplicationOptionalClaimsArray) ToApplicationOptionalClaimsArrayOutputWithContext(ctx context.Context) ApplicationOptionalClaimsArrayOutput

type ApplicationOptionalClaimsArrayInput added in v5.44.0

type ApplicationOptionalClaimsArrayInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsArrayOutput() ApplicationOptionalClaimsArrayOutput
	ToApplicationOptionalClaimsArrayOutputWithContext(context.Context) ApplicationOptionalClaimsArrayOutput
}

ApplicationOptionalClaimsArrayInput is an input type that accepts ApplicationOptionalClaimsArray and ApplicationOptionalClaimsArrayOutput values. You can construct a concrete instance of `ApplicationOptionalClaimsArrayInput` via:

ApplicationOptionalClaimsArray{ ApplicationOptionalClaimsArgs{...} }

type ApplicationOptionalClaimsArrayOutput added in v5.44.0

type ApplicationOptionalClaimsArrayOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsArrayOutput) ElementType added in v5.44.0

func (ApplicationOptionalClaimsArrayOutput) Index added in v5.44.0

func (ApplicationOptionalClaimsArrayOutput) ToApplicationOptionalClaimsArrayOutput added in v5.44.0

func (o ApplicationOptionalClaimsArrayOutput) ToApplicationOptionalClaimsArrayOutput() ApplicationOptionalClaimsArrayOutput

func (ApplicationOptionalClaimsArrayOutput) ToApplicationOptionalClaimsArrayOutputWithContext added in v5.44.0

func (o ApplicationOptionalClaimsArrayOutput) ToApplicationOptionalClaimsArrayOutputWithContext(ctx context.Context) ApplicationOptionalClaimsArrayOutput

type ApplicationOptionalClaimsIdToken

type ApplicationOptionalClaimsIdToken struct {
	// List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: `cloudDisplayname`, `dnsDomainAndSamAccountName`, `emitAsRoles`, `includeExternallyAuthenticatedUpnWithoutHash`, `includeExternallyAuthenticatedUpn`, `maxSizeLimit`, `netbiosDomainAndSamAccountName`, `onPremiseSecurityIdentifier`, `samAccountName`, and `useGuid`.
	AdditionalProperties []string `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential *bool `pulumi:"essential"`
	// The name of the optional claim.
	Name string `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source *string `pulumi:"source"`
}

type ApplicationOptionalClaimsIdTokenArgs

type ApplicationOptionalClaimsIdTokenArgs struct {
	// List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: `cloudDisplayname`, `dnsDomainAndSamAccountName`, `emitAsRoles`, `includeExternallyAuthenticatedUpnWithoutHash`, `includeExternallyAuthenticatedUpn`, `maxSizeLimit`, `netbiosDomainAndSamAccountName`, `onPremiseSecurityIdentifier`, `samAccountName`, and `useGuid`.
	AdditionalProperties pulumi.StringArrayInput `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential pulumi.BoolPtrInput `pulumi:"essential"`
	// The name of the optional claim.
	Name pulumi.StringInput `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source pulumi.StringPtrInput `pulumi:"source"`
}

func (ApplicationOptionalClaimsIdTokenArgs) ElementType

func (ApplicationOptionalClaimsIdTokenArgs) ToApplicationOptionalClaimsIdTokenOutput

func (i ApplicationOptionalClaimsIdTokenArgs) ToApplicationOptionalClaimsIdTokenOutput() ApplicationOptionalClaimsIdTokenOutput

func (ApplicationOptionalClaimsIdTokenArgs) ToApplicationOptionalClaimsIdTokenOutputWithContext

func (i ApplicationOptionalClaimsIdTokenArgs) ToApplicationOptionalClaimsIdTokenOutputWithContext(ctx context.Context) ApplicationOptionalClaimsIdTokenOutput

type ApplicationOptionalClaimsIdTokenArray

type ApplicationOptionalClaimsIdTokenArray []ApplicationOptionalClaimsIdTokenInput

func (ApplicationOptionalClaimsIdTokenArray) ElementType

func (ApplicationOptionalClaimsIdTokenArray) ToApplicationOptionalClaimsIdTokenArrayOutput

func (i ApplicationOptionalClaimsIdTokenArray) ToApplicationOptionalClaimsIdTokenArrayOutput() ApplicationOptionalClaimsIdTokenArrayOutput

func (ApplicationOptionalClaimsIdTokenArray) ToApplicationOptionalClaimsIdTokenArrayOutputWithContext

func (i ApplicationOptionalClaimsIdTokenArray) ToApplicationOptionalClaimsIdTokenArrayOutputWithContext(ctx context.Context) ApplicationOptionalClaimsIdTokenArrayOutput

type ApplicationOptionalClaimsIdTokenArrayInput

type ApplicationOptionalClaimsIdTokenArrayInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsIdTokenArrayOutput() ApplicationOptionalClaimsIdTokenArrayOutput
	ToApplicationOptionalClaimsIdTokenArrayOutputWithContext(context.Context) ApplicationOptionalClaimsIdTokenArrayOutput
}

ApplicationOptionalClaimsIdTokenArrayInput is an input type that accepts ApplicationOptionalClaimsIdTokenArray and ApplicationOptionalClaimsIdTokenArrayOutput values. You can construct a concrete instance of `ApplicationOptionalClaimsIdTokenArrayInput` via:

ApplicationOptionalClaimsIdTokenArray{ ApplicationOptionalClaimsIdTokenArgs{...} }

type ApplicationOptionalClaimsIdTokenArrayOutput

type ApplicationOptionalClaimsIdTokenArrayOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsIdTokenArrayOutput) ElementType

func (ApplicationOptionalClaimsIdTokenArrayOutput) Index

func (ApplicationOptionalClaimsIdTokenArrayOutput) ToApplicationOptionalClaimsIdTokenArrayOutput

func (o ApplicationOptionalClaimsIdTokenArrayOutput) ToApplicationOptionalClaimsIdTokenArrayOutput() ApplicationOptionalClaimsIdTokenArrayOutput

func (ApplicationOptionalClaimsIdTokenArrayOutput) ToApplicationOptionalClaimsIdTokenArrayOutputWithContext

func (o ApplicationOptionalClaimsIdTokenArrayOutput) ToApplicationOptionalClaimsIdTokenArrayOutputWithContext(ctx context.Context) ApplicationOptionalClaimsIdTokenArrayOutput

type ApplicationOptionalClaimsIdTokenInput

type ApplicationOptionalClaimsIdTokenInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsIdTokenOutput() ApplicationOptionalClaimsIdTokenOutput
	ToApplicationOptionalClaimsIdTokenOutputWithContext(context.Context) ApplicationOptionalClaimsIdTokenOutput
}

ApplicationOptionalClaimsIdTokenInput is an input type that accepts ApplicationOptionalClaimsIdTokenArgs and ApplicationOptionalClaimsIdTokenOutput values. You can construct a concrete instance of `ApplicationOptionalClaimsIdTokenInput` via:

ApplicationOptionalClaimsIdTokenArgs{...}

type ApplicationOptionalClaimsIdTokenOutput

type ApplicationOptionalClaimsIdTokenOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsIdTokenOutput) AdditionalProperties

List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: `cloudDisplayname`, `dnsDomainAndSamAccountName`, `emitAsRoles`, `includeExternallyAuthenticatedUpnWithoutHash`, `includeExternallyAuthenticatedUpn`, `maxSizeLimit`, `netbiosDomainAndSamAccountName`, `onPremiseSecurityIdentifier`, `samAccountName`, and `useGuid`.

func (ApplicationOptionalClaimsIdTokenOutput) ElementType

func (ApplicationOptionalClaimsIdTokenOutput) Essential

Whether the claim specified by the client is necessary to ensure a smooth authorization experience.

func (ApplicationOptionalClaimsIdTokenOutput) Name

The name of the optional claim.

func (ApplicationOptionalClaimsIdTokenOutput) Source

The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.

func (ApplicationOptionalClaimsIdTokenOutput) ToApplicationOptionalClaimsIdTokenOutput

func (o ApplicationOptionalClaimsIdTokenOutput) ToApplicationOptionalClaimsIdTokenOutput() ApplicationOptionalClaimsIdTokenOutput

func (ApplicationOptionalClaimsIdTokenOutput) ToApplicationOptionalClaimsIdTokenOutputWithContext

func (o ApplicationOptionalClaimsIdTokenOutput) ToApplicationOptionalClaimsIdTokenOutputWithContext(ctx context.Context) ApplicationOptionalClaimsIdTokenOutput

type ApplicationOptionalClaimsInput

type ApplicationOptionalClaimsInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsOutput() ApplicationOptionalClaimsOutput
	ToApplicationOptionalClaimsOutputWithContext(ctx context.Context) ApplicationOptionalClaimsOutput
}

type ApplicationOptionalClaimsMap added in v5.44.0

type ApplicationOptionalClaimsMap map[string]ApplicationOptionalClaimsInput

func (ApplicationOptionalClaimsMap) ElementType added in v5.44.0

func (ApplicationOptionalClaimsMap) ToApplicationOptionalClaimsMapOutput added in v5.44.0

func (i ApplicationOptionalClaimsMap) ToApplicationOptionalClaimsMapOutput() ApplicationOptionalClaimsMapOutput

func (ApplicationOptionalClaimsMap) ToApplicationOptionalClaimsMapOutputWithContext added in v5.44.0

func (i ApplicationOptionalClaimsMap) ToApplicationOptionalClaimsMapOutputWithContext(ctx context.Context) ApplicationOptionalClaimsMapOutput

type ApplicationOptionalClaimsMapInput added in v5.44.0

type ApplicationOptionalClaimsMapInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsMapOutput() ApplicationOptionalClaimsMapOutput
	ToApplicationOptionalClaimsMapOutputWithContext(context.Context) ApplicationOptionalClaimsMapOutput
}

ApplicationOptionalClaimsMapInput is an input type that accepts ApplicationOptionalClaimsMap and ApplicationOptionalClaimsMapOutput values. You can construct a concrete instance of `ApplicationOptionalClaimsMapInput` via:

ApplicationOptionalClaimsMap{ "key": ApplicationOptionalClaimsArgs{...} }

type ApplicationOptionalClaimsMapOutput added in v5.44.0

type ApplicationOptionalClaimsMapOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsMapOutput) ElementType added in v5.44.0

func (ApplicationOptionalClaimsMapOutput) MapIndex added in v5.44.0

func (ApplicationOptionalClaimsMapOutput) ToApplicationOptionalClaimsMapOutput added in v5.44.0

func (o ApplicationOptionalClaimsMapOutput) ToApplicationOptionalClaimsMapOutput() ApplicationOptionalClaimsMapOutput

func (ApplicationOptionalClaimsMapOutput) ToApplicationOptionalClaimsMapOutputWithContext added in v5.44.0

func (o ApplicationOptionalClaimsMapOutput) ToApplicationOptionalClaimsMapOutputWithContext(ctx context.Context) ApplicationOptionalClaimsMapOutput

type ApplicationOptionalClaimsOutput

type ApplicationOptionalClaimsOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsOutput) AccessTokens

One or more `accessToken` blocks as documented below.

func (ApplicationOptionalClaimsOutput) ApplicationId added in v5.44.0

The resource ID of the application registration. Changing this forces a new resource to be created.

func (ApplicationOptionalClaimsOutput) ElementType

func (ApplicationOptionalClaimsOutput) IdTokens

One or more `idToken` blocks as documented below.

func (ApplicationOptionalClaimsOutput) Saml2Tokens

One or more `saml2Token` blocks as documented below.

> At least one of `accessToken`, `idToken` or `saml2Token` must be specified

func (ApplicationOptionalClaimsOutput) ToApplicationOptionalClaimsOutput

func (o ApplicationOptionalClaimsOutput) ToApplicationOptionalClaimsOutput() ApplicationOptionalClaimsOutput

func (ApplicationOptionalClaimsOutput) ToApplicationOptionalClaimsOutputWithContext

func (o ApplicationOptionalClaimsOutput) ToApplicationOptionalClaimsOutputWithContext(ctx context.Context) ApplicationOptionalClaimsOutput

type ApplicationOptionalClaimsSaml2Token

type ApplicationOptionalClaimsSaml2Token struct {
	// List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: `cloudDisplayname`, `dnsDomainAndSamAccountName`, `emitAsRoles`, `includeExternallyAuthenticatedUpnWithoutHash`, `includeExternallyAuthenticatedUpn`, `maxSizeLimit`, `netbiosDomainAndSamAccountName`, `onPremiseSecurityIdentifier`, `samAccountName`, and `useGuid`.
	AdditionalProperties []string `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential *bool `pulumi:"essential"`
	// The name of the optional claim.
	Name string `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source *string `pulumi:"source"`
}

type ApplicationOptionalClaimsSaml2TokenArgs

type ApplicationOptionalClaimsSaml2TokenArgs struct {
	// List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: `cloudDisplayname`, `dnsDomainAndSamAccountName`, `emitAsRoles`, `includeExternallyAuthenticatedUpnWithoutHash`, `includeExternallyAuthenticatedUpn`, `maxSizeLimit`, `netbiosDomainAndSamAccountName`, `onPremiseSecurityIdentifier`, `samAccountName`, and `useGuid`.
	AdditionalProperties pulumi.StringArrayInput `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential pulumi.BoolPtrInput `pulumi:"essential"`
	// The name of the optional claim.
	Name pulumi.StringInput `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source pulumi.StringPtrInput `pulumi:"source"`
}

func (ApplicationOptionalClaimsSaml2TokenArgs) ElementType

func (ApplicationOptionalClaimsSaml2TokenArgs) ToApplicationOptionalClaimsSaml2TokenOutput

func (i ApplicationOptionalClaimsSaml2TokenArgs) ToApplicationOptionalClaimsSaml2TokenOutput() ApplicationOptionalClaimsSaml2TokenOutput

func (ApplicationOptionalClaimsSaml2TokenArgs) ToApplicationOptionalClaimsSaml2TokenOutputWithContext

func (i ApplicationOptionalClaimsSaml2TokenArgs) ToApplicationOptionalClaimsSaml2TokenOutputWithContext(ctx context.Context) ApplicationOptionalClaimsSaml2TokenOutput

type ApplicationOptionalClaimsSaml2TokenArray

type ApplicationOptionalClaimsSaml2TokenArray []ApplicationOptionalClaimsSaml2TokenInput

func (ApplicationOptionalClaimsSaml2TokenArray) ElementType

func (ApplicationOptionalClaimsSaml2TokenArray) ToApplicationOptionalClaimsSaml2TokenArrayOutput

func (i ApplicationOptionalClaimsSaml2TokenArray) ToApplicationOptionalClaimsSaml2TokenArrayOutput() ApplicationOptionalClaimsSaml2TokenArrayOutput

func (ApplicationOptionalClaimsSaml2TokenArray) ToApplicationOptionalClaimsSaml2TokenArrayOutputWithContext

func (i ApplicationOptionalClaimsSaml2TokenArray) ToApplicationOptionalClaimsSaml2TokenArrayOutputWithContext(ctx context.Context) ApplicationOptionalClaimsSaml2TokenArrayOutput

type ApplicationOptionalClaimsSaml2TokenArrayInput

type ApplicationOptionalClaimsSaml2TokenArrayInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsSaml2TokenArrayOutput() ApplicationOptionalClaimsSaml2TokenArrayOutput
	ToApplicationOptionalClaimsSaml2TokenArrayOutputWithContext(context.Context) ApplicationOptionalClaimsSaml2TokenArrayOutput
}

ApplicationOptionalClaimsSaml2TokenArrayInput is an input type that accepts ApplicationOptionalClaimsSaml2TokenArray and ApplicationOptionalClaimsSaml2TokenArrayOutput values. You can construct a concrete instance of `ApplicationOptionalClaimsSaml2TokenArrayInput` via:

ApplicationOptionalClaimsSaml2TokenArray{ ApplicationOptionalClaimsSaml2TokenArgs{...} }

type ApplicationOptionalClaimsSaml2TokenArrayOutput

type ApplicationOptionalClaimsSaml2TokenArrayOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsSaml2TokenArrayOutput) ElementType

func (ApplicationOptionalClaimsSaml2TokenArrayOutput) Index

func (ApplicationOptionalClaimsSaml2TokenArrayOutput) ToApplicationOptionalClaimsSaml2TokenArrayOutput

func (o ApplicationOptionalClaimsSaml2TokenArrayOutput) ToApplicationOptionalClaimsSaml2TokenArrayOutput() ApplicationOptionalClaimsSaml2TokenArrayOutput

func (ApplicationOptionalClaimsSaml2TokenArrayOutput) ToApplicationOptionalClaimsSaml2TokenArrayOutputWithContext

func (o ApplicationOptionalClaimsSaml2TokenArrayOutput) ToApplicationOptionalClaimsSaml2TokenArrayOutputWithContext(ctx context.Context) ApplicationOptionalClaimsSaml2TokenArrayOutput

type ApplicationOptionalClaimsSaml2TokenInput

type ApplicationOptionalClaimsSaml2TokenInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsSaml2TokenOutput() ApplicationOptionalClaimsSaml2TokenOutput
	ToApplicationOptionalClaimsSaml2TokenOutputWithContext(context.Context) ApplicationOptionalClaimsSaml2TokenOutput
}

ApplicationOptionalClaimsSaml2TokenInput is an input type that accepts ApplicationOptionalClaimsSaml2TokenArgs and ApplicationOptionalClaimsSaml2TokenOutput values. You can construct a concrete instance of `ApplicationOptionalClaimsSaml2TokenInput` via:

ApplicationOptionalClaimsSaml2TokenArgs{...}

type ApplicationOptionalClaimsSaml2TokenOutput

type ApplicationOptionalClaimsSaml2TokenOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsSaml2TokenOutput) AdditionalProperties

List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: `cloudDisplayname`, `dnsDomainAndSamAccountName`, `emitAsRoles`, `includeExternallyAuthenticatedUpnWithoutHash`, `includeExternallyAuthenticatedUpn`, `maxSizeLimit`, `netbiosDomainAndSamAccountName`, `onPremiseSecurityIdentifier`, `samAccountName`, and `useGuid`.

func (ApplicationOptionalClaimsSaml2TokenOutput) ElementType

func (ApplicationOptionalClaimsSaml2TokenOutput) Essential

Whether the claim specified by the client is necessary to ensure a smooth authorization experience.

func (ApplicationOptionalClaimsSaml2TokenOutput) Name

The name of the optional claim.

func (ApplicationOptionalClaimsSaml2TokenOutput) Source

The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.

func (ApplicationOptionalClaimsSaml2TokenOutput) ToApplicationOptionalClaimsSaml2TokenOutput

func (o ApplicationOptionalClaimsSaml2TokenOutput) ToApplicationOptionalClaimsSaml2TokenOutput() ApplicationOptionalClaimsSaml2TokenOutput

func (ApplicationOptionalClaimsSaml2TokenOutput) ToApplicationOptionalClaimsSaml2TokenOutputWithContext

func (o ApplicationOptionalClaimsSaml2TokenOutput) ToApplicationOptionalClaimsSaml2TokenOutputWithContext(ctx context.Context) ApplicationOptionalClaimsSaml2TokenOutput

type ApplicationOptionalClaimsState added in v5.44.0

type ApplicationOptionalClaimsState struct {
	// One or more `accessToken` blocks as documented below.
	AccessTokens ApplicationOptionalClaimsAccessTokenArrayInput
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// One or more `idToken` blocks as documented below.
	IdTokens ApplicationOptionalClaimsIdTokenArrayInput
	// One or more `saml2Token` blocks as documented below.
	//
	// > At least one of `accessToken`, `idToken` or `saml2Token` must be specified
	Saml2Tokens ApplicationOptionalClaimsSaml2TokenArrayInput
}

func (ApplicationOptionalClaimsState) ElementType added in v5.44.0

type ApplicationOptionalClaimsType added in v5.44.0

type ApplicationOptionalClaimsType struct {
	// One or more `accessToken` blocks as documented below.
	AccessTokens []ApplicationOptionalClaimsAccessToken `pulumi:"accessTokens"`
	// One or more `idToken` blocks as documented below.
	IdTokens []ApplicationOptionalClaimsIdToken `pulumi:"idTokens"`
	// One or more `saml2Token` blocks as documented below.
	Saml2Tokens []ApplicationOptionalClaimsSaml2Token `pulumi:"saml2Tokens"`
}

type ApplicationOptionalClaimsTypeArgs added in v5.44.0

type ApplicationOptionalClaimsTypeArgs struct {
	// One or more `accessToken` blocks as documented below.
	AccessTokens ApplicationOptionalClaimsAccessTokenArrayInput `pulumi:"accessTokens"`
	// One or more `idToken` blocks as documented below.
	IdTokens ApplicationOptionalClaimsIdTokenArrayInput `pulumi:"idTokens"`
	// One or more `saml2Token` blocks as documented below.
	Saml2Tokens ApplicationOptionalClaimsSaml2TokenArrayInput `pulumi:"saml2Tokens"`
}

func (ApplicationOptionalClaimsTypeArgs) ElementType added in v5.44.0

func (ApplicationOptionalClaimsTypeArgs) ToApplicationOptionalClaimsTypeOutput added in v5.44.0

func (i ApplicationOptionalClaimsTypeArgs) ToApplicationOptionalClaimsTypeOutput() ApplicationOptionalClaimsTypeOutput

func (ApplicationOptionalClaimsTypeArgs) ToApplicationOptionalClaimsTypeOutputWithContext added in v5.44.0

func (i ApplicationOptionalClaimsTypeArgs) ToApplicationOptionalClaimsTypeOutputWithContext(ctx context.Context) ApplicationOptionalClaimsTypeOutput

func (ApplicationOptionalClaimsTypeArgs) ToApplicationOptionalClaimsTypePtrOutput added in v5.44.0

func (i ApplicationOptionalClaimsTypeArgs) ToApplicationOptionalClaimsTypePtrOutput() ApplicationOptionalClaimsTypePtrOutput

func (ApplicationOptionalClaimsTypeArgs) ToApplicationOptionalClaimsTypePtrOutputWithContext added in v5.44.0

func (i ApplicationOptionalClaimsTypeArgs) ToApplicationOptionalClaimsTypePtrOutputWithContext(ctx context.Context) ApplicationOptionalClaimsTypePtrOutput

type ApplicationOptionalClaimsTypeInput added in v5.44.0

type ApplicationOptionalClaimsTypeInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsTypeOutput() ApplicationOptionalClaimsTypeOutput
	ToApplicationOptionalClaimsTypeOutputWithContext(context.Context) ApplicationOptionalClaimsTypeOutput
}

ApplicationOptionalClaimsTypeInput is an input type that accepts ApplicationOptionalClaimsTypeArgs and ApplicationOptionalClaimsTypeOutput values. You can construct a concrete instance of `ApplicationOptionalClaimsTypeInput` via:

ApplicationOptionalClaimsTypeArgs{...}

type ApplicationOptionalClaimsTypeOutput added in v5.44.0

type ApplicationOptionalClaimsTypeOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsTypeOutput) AccessTokens added in v5.44.0

One or more `accessToken` blocks as documented below.

func (ApplicationOptionalClaimsTypeOutput) ElementType added in v5.44.0

func (ApplicationOptionalClaimsTypeOutput) IdTokens added in v5.44.0

One or more `idToken` blocks as documented below.

func (ApplicationOptionalClaimsTypeOutput) Saml2Tokens added in v5.44.0

One or more `saml2Token` blocks as documented below.

func (ApplicationOptionalClaimsTypeOutput) ToApplicationOptionalClaimsTypeOutput added in v5.44.0

func (o ApplicationOptionalClaimsTypeOutput) ToApplicationOptionalClaimsTypeOutput() ApplicationOptionalClaimsTypeOutput

func (ApplicationOptionalClaimsTypeOutput) ToApplicationOptionalClaimsTypeOutputWithContext added in v5.44.0

func (o ApplicationOptionalClaimsTypeOutput) ToApplicationOptionalClaimsTypeOutputWithContext(ctx context.Context) ApplicationOptionalClaimsTypeOutput

func (ApplicationOptionalClaimsTypeOutput) ToApplicationOptionalClaimsTypePtrOutput added in v5.44.0

func (o ApplicationOptionalClaimsTypeOutput) ToApplicationOptionalClaimsTypePtrOutput() ApplicationOptionalClaimsTypePtrOutput

func (ApplicationOptionalClaimsTypeOutput) ToApplicationOptionalClaimsTypePtrOutputWithContext added in v5.44.0

func (o ApplicationOptionalClaimsTypeOutput) ToApplicationOptionalClaimsTypePtrOutputWithContext(ctx context.Context) ApplicationOptionalClaimsTypePtrOutput

type ApplicationOptionalClaimsTypePtrInput added in v5.44.0

type ApplicationOptionalClaimsTypePtrInput interface {
	pulumi.Input

	ToApplicationOptionalClaimsTypePtrOutput() ApplicationOptionalClaimsTypePtrOutput
	ToApplicationOptionalClaimsTypePtrOutputWithContext(context.Context) ApplicationOptionalClaimsTypePtrOutput
}

ApplicationOptionalClaimsTypePtrInput is an input type that accepts ApplicationOptionalClaimsTypeArgs, ApplicationOptionalClaimsTypePtr and ApplicationOptionalClaimsTypePtrOutput values. You can construct a concrete instance of `ApplicationOptionalClaimsTypePtrInput` via:

        ApplicationOptionalClaimsTypeArgs{...}

or:

        nil

type ApplicationOptionalClaimsTypePtrOutput added in v5.44.0

type ApplicationOptionalClaimsTypePtrOutput struct{ *pulumi.OutputState }

func (ApplicationOptionalClaimsTypePtrOutput) AccessTokens added in v5.44.0

One or more `accessToken` blocks as documented below.

func (ApplicationOptionalClaimsTypePtrOutput) Elem added in v5.44.0

func (ApplicationOptionalClaimsTypePtrOutput) ElementType added in v5.44.0

func (ApplicationOptionalClaimsTypePtrOutput) IdTokens added in v5.44.0

One or more `idToken` blocks as documented below.

func (ApplicationOptionalClaimsTypePtrOutput) Saml2Tokens added in v5.44.0

One or more `saml2Token` blocks as documented below.

func (ApplicationOptionalClaimsTypePtrOutput) ToApplicationOptionalClaimsTypePtrOutput added in v5.44.0

func (o ApplicationOptionalClaimsTypePtrOutput) ToApplicationOptionalClaimsTypePtrOutput() ApplicationOptionalClaimsTypePtrOutput

func (ApplicationOptionalClaimsTypePtrOutput) ToApplicationOptionalClaimsTypePtrOutputWithContext added in v5.44.0

func (o ApplicationOptionalClaimsTypePtrOutput) ToApplicationOptionalClaimsTypePtrOutputWithContext(ctx context.Context) ApplicationOptionalClaimsTypePtrOutput

type ApplicationOutput

type ApplicationOutput struct{ *pulumi.OutputState }

func (ApplicationOutput) Api added in v5.22.0

An `api` block as documented below, which configures API related settings for this application.

func (ApplicationOutput) AppRoleIds added in v5.22.0

func (o ApplicationOutput) AppRoleIds() pulumi.StringMapOutput

A mapping of app role values to app role IDs, intended to be useful when referencing app roles in other resources in your configuration.

func (ApplicationOutput) AppRoles added in v5.22.0

A collection of `appRole` blocks as documented below. For more information see [official documentation on Application Roles](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).

func (ApplicationOutput) ApplicationId deprecated added in v5.22.0

func (o ApplicationOutput) ApplicationId() pulumi.StringOutput

The Application ID (also called Client ID)

Deprecated: The `applicationId` attribute has been replaced by the `clientId` attribute and will be removed in version 3.0 of the AzureAD provider

func (ApplicationOutput) ClientId added in v5.43.0

func (o ApplicationOutput) ClientId() pulumi.StringOutput

The Client ID for the application.

func (ApplicationOutput) Description added in v5.34.0

func (o ApplicationOutput) Description() pulumi.StringPtrOutput

A description of the application, as shown to end users.

func (ApplicationOutput) DeviceOnlyAuthEnabled added in v5.22.0

func (o ApplicationOutput) DeviceOnlyAuthEnabled() pulumi.BoolPtrOutput

Specifies whether this application supports device authentication without a user. Defaults to `false`.

func (ApplicationOutput) DisabledByMicrosoft added in v5.22.0

func (o ApplicationOutput) DisabledByMicrosoft() pulumi.StringOutput

Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. `DisabledDueToViolationOfServicesAgreement`

func (ApplicationOutput) DisplayName added in v5.22.0

func (o ApplicationOutput) DisplayName() pulumi.StringOutput

The display name for the application.

func (ApplicationOutput) ElementType

func (ApplicationOutput) ElementType() reflect.Type

func (ApplicationOutput) FallbackPublicClientEnabled added in v5.22.0

func (o ApplicationOutput) FallbackPublicClientEnabled() pulumi.BoolPtrOutput

Specifies whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI. Defaults to `false`.

func (ApplicationOutput) FeatureTags added in v5.22.0

A `featureTags` block as described below. Cannot be used together with the `tags` property.

> **Features and Tags** Features are configured for an application using tags, and are provided as a shortcut to set the corresponding magic tag value for each feature. You cannot configure `featureTags` and `tags` for an application at the same time, so if you need to assign additional custom tags it's recommended to use the `tags` property instead. Tag values also propagate to any linked service principals.

func (ApplicationOutput) GroupMembershipClaims added in v5.22.0

func (o ApplicationOutput) GroupMembershipClaims() pulumi.StringArrayOutput

Configures the `groups` claim issued in a user or OAuth 2.0 access token that the app expects. Possible values are `None`, `SecurityGroup`, `DirectoryRole`, `ApplicationGroup` or `All`.

func (ApplicationOutput) IdentifierUris added in v5.22.0

func (o ApplicationOutput) IdentifierUris() pulumi.StringArrayOutput

A set of user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant.

func (ApplicationOutput) LogoImage added in v5.22.0

A logo image to upload for the application, as a raw base64-encoded string. The image should be in gif, jpeg or png format. Note that once an image has been uploaded, it is not possible to remove it without replacing it with another image.

func (ApplicationOutput) LogoUrl added in v5.22.0

CDN URL to the application's logo, as uploaded with the `logoImage` property.

func (ApplicationOutput) MarketingUrl added in v5.22.0

func (o ApplicationOutput) MarketingUrl() pulumi.StringPtrOutput

URL of the application's marketing page.

func (ApplicationOutput) Notes added in v5.35.0

User-specified notes relevant for the management of the application.

func (ApplicationOutput) Oauth2PermissionScopeIds added in v5.22.0

func (o ApplicationOutput) Oauth2PermissionScopeIds() pulumi.StringMapOutput

A mapping of OAuth2.0 permission scope values to scope IDs, intended to be useful when referencing permission scopes in other resources in your configuration.

func (ApplicationOutput) Oauth2PostResponseRequired added in v5.22.0

func (o ApplicationOutput) Oauth2PostResponseRequired() pulumi.BoolPtrOutput

Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. Defaults to `false`, which specifies that only GET requests are allowed.

func (ApplicationOutput) ObjectId added in v5.22.0

func (o ApplicationOutput) ObjectId() pulumi.StringOutput

The application's object ID.

func (ApplicationOutput) OptionalClaims added in v5.22.0

An `optionalClaims` block as documented below.

func (ApplicationOutput) Owners added in v5.22.0

A list of object IDs of principals that will be granted ownership of the application

func (ApplicationOutput) PreventDuplicateNames added in v5.22.0

func (o ApplicationOutput) PreventDuplicateNames() pulumi.BoolPtrOutput

If `true`, will return an error if an existing application is found with the same name. Defaults to `false`.

func (ApplicationOutput) PrivacyStatementUrl added in v5.22.0

func (o ApplicationOutput) PrivacyStatementUrl() pulumi.StringPtrOutput

URL of the application's privacy statement.

func (ApplicationOutput) PublicClient added in v5.22.0

A `publicClient` block as documented below, which configures non-web app or non-web API application settings, for example mobile or other public clients such as an installed application running on a desktop device.

func (ApplicationOutput) PublisherDomain added in v5.22.0

func (o ApplicationOutput) PublisherDomain() pulumi.StringOutput

The verified publisher domain for the application.

func (ApplicationOutput) RequiredResourceAccesses added in v5.22.0

A collection of `requiredResourceAccess` blocks as documented below.

func (ApplicationOutput) ServiceManagementReference added in v5.37.0

func (o ApplicationOutput) ServiceManagementReference() pulumi.StringPtrOutput

References application context information from a Service or Asset Management database.

func (ApplicationOutput) SignInAudience added in v5.22.0

func (o ApplicationOutput) SignInAudience() pulumi.StringPtrOutput

The Microsoft account types that are supported for the current application. Must be one of `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`. Defaults to `AzureADMyOrg`.

> **Changing `signInAudience` for existing applications** When updating an existing application to use a `signInAudience` value of `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`, your configuration may no longer be valid. Refer to [official documentation](https://docs.microsoft.com/en-gb/azure/active-directory/develop/supported-accounts-validation) to understand the differences in supported configurations. Where possible, the provider will attempt to validate your configuration and try to avoid applying unsupported settings to your application.

func (ApplicationOutput) SinglePageApplication added in v5.22.0

A `singlePageApplication` block as documented below, which configures single-page application (SPA) related settings for this application.

func (ApplicationOutput) SupportUrl added in v5.22.0

func (o ApplicationOutput) SupportUrl() pulumi.StringPtrOutput

URL of the application's support page.

func (ApplicationOutput) Tags added in v5.22.0

A set of tags to apply to the application for configuring specific behaviours of the application and linked service principals. Note that these are not provided for use by practitioners. Cannot be used together with the `featureTags` block.

> **Tags and Features** Azure Active Directory uses special tag values to configure the behavior of applications. These can be specified using either the `tags` property or with the `featureTags` block. If you need to set any custom tag values not supported by the `featureTags` block, it's recommended to use the `tags` property. Tag values also propagate to any linked service principals.

func (ApplicationOutput) TemplateId added in v5.22.0

func (o ApplicationOutput) TemplateId() pulumi.StringOutput

Unique ID for a templated application in the Azure AD App Gallery, from which to create the application. Changing this forces a new resource to be created.

> **Tip for Gallery Applications** This resource can be used to instantiate a gallery application, however it will also attempt to manage the properties of the resulting application. If this is not desired, consider using the ApplicationRegistration resource instead.

func (ApplicationOutput) TermsOfServiceUrl added in v5.22.0

func (o ApplicationOutput) TermsOfServiceUrl() pulumi.StringPtrOutput

URL of the application's terms of service statement.

func (ApplicationOutput) ToApplicationOutput

func (o ApplicationOutput) ToApplicationOutput() ApplicationOutput

func (ApplicationOutput) ToApplicationOutputWithContext

func (o ApplicationOutput) ToApplicationOutputWithContext(ctx context.Context) ApplicationOutput

func (ApplicationOutput) Web added in v5.22.0

A `web` block as documented below, which configures web related settings for this application.

> **Application Name Uniqueness** Application names are not unique within Azure Active Directory. Use the `preventDuplicateNames` argument to check for existing applications if you want to avoid name collisions.

type ApplicationOwner added in v5.43.0

type ApplicationOwner struct {
	pulumi.CustomResourceState

	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The object ID of the owner to assign to the application, typically a user or service principal. Changing this forces a new resource to be created.
	OwnerObjectId pulumi.StringOutput `pulumi:"ownerObjectId"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		jane, err := azuread.NewUser(ctx, "jane", &azuread.UserArgs{
			UserPrincipalName: pulumi.String("jane.fischer@hashitown.com"),
			DisplayName:       pulumi.String("Jane Fischer"),
			Password:          pulumi.String("Ch@ngeMe"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationOwner(ctx, "example_jane", &azuread.ApplicationOwnerArgs{
			ApplicationId: example.ID(),
			OwnerObjectId: jane.ObjectId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

> **Tip** For managing more application owners, create additional instances of this resource

## Import

Application Owners can be imported using the object ID of the application and the object ID of the owner, in the following format.

```sh $ pulumi import azuread:index/applicationOwner:ApplicationOwner example /applications/00000000-0000-0000-0000-000000000000/owners/11111111-1111-1111-1111-111111111111 ```

func GetApplicationOwner added in v5.43.0

func GetApplicationOwner(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationOwnerState, opts ...pulumi.ResourceOption) (*ApplicationOwner, error)

GetApplicationOwner gets an existing ApplicationOwner resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationOwner added in v5.43.0

func NewApplicationOwner(ctx *pulumi.Context,
	name string, args *ApplicationOwnerArgs, opts ...pulumi.ResourceOption) (*ApplicationOwner, error)

NewApplicationOwner registers a new resource with the given unique name, arguments, and options.

func (*ApplicationOwner) ElementType added in v5.43.0

func (*ApplicationOwner) ElementType() reflect.Type

func (*ApplicationOwner) ToApplicationOwnerOutput added in v5.43.0

func (i *ApplicationOwner) ToApplicationOwnerOutput() ApplicationOwnerOutput

func (*ApplicationOwner) ToApplicationOwnerOutputWithContext added in v5.43.0

func (i *ApplicationOwner) ToApplicationOwnerOutputWithContext(ctx context.Context) ApplicationOwnerOutput

type ApplicationOwnerArgs added in v5.43.0

type ApplicationOwnerArgs struct {
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringInput
	// The object ID of the owner to assign to the application, typically a user or service principal. Changing this forces a new resource to be created.
	OwnerObjectId pulumi.StringInput
}

The set of arguments for constructing a ApplicationOwner resource.

func (ApplicationOwnerArgs) ElementType added in v5.43.0

func (ApplicationOwnerArgs) ElementType() reflect.Type

type ApplicationOwnerArray added in v5.43.0

type ApplicationOwnerArray []ApplicationOwnerInput

func (ApplicationOwnerArray) ElementType added in v5.43.0

func (ApplicationOwnerArray) ElementType() reflect.Type

func (ApplicationOwnerArray) ToApplicationOwnerArrayOutput added in v5.43.0

func (i ApplicationOwnerArray) ToApplicationOwnerArrayOutput() ApplicationOwnerArrayOutput

func (ApplicationOwnerArray) ToApplicationOwnerArrayOutputWithContext added in v5.43.0

func (i ApplicationOwnerArray) ToApplicationOwnerArrayOutputWithContext(ctx context.Context) ApplicationOwnerArrayOutput

type ApplicationOwnerArrayInput added in v5.43.0

type ApplicationOwnerArrayInput interface {
	pulumi.Input

	ToApplicationOwnerArrayOutput() ApplicationOwnerArrayOutput
	ToApplicationOwnerArrayOutputWithContext(context.Context) ApplicationOwnerArrayOutput
}

ApplicationOwnerArrayInput is an input type that accepts ApplicationOwnerArray and ApplicationOwnerArrayOutput values. You can construct a concrete instance of `ApplicationOwnerArrayInput` via:

ApplicationOwnerArray{ ApplicationOwnerArgs{...} }

type ApplicationOwnerArrayOutput added in v5.43.0

type ApplicationOwnerArrayOutput struct{ *pulumi.OutputState }

func (ApplicationOwnerArrayOutput) ElementType added in v5.43.0

func (ApplicationOwnerArrayOutput) Index added in v5.43.0

func (ApplicationOwnerArrayOutput) ToApplicationOwnerArrayOutput added in v5.43.0

func (o ApplicationOwnerArrayOutput) ToApplicationOwnerArrayOutput() ApplicationOwnerArrayOutput

func (ApplicationOwnerArrayOutput) ToApplicationOwnerArrayOutputWithContext added in v5.43.0

func (o ApplicationOwnerArrayOutput) ToApplicationOwnerArrayOutputWithContext(ctx context.Context) ApplicationOwnerArrayOutput

type ApplicationOwnerInput added in v5.43.0

type ApplicationOwnerInput interface {
	pulumi.Input

	ToApplicationOwnerOutput() ApplicationOwnerOutput
	ToApplicationOwnerOutputWithContext(ctx context.Context) ApplicationOwnerOutput
}

type ApplicationOwnerMap added in v5.43.0

type ApplicationOwnerMap map[string]ApplicationOwnerInput

func (ApplicationOwnerMap) ElementType added in v5.43.0

func (ApplicationOwnerMap) ElementType() reflect.Type

func (ApplicationOwnerMap) ToApplicationOwnerMapOutput added in v5.43.0

func (i ApplicationOwnerMap) ToApplicationOwnerMapOutput() ApplicationOwnerMapOutput

func (ApplicationOwnerMap) ToApplicationOwnerMapOutputWithContext added in v5.43.0

func (i ApplicationOwnerMap) ToApplicationOwnerMapOutputWithContext(ctx context.Context) ApplicationOwnerMapOutput

type ApplicationOwnerMapInput added in v5.43.0

type ApplicationOwnerMapInput interface {
	pulumi.Input

	ToApplicationOwnerMapOutput() ApplicationOwnerMapOutput
	ToApplicationOwnerMapOutputWithContext(context.Context) ApplicationOwnerMapOutput
}

ApplicationOwnerMapInput is an input type that accepts ApplicationOwnerMap and ApplicationOwnerMapOutput values. You can construct a concrete instance of `ApplicationOwnerMapInput` via:

ApplicationOwnerMap{ "key": ApplicationOwnerArgs{...} }

type ApplicationOwnerMapOutput added in v5.43.0

type ApplicationOwnerMapOutput struct{ *pulumi.OutputState }

func (ApplicationOwnerMapOutput) ElementType added in v5.43.0

func (ApplicationOwnerMapOutput) ElementType() reflect.Type

func (ApplicationOwnerMapOutput) MapIndex added in v5.43.0

func (ApplicationOwnerMapOutput) ToApplicationOwnerMapOutput added in v5.43.0

func (o ApplicationOwnerMapOutput) ToApplicationOwnerMapOutput() ApplicationOwnerMapOutput

func (ApplicationOwnerMapOutput) ToApplicationOwnerMapOutputWithContext added in v5.43.0

func (o ApplicationOwnerMapOutput) ToApplicationOwnerMapOutputWithContext(ctx context.Context) ApplicationOwnerMapOutput

type ApplicationOwnerOutput added in v5.43.0

type ApplicationOwnerOutput struct{ *pulumi.OutputState }

func (ApplicationOwnerOutput) ApplicationId added in v5.43.0

func (o ApplicationOwnerOutput) ApplicationId() pulumi.StringOutput

The resource ID of the application registration. Changing this forces a new resource to be created.

func (ApplicationOwnerOutput) ElementType added in v5.43.0

func (ApplicationOwnerOutput) ElementType() reflect.Type

func (ApplicationOwnerOutput) OwnerObjectId added in v5.43.0

func (o ApplicationOwnerOutput) OwnerObjectId() pulumi.StringOutput

The object ID of the owner to assign to the application, typically a user or service principal. Changing this forces a new resource to be created.

func (ApplicationOwnerOutput) ToApplicationOwnerOutput added in v5.43.0

func (o ApplicationOwnerOutput) ToApplicationOwnerOutput() ApplicationOwnerOutput

func (ApplicationOwnerOutput) ToApplicationOwnerOutputWithContext added in v5.43.0

func (o ApplicationOwnerOutput) ToApplicationOwnerOutputWithContext(ctx context.Context) ApplicationOwnerOutput

type ApplicationOwnerState added in v5.43.0

type ApplicationOwnerState struct {
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The object ID of the owner to assign to the application, typically a user or service principal. Changing this forces a new resource to be created.
	OwnerObjectId pulumi.StringPtrInput
}

func (ApplicationOwnerState) ElementType added in v5.43.0

func (ApplicationOwnerState) ElementType() reflect.Type

type ApplicationPassword

type ApplicationPassword struct {
	pulumi.CustomResourceState

	// The resource ID of the application for which this password should be created. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The object ID of the application for which this password should be created
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringOutput `pulumi:"applicationObjectId"`
	// A display name for the password. Changing this field forces a new resource to be created.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The end date until which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringOutput `pulumi:"endDate"`
	// A relative duration for which the password is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.
	EndDateRelative pulumi.StringPtrOutput `pulumi:"endDateRelative"`
	// A UUID used to uniquely identify this password credential.
	KeyId pulumi.StringOutput `pulumi:"keyId"`
	// A map of arbitrary key/value pairs that will force recreation of the password when they change, enabling password rotation based on external conditions such as a rotating timestamp. Changing this forces a new resource to be created.
	RotateWhenChanged pulumi.StringMapOutput `pulumi:"rotateWhenChanged"`
	// The start date from which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date is used.  Changing this field forces a new resource to be created.
	StartDate pulumi.StringOutput `pulumi:"startDate"`
	// The password for this application, which is generated by Azure Active Directory.
	Value pulumi.StringOutput `pulumi:"value"`
}

## Example Usage

*Basic example*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationPassword(ctx, "example", &azuread.ApplicationPasswordArgs{
			ApplicationId: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Time-based rotation*

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi-time/sdk/go/time"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleRotating, err := time.NewRotating(ctx, "example", &time.RotatingArgs{
			RotationDays: pulumi.Int(7),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationPassword(ctx, "example", &azuread.ApplicationPasswordArgs{
			ApplicationId: example.ID(),
			RotateWhenChanged: pulumi.StringMap{
				"rotation": exampleRotating.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

This resource does not support importing.

func GetApplicationPassword

func GetApplicationPassword(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationPasswordState, opts ...pulumi.ResourceOption) (*ApplicationPassword, error)

GetApplicationPassword gets an existing ApplicationPassword resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationPassword

func NewApplicationPassword(ctx *pulumi.Context,
	name string, args *ApplicationPasswordArgs, opts ...pulumi.ResourceOption) (*ApplicationPassword, error)

NewApplicationPassword registers a new resource with the given unique name, arguments, and options.

func (*ApplicationPassword) ElementType

func (*ApplicationPassword) ElementType() reflect.Type

func (*ApplicationPassword) ToApplicationPasswordOutput

func (i *ApplicationPassword) ToApplicationPasswordOutput() ApplicationPasswordOutput

func (*ApplicationPassword) ToApplicationPasswordOutputWithContext

func (i *ApplicationPassword) ToApplicationPasswordOutputWithContext(ctx context.Context) ApplicationPasswordOutput

type ApplicationPasswordArgs

type ApplicationPasswordArgs struct {
	// The resource ID of the application for which this password should be created. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The object ID of the application for which this password should be created
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringPtrInput
	// A display name for the password. Changing this field forces a new resource to be created.
	DisplayName pulumi.StringPtrInput
	// The end date until which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringPtrInput
	// A relative duration for which the password is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.
	EndDateRelative pulumi.StringPtrInput
	// A map of arbitrary key/value pairs that will force recreation of the password when they change, enabling password rotation based on external conditions such as a rotating timestamp. Changing this forces a new resource to be created.
	RotateWhenChanged pulumi.StringMapInput
	// The start date from which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date is used.  Changing this field forces a new resource to be created.
	StartDate pulumi.StringPtrInput
}

The set of arguments for constructing a ApplicationPassword resource.

func (ApplicationPasswordArgs) ElementType

func (ApplicationPasswordArgs) ElementType() reflect.Type

type ApplicationPasswordArray

type ApplicationPasswordArray []ApplicationPasswordInput

func (ApplicationPasswordArray) ElementType

func (ApplicationPasswordArray) ElementType() reflect.Type

func (ApplicationPasswordArray) ToApplicationPasswordArrayOutput

func (i ApplicationPasswordArray) ToApplicationPasswordArrayOutput() ApplicationPasswordArrayOutput

func (ApplicationPasswordArray) ToApplicationPasswordArrayOutputWithContext

func (i ApplicationPasswordArray) ToApplicationPasswordArrayOutputWithContext(ctx context.Context) ApplicationPasswordArrayOutput

type ApplicationPasswordArrayInput

type ApplicationPasswordArrayInput interface {
	pulumi.Input

	ToApplicationPasswordArrayOutput() ApplicationPasswordArrayOutput
	ToApplicationPasswordArrayOutputWithContext(context.Context) ApplicationPasswordArrayOutput
}

ApplicationPasswordArrayInput is an input type that accepts ApplicationPasswordArray and ApplicationPasswordArrayOutput values. You can construct a concrete instance of `ApplicationPasswordArrayInput` via:

ApplicationPasswordArray{ ApplicationPasswordArgs{...} }

type ApplicationPasswordArrayOutput

type ApplicationPasswordArrayOutput struct{ *pulumi.OutputState }

func (ApplicationPasswordArrayOutput) ElementType

func (ApplicationPasswordArrayOutput) Index

func (ApplicationPasswordArrayOutput) ToApplicationPasswordArrayOutput

func (o ApplicationPasswordArrayOutput) ToApplicationPasswordArrayOutput() ApplicationPasswordArrayOutput

func (ApplicationPasswordArrayOutput) ToApplicationPasswordArrayOutputWithContext

func (o ApplicationPasswordArrayOutput) ToApplicationPasswordArrayOutputWithContext(ctx context.Context) ApplicationPasswordArrayOutput

type ApplicationPasswordInput

type ApplicationPasswordInput interface {
	pulumi.Input

	ToApplicationPasswordOutput() ApplicationPasswordOutput
	ToApplicationPasswordOutputWithContext(ctx context.Context) ApplicationPasswordOutput
}

type ApplicationPasswordMap

type ApplicationPasswordMap map[string]ApplicationPasswordInput

func (ApplicationPasswordMap) ElementType

func (ApplicationPasswordMap) ElementType() reflect.Type

func (ApplicationPasswordMap) ToApplicationPasswordMapOutput

func (i ApplicationPasswordMap) ToApplicationPasswordMapOutput() ApplicationPasswordMapOutput

func (ApplicationPasswordMap) ToApplicationPasswordMapOutputWithContext

func (i ApplicationPasswordMap) ToApplicationPasswordMapOutputWithContext(ctx context.Context) ApplicationPasswordMapOutput

type ApplicationPasswordMapInput

type ApplicationPasswordMapInput interface {
	pulumi.Input

	ToApplicationPasswordMapOutput() ApplicationPasswordMapOutput
	ToApplicationPasswordMapOutputWithContext(context.Context) ApplicationPasswordMapOutput
}

ApplicationPasswordMapInput is an input type that accepts ApplicationPasswordMap and ApplicationPasswordMapOutput values. You can construct a concrete instance of `ApplicationPasswordMapInput` via:

ApplicationPasswordMap{ "key": ApplicationPasswordArgs{...} }

type ApplicationPasswordMapOutput

type ApplicationPasswordMapOutput struct{ *pulumi.OutputState }

func (ApplicationPasswordMapOutput) ElementType

func (ApplicationPasswordMapOutput) MapIndex

func (ApplicationPasswordMapOutput) ToApplicationPasswordMapOutput

func (o ApplicationPasswordMapOutput) ToApplicationPasswordMapOutput() ApplicationPasswordMapOutput

func (ApplicationPasswordMapOutput) ToApplicationPasswordMapOutputWithContext

func (o ApplicationPasswordMapOutput) ToApplicationPasswordMapOutputWithContext(ctx context.Context) ApplicationPasswordMapOutput

type ApplicationPasswordOutput

type ApplicationPasswordOutput struct{ *pulumi.OutputState }

func (ApplicationPasswordOutput) ApplicationId added in v5.43.0

func (o ApplicationPasswordOutput) ApplicationId() pulumi.StringOutput

The resource ID of the application for which this password should be created. Changing this field forces a new resource to be created.

func (ApplicationPasswordOutput) ApplicationObjectId deprecated added in v5.22.0

func (o ApplicationPasswordOutput) ApplicationObjectId() pulumi.StringOutput

The object ID of the application for which this password should be created

Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider

func (ApplicationPasswordOutput) DisplayName added in v5.22.0

A display name for the password. Changing this field forces a new resource to be created.

func (ApplicationPasswordOutput) ElementType

func (ApplicationPasswordOutput) ElementType() reflect.Type

func (ApplicationPasswordOutput) EndDate added in v5.22.0

The end date until which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.

func (ApplicationPasswordOutput) EndDateRelative added in v5.22.0

func (o ApplicationPasswordOutput) EndDateRelative() pulumi.StringPtrOutput

A relative duration for which the password is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.

func (ApplicationPasswordOutput) KeyId added in v5.22.0

A UUID used to uniquely identify this password credential.

func (ApplicationPasswordOutput) RotateWhenChanged added in v5.22.0

func (o ApplicationPasswordOutput) RotateWhenChanged() pulumi.StringMapOutput

A map of arbitrary key/value pairs that will force recreation of the password when they change, enabling password rotation based on external conditions such as a rotating timestamp. Changing this forces a new resource to be created.

func (ApplicationPasswordOutput) StartDate added in v5.22.0

The start date from which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date is used. Changing this field forces a new resource to be created.

func (ApplicationPasswordOutput) ToApplicationPasswordOutput

func (o ApplicationPasswordOutput) ToApplicationPasswordOutput() ApplicationPasswordOutput

func (ApplicationPasswordOutput) ToApplicationPasswordOutputWithContext

func (o ApplicationPasswordOutput) ToApplicationPasswordOutputWithContext(ctx context.Context) ApplicationPasswordOutput

func (ApplicationPasswordOutput) Value added in v5.22.0

The password for this application, which is generated by Azure Active Directory.

type ApplicationPasswordState

type ApplicationPasswordState struct {
	// The resource ID of the application for which this password should be created. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The object ID of the application for which this password should be created
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringPtrInput
	// A display name for the password. Changing this field forces a new resource to be created.
	DisplayName pulumi.StringPtrInput
	// The end date until which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringPtrInput
	// A relative duration for which the password is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.
	EndDateRelative pulumi.StringPtrInput
	// A UUID used to uniquely identify this password credential.
	KeyId pulumi.StringPtrInput
	// A map of arbitrary key/value pairs that will force recreation of the password when they change, enabling password rotation based on external conditions such as a rotating timestamp. Changing this forces a new resource to be created.
	RotateWhenChanged pulumi.StringMapInput
	// The start date from which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date is used.  Changing this field forces a new resource to be created.
	StartDate pulumi.StringPtrInput
	// The password for this application, which is generated by Azure Active Directory.
	Value pulumi.StringPtrInput
}

func (ApplicationPasswordState) ElementType

func (ApplicationPasswordState) ElementType() reflect.Type

type ApplicationPermissionScope added in v5.43.0

type ApplicationPermissionScope struct {
	pulumi.CustomResourceState

	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription pulumi.StringOutput `pulumi:"adminConsentDescription"`
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName pulumi.StringOutput `pulumi:"adminConsentDisplayName"`
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The unique identifier of the permission scope. Must be a valid UUID. Changing this forces a new resource to be created.
	ScopeId pulumi.StringOutput `pulumi:"scopeId"`
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions.
	Type pulumi.StringPtrOutput `pulumi:"type"`
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription pulumi.StringPtrOutput `pulumi:"userConsentDescription"`
	// Display name for the delegated permission that appears in the end user consent experience
	UserConsentDisplayName pulumi.StringPtrOutput `pulumi:"userConsentDisplayName"`
	// The value that is used for the `scp` claim in OAuth access tokens.
	//
	// > **Roles and Permission Scopes** In Azure Active Directory, application roles and permission scopes exported by an application share the same namespace and cannot contain duplicate values.
	Value pulumi.StringOutput `pulumi:"value"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi-random/sdk/v4/go/random"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleAdminister, err := random.NewRandomUuid(ctx, "example_administer", nil)
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationPermissionScope(ctx, "example", &azuread.ApplicationPermissionScopeArgs{
			ApplicationId:           pulumi.Any(test.Id),
			ScopeId:                 exampleAdminister.ID(),
			Value:                   pulumi.String("administer"),
			AdminConsentDescription: pulumi.String("Administer the application"),
			AdminConsentDisplayName: pulumi.String("Administer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

> **Tip** For managing more permissions scopes, create additional instances of this resource

*Usage with Application resource*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationPermissionScope(ctx, "example", &azuread.ApplicationPermissionScopeArgs{
			ApplicationId: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Application App Roles can be imported using the object ID of the application and the ID of the permission scope, in the following format.

```sh $ pulumi import azuread:index/applicationPermissionScope:ApplicationPermissionScope example /applications/00000000-0000-0000-0000-000000000000/permissionScopes/11111111-1111-1111-1111-111111111111 ```

func GetApplicationPermissionScope added in v5.43.0

func GetApplicationPermissionScope(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationPermissionScopeState, opts ...pulumi.ResourceOption) (*ApplicationPermissionScope, error)

GetApplicationPermissionScope gets an existing ApplicationPermissionScope resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationPermissionScope added in v5.43.0

func NewApplicationPermissionScope(ctx *pulumi.Context,
	name string, args *ApplicationPermissionScopeArgs, opts ...pulumi.ResourceOption) (*ApplicationPermissionScope, error)

NewApplicationPermissionScope registers a new resource with the given unique name, arguments, and options.

func (*ApplicationPermissionScope) ElementType added in v5.43.0

func (*ApplicationPermissionScope) ElementType() reflect.Type

func (*ApplicationPermissionScope) ToApplicationPermissionScopeOutput added in v5.43.0

func (i *ApplicationPermissionScope) ToApplicationPermissionScopeOutput() ApplicationPermissionScopeOutput

func (*ApplicationPermissionScope) ToApplicationPermissionScopeOutputWithContext added in v5.43.0

func (i *ApplicationPermissionScope) ToApplicationPermissionScopeOutputWithContext(ctx context.Context) ApplicationPermissionScopeOutput

type ApplicationPermissionScopeArgs added in v5.43.0

type ApplicationPermissionScopeArgs struct {
	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription pulumi.StringInput
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName pulumi.StringInput
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringInput
	// The unique identifier of the permission scope. Must be a valid UUID. Changing this forces a new resource to be created.
	ScopeId pulumi.StringInput
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions.
	Type pulumi.StringPtrInput
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription pulumi.StringPtrInput
	// Display name for the delegated permission that appears in the end user consent experience
	UserConsentDisplayName pulumi.StringPtrInput
	// The value that is used for the `scp` claim in OAuth access tokens.
	//
	// > **Roles and Permission Scopes** In Azure Active Directory, application roles and permission scopes exported by an application share the same namespace and cannot contain duplicate values.
	Value pulumi.StringInput
}

The set of arguments for constructing a ApplicationPermissionScope resource.

func (ApplicationPermissionScopeArgs) ElementType added in v5.43.0

type ApplicationPermissionScopeArray added in v5.43.0

type ApplicationPermissionScopeArray []ApplicationPermissionScopeInput

func (ApplicationPermissionScopeArray) ElementType added in v5.43.0

func (ApplicationPermissionScopeArray) ToApplicationPermissionScopeArrayOutput added in v5.43.0

func (i ApplicationPermissionScopeArray) ToApplicationPermissionScopeArrayOutput() ApplicationPermissionScopeArrayOutput

func (ApplicationPermissionScopeArray) ToApplicationPermissionScopeArrayOutputWithContext added in v5.43.0

func (i ApplicationPermissionScopeArray) ToApplicationPermissionScopeArrayOutputWithContext(ctx context.Context) ApplicationPermissionScopeArrayOutput

type ApplicationPermissionScopeArrayInput added in v5.43.0

type ApplicationPermissionScopeArrayInput interface {
	pulumi.Input

	ToApplicationPermissionScopeArrayOutput() ApplicationPermissionScopeArrayOutput
	ToApplicationPermissionScopeArrayOutputWithContext(context.Context) ApplicationPermissionScopeArrayOutput
}

ApplicationPermissionScopeArrayInput is an input type that accepts ApplicationPermissionScopeArray and ApplicationPermissionScopeArrayOutput values. You can construct a concrete instance of `ApplicationPermissionScopeArrayInput` via:

ApplicationPermissionScopeArray{ ApplicationPermissionScopeArgs{...} }

type ApplicationPermissionScopeArrayOutput added in v5.43.0

type ApplicationPermissionScopeArrayOutput struct{ *pulumi.OutputState }

func (ApplicationPermissionScopeArrayOutput) ElementType added in v5.43.0

func (ApplicationPermissionScopeArrayOutput) Index added in v5.43.0

func (ApplicationPermissionScopeArrayOutput) ToApplicationPermissionScopeArrayOutput added in v5.43.0

func (o ApplicationPermissionScopeArrayOutput) ToApplicationPermissionScopeArrayOutput() ApplicationPermissionScopeArrayOutput

func (ApplicationPermissionScopeArrayOutput) ToApplicationPermissionScopeArrayOutputWithContext added in v5.43.0

func (o ApplicationPermissionScopeArrayOutput) ToApplicationPermissionScopeArrayOutputWithContext(ctx context.Context) ApplicationPermissionScopeArrayOutput

type ApplicationPermissionScopeInput added in v5.43.0

type ApplicationPermissionScopeInput interface {
	pulumi.Input

	ToApplicationPermissionScopeOutput() ApplicationPermissionScopeOutput
	ToApplicationPermissionScopeOutputWithContext(ctx context.Context) ApplicationPermissionScopeOutput
}

type ApplicationPermissionScopeMap added in v5.43.0

type ApplicationPermissionScopeMap map[string]ApplicationPermissionScopeInput

func (ApplicationPermissionScopeMap) ElementType added in v5.43.0

func (ApplicationPermissionScopeMap) ToApplicationPermissionScopeMapOutput added in v5.43.0

func (i ApplicationPermissionScopeMap) ToApplicationPermissionScopeMapOutput() ApplicationPermissionScopeMapOutput

func (ApplicationPermissionScopeMap) ToApplicationPermissionScopeMapOutputWithContext added in v5.43.0

func (i ApplicationPermissionScopeMap) ToApplicationPermissionScopeMapOutputWithContext(ctx context.Context) ApplicationPermissionScopeMapOutput

type ApplicationPermissionScopeMapInput added in v5.43.0

type ApplicationPermissionScopeMapInput interface {
	pulumi.Input

	ToApplicationPermissionScopeMapOutput() ApplicationPermissionScopeMapOutput
	ToApplicationPermissionScopeMapOutputWithContext(context.Context) ApplicationPermissionScopeMapOutput
}

ApplicationPermissionScopeMapInput is an input type that accepts ApplicationPermissionScopeMap and ApplicationPermissionScopeMapOutput values. You can construct a concrete instance of `ApplicationPermissionScopeMapInput` via:

ApplicationPermissionScopeMap{ "key": ApplicationPermissionScopeArgs{...} }

type ApplicationPermissionScopeMapOutput added in v5.43.0

type ApplicationPermissionScopeMapOutput struct{ *pulumi.OutputState }

func (ApplicationPermissionScopeMapOutput) ElementType added in v5.43.0

func (ApplicationPermissionScopeMapOutput) MapIndex added in v5.43.0

func (ApplicationPermissionScopeMapOutput) ToApplicationPermissionScopeMapOutput added in v5.43.0

func (o ApplicationPermissionScopeMapOutput) ToApplicationPermissionScopeMapOutput() ApplicationPermissionScopeMapOutput

func (ApplicationPermissionScopeMapOutput) ToApplicationPermissionScopeMapOutputWithContext added in v5.43.0

func (o ApplicationPermissionScopeMapOutput) ToApplicationPermissionScopeMapOutputWithContext(ctx context.Context) ApplicationPermissionScopeMapOutput

type ApplicationPermissionScopeOutput added in v5.43.0

type ApplicationPermissionScopeOutput struct{ *pulumi.OutputState }

func (ApplicationPermissionScopeOutput) AdminConsentDescription added in v5.43.0

func (o ApplicationPermissionScopeOutput) AdminConsentDescription() pulumi.StringOutput

Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.

func (ApplicationPermissionScopeOutput) AdminConsentDisplayName added in v5.43.0

func (o ApplicationPermissionScopeOutput) AdminConsentDisplayName() pulumi.StringOutput

Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.

func (ApplicationPermissionScopeOutput) ApplicationId added in v5.43.0

The resource ID of the application registration. Changing this forces a new resource to be created.

func (ApplicationPermissionScopeOutput) ElementType added in v5.43.0

func (ApplicationPermissionScopeOutput) ScopeId added in v5.43.0

The unique identifier of the permission scope. Must be a valid UUID. Changing this forces a new resource to be created.

func (ApplicationPermissionScopeOutput) ToApplicationPermissionScopeOutput added in v5.43.0

func (o ApplicationPermissionScopeOutput) ToApplicationPermissionScopeOutput() ApplicationPermissionScopeOutput

func (ApplicationPermissionScopeOutput) ToApplicationPermissionScopeOutputWithContext added in v5.43.0

func (o ApplicationPermissionScopeOutput) ToApplicationPermissionScopeOutputWithContext(ctx context.Context) ApplicationPermissionScopeOutput

func (ApplicationPermissionScopeOutput) Type added in v5.43.0

Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions.

func (ApplicationPermissionScopeOutput) UserConsentDescription added in v5.43.0

func (o ApplicationPermissionScopeOutput) UserConsentDescription() pulumi.StringPtrOutput

Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.

func (ApplicationPermissionScopeOutput) UserConsentDisplayName added in v5.43.0

func (o ApplicationPermissionScopeOutput) UserConsentDisplayName() pulumi.StringPtrOutput

Display name for the delegated permission that appears in the end user consent experience

func (ApplicationPermissionScopeOutput) Value added in v5.43.0

The value that is used for the `scp` claim in OAuth access tokens.

> **Roles and Permission Scopes** In Azure Active Directory, application roles and permission scopes exported by an application share the same namespace and cannot contain duplicate values.

type ApplicationPermissionScopeState added in v5.43.0

type ApplicationPermissionScopeState struct {
	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription pulumi.StringPtrInput
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName pulumi.StringPtrInput
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The unique identifier of the permission scope. Must be a valid UUID. Changing this forces a new resource to be created.
	ScopeId pulumi.StringPtrInput
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions.
	Type pulumi.StringPtrInput
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription pulumi.StringPtrInput
	// Display name for the delegated permission that appears in the end user consent experience
	UserConsentDisplayName pulumi.StringPtrInput
	// The value that is used for the `scp` claim in OAuth access tokens.
	//
	// > **Roles and Permission Scopes** In Azure Active Directory, application roles and permission scopes exported by an application share the same namespace and cannot contain duplicate values.
	Value pulumi.StringPtrInput
}

func (ApplicationPermissionScopeState) ElementType added in v5.43.0

type ApplicationPreAuthorized

type ApplicationPreAuthorized struct {
	pulumi.CustomResourceState

	// The resource ID of the application for which permissions are being authorized. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The object ID of the application to which this pre-authorized application should be added
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringOutput `pulumi:"applicationObjectId"`
	// The application ID of the pre-authorized application
	//
	// Deprecated: The `authorizedAppId` property has been replaced with the `authorizedClientId` property and will be removed in version 3.0 of the AzureAD provider
	AuthorizedAppId pulumi.StringOutput `pulumi:"authorizedAppId"`
	// The client ID of the application being authorized. Changing this field forces a new resource to be created.
	AuthorizedClientId pulumi.StringOutput `pulumi:"authorizedClientId"`
	// A set of permission scope IDs required by the authorized application.
	PermissionIds pulumi.StringArrayOutput `pulumi:"permissionIds"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		authorized, err := azuread.NewApplicationRegistration(ctx, "authorized", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example-authorized-app"),
		})
		if err != nil {
			return err
		}
		authorizer, err := azuread.NewApplication(ctx, "authorizer", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example-authorizing-app"),
			Api: &azuread.ApplicationApiArgs{
				Oauth2PermissionScopes: azuread.ApplicationApiOauth2PermissionScopeArray{
					&azuread.ApplicationApiOauth2PermissionScopeArgs{
						AdminConsentDescription: pulumi.String("Administer the application"),
						AdminConsentDisplayName: pulumi.String("Administer"),
						Enabled:                 pulumi.Bool(true),
						Id:                      pulumi.String("00000000-0000-0000-0000-000000000000"),
						Type:                    pulumi.String("Admin"),
						Value:                   pulumi.String("administer"),
					},
					&azuread.ApplicationApiOauth2PermissionScopeArgs{
						AdminConsentDescription: pulumi.String("Access the application"),
						AdminConsentDisplayName: pulumi.String("Access"),
						Enabled:                 pulumi.Bool(true),
						Id:                      pulumi.String("11111111-1111-1111-1111-111111111111"),
						Type:                    pulumi.String("User"),
						UserConsentDescription:  pulumi.String("Access the application"),
						UserConsentDisplayName:  pulumi.String("Access"),
						Value:                   pulumi.String("user_impersonation"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationPreAuthorized(ctx, "example", &azuread.ApplicationPreAuthorizedArgs{
			ApplicationId:      authorizer.ID(),
			AuthorizedClientId: authorized.ClientId,
			PermissionIds: pulumi.StringArray{
				pulumi.String("00000000-0000-0000-0000-000000000000"),
				pulumi.String("11111111-1111-1111-1111-111111111111"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Pre-authorized applications can be imported using the object ID of the authorizing application and the application ID of the application being authorized, e.g.

```sh $ pulumi import azuread:index/applicationPreAuthorized:ApplicationPreAuthorized example 00000000-0000-0000-0000-000000000000/preAuthorizedApplication/11111111-1111-1111-1111-111111111111 ```

-> This ID format is unique to Terraform and is composed of the authorizing application's object ID, the string "preAuthorizedApplication" and the authorized application's application ID (client ID) in the format `{ObjectId}/preAuthorizedApplication/{ApplicationId}`.

func GetApplicationPreAuthorized

func GetApplicationPreAuthorized(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationPreAuthorizedState, opts ...pulumi.ResourceOption) (*ApplicationPreAuthorized, error)

GetApplicationPreAuthorized gets an existing ApplicationPreAuthorized resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationPreAuthorized

func NewApplicationPreAuthorized(ctx *pulumi.Context,
	name string, args *ApplicationPreAuthorizedArgs, opts ...pulumi.ResourceOption) (*ApplicationPreAuthorized, error)

NewApplicationPreAuthorized registers a new resource with the given unique name, arguments, and options.

func (*ApplicationPreAuthorized) ElementType

func (*ApplicationPreAuthorized) ElementType() reflect.Type

func (*ApplicationPreAuthorized) ToApplicationPreAuthorizedOutput

func (i *ApplicationPreAuthorized) ToApplicationPreAuthorizedOutput() ApplicationPreAuthorizedOutput

func (*ApplicationPreAuthorized) ToApplicationPreAuthorizedOutputWithContext

func (i *ApplicationPreAuthorized) ToApplicationPreAuthorizedOutputWithContext(ctx context.Context) ApplicationPreAuthorizedOutput

type ApplicationPreAuthorizedArgs

type ApplicationPreAuthorizedArgs struct {
	// The resource ID of the application for which permissions are being authorized. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The object ID of the application to which this pre-authorized application should be added
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringPtrInput
	// The application ID of the pre-authorized application
	//
	// Deprecated: The `authorizedAppId` property has been replaced with the `authorizedClientId` property and will be removed in version 3.0 of the AzureAD provider
	AuthorizedAppId pulumi.StringPtrInput
	// The client ID of the application being authorized. Changing this field forces a new resource to be created.
	AuthorizedClientId pulumi.StringPtrInput
	// A set of permission scope IDs required by the authorized application.
	PermissionIds pulumi.StringArrayInput
}

The set of arguments for constructing a ApplicationPreAuthorized resource.

func (ApplicationPreAuthorizedArgs) ElementType

type ApplicationPreAuthorizedArray

type ApplicationPreAuthorizedArray []ApplicationPreAuthorizedInput

func (ApplicationPreAuthorizedArray) ElementType

func (ApplicationPreAuthorizedArray) ToApplicationPreAuthorizedArrayOutput

func (i ApplicationPreAuthorizedArray) ToApplicationPreAuthorizedArrayOutput() ApplicationPreAuthorizedArrayOutput

func (ApplicationPreAuthorizedArray) ToApplicationPreAuthorizedArrayOutputWithContext

func (i ApplicationPreAuthorizedArray) ToApplicationPreAuthorizedArrayOutputWithContext(ctx context.Context) ApplicationPreAuthorizedArrayOutput

type ApplicationPreAuthorizedArrayInput

type ApplicationPreAuthorizedArrayInput interface {
	pulumi.Input

	ToApplicationPreAuthorizedArrayOutput() ApplicationPreAuthorizedArrayOutput
	ToApplicationPreAuthorizedArrayOutputWithContext(context.Context) ApplicationPreAuthorizedArrayOutput
}

ApplicationPreAuthorizedArrayInput is an input type that accepts ApplicationPreAuthorizedArray and ApplicationPreAuthorizedArrayOutput values. You can construct a concrete instance of `ApplicationPreAuthorizedArrayInput` via:

ApplicationPreAuthorizedArray{ ApplicationPreAuthorizedArgs{...} }

type ApplicationPreAuthorizedArrayOutput

type ApplicationPreAuthorizedArrayOutput struct{ *pulumi.OutputState }

func (ApplicationPreAuthorizedArrayOutput) ElementType

func (ApplicationPreAuthorizedArrayOutput) Index

func (ApplicationPreAuthorizedArrayOutput) ToApplicationPreAuthorizedArrayOutput

func (o ApplicationPreAuthorizedArrayOutput) ToApplicationPreAuthorizedArrayOutput() ApplicationPreAuthorizedArrayOutput

func (ApplicationPreAuthorizedArrayOutput) ToApplicationPreAuthorizedArrayOutputWithContext

func (o ApplicationPreAuthorizedArrayOutput) ToApplicationPreAuthorizedArrayOutputWithContext(ctx context.Context) ApplicationPreAuthorizedArrayOutput

type ApplicationPreAuthorizedInput

type ApplicationPreAuthorizedInput interface {
	pulumi.Input

	ToApplicationPreAuthorizedOutput() ApplicationPreAuthorizedOutput
	ToApplicationPreAuthorizedOutputWithContext(ctx context.Context) ApplicationPreAuthorizedOutput
}

type ApplicationPreAuthorizedMap

type ApplicationPreAuthorizedMap map[string]ApplicationPreAuthorizedInput

func (ApplicationPreAuthorizedMap) ElementType

func (ApplicationPreAuthorizedMap) ToApplicationPreAuthorizedMapOutput

func (i ApplicationPreAuthorizedMap) ToApplicationPreAuthorizedMapOutput() ApplicationPreAuthorizedMapOutput

func (ApplicationPreAuthorizedMap) ToApplicationPreAuthorizedMapOutputWithContext

func (i ApplicationPreAuthorizedMap) ToApplicationPreAuthorizedMapOutputWithContext(ctx context.Context) ApplicationPreAuthorizedMapOutput

type ApplicationPreAuthorizedMapInput

type ApplicationPreAuthorizedMapInput interface {
	pulumi.Input

	ToApplicationPreAuthorizedMapOutput() ApplicationPreAuthorizedMapOutput
	ToApplicationPreAuthorizedMapOutputWithContext(context.Context) ApplicationPreAuthorizedMapOutput
}

ApplicationPreAuthorizedMapInput is an input type that accepts ApplicationPreAuthorizedMap and ApplicationPreAuthorizedMapOutput values. You can construct a concrete instance of `ApplicationPreAuthorizedMapInput` via:

ApplicationPreAuthorizedMap{ "key": ApplicationPreAuthorizedArgs{...} }

type ApplicationPreAuthorizedMapOutput

type ApplicationPreAuthorizedMapOutput struct{ *pulumi.OutputState }

func (ApplicationPreAuthorizedMapOutput) ElementType

func (ApplicationPreAuthorizedMapOutput) MapIndex

func (ApplicationPreAuthorizedMapOutput) ToApplicationPreAuthorizedMapOutput

func (o ApplicationPreAuthorizedMapOutput) ToApplicationPreAuthorizedMapOutput() ApplicationPreAuthorizedMapOutput

func (ApplicationPreAuthorizedMapOutput) ToApplicationPreAuthorizedMapOutputWithContext

func (o ApplicationPreAuthorizedMapOutput) ToApplicationPreAuthorizedMapOutputWithContext(ctx context.Context) ApplicationPreAuthorizedMapOutput

type ApplicationPreAuthorizedOutput

type ApplicationPreAuthorizedOutput struct{ *pulumi.OutputState }

func (ApplicationPreAuthorizedOutput) ApplicationId added in v5.43.0

The resource ID of the application for which permissions are being authorized. Changing this field forces a new resource to be created.

func (ApplicationPreAuthorizedOutput) ApplicationObjectId deprecated added in v5.22.0

func (o ApplicationPreAuthorizedOutput) ApplicationObjectId() pulumi.StringOutput

The object ID of the application to which this pre-authorized application should be added

Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider

func (ApplicationPreAuthorizedOutput) AuthorizedAppId deprecated added in v5.22.0

The application ID of the pre-authorized application

Deprecated: The `authorizedAppId` property has been replaced with the `authorizedClientId` property and will be removed in version 3.0 of the AzureAD provider

func (ApplicationPreAuthorizedOutput) AuthorizedClientId added in v5.43.0

func (o ApplicationPreAuthorizedOutput) AuthorizedClientId() pulumi.StringOutput

The client ID of the application being authorized. Changing this field forces a new resource to be created.

func (ApplicationPreAuthorizedOutput) ElementType

func (ApplicationPreAuthorizedOutput) PermissionIds added in v5.22.0

A set of permission scope IDs required by the authorized application.

func (ApplicationPreAuthorizedOutput) ToApplicationPreAuthorizedOutput

func (o ApplicationPreAuthorizedOutput) ToApplicationPreAuthorizedOutput() ApplicationPreAuthorizedOutput

func (ApplicationPreAuthorizedOutput) ToApplicationPreAuthorizedOutputWithContext

func (o ApplicationPreAuthorizedOutput) ToApplicationPreAuthorizedOutputWithContext(ctx context.Context) ApplicationPreAuthorizedOutput

type ApplicationPreAuthorizedState

type ApplicationPreAuthorizedState struct {
	// The resource ID of the application for which permissions are being authorized. Changing this field forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// The object ID of the application to which this pre-authorized application should be added
	//
	// Deprecated: The `applicationObjectId` property has been replaced with the `applicationId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationObjectId pulumi.StringPtrInput
	// The application ID of the pre-authorized application
	//
	// Deprecated: The `authorizedAppId` property has been replaced with the `authorizedClientId` property and will be removed in version 3.0 of the AzureAD provider
	AuthorizedAppId pulumi.StringPtrInput
	// The client ID of the application being authorized. Changing this field forces a new resource to be created.
	AuthorizedClientId pulumi.StringPtrInput
	// A set of permission scope IDs required by the authorized application.
	PermissionIds pulumi.StringArrayInput
}

func (ApplicationPreAuthorizedState) ElementType

type ApplicationPublicClient

type ApplicationPublicClient struct {
	// A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `https` or `ms-appx-web` URL.
	RedirectUris []string `pulumi:"redirectUris"`
}

type ApplicationPublicClientArgs

type ApplicationPublicClientArgs struct {
	// A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `https` or `ms-appx-web` URL.
	RedirectUris pulumi.StringArrayInput `pulumi:"redirectUris"`
}

func (ApplicationPublicClientArgs) ElementType

func (ApplicationPublicClientArgs) ToApplicationPublicClientOutput

func (i ApplicationPublicClientArgs) ToApplicationPublicClientOutput() ApplicationPublicClientOutput

func (ApplicationPublicClientArgs) ToApplicationPublicClientOutputWithContext

func (i ApplicationPublicClientArgs) ToApplicationPublicClientOutputWithContext(ctx context.Context) ApplicationPublicClientOutput

func (ApplicationPublicClientArgs) ToApplicationPublicClientPtrOutput

func (i ApplicationPublicClientArgs) ToApplicationPublicClientPtrOutput() ApplicationPublicClientPtrOutput

func (ApplicationPublicClientArgs) ToApplicationPublicClientPtrOutputWithContext

func (i ApplicationPublicClientArgs) ToApplicationPublicClientPtrOutputWithContext(ctx context.Context) ApplicationPublicClientPtrOutput

type ApplicationPublicClientInput

type ApplicationPublicClientInput interface {
	pulumi.Input

	ToApplicationPublicClientOutput() ApplicationPublicClientOutput
	ToApplicationPublicClientOutputWithContext(context.Context) ApplicationPublicClientOutput
}

ApplicationPublicClientInput is an input type that accepts ApplicationPublicClientArgs and ApplicationPublicClientOutput values. You can construct a concrete instance of `ApplicationPublicClientInput` via:

ApplicationPublicClientArgs{...}

type ApplicationPublicClientOutput

type ApplicationPublicClientOutput struct{ *pulumi.OutputState }

func (ApplicationPublicClientOutput) ElementType

func (ApplicationPublicClientOutput) RedirectUris

A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `https` or `ms-appx-web` URL.

func (ApplicationPublicClientOutput) ToApplicationPublicClientOutput

func (o ApplicationPublicClientOutput) ToApplicationPublicClientOutput() ApplicationPublicClientOutput

func (ApplicationPublicClientOutput) ToApplicationPublicClientOutputWithContext

func (o ApplicationPublicClientOutput) ToApplicationPublicClientOutputWithContext(ctx context.Context) ApplicationPublicClientOutput

func (ApplicationPublicClientOutput) ToApplicationPublicClientPtrOutput

func (o ApplicationPublicClientOutput) ToApplicationPublicClientPtrOutput() ApplicationPublicClientPtrOutput

func (ApplicationPublicClientOutput) ToApplicationPublicClientPtrOutputWithContext

func (o ApplicationPublicClientOutput) ToApplicationPublicClientPtrOutputWithContext(ctx context.Context) ApplicationPublicClientPtrOutput

type ApplicationPublicClientPtrInput

type ApplicationPublicClientPtrInput interface {
	pulumi.Input

	ToApplicationPublicClientPtrOutput() ApplicationPublicClientPtrOutput
	ToApplicationPublicClientPtrOutputWithContext(context.Context) ApplicationPublicClientPtrOutput
}

ApplicationPublicClientPtrInput is an input type that accepts ApplicationPublicClientArgs, ApplicationPublicClientPtr and ApplicationPublicClientPtrOutput values. You can construct a concrete instance of `ApplicationPublicClientPtrInput` via:

        ApplicationPublicClientArgs{...}

or:

        nil

type ApplicationPublicClientPtrOutput

type ApplicationPublicClientPtrOutput struct{ *pulumi.OutputState }

func (ApplicationPublicClientPtrOutput) Elem

func (ApplicationPublicClientPtrOutput) ElementType

func (ApplicationPublicClientPtrOutput) RedirectUris

A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `https` or `ms-appx-web` URL.

func (ApplicationPublicClientPtrOutput) ToApplicationPublicClientPtrOutput

func (o ApplicationPublicClientPtrOutput) ToApplicationPublicClientPtrOutput() ApplicationPublicClientPtrOutput

func (ApplicationPublicClientPtrOutput) ToApplicationPublicClientPtrOutputWithContext

func (o ApplicationPublicClientPtrOutput) ToApplicationPublicClientPtrOutputWithContext(ctx context.Context) ApplicationPublicClientPtrOutput

type ApplicationRedirectUris added in v5.43.0

type ApplicationRedirectUris struct {
	pulumi.CustomResourceState

	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// A set of redirect URIs to assign to the application.
	RedirectUris pulumi.StringArrayOutput `pulumi:"redirectUris"`
	// The type of redirect URIs to manage. Must be one of: `PublicClient`, `SPA`, or `Web`. Changing this forces a new resource to be created.
	Type pulumi.StringOutput `pulumi:"type"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationRedirectUris(ctx, "example_public", &azuread.ApplicationRedirectUrisArgs{
			ApplicationId: example.ID(),
			Type:          pulumi.String("PublicClient"),
			RedirectUris: pulumi.StringArray{
				pulumi.String("myapp://auth"),
				pulumi.String("sample.mobile.app.bundie.id://auth"),
				pulumi.String("https://login.microsoftonline.com/common/oauth2/nativeclient"),
				pulumi.String("https://login.live.com/oauth20_desktop.srf"),
				pulumi.String("ms-appx-web://Microsoft.AAD.BrokerPlugin/00000000-1111-1111-1111-222222222222"),
				pulumi.String("urn:ietf:wg:oauth:2.0:foo"),
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationRedirectUris(ctx, "example_spa", &azuread.ApplicationRedirectUrisArgs{
			ApplicationId: example.ID(),
			Type:          pulumi.String("SPA"),
			RedirectUris: pulumi.StringArray{
				pulumi.String("https://mobile.hashitown.com/"),
				pulumi.String("https://beta.hashitown.com/"),
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationRedirectUris(ctx, "example_web", &azuread.ApplicationRedirectUrisArgs{
			ApplicationId: example.ID(),
			Type:          pulumi.String("Web"),
			RedirectUris: pulumi.StringArray{
				pulumi.String("https://app.hashitown.com/"),
				pulumi.String("https://classic.hashitown.com/"),
				pulumi.String("urn:ietf:wg:oauth:2.0:oob"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Application API Access can be imported using the object ID of the application and the URI type, in the following format.

```sh $ pulumi import azuread:index/applicationRedirectUris:ApplicationRedirectUris example /applications/00000000-0000-0000-0000-000000000000/redirectUris/Web ```

func GetApplicationRedirectUris added in v5.43.0

func GetApplicationRedirectUris(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationRedirectUrisState, opts ...pulumi.ResourceOption) (*ApplicationRedirectUris, error)

GetApplicationRedirectUris gets an existing ApplicationRedirectUris resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationRedirectUris added in v5.43.0

func NewApplicationRedirectUris(ctx *pulumi.Context,
	name string, args *ApplicationRedirectUrisArgs, opts ...pulumi.ResourceOption) (*ApplicationRedirectUris, error)

NewApplicationRedirectUris registers a new resource with the given unique name, arguments, and options.

func (*ApplicationRedirectUris) ElementType added in v5.43.0

func (*ApplicationRedirectUris) ElementType() reflect.Type

func (*ApplicationRedirectUris) ToApplicationRedirectUrisOutput added in v5.43.0

func (i *ApplicationRedirectUris) ToApplicationRedirectUrisOutput() ApplicationRedirectUrisOutput

func (*ApplicationRedirectUris) ToApplicationRedirectUrisOutputWithContext added in v5.43.0

func (i *ApplicationRedirectUris) ToApplicationRedirectUrisOutputWithContext(ctx context.Context) ApplicationRedirectUrisOutput

type ApplicationRedirectUrisArgs added in v5.43.0

type ApplicationRedirectUrisArgs struct {
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringInput
	// A set of redirect URIs to assign to the application.
	RedirectUris pulumi.StringArrayInput
	// The type of redirect URIs to manage. Must be one of: `PublicClient`, `SPA`, or `Web`. Changing this forces a new resource to be created.
	Type pulumi.StringInput
}

The set of arguments for constructing a ApplicationRedirectUris resource.

func (ApplicationRedirectUrisArgs) ElementType added in v5.43.0

type ApplicationRedirectUrisArray added in v5.43.0

type ApplicationRedirectUrisArray []ApplicationRedirectUrisInput

func (ApplicationRedirectUrisArray) ElementType added in v5.43.0

func (ApplicationRedirectUrisArray) ToApplicationRedirectUrisArrayOutput added in v5.43.0

func (i ApplicationRedirectUrisArray) ToApplicationRedirectUrisArrayOutput() ApplicationRedirectUrisArrayOutput

func (ApplicationRedirectUrisArray) ToApplicationRedirectUrisArrayOutputWithContext added in v5.43.0

func (i ApplicationRedirectUrisArray) ToApplicationRedirectUrisArrayOutputWithContext(ctx context.Context) ApplicationRedirectUrisArrayOutput

type ApplicationRedirectUrisArrayInput added in v5.43.0

type ApplicationRedirectUrisArrayInput interface {
	pulumi.Input

	ToApplicationRedirectUrisArrayOutput() ApplicationRedirectUrisArrayOutput
	ToApplicationRedirectUrisArrayOutputWithContext(context.Context) ApplicationRedirectUrisArrayOutput
}

ApplicationRedirectUrisArrayInput is an input type that accepts ApplicationRedirectUrisArray and ApplicationRedirectUrisArrayOutput values. You can construct a concrete instance of `ApplicationRedirectUrisArrayInput` via:

ApplicationRedirectUrisArray{ ApplicationRedirectUrisArgs{...} }

type ApplicationRedirectUrisArrayOutput added in v5.43.0

type ApplicationRedirectUrisArrayOutput struct{ *pulumi.OutputState }

func (ApplicationRedirectUrisArrayOutput) ElementType added in v5.43.0

func (ApplicationRedirectUrisArrayOutput) Index added in v5.43.0

func (ApplicationRedirectUrisArrayOutput) ToApplicationRedirectUrisArrayOutput added in v5.43.0

func (o ApplicationRedirectUrisArrayOutput) ToApplicationRedirectUrisArrayOutput() ApplicationRedirectUrisArrayOutput

func (ApplicationRedirectUrisArrayOutput) ToApplicationRedirectUrisArrayOutputWithContext added in v5.43.0

func (o ApplicationRedirectUrisArrayOutput) ToApplicationRedirectUrisArrayOutputWithContext(ctx context.Context) ApplicationRedirectUrisArrayOutput

type ApplicationRedirectUrisInput added in v5.43.0

type ApplicationRedirectUrisInput interface {
	pulumi.Input

	ToApplicationRedirectUrisOutput() ApplicationRedirectUrisOutput
	ToApplicationRedirectUrisOutputWithContext(ctx context.Context) ApplicationRedirectUrisOutput
}

type ApplicationRedirectUrisMap added in v5.43.0

type ApplicationRedirectUrisMap map[string]ApplicationRedirectUrisInput

func (ApplicationRedirectUrisMap) ElementType added in v5.43.0

func (ApplicationRedirectUrisMap) ElementType() reflect.Type

func (ApplicationRedirectUrisMap) ToApplicationRedirectUrisMapOutput added in v5.43.0

func (i ApplicationRedirectUrisMap) ToApplicationRedirectUrisMapOutput() ApplicationRedirectUrisMapOutput

func (ApplicationRedirectUrisMap) ToApplicationRedirectUrisMapOutputWithContext added in v5.43.0

func (i ApplicationRedirectUrisMap) ToApplicationRedirectUrisMapOutputWithContext(ctx context.Context) ApplicationRedirectUrisMapOutput

type ApplicationRedirectUrisMapInput added in v5.43.0

type ApplicationRedirectUrisMapInput interface {
	pulumi.Input

	ToApplicationRedirectUrisMapOutput() ApplicationRedirectUrisMapOutput
	ToApplicationRedirectUrisMapOutputWithContext(context.Context) ApplicationRedirectUrisMapOutput
}

ApplicationRedirectUrisMapInput is an input type that accepts ApplicationRedirectUrisMap and ApplicationRedirectUrisMapOutput values. You can construct a concrete instance of `ApplicationRedirectUrisMapInput` via:

ApplicationRedirectUrisMap{ "key": ApplicationRedirectUrisArgs{...} }

type ApplicationRedirectUrisMapOutput added in v5.43.0

type ApplicationRedirectUrisMapOutput struct{ *pulumi.OutputState }

func (ApplicationRedirectUrisMapOutput) ElementType added in v5.43.0

func (ApplicationRedirectUrisMapOutput) MapIndex added in v5.43.0

func (ApplicationRedirectUrisMapOutput) ToApplicationRedirectUrisMapOutput added in v5.43.0

func (o ApplicationRedirectUrisMapOutput) ToApplicationRedirectUrisMapOutput() ApplicationRedirectUrisMapOutput

func (ApplicationRedirectUrisMapOutput) ToApplicationRedirectUrisMapOutputWithContext added in v5.43.0

func (o ApplicationRedirectUrisMapOutput) ToApplicationRedirectUrisMapOutputWithContext(ctx context.Context) ApplicationRedirectUrisMapOutput

type ApplicationRedirectUrisOutput added in v5.43.0

type ApplicationRedirectUrisOutput struct{ *pulumi.OutputState }

func (ApplicationRedirectUrisOutput) ApplicationId added in v5.43.0

The resource ID of the application registration. Changing this forces a new resource to be created.

func (ApplicationRedirectUrisOutput) ElementType added in v5.43.0

func (ApplicationRedirectUrisOutput) RedirectUris added in v5.43.0

A set of redirect URIs to assign to the application.

func (ApplicationRedirectUrisOutput) ToApplicationRedirectUrisOutput added in v5.43.0

func (o ApplicationRedirectUrisOutput) ToApplicationRedirectUrisOutput() ApplicationRedirectUrisOutput

func (ApplicationRedirectUrisOutput) ToApplicationRedirectUrisOutputWithContext added in v5.43.0

func (o ApplicationRedirectUrisOutput) ToApplicationRedirectUrisOutputWithContext(ctx context.Context) ApplicationRedirectUrisOutput

func (ApplicationRedirectUrisOutput) Type added in v5.43.0

The type of redirect URIs to manage. Must be one of: `PublicClient`, `SPA`, or `Web`. Changing this forces a new resource to be created.

type ApplicationRedirectUrisState added in v5.43.0

type ApplicationRedirectUrisState struct {
	// The resource ID of the application registration. Changing this forces a new resource to be created.
	ApplicationId pulumi.StringPtrInput
	// A set of redirect URIs to assign to the application.
	RedirectUris pulumi.StringArrayInput
	// The type of redirect URIs to manage. Must be one of: `PublicClient`, `SPA`, or `Web`. Changing this forces a new resource to be created.
	Type pulumi.StringPtrInput
}

func (ApplicationRedirectUrisState) ElementType added in v5.43.0

type ApplicationRegistration added in v5.43.0

type ApplicationRegistration struct {
	pulumi.CustomResourceState

	// The Client ID for the application, which is globally unique.
	ClientId pulumi.StringOutput `pulumi:"clientId"`
	// A description of the application, as shown to end users.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. `DisabledDueToViolationOfServicesAgreement`
	DisabledByMicrosoft pulumi.StringOutput `pulumi:"disabledByMicrosoft"`
	// The display name for the application.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Configures the `groups` claim issued in a user or OAuth access token that the app expects. Possible values are `None`, `SecurityGroup`, `DirectoryRole`, `ApplicationGroup` or `All`.
	GroupMembershipClaims pulumi.StringArrayOutput `pulumi:"groupMembershipClaims"`
	// Home page or landing page of the application.
	HomepageUrl pulumi.StringPtrOutput `pulumi:"homepageUrl"`
	// Whether this web application can request an access token using OAuth implicit flow.
	ImplicitAccessTokenIssuanceEnabled pulumi.BoolPtrOutput `pulumi:"implicitAccessTokenIssuanceEnabled"`
	// Whether this web application can request an ID token using OAuth implicit flow.
	ImplicitIdTokenIssuanceEnabled pulumi.BoolPtrOutput `pulumi:"implicitIdTokenIssuanceEnabled"`
	// The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
	LogoutUrl pulumi.StringPtrOutput `pulumi:"logoutUrl"`
	// URL of the marketing page for the application.
	MarketingUrl pulumi.StringPtrOutput `pulumi:"marketingUrl"`
	// User-specified notes relevant for the management of the application.
	Notes pulumi.StringPtrOutput `pulumi:"notes"`
	// The object ID of the application within the tenant.
	ObjectId pulumi.StringOutput `pulumi:"objectId"`
	// URL of the privacy statement for the application.
	PrivacyStatementUrl pulumi.StringPtrOutput `pulumi:"privacyStatementUrl"`
	// The verified publisher domain for the application.
	PublisherDomain pulumi.StringOutput `pulumi:"publisherDomain"`
	// The access token version expected by this resource. Must be one of `1` or `2`, and must be `2` when `signInAudience` is either `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount` Defaults to `2`.
	RequestedAccessTokenVersion pulumi.IntPtrOutput `pulumi:"requestedAccessTokenVersion"`
	// References application context information from a Service or Asset Management database.
	ServiceManagementReference pulumi.StringPtrOutput `pulumi:"serviceManagementReference"`
	// The Microsoft account types that are supported for the current application. Must be one of `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`. Defaults to `AzureADMyOrg`.
	SignInAudience pulumi.StringPtrOutput `pulumi:"signInAudience"`
	// URL of the support page for the application.
	SupportUrl pulumi.StringPtrOutput `pulumi:"supportUrl"`
	// URL of the terms of service statement for the application.
	TermsOfServiceUrl pulumi.StringPtrOutput `pulumi:"termsOfServiceUrl"`
}

Manages an application registration within Azure Active Directory.

For a more comprehensive alternative, please see the Application resource. Please note that this resource should not be used together with the `Application` resource when managing the same application.

## API Permissions

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

When authenticated with a service principal, this resource requires one of the following application roles: `Application.ReadWrite.OwnedBy` or `Application.ReadWrite.All`

When authenticated with a user principal, this resource may require one of the following directory roles: `Application Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName:         pulumi.String("Example Application"),
			Description:         pulumi.String("My example application"),
			SignInAudience:      pulumi.String("AzureADMyOrg"),
			HomepageUrl:         pulumi.String("https://app.hashitown.com/"),
			LogoutUrl:           pulumi.String("https://app.hashitown.com/logout"),
			MarketingUrl:        pulumi.String("https://hashitown.com/"),
			PrivacyStatementUrl: pulumi.String("https://hashitown.com/privacy"),
			SupportUrl:          pulumi.String("https://support.hashitown.com/"),
			TermsOfServiceUrl:   pulumi.String("https://hashitown.com/terms"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Application Registrations can be imported using the object ID of the application, in the following format.

```sh $ pulumi import azuread:index/applicationRegistration:ApplicationRegistration example /applications/00000000-0000-0000-0000-000000000000 ```

func GetApplicationRegistration added in v5.43.0

func GetApplicationRegistration(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationRegistrationState, opts ...pulumi.ResourceOption) (*ApplicationRegistration, error)

GetApplicationRegistration gets an existing ApplicationRegistration resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApplicationRegistration added in v5.43.0

func NewApplicationRegistration(ctx *pulumi.Context,
	name string, args *ApplicationRegistrationArgs, opts ...pulumi.ResourceOption) (*ApplicationRegistration, error)

NewApplicationRegistration registers a new resource with the given unique name, arguments, and options.

func (*ApplicationRegistration) ElementType added in v5.43.0

func (*ApplicationRegistration) ElementType() reflect.Type

func (*ApplicationRegistration) ToApplicationRegistrationOutput added in v5.43.0

func (i *ApplicationRegistration) ToApplicationRegistrationOutput() ApplicationRegistrationOutput

func (*ApplicationRegistration) ToApplicationRegistrationOutputWithContext added in v5.43.0

func (i *ApplicationRegistration) ToApplicationRegistrationOutputWithContext(ctx context.Context) ApplicationRegistrationOutput

type ApplicationRegistrationArgs added in v5.43.0

type ApplicationRegistrationArgs struct {
	// A description of the application, as shown to end users.
	Description pulumi.StringPtrInput
	// The display name for the application.
	DisplayName pulumi.StringInput
	// Configures the `groups` claim issued in a user or OAuth access token that the app expects. Possible values are `None`, `SecurityGroup`, `DirectoryRole`, `ApplicationGroup` or `All`.
	GroupMembershipClaims pulumi.StringArrayInput
	// Home page or landing page of the application.
	HomepageUrl pulumi.StringPtrInput
	// Whether this web application can request an access token using OAuth implicit flow.
	ImplicitAccessTokenIssuanceEnabled pulumi.BoolPtrInput
	// Whether this web application can request an ID token using OAuth implicit flow.
	ImplicitIdTokenIssuanceEnabled pulumi.BoolPtrInput
	// The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
	LogoutUrl pulumi.StringPtrInput
	// URL of the marketing page for the application.
	MarketingUrl pulumi.StringPtrInput
	// User-specified notes relevant for the management of the application.
	Notes pulumi.StringPtrInput
	// URL of the privacy statement for the application.
	PrivacyStatementUrl pulumi.StringPtrInput
	// The access token version expected by this resource. Must be one of `1` or `2`, and must be `2` when `signInAudience` is either `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount` Defaults to `2`.
	RequestedAccessTokenVersion pulumi.IntPtrInput
	// References application context information from a Service or Asset Management database.
	ServiceManagementReference pulumi.StringPtrInput
	// The Microsoft account types that are supported for the current application. Must be one of `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`. Defaults to `AzureADMyOrg`.
	SignInAudience pulumi.StringPtrInput
	// URL of the support page for the application.
	SupportUrl pulumi.StringPtrInput
	// URL of the terms of service statement for the application.
	TermsOfServiceUrl pulumi.StringPtrInput
}

The set of arguments for constructing a ApplicationRegistration resource.

func (ApplicationRegistrationArgs) ElementType added in v5.43.0

type ApplicationRegistrationArray added in v5.43.0

type ApplicationRegistrationArray []ApplicationRegistrationInput

func (ApplicationRegistrationArray) ElementType added in v5.43.0

func (ApplicationRegistrationArray) ToApplicationRegistrationArrayOutput added in v5.43.0

func (i ApplicationRegistrationArray) ToApplicationRegistrationArrayOutput() ApplicationRegistrationArrayOutput

func (ApplicationRegistrationArray) ToApplicationRegistrationArrayOutputWithContext added in v5.43.0

func (i ApplicationRegistrationArray) ToApplicationRegistrationArrayOutputWithContext(ctx context.Context) ApplicationRegistrationArrayOutput

type ApplicationRegistrationArrayInput added in v5.43.0

type ApplicationRegistrationArrayInput interface {
	pulumi.Input

	ToApplicationRegistrationArrayOutput() ApplicationRegistrationArrayOutput
	ToApplicationRegistrationArrayOutputWithContext(context.Context) ApplicationRegistrationArrayOutput
}

ApplicationRegistrationArrayInput is an input type that accepts ApplicationRegistrationArray and ApplicationRegistrationArrayOutput values. You can construct a concrete instance of `ApplicationRegistrationArrayInput` via:

ApplicationRegistrationArray{ ApplicationRegistrationArgs{...} }

type ApplicationRegistrationArrayOutput added in v5.43.0

type ApplicationRegistrationArrayOutput struct{ *pulumi.OutputState }

func (ApplicationRegistrationArrayOutput) ElementType added in v5.43.0

func (ApplicationRegistrationArrayOutput) Index added in v5.43.0

func (ApplicationRegistrationArrayOutput) ToApplicationRegistrationArrayOutput added in v5.43.0

func (o ApplicationRegistrationArrayOutput) ToApplicationRegistrationArrayOutput() ApplicationRegistrationArrayOutput

func (ApplicationRegistrationArrayOutput) ToApplicationRegistrationArrayOutputWithContext added in v5.43.0

func (o ApplicationRegistrationArrayOutput) ToApplicationRegistrationArrayOutputWithContext(ctx context.Context) ApplicationRegistrationArrayOutput

type ApplicationRegistrationInput added in v5.43.0

type ApplicationRegistrationInput interface {
	pulumi.Input

	ToApplicationRegistrationOutput() ApplicationRegistrationOutput
	ToApplicationRegistrationOutputWithContext(ctx context.Context) ApplicationRegistrationOutput
}

type ApplicationRegistrationMap added in v5.43.0

type ApplicationRegistrationMap map[string]ApplicationRegistrationInput

func (ApplicationRegistrationMap) ElementType added in v5.43.0

func (ApplicationRegistrationMap) ElementType() reflect.Type

func (ApplicationRegistrationMap) ToApplicationRegistrationMapOutput added in v5.43.0

func (i ApplicationRegistrationMap) ToApplicationRegistrationMapOutput() ApplicationRegistrationMapOutput

func (ApplicationRegistrationMap) ToApplicationRegistrationMapOutputWithContext added in v5.43.0

func (i ApplicationRegistrationMap) ToApplicationRegistrationMapOutputWithContext(ctx context.Context) ApplicationRegistrationMapOutput

type ApplicationRegistrationMapInput added in v5.43.0

type ApplicationRegistrationMapInput interface {
	pulumi.Input

	ToApplicationRegistrationMapOutput() ApplicationRegistrationMapOutput
	ToApplicationRegistrationMapOutputWithContext(context.Context) ApplicationRegistrationMapOutput
}

ApplicationRegistrationMapInput is an input type that accepts ApplicationRegistrationMap and ApplicationRegistrationMapOutput values. You can construct a concrete instance of `ApplicationRegistrationMapInput` via:

ApplicationRegistrationMap{ "key": ApplicationRegistrationArgs{...} }

type ApplicationRegistrationMapOutput added in v5.43.0

type ApplicationRegistrationMapOutput struct{ *pulumi.OutputState }

func (ApplicationRegistrationMapOutput) ElementType added in v5.43.0

func (ApplicationRegistrationMapOutput) MapIndex added in v5.43.0

func (ApplicationRegistrationMapOutput) ToApplicationRegistrationMapOutput added in v5.43.0

func (o ApplicationRegistrationMapOutput) ToApplicationRegistrationMapOutput() ApplicationRegistrationMapOutput

func (ApplicationRegistrationMapOutput) ToApplicationRegistrationMapOutputWithContext added in v5.43.0

func (o ApplicationRegistrationMapOutput) ToApplicationRegistrationMapOutputWithContext(ctx context.Context) ApplicationRegistrationMapOutput

type ApplicationRegistrationOutput added in v5.43.0

type ApplicationRegistrationOutput struct{ *pulumi.OutputState }

func (ApplicationRegistrationOutput) ClientId added in v5.43.0

The Client ID for the application, which is globally unique.

func (ApplicationRegistrationOutput) Description added in v5.43.0

A description of the application, as shown to end users.

func (ApplicationRegistrationOutput) DisabledByMicrosoft added in v5.43.0

func (o ApplicationRegistrationOutput) DisabledByMicrosoft() pulumi.StringOutput

Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. `DisabledDueToViolationOfServicesAgreement`

func (ApplicationRegistrationOutput) DisplayName added in v5.43.0

The display name for the application.

func (ApplicationRegistrationOutput) ElementType added in v5.43.0

func (ApplicationRegistrationOutput) GroupMembershipClaims added in v5.43.0

func (o ApplicationRegistrationOutput) GroupMembershipClaims() pulumi.StringArrayOutput

Configures the `groups` claim issued in a user or OAuth access token that the app expects. Possible values are `None`, `SecurityGroup`, `DirectoryRole`, `ApplicationGroup` or `All`.

func (ApplicationRegistrationOutput) HomepageUrl added in v5.43.0

Home page or landing page of the application.

func (ApplicationRegistrationOutput) ImplicitAccessTokenIssuanceEnabled added in v5.43.0

func (o ApplicationRegistrationOutput) ImplicitAccessTokenIssuanceEnabled() pulumi.BoolPtrOutput

Whether this web application can request an access token using OAuth implicit flow.

func (ApplicationRegistrationOutput) ImplicitIdTokenIssuanceEnabled added in v5.43.0

func (o ApplicationRegistrationOutput) ImplicitIdTokenIssuanceEnabled() pulumi.BoolPtrOutput

Whether this web application can request an ID token using OAuth implicit flow.

func (ApplicationRegistrationOutput) LogoutUrl added in v5.43.0

The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.

func (ApplicationRegistrationOutput) MarketingUrl added in v5.43.0

URL of the marketing page for the application.

func (ApplicationRegistrationOutput) Notes added in v5.43.0

User-specified notes relevant for the management of the application.

func (ApplicationRegistrationOutput) ObjectId added in v5.43.0

The object ID of the application within the tenant.

func (ApplicationRegistrationOutput) PrivacyStatementUrl added in v5.43.0

func (o ApplicationRegistrationOutput) PrivacyStatementUrl() pulumi.StringPtrOutput

URL of the privacy statement for the application.

func (ApplicationRegistrationOutput) PublisherDomain added in v5.43.0

The verified publisher domain for the application.

func (ApplicationRegistrationOutput) RequestedAccessTokenVersion added in v5.43.0

func (o ApplicationRegistrationOutput) RequestedAccessTokenVersion() pulumi.IntPtrOutput

The access token version expected by this resource. Must be one of `1` or `2`, and must be `2` when `signInAudience` is either `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount` Defaults to `2`.

func (ApplicationRegistrationOutput) ServiceManagementReference added in v5.43.0

func (o ApplicationRegistrationOutput) ServiceManagementReference() pulumi.StringPtrOutput

References application context information from a Service or Asset Management database.

func (ApplicationRegistrationOutput) SignInAudience added in v5.43.0

The Microsoft account types that are supported for the current application. Must be one of `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`. Defaults to `AzureADMyOrg`.

func (ApplicationRegistrationOutput) SupportUrl added in v5.43.0

URL of the support page for the application.

func (ApplicationRegistrationOutput) TermsOfServiceUrl added in v5.43.0

URL of the terms of service statement for the application.

func (ApplicationRegistrationOutput) ToApplicationRegistrationOutput added in v5.43.0

func (o ApplicationRegistrationOutput) ToApplicationRegistrationOutput() ApplicationRegistrationOutput

func (ApplicationRegistrationOutput) ToApplicationRegistrationOutputWithContext added in v5.43.0

func (o ApplicationRegistrationOutput) ToApplicationRegistrationOutputWithContext(ctx context.Context) ApplicationRegistrationOutput

type ApplicationRegistrationState added in v5.43.0

type ApplicationRegistrationState struct {
	// The Client ID for the application, which is globally unique.
	ClientId pulumi.StringPtrInput
	// A description of the application, as shown to end users.
	Description pulumi.StringPtrInput
	// Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. `DisabledDueToViolationOfServicesAgreement`
	DisabledByMicrosoft pulumi.StringPtrInput
	// The display name for the application.
	DisplayName pulumi.StringPtrInput
	// Configures the `groups` claim issued in a user or OAuth access token that the app expects. Possible values are `None`, `SecurityGroup`, `DirectoryRole`, `ApplicationGroup` or `All`.
	GroupMembershipClaims pulumi.StringArrayInput
	// Home page or landing page of the application.
	HomepageUrl pulumi.StringPtrInput
	// Whether this web application can request an access token using OAuth implicit flow.
	ImplicitAccessTokenIssuanceEnabled pulumi.BoolPtrInput
	// Whether this web application can request an ID token using OAuth implicit flow.
	ImplicitIdTokenIssuanceEnabled pulumi.BoolPtrInput
	// The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
	LogoutUrl pulumi.StringPtrInput
	// URL of the marketing page for the application.
	MarketingUrl pulumi.StringPtrInput
	// User-specified notes relevant for the management of the application.
	Notes pulumi.StringPtrInput
	// The object ID of the application within the tenant.
	ObjectId pulumi.StringPtrInput
	// URL of the privacy statement for the application.
	PrivacyStatementUrl pulumi.StringPtrInput
	// The verified publisher domain for the application.
	PublisherDomain pulumi.StringPtrInput
	// The access token version expected by this resource. Must be one of `1` or `2`, and must be `2` when `signInAudience` is either `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount` Defaults to `2`.
	RequestedAccessTokenVersion pulumi.IntPtrInput
	// References application context information from a Service or Asset Management database.
	ServiceManagementReference pulumi.StringPtrInput
	// The Microsoft account types that are supported for the current application. Must be one of `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`. Defaults to `AzureADMyOrg`.
	SignInAudience pulumi.StringPtrInput
	// URL of the support page for the application.
	SupportUrl pulumi.StringPtrInput
	// URL of the terms of service statement for the application.
	TermsOfServiceUrl pulumi.StringPtrInput
}

func (ApplicationRegistrationState) ElementType added in v5.43.0

type ApplicationRequiredResourceAccess

type ApplicationRequiredResourceAccess struct {
	// A collection of `resourceAccess` blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
	ResourceAccesses []ApplicationRequiredResourceAccessResourceAccess `pulumi:"resourceAccesses"`
	// The unique identifier for the resource that the application requires access to. This should be the Application ID of the target application.
	//
	// > **Note:** Documentation on `resourceAppId` values for Microsoft APIs can be difficult to find, but you can use the [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/ad/sp?view=azure-cli-latest#az_ad_sp_list) to find them. (e.g. `az ad sp list --display-name "Microsoft Graph" --query '[].{appDisplayName:appDisplayName, appId:appId}'`)
	ResourceAppId string `pulumi:"resourceAppId"`
}

type ApplicationRequiredResourceAccessArgs

type ApplicationRequiredResourceAccessArgs struct {
	// A collection of `resourceAccess` blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
	ResourceAccesses ApplicationRequiredResourceAccessResourceAccessArrayInput `pulumi:"resourceAccesses"`
	// The unique identifier for the resource that the application requires access to. This should be the Application ID of the target application.
	//
	// > **Note:** Documentation on `resourceAppId` values for Microsoft APIs can be difficult to find, but you can use the [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/ad/sp?view=azure-cli-latest#az_ad_sp_list) to find them. (e.g. `az ad sp list --display-name "Microsoft Graph" --query '[].{appDisplayName:appDisplayName, appId:appId}'`)
	ResourceAppId pulumi.StringInput `pulumi:"resourceAppId"`
}

func (ApplicationRequiredResourceAccessArgs) ElementType

func (ApplicationRequiredResourceAccessArgs) ToApplicationRequiredResourceAccessOutput

func (i ApplicationRequiredResourceAccessArgs) ToApplicationRequiredResourceAccessOutput() ApplicationRequiredResourceAccessOutput

func (ApplicationRequiredResourceAccessArgs) ToApplicationRequiredResourceAccessOutputWithContext

func (i ApplicationRequiredResourceAccessArgs) ToApplicationRequiredResourceAccessOutputWithContext(ctx context.Context) ApplicationRequiredResourceAccessOutput

type ApplicationRequiredResourceAccessArray

type ApplicationRequiredResourceAccessArray []ApplicationRequiredResourceAccessInput

func (ApplicationRequiredResourceAccessArray) ElementType

func (ApplicationRequiredResourceAccessArray) ToApplicationRequiredResourceAccessArrayOutput

func (i ApplicationRequiredResourceAccessArray) ToApplicationRequiredResourceAccessArrayOutput() ApplicationRequiredResourceAccessArrayOutput

func (ApplicationRequiredResourceAccessArray) ToApplicationRequiredResourceAccessArrayOutputWithContext

func (i ApplicationRequiredResourceAccessArray) ToApplicationRequiredResourceAccessArrayOutputWithContext(ctx context.Context) ApplicationRequiredResourceAccessArrayOutput

type ApplicationRequiredResourceAccessArrayInput

type ApplicationRequiredResourceAccessArrayInput interface {
	pulumi.Input

	ToApplicationRequiredResourceAccessArrayOutput() ApplicationRequiredResourceAccessArrayOutput
	ToApplicationRequiredResourceAccessArrayOutputWithContext(context.Context) ApplicationRequiredResourceAccessArrayOutput
}

ApplicationRequiredResourceAccessArrayInput is an input type that accepts ApplicationRequiredResourceAccessArray and ApplicationRequiredResourceAccessArrayOutput values. You can construct a concrete instance of `ApplicationRequiredResourceAccessArrayInput` via:

ApplicationRequiredResourceAccessArray{ ApplicationRequiredResourceAccessArgs{...} }

type ApplicationRequiredResourceAccessArrayOutput

type ApplicationRequiredResourceAccessArrayOutput struct{ *pulumi.OutputState }

func (ApplicationRequiredResourceAccessArrayOutput) ElementType

func (ApplicationRequiredResourceAccessArrayOutput) Index

func (ApplicationRequiredResourceAccessArrayOutput) ToApplicationRequiredResourceAccessArrayOutput

func (o ApplicationRequiredResourceAccessArrayOutput) ToApplicationRequiredResourceAccessArrayOutput() ApplicationRequiredResourceAccessArrayOutput

func (ApplicationRequiredResourceAccessArrayOutput) ToApplicationRequiredResourceAccessArrayOutputWithContext

func (o ApplicationRequiredResourceAccessArrayOutput) ToApplicationRequiredResourceAccessArrayOutputWithContext(ctx context.Context) ApplicationRequiredResourceAccessArrayOutput

type ApplicationRequiredResourceAccessInput

type ApplicationRequiredResourceAccessInput interface {
	pulumi.Input

	ToApplicationRequiredResourceAccessOutput() ApplicationRequiredResourceAccessOutput
	ToApplicationRequiredResourceAccessOutputWithContext(context.Context) ApplicationRequiredResourceAccessOutput
}

ApplicationRequiredResourceAccessInput is an input type that accepts ApplicationRequiredResourceAccessArgs and ApplicationRequiredResourceAccessOutput values. You can construct a concrete instance of `ApplicationRequiredResourceAccessInput` via:

ApplicationRequiredResourceAccessArgs{...}

type ApplicationRequiredResourceAccessOutput

type ApplicationRequiredResourceAccessOutput struct{ *pulumi.OutputState }

func (ApplicationRequiredResourceAccessOutput) ElementType

func (ApplicationRequiredResourceAccessOutput) ResourceAccesses

A collection of `resourceAccess` blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource.

func (ApplicationRequiredResourceAccessOutput) ResourceAppId

The unique identifier for the resource that the application requires access to. This should be the Application ID of the target application.

> **Note:** Documentation on `resourceAppId` values for Microsoft APIs can be difficult to find, but you can use the [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/ad/sp?view=azure-cli-latest#az_ad_sp_list) to find them. (e.g. `az ad sp list --display-name "Microsoft Graph" --query '[].{appDisplayName:appDisplayName, appId:appId}'`)

func (ApplicationRequiredResourceAccessOutput) ToApplicationRequiredResourceAccessOutput

func (o ApplicationRequiredResourceAccessOutput) ToApplicationRequiredResourceAccessOutput() ApplicationRequiredResourceAccessOutput

func (ApplicationRequiredResourceAccessOutput) ToApplicationRequiredResourceAccessOutputWithContext

func (o ApplicationRequiredResourceAccessOutput) ToApplicationRequiredResourceAccessOutputWithContext(ctx context.Context) ApplicationRequiredResourceAccessOutput

type ApplicationRequiredResourceAccessResourceAccess

type ApplicationRequiredResourceAccessResourceAccess struct {
	// The unique identifier for an app role or OAuth2 permission scope published by the resource application.
	Id string `pulumi:"id"`
	// Specifies whether the `id` property references an app role or an OAuth2 permission scope. Possible values are `Role` or `Scope`.
	Type string `pulumi:"type"`
}

type ApplicationRequiredResourceAccessResourceAccessArgs

type ApplicationRequiredResourceAccessResourceAccessArgs struct {
	// The unique identifier for an app role or OAuth2 permission scope published by the resource application.
	Id pulumi.StringInput `pulumi:"id"`
	// Specifies whether the `id` property references an app role or an OAuth2 permission scope. Possible values are `Role` or `Scope`.
	Type pulumi.StringInput `pulumi:"type"`
}

func (ApplicationRequiredResourceAccessResourceAccessArgs) ElementType

func (ApplicationRequiredResourceAccessResourceAccessArgs) ToApplicationRequiredResourceAccessResourceAccessOutput

func (i ApplicationRequiredResourceAccessResourceAccessArgs) ToApplicationRequiredResourceAccessResourceAccessOutput() ApplicationRequiredResourceAccessResourceAccessOutput

func (ApplicationRequiredResourceAccessResourceAccessArgs) ToApplicationRequiredResourceAccessResourceAccessOutputWithContext

func (i ApplicationRequiredResourceAccessResourceAccessArgs) ToApplicationRequiredResourceAccessResourceAccessOutputWithContext(ctx context.Context) ApplicationRequiredResourceAccessResourceAccessOutput

type ApplicationRequiredResourceAccessResourceAccessArray

type ApplicationRequiredResourceAccessResourceAccessArray []ApplicationRequiredResourceAccessResourceAccessInput

func (ApplicationRequiredResourceAccessResourceAccessArray) ElementType

func (ApplicationRequiredResourceAccessResourceAccessArray) ToApplicationRequiredResourceAccessResourceAccessArrayOutput

func (i ApplicationRequiredResourceAccessResourceAccessArray) ToApplicationRequiredResourceAccessResourceAccessArrayOutput() ApplicationRequiredResourceAccessResourceAccessArrayOutput

func (ApplicationRequiredResourceAccessResourceAccessArray) ToApplicationRequiredResourceAccessResourceAccessArrayOutputWithContext

func (i ApplicationRequiredResourceAccessResourceAccessArray) ToApplicationRequiredResourceAccessResourceAccessArrayOutputWithContext(ctx context.Context) ApplicationRequiredResourceAccessResourceAccessArrayOutput

type ApplicationRequiredResourceAccessResourceAccessArrayInput

type ApplicationRequiredResourceAccessResourceAccessArrayInput interface {
	pulumi.Input

	ToApplicationRequiredResourceAccessResourceAccessArrayOutput() ApplicationRequiredResourceAccessResourceAccessArrayOutput
	ToApplicationRequiredResourceAccessResourceAccessArrayOutputWithContext(context.Context) ApplicationRequiredResourceAccessResourceAccessArrayOutput
}

ApplicationRequiredResourceAccessResourceAccessArrayInput is an input type that accepts ApplicationRequiredResourceAccessResourceAccessArray and ApplicationRequiredResourceAccessResourceAccessArrayOutput values. You can construct a concrete instance of `ApplicationRequiredResourceAccessResourceAccessArrayInput` via:

ApplicationRequiredResourceAccessResourceAccessArray{ ApplicationRequiredResourceAccessResourceAccessArgs{...} }

type ApplicationRequiredResourceAccessResourceAccessArrayOutput

type ApplicationRequiredResourceAccessResourceAccessArrayOutput struct{ *pulumi.OutputState }

func (ApplicationRequiredResourceAccessResourceAccessArrayOutput) ElementType

func (ApplicationRequiredResourceAccessResourceAccessArrayOutput) Index

func (ApplicationRequiredResourceAccessResourceAccessArrayOutput) ToApplicationRequiredResourceAccessResourceAccessArrayOutput

func (ApplicationRequiredResourceAccessResourceAccessArrayOutput) ToApplicationRequiredResourceAccessResourceAccessArrayOutputWithContext

func (o ApplicationRequiredResourceAccessResourceAccessArrayOutput) ToApplicationRequiredResourceAccessResourceAccessArrayOutputWithContext(ctx context.Context) ApplicationRequiredResourceAccessResourceAccessArrayOutput

type ApplicationRequiredResourceAccessResourceAccessInput

type ApplicationRequiredResourceAccessResourceAccessInput interface {
	pulumi.Input

	ToApplicationRequiredResourceAccessResourceAccessOutput() ApplicationRequiredResourceAccessResourceAccessOutput
	ToApplicationRequiredResourceAccessResourceAccessOutputWithContext(context.Context) ApplicationRequiredResourceAccessResourceAccessOutput
}

ApplicationRequiredResourceAccessResourceAccessInput is an input type that accepts ApplicationRequiredResourceAccessResourceAccessArgs and ApplicationRequiredResourceAccessResourceAccessOutput values. You can construct a concrete instance of `ApplicationRequiredResourceAccessResourceAccessInput` via:

ApplicationRequiredResourceAccessResourceAccessArgs{...}

type ApplicationRequiredResourceAccessResourceAccessOutput

type ApplicationRequiredResourceAccessResourceAccessOutput struct{ *pulumi.OutputState }

func (ApplicationRequiredResourceAccessResourceAccessOutput) ElementType

func (ApplicationRequiredResourceAccessResourceAccessOutput) Id

The unique identifier for an app role or OAuth2 permission scope published by the resource application.

func (ApplicationRequiredResourceAccessResourceAccessOutput) ToApplicationRequiredResourceAccessResourceAccessOutput

func (ApplicationRequiredResourceAccessResourceAccessOutput) ToApplicationRequiredResourceAccessResourceAccessOutputWithContext

func (o ApplicationRequiredResourceAccessResourceAccessOutput) ToApplicationRequiredResourceAccessResourceAccessOutputWithContext(ctx context.Context) ApplicationRequiredResourceAccessResourceAccessOutput

func (ApplicationRequiredResourceAccessResourceAccessOutput) Type

Specifies whether the `id` property references an app role or an OAuth2 permission scope. Possible values are `Role` or `Scope`.

type ApplicationSinglePageApplication

type ApplicationSinglePageApplication struct {
	// A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `https` URL.
	RedirectUris []string `pulumi:"redirectUris"`
}

type ApplicationSinglePageApplicationArgs

type ApplicationSinglePageApplicationArgs struct {
	// A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `https` URL.
	RedirectUris pulumi.StringArrayInput `pulumi:"redirectUris"`
}

func (ApplicationSinglePageApplicationArgs) ElementType

func (ApplicationSinglePageApplicationArgs) ToApplicationSinglePageApplicationOutput

func (i ApplicationSinglePageApplicationArgs) ToApplicationSinglePageApplicationOutput() ApplicationSinglePageApplicationOutput

func (ApplicationSinglePageApplicationArgs) ToApplicationSinglePageApplicationOutputWithContext

func (i ApplicationSinglePageApplicationArgs) ToApplicationSinglePageApplicationOutputWithContext(ctx context.Context) ApplicationSinglePageApplicationOutput

func (ApplicationSinglePageApplicationArgs) ToApplicationSinglePageApplicationPtrOutput

func (i ApplicationSinglePageApplicationArgs) ToApplicationSinglePageApplicationPtrOutput() ApplicationSinglePageApplicationPtrOutput

func (ApplicationSinglePageApplicationArgs) ToApplicationSinglePageApplicationPtrOutputWithContext

func (i ApplicationSinglePageApplicationArgs) ToApplicationSinglePageApplicationPtrOutputWithContext(ctx context.Context) ApplicationSinglePageApplicationPtrOutput

type ApplicationSinglePageApplicationInput

type ApplicationSinglePageApplicationInput interface {
	pulumi.Input

	ToApplicationSinglePageApplicationOutput() ApplicationSinglePageApplicationOutput
	ToApplicationSinglePageApplicationOutputWithContext(context.Context) ApplicationSinglePageApplicationOutput
}

ApplicationSinglePageApplicationInput is an input type that accepts ApplicationSinglePageApplicationArgs and ApplicationSinglePageApplicationOutput values. You can construct a concrete instance of `ApplicationSinglePageApplicationInput` via:

ApplicationSinglePageApplicationArgs{...}

type ApplicationSinglePageApplicationOutput

type ApplicationSinglePageApplicationOutput struct{ *pulumi.OutputState }

func (ApplicationSinglePageApplicationOutput) ElementType

func (ApplicationSinglePageApplicationOutput) RedirectUris

A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `https` URL.

func (ApplicationSinglePageApplicationOutput) ToApplicationSinglePageApplicationOutput

func (o ApplicationSinglePageApplicationOutput) ToApplicationSinglePageApplicationOutput() ApplicationSinglePageApplicationOutput

func (ApplicationSinglePageApplicationOutput) ToApplicationSinglePageApplicationOutputWithContext

func (o ApplicationSinglePageApplicationOutput) ToApplicationSinglePageApplicationOutputWithContext(ctx context.Context) ApplicationSinglePageApplicationOutput

func (ApplicationSinglePageApplicationOutput) ToApplicationSinglePageApplicationPtrOutput

func (o ApplicationSinglePageApplicationOutput) ToApplicationSinglePageApplicationPtrOutput() ApplicationSinglePageApplicationPtrOutput

func (ApplicationSinglePageApplicationOutput) ToApplicationSinglePageApplicationPtrOutputWithContext

func (o ApplicationSinglePageApplicationOutput) ToApplicationSinglePageApplicationPtrOutputWithContext(ctx context.Context) ApplicationSinglePageApplicationPtrOutput

type ApplicationSinglePageApplicationPtrInput

type ApplicationSinglePageApplicationPtrInput interface {
	pulumi.Input

	ToApplicationSinglePageApplicationPtrOutput() ApplicationSinglePageApplicationPtrOutput
	ToApplicationSinglePageApplicationPtrOutputWithContext(context.Context) ApplicationSinglePageApplicationPtrOutput
}

ApplicationSinglePageApplicationPtrInput is an input type that accepts ApplicationSinglePageApplicationArgs, ApplicationSinglePageApplicationPtr and ApplicationSinglePageApplicationPtrOutput values. You can construct a concrete instance of `ApplicationSinglePageApplicationPtrInput` via:

        ApplicationSinglePageApplicationArgs{...}

or:

        nil

type ApplicationSinglePageApplicationPtrOutput

type ApplicationSinglePageApplicationPtrOutput struct{ *pulumi.OutputState }

func (ApplicationSinglePageApplicationPtrOutput) Elem

func (ApplicationSinglePageApplicationPtrOutput) ElementType

func (ApplicationSinglePageApplicationPtrOutput) RedirectUris

A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `https` URL.

func (ApplicationSinglePageApplicationPtrOutput) ToApplicationSinglePageApplicationPtrOutput

func (o ApplicationSinglePageApplicationPtrOutput) ToApplicationSinglePageApplicationPtrOutput() ApplicationSinglePageApplicationPtrOutput

func (ApplicationSinglePageApplicationPtrOutput) ToApplicationSinglePageApplicationPtrOutputWithContext

func (o ApplicationSinglePageApplicationPtrOutput) ToApplicationSinglePageApplicationPtrOutputWithContext(ctx context.Context) ApplicationSinglePageApplicationPtrOutput

type ApplicationState

type ApplicationState struct {
	// An `api` block as documented below, which configures API related settings for this application.
	Api ApplicationApiPtrInput
	// A mapping of app role values to app role IDs, intended to be useful when referencing app roles in other resources in your configuration.
	AppRoleIds pulumi.StringMapInput
	// A collection of `appRole` blocks as documented below. For more information see [official documentation on Application Roles](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).
	AppRoles ApplicationAppRoleTypeArrayInput
	// The Application ID (also called Client ID)
	//
	// Deprecated: The `applicationId` attribute has been replaced by the `clientId` attribute and will be removed in version 3.0 of the AzureAD provider
	ApplicationId pulumi.StringPtrInput
	// The Client ID for the application.
	ClientId pulumi.StringPtrInput
	// A description of the application, as shown to end users.
	Description pulumi.StringPtrInput
	// Specifies whether this application supports device authentication without a user. Defaults to `false`.
	DeviceOnlyAuthEnabled pulumi.BoolPtrInput
	// Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. `DisabledDueToViolationOfServicesAgreement`
	DisabledByMicrosoft pulumi.StringPtrInput
	// The display name for the application.
	DisplayName pulumi.StringPtrInput
	// Specifies whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI. Defaults to `false`.
	FallbackPublicClientEnabled pulumi.BoolPtrInput
	// A `featureTags` block as described below. Cannot be used together with the `tags` property.
	//
	// > **Features and Tags** Features are configured for an application using tags, and are provided as a shortcut to set the corresponding magic tag value for each feature. You cannot configure `featureTags` and `tags` for an application at the same time, so if you need to assign additional custom tags it's recommended to use the `tags` property instead. Tag values also propagate to any linked service principals.
	FeatureTags ApplicationFeatureTagArrayInput
	// Configures the `groups` claim issued in a user or OAuth 2.0 access token that the app expects. Possible values are `None`, `SecurityGroup`, `DirectoryRole`, `ApplicationGroup` or `All`.
	GroupMembershipClaims pulumi.StringArrayInput
	// A set of user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant.
	IdentifierUris pulumi.StringArrayInput
	// A logo image to upload for the application, as a raw base64-encoded string. The image should be in gif, jpeg or png format. Note that once an image has been uploaded, it is not possible to remove it without replacing it with another image.
	LogoImage pulumi.StringPtrInput
	// CDN URL to the application's logo, as uploaded with the `logoImage` property.
	LogoUrl pulumi.StringPtrInput
	// URL of the application's marketing page.
	MarketingUrl pulumi.StringPtrInput
	// User-specified notes relevant for the management of the application.
	Notes pulumi.StringPtrInput
	// A mapping of OAuth2.0 permission scope values to scope IDs, intended to be useful when referencing permission scopes in other resources in your configuration.
	Oauth2PermissionScopeIds pulumi.StringMapInput
	// Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. Defaults to `false`, which specifies that only GET requests are allowed.
	Oauth2PostResponseRequired pulumi.BoolPtrInput
	// The application's object ID.
	ObjectId pulumi.StringPtrInput
	// An `optionalClaims` block as documented below.
	OptionalClaims ApplicationOptionalClaimsTypePtrInput
	// A list of object IDs of principals that will be granted ownership of the application
	Owners pulumi.StringArrayInput
	// If `true`, will return an error if an existing application is found with the same name. Defaults to `false`.
	PreventDuplicateNames pulumi.BoolPtrInput
	// URL of the application's privacy statement.
	PrivacyStatementUrl pulumi.StringPtrInput
	// A `publicClient` block as documented below, which configures non-web app or non-web API application settings, for example mobile or other public clients such as an installed application running on a desktop device.
	PublicClient ApplicationPublicClientPtrInput
	// The verified publisher domain for the application.
	PublisherDomain pulumi.StringPtrInput
	// A collection of `requiredResourceAccess` blocks as documented below.
	RequiredResourceAccesses ApplicationRequiredResourceAccessArrayInput
	// References application context information from a Service or Asset Management database.
	ServiceManagementReference pulumi.StringPtrInput
	// The Microsoft account types that are supported for the current application. Must be one of `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`. Defaults to `AzureADMyOrg`.
	//
	// > **Changing `signInAudience` for existing applications** When updating an existing application to use a `signInAudience` value of `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`, your configuration may no longer be valid. Refer to [official documentation](https://docs.microsoft.com/en-gb/azure/active-directory/develop/supported-accounts-validation) to understand the differences in supported configurations. Where possible, the provider will attempt to validate your configuration and try to avoid applying unsupported settings to your application.
	SignInAudience pulumi.StringPtrInput
	// A `singlePageApplication` block as documented below, which configures single-page application (SPA) related settings for this application.
	SinglePageApplication ApplicationSinglePageApplicationPtrInput
	// URL of the application's support page.
	SupportUrl pulumi.StringPtrInput
	// A set of tags to apply to the application for configuring specific behaviours of the application and linked service principals. Note that these are not provided for use by practitioners. Cannot be used together with the `featureTags` block.
	//
	// > **Tags and Features** Azure Active Directory uses special tag values to configure the behavior of applications. These can be specified using either the `tags` property or with the `featureTags` block. If you need to set any custom tag values not supported by the `featureTags` block, it's recommended to use the `tags` property. Tag values also propagate to any linked service principals.
	Tags pulumi.StringArrayInput
	// Unique ID for a templated application in the Azure AD App Gallery, from which to create the application. Changing this forces a new resource to be created.
	//
	// > **Tip for Gallery Applications** This resource can  be used to instantiate a gallery application, however it will also attempt to manage the properties of the resulting application. If this is not desired, consider using the ApplicationRegistration resource instead.
	TemplateId pulumi.StringPtrInput
	// URL of the application's terms of service statement.
	TermsOfServiceUrl pulumi.StringPtrInput
	// A `web` block as documented below, which configures web related settings for this application.
	//
	// > **Application Name Uniqueness** Application names are not unique within Azure Active Directory. Use the `preventDuplicateNames` argument to check for existing applications if you want to avoid name collisions.
	Web ApplicationWebPtrInput
}

func (ApplicationState) ElementType

func (ApplicationState) ElementType() reflect.Type

type ApplicationWeb

type ApplicationWeb struct {
	// Home page or landing page of the application.
	HomepageUrl *string `pulumi:"homepageUrl"`
	// An `implicitGrant` block as documented above.
	ImplicitGrant *ApplicationWebImplicitGrant `pulumi:"implicitGrant"`
	// The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
	LogoutUrl *string `pulumi:"logoutUrl"`
	// A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `http` URL or a URN.
	RedirectUris []string `pulumi:"redirectUris"`
}

type ApplicationWebArgs

type ApplicationWebArgs struct {
	// Home page or landing page of the application.
	HomepageUrl pulumi.StringPtrInput `pulumi:"homepageUrl"`
	// An `implicitGrant` block as documented above.
	ImplicitGrant ApplicationWebImplicitGrantPtrInput `pulumi:"implicitGrant"`
	// The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
	LogoutUrl pulumi.StringPtrInput `pulumi:"logoutUrl"`
	// A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `http` URL or a URN.
	RedirectUris pulumi.StringArrayInput `pulumi:"redirectUris"`
}

func (ApplicationWebArgs) ElementType

func (ApplicationWebArgs) ElementType() reflect.Type

func (ApplicationWebArgs) ToApplicationWebOutput

func (i ApplicationWebArgs) ToApplicationWebOutput() ApplicationWebOutput

func (ApplicationWebArgs) ToApplicationWebOutputWithContext

func (i ApplicationWebArgs) ToApplicationWebOutputWithContext(ctx context.Context) ApplicationWebOutput

func (ApplicationWebArgs) ToApplicationWebPtrOutput

func (i ApplicationWebArgs) ToApplicationWebPtrOutput() ApplicationWebPtrOutput

func (ApplicationWebArgs) ToApplicationWebPtrOutputWithContext

func (i ApplicationWebArgs) ToApplicationWebPtrOutputWithContext(ctx context.Context) ApplicationWebPtrOutput

type ApplicationWebImplicitGrant

type ApplicationWebImplicitGrant struct {
	// Whether this web application can request an access token using OAuth 2.0 implicit flow.
	AccessTokenIssuanceEnabled *bool `pulumi:"accessTokenIssuanceEnabled"`
	// Whether this web application can request an ID token using OAuth 2.0 implicit flow.
	IdTokenIssuanceEnabled *bool `pulumi:"idTokenIssuanceEnabled"`
}

type ApplicationWebImplicitGrantArgs

type ApplicationWebImplicitGrantArgs struct {
	// Whether this web application can request an access token using OAuth 2.0 implicit flow.
	AccessTokenIssuanceEnabled pulumi.BoolPtrInput `pulumi:"accessTokenIssuanceEnabled"`
	// Whether this web application can request an ID token using OAuth 2.0 implicit flow.
	IdTokenIssuanceEnabled pulumi.BoolPtrInput `pulumi:"idTokenIssuanceEnabled"`
}

func (ApplicationWebImplicitGrantArgs) ElementType

func (ApplicationWebImplicitGrantArgs) ToApplicationWebImplicitGrantOutput

func (i ApplicationWebImplicitGrantArgs) ToApplicationWebImplicitGrantOutput() ApplicationWebImplicitGrantOutput

func (ApplicationWebImplicitGrantArgs) ToApplicationWebImplicitGrantOutputWithContext

func (i ApplicationWebImplicitGrantArgs) ToApplicationWebImplicitGrantOutputWithContext(ctx context.Context) ApplicationWebImplicitGrantOutput

func (ApplicationWebImplicitGrantArgs) ToApplicationWebImplicitGrantPtrOutput

func (i ApplicationWebImplicitGrantArgs) ToApplicationWebImplicitGrantPtrOutput() ApplicationWebImplicitGrantPtrOutput

func (ApplicationWebImplicitGrantArgs) ToApplicationWebImplicitGrantPtrOutputWithContext

func (i ApplicationWebImplicitGrantArgs) ToApplicationWebImplicitGrantPtrOutputWithContext(ctx context.Context) ApplicationWebImplicitGrantPtrOutput

type ApplicationWebImplicitGrantInput

type ApplicationWebImplicitGrantInput interface {
	pulumi.Input

	ToApplicationWebImplicitGrantOutput() ApplicationWebImplicitGrantOutput
	ToApplicationWebImplicitGrantOutputWithContext(context.Context) ApplicationWebImplicitGrantOutput
}

ApplicationWebImplicitGrantInput is an input type that accepts ApplicationWebImplicitGrantArgs and ApplicationWebImplicitGrantOutput values. You can construct a concrete instance of `ApplicationWebImplicitGrantInput` via:

ApplicationWebImplicitGrantArgs{...}

type ApplicationWebImplicitGrantOutput

type ApplicationWebImplicitGrantOutput struct{ *pulumi.OutputState }

func (ApplicationWebImplicitGrantOutput) AccessTokenIssuanceEnabled

func (o ApplicationWebImplicitGrantOutput) AccessTokenIssuanceEnabled() pulumi.BoolPtrOutput

Whether this web application can request an access token using OAuth 2.0 implicit flow.

func (ApplicationWebImplicitGrantOutput) ElementType

func (ApplicationWebImplicitGrantOutput) IdTokenIssuanceEnabled

func (o ApplicationWebImplicitGrantOutput) IdTokenIssuanceEnabled() pulumi.BoolPtrOutput

Whether this web application can request an ID token using OAuth 2.0 implicit flow.

func (ApplicationWebImplicitGrantOutput) ToApplicationWebImplicitGrantOutput

func (o ApplicationWebImplicitGrantOutput) ToApplicationWebImplicitGrantOutput() ApplicationWebImplicitGrantOutput

func (ApplicationWebImplicitGrantOutput) ToApplicationWebImplicitGrantOutputWithContext

func (o ApplicationWebImplicitGrantOutput) ToApplicationWebImplicitGrantOutputWithContext(ctx context.Context) ApplicationWebImplicitGrantOutput

func (ApplicationWebImplicitGrantOutput) ToApplicationWebImplicitGrantPtrOutput

func (o ApplicationWebImplicitGrantOutput) ToApplicationWebImplicitGrantPtrOutput() ApplicationWebImplicitGrantPtrOutput

func (ApplicationWebImplicitGrantOutput) ToApplicationWebImplicitGrantPtrOutputWithContext

func (o ApplicationWebImplicitGrantOutput) ToApplicationWebImplicitGrantPtrOutputWithContext(ctx context.Context) ApplicationWebImplicitGrantPtrOutput

type ApplicationWebImplicitGrantPtrInput

type ApplicationWebImplicitGrantPtrInput interface {
	pulumi.Input

	ToApplicationWebImplicitGrantPtrOutput() ApplicationWebImplicitGrantPtrOutput
	ToApplicationWebImplicitGrantPtrOutputWithContext(context.Context) ApplicationWebImplicitGrantPtrOutput
}

ApplicationWebImplicitGrantPtrInput is an input type that accepts ApplicationWebImplicitGrantArgs, ApplicationWebImplicitGrantPtr and ApplicationWebImplicitGrantPtrOutput values. You can construct a concrete instance of `ApplicationWebImplicitGrantPtrInput` via:

        ApplicationWebImplicitGrantArgs{...}

or:

        nil

type ApplicationWebImplicitGrantPtrOutput

type ApplicationWebImplicitGrantPtrOutput struct{ *pulumi.OutputState }

func (ApplicationWebImplicitGrantPtrOutput) AccessTokenIssuanceEnabled

func (o ApplicationWebImplicitGrantPtrOutput) AccessTokenIssuanceEnabled() pulumi.BoolPtrOutput

Whether this web application can request an access token using OAuth 2.0 implicit flow.

func (ApplicationWebImplicitGrantPtrOutput) Elem

func (ApplicationWebImplicitGrantPtrOutput) ElementType

func (ApplicationWebImplicitGrantPtrOutput) IdTokenIssuanceEnabled

func (o ApplicationWebImplicitGrantPtrOutput) IdTokenIssuanceEnabled() pulumi.BoolPtrOutput

Whether this web application can request an ID token using OAuth 2.0 implicit flow.

func (ApplicationWebImplicitGrantPtrOutput) ToApplicationWebImplicitGrantPtrOutput

func (o ApplicationWebImplicitGrantPtrOutput) ToApplicationWebImplicitGrantPtrOutput() ApplicationWebImplicitGrantPtrOutput

func (ApplicationWebImplicitGrantPtrOutput) ToApplicationWebImplicitGrantPtrOutputWithContext

func (o ApplicationWebImplicitGrantPtrOutput) ToApplicationWebImplicitGrantPtrOutputWithContext(ctx context.Context) ApplicationWebImplicitGrantPtrOutput

type ApplicationWebInput

type ApplicationWebInput interface {
	pulumi.Input

	ToApplicationWebOutput() ApplicationWebOutput
	ToApplicationWebOutputWithContext(context.Context) ApplicationWebOutput
}

ApplicationWebInput is an input type that accepts ApplicationWebArgs and ApplicationWebOutput values. You can construct a concrete instance of `ApplicationWebInput` via:

ApplicationWebArgs{...}

type ApplicationWebOutput

type ApplicationWebOutput struct{ *pulumi.OutputState }

func (ApplicationWebOutput) ElementType

func (ApplicationWebOutput) ElementType() reflect.Type

func (ApplicationWebOutput) HomepageUrl

Home page or landing page of the application.

func (ApplicationWebOutput) ImplicitGrant

An `implicitGrant` block as documented above.

func (ApplicationWebOutput) LogoutUrl

The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.

func (ApplicationWebOutput) RedirectUris

A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `http` URL or a URN.

func (ApplicationWebOutput) ToApplicationWebOutput

func (o ApplicationWebOutput) ToApplicationWebOutput() ApplicationWebOutput

func (ApplicationWebOutput) ToApplicationWebOutputWithContext

func (o ApplicationWebOutput) ToApplicationWebOutputWithContext(ctx context.Context) ApplicationWebOutput

func (ApplicationWebOutput) ToApplicationWebPtrOutput

func (o ApplicationWebOutput) ToApplicationWebPtrOutput() ApplicationWebPtrOutput

func (ApplicationWebOutput) ToApplicationWebPtrOutputWithContext

func (o ApplicationWebOutput) ToApplicationWebPtrOutputWithContext(ctx context.Context) ApplicationWebPtrOutput

type ApplicationWebPtrInput

type ApplicationWebPtrInput interface {
	pulumi.Input

	ToApplicationWebPtrOutput() ApplicationWebPtrOutput
	ToApplicationWebPtrOutputWithContext(context.Context) ApplicationWebPtrOutput
}

ApplicationWebPtrInput is an input type that accepts ApplicationWebArgs, ApplicationWebPtr and ApplicationWebPtrOutput values. You can construct a concrete instance of `ApplicationWebPtrInput` via:

        ApplicationWebArgs{...}

or:

        nil

type ApplicationWebPtrOutput

type ApplicationWebPtrOutput struct{ *pulumi.OutputState }

func (ApplicationWebPtrOutput) Elem

func (ApplicationWebPtrOutput) ElementType

func (ApplicationWebPtrOutput) ElementType() reflect.Type

func (ApplicationWebPtrOutput) HomepageUrl

Home page or landing page of the application.

func (ApplicationWebPtrOutput) ImplicitGrant

An `implicitGrant` block as documented above.

func (ApplicationWebPtrOutput) LogoutUrl

The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.

func (ApplicationWebPtrOutput) RedirectUris

A set of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Must be a valid `http` URL or a URN.

func (ApplicationWebPtrOutput) ToApplicationWebPtrOutput

func (o ApplicationWebPtrOutput) ToApplicationWebPtrOutput() ApplicationWebPtrOutput

func (ApplicationWebPtrOutput) ToApplicationWebPtrOutputWithContext

func (o ApplicationWebPtrOutput) ToApplicationWebPtrOutputWithContext(ctx context.Context) ApplicationWebPtrOutput

type AuthenticationStrengthPolicy added in v5.43.0

type AuthenticationStrengthPolicy struct {
	pulumi.CustomResourceState

	// List of allowed authentication methods for this authentication strength policy.
	AllowedCombinations pulumi.StringArrayOutput `pulumi:"allowedCombinations"`
	// The description for this authentication strength policy.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The friendly name for this authentication strength policy.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
}

Manages a Authentication Strength Policy within 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 roles: `Policy.ReadWrite.ConditionalAccess` and `Policy.Read.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Conditional Access Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.NewAuthenticationStrengthPolicy(ctx, "example", &azuread.AuthenticationStrengthPolicyArgs{
			DisplayName: pulumi.String("Example Authentication Strength Policy"),
			Description: pulumi.String("Policy for demo purposes"),
			AllowedCombinations: pulumi.StringArray{
				pulumi.String("fido2"),
				pulumi.String("password"),
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewAuthenticationStrengthPolicy(ctx, "example2", &azuread.AuthenticationStrengthPolicyArgs{
			DisplayName: pulumi.String("Example Authentication Strength Policy"),
			Description: pulumi.String("Policy for demo purposes with all possible combinations"),
			AllowedCombinations: pulumi.StringArray{
				pulumi.String("fido2"),
				pulumi.String("password"),
				pulumi.String("deviceBasedPush"),
				pulumi.String("temporaryAccessPassOneTime"),
				pulumi.String("federatedMultiFactor"),
				pulumi.String("federatedSingleFactor"),
				pulumi.String("hardwareOath,federatedSingleFactor"),
				pulumi.String("microsoftAuthenticatorPush,federatedSingleFactor"),
				pulumi.String("password,hardwareOath"),
				pulumi.String("password,microsoftAuthenticatorPush"),
				pulumi.String("password,sms"),
				pulumi.String("password,softwareOath"),
				pulumi.String("password,voice"),
				pulumi.String("sms"),
				pulumi.String("sms,federatedSingleFactor"),
				pulumi.String("softwareOath,federatedSingleFactor"),
				pulumi.String("temporaryAccessPassMultiUse"),
				pulumi.String("voice,federatedSingleFactor"),
				pulumi.String("windowsHelloForBusiness"),
				pulumi.String("x509CertificateMultiFactor"),
				pulumi.String("x509CertificateSingleFactor"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Authentication Strength Policies can be imported using the `id`, e.g.

```sh $ pulumi import azuread:index/authenticationStrengthPolicy:AuthenticationStrengthPolicy my_policy 00000000-0000-0000-0000-000000000000 ```

func GetAuthenticationStrengthPolicy added in v5.43.0

func GetAuthenticationStrengthPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AuthenticationStrengthPolicyState, opts ...pulumi.ResourceOption) (*AuthenticationStrengthPolicy, error)

GetAuthenticationStrengthPolicy gets an existing AuthenticationStrengthPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAuthenticationStrengthPolicy added in v5.43.0

func NewAuthenticationStrengthPolicy(ctx *pulumi.Context,
	name string, args *AuthenticationStrengthPolicyArgs, opts ...pulumi.ResourceOption) (*AuthenticationStrengthPolicy, error)

NewAuthenticationStrengthPolicy registers a new resource with the given unique name, arguments, and options.

func (*AuthenticationStrengthPolicy) ElementType added in v5.43.0

func (*AuthenticationStrengthPolicy) ElementType() reflect.Type

func (*AuthenticationStrengthPolicy) ToAuthenticationStrengthPolicyOutput added in v5.43.0

func (i *AuthenticationStrengthPolicy) ToAuthenticationStrengthPolicyOutput() AuthenticationStrengthPolicyOutput

func (*AuthenticationStrengthPolicy) ToAuthenticationStrengthPolicyOutputWithContext added in v5.43.0

func (i *AuthenticationStrengthPolicy) ToAuthenticationStrengthPolicyOutputWithContext(ctx context.Context) AuthenticationStrengthPolicyOutput

type AuthenticationStrengthPolicyArgs added in v5.43.0

type AuthenticationStrengthPolicyArgs struct {
	// List of allowed authentication methods for this authentication strength policy.
	AllowedCombinations pulumi.StringArrayInput
	// The description for this authentication strength policy.
	Description pulumi.StringPtrInput
	// The friendly name for this authentication strength policy.
	DisplayName pulumi.StringInput
}

The set of arguments for constructing a AuthenticationStrengthPolicy resource.

func (AuthenticationStrengthPolicyArgs) ElementType added in v5.43.0

type AuthenticationStrengthPolicyArray added in v5.43.0

type AuthenticationStrengthPolicyArray []AuthenticationStrengthPolicyInput

func (AuthenticationStrengthPolicyArray) ElementType added in v5.43.0

func (AuthenticationStrengthPolicyArray) ToAuthenticationStrengthPolicyArrayOutput added in v5.43.0

func (i AuthenticationStrengthPolicyArray) ToAuthenticationStrengthPolicyArrayOutput() AuthenticationStrengthPolicyArrayOutput

func (AuthenticationStrengthPolicyArray) ToAuthenticationStrengthPolicyArrayOutputWithContext added in v5.43.0

func (i AuthenticationStrengthPolicyArray) ToAuthenticationStrengthPolicyArrayOutputWithContext(ctx context.Context) AuthenticationStrengthPolicyArrayOutput

type AuthenticationStrengthPolicyArrayInput added in v5.43.0

type AuthenticationStrengthPolicyArrayInput interface {
	pulumi.Input

	ToAuthenticationStrengthPolicyArrayOutput() AuthenticationStrengthPolicyArrayOutput
	ToAuthenticationStrengthPolicyArrayOutputWithContext(context.Context) AuthenticationStrengthPolicyArrayOutput
}

AuthenticationStrengthPolicyArrayInput is an input type that accepts AuthenticationStrengthPolicyArray and AuthenticationStrengthPolicyArrayOutput values. You can construct a concrete instance of `AuthenticationStrengthPolicyArrayInput` via:

AuthenticationStrengthPolicyArray{ AuthenticationStrengthPolicyArgs{...} }

type AuthenticationStrengthPolicyArrayOutput added in v5.43.0

type AuthenticationStrengthPolicyArrayOutput struct{ *pulumi.OutputState }

func (AuthenticationStrengthPolicyArrayOutput) ElementType added in v5.43.0

func (AuthenticationStrengthPolicyArrayOutput) Index added in v5.43.0

func (AuthenticationStrengthPolicyArrayOutput) ToAuthenticationStrengthPolicyArrayOutput added in v5.43.0

func (o AuthenticationStrengthPolicyArrayOutput) ToAuthenticationStrengthPolicyArrayOutput() AuthenticationStrengthPolicyArrayOutput

func (AuthenticationStrengthPolicyArrayOutput) ToAuthenticationStrengthPolicyArrayOutputWithContext added in v5.43.0

func (o AuthenticationStrengthPolicyArrayOutput) ToAuthenticationStrengthPolicyArrayOutputWithContext(ctx context.Context) AuthenticationStrengthPolicyArrayOutput

type AuthenticationStrengthPolicyInput added in v5.43.0

type AuthenticationStrengthPolicyInput interface {
	pulumi.Input

	ToAuthenticationStrengthPolicyOutput() AuthenticationStrengthPolicyOutput
	ToAuthenticationStrengthPolicyOutputWithContext(ctx context.Context) AuthenticationStrengthPolicyOutput
}

type AuthenticationStrengthPolicyMap added in v5.43.0

type AuthenticationStrengthPolicyMap map[string]AuthenticationStrengthPolicyInput

func (AuthenticationStrengthPolicyMap) ElementType added in v5.43.0

func (AuthenticationStrengthPolicyMap) ToAuthenticationStrengthPolicyMapOutput added in v5.43.0

func (i AuthenticationStrengthPolicyMap) ToAuthenticationStrengthPolicyMapOutput() AuthenticationStrengthPolicyMapOutput

func (AuthenticationStrengthPolicyMap) ToAuthenticationStrengthPolicyMapOutputWithContext added in v5.43.0

func (i AuthenticationStrengthPolicyMap) ToAuthenticationStrengthPolicyMapOutputWithContext(ctx context.Context) AuthenticationStrengthPolicyMapOutput

type AuthenticationStrengthPolicyMapInput added in v5.43.0

type AuthenticationStrengthPolicyMapInput interface {
	pulumi.Input

	ToAuthenticationStrengthPolicyMapOutput() AuthenticationStrengthPolicyMapOutput
	ToAuthenticationStrengthPolicyMapOutputWithContext(context.Context) AuthenticationStrengthPolicyMapOutput
}

AuthenticationStrengthPolicyMapInput is an input type that accepts AuthenticationStrengthPolicyMap and AuthenticationStrengthPolicyMapOutput values. You can construct a concrete instance of `AuthenticationStrengthPolicyMapInput` via:

AuthenticationStrengthPolicyMap{ "key": AuthenticationStrengthPolicyArgs{...} }

type AuthenticationStrengthPolicyMapOutput added in v5.43.0

type AuthenticationStrengthPolicyMapOutput struct{ *pulumi.OutputState }

func (AuthenticationStrengthPolicyMapOutput) ElementType added in v5.43.0

func (AuthenticationStrengthPolicyMapOutput) MapIndex added in v5.43.0

func (AuthenticationStrengthPolicyMapOutput) ToAuthenticationStrengthPolicyMapOutput added in v5.43.0

func (o AuthenticationStrengthPolicyMapOutput) ToAuthenticationStrengthPolicyMapOutput() AuthenticationStrengthPolicyMapOutput

func (AuthenticationStrengthPolicyMapOutput) ToAuthenticationStrengthPolicyMapOutputWithContext added in v5.43.0

func (o AuthenticationStrengthPolicyMapOutput) ToAuthenticationStrengthPolicyMapOutputWithContext(ctx context.Context) AuthenticationStrengthPolicyMapOutput

type AuthenticationStrengthPolicyOutput added in v5.43.0

type AuthenticationStrengthPolicyOutput struct{ *pulumi.OutputState }

func (AuthenticationStrengthPolicyOutput) AllowedCombinations added in v5.43.0

List of allowed authentication methods for this authentication strength policy.

func (AuthenticationStrengthPolicyOutput) Description added in v5.43.0

The description for this authentication strength policy.

func (AuthenticationStrengthPolicyOutput) DisplayName added in v5.43.0

The friendly name for this authentication strength policy.

func (AuthenticationStrengthPolicyOutput) ElementType added in v5.43.0

func (AuthenticationStrengthPolicyOutput) ToAuthenticationStrengthPolicyOutput added in v5.43.0

func (o AuthenticationStrengthPolicyOutput) ToAuthenticationStrengthPolicyOutput() AuthenticationStrengthPolicyOutput

func (AuthenticationStrengthPolicyOutput) ToAuthenticationStrengthPolicyOutputWithContext added in v5.43.0

func (o AuthenticationStrengthPolicyOutput) ToAuthenticationStrengthPolicyOutputWithContext(ctx context.Context) AuthenticationStrengthPolicyOutput

type AuthenticationStrengthPolicyState added in v5.43.0

type AuthenticationStrengthPolicyState struct {
	// List of allowed authentication methods for this authentication strength policy.
	AllowedCombinations pulumi.StringArrayInput
	// The description for this authentication strength policy.
	Description pulumi.StringPtrInput
	// The friendly name for this authentication strength policy.
	DisplayName pulumi.StringPtrInput
}

func (AuthenticationStrengthPolicyState) ElementType added in v5.43.0

type ClaimsMappingPolicy added in v5.19.0

type ClaimsMappingPolicy struct {
	pulumi.CustomResourceState

	// The claims mapping policy. This is a JSON formatted string, for which the `jsonencode()` function can be used.
	Definitions pulumi.StringArrayOutput `pulumi:"definitions"`
	// The display name for this Claims Mapping Policy.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
}

Manages a Claims Mapping Policy within 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 roles: `Policy.ReadWrite.ApplicationConfiguration` and `Policy.Read.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Application Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import (

"encoding/json"

"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 {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"claimsMappingPolicy": map[string]interface{}{
				"claimsSchema": []map[string]interface{}{
					map[string]interface{}{
						"ID":            "employeeid",
						"jwtClaimType":  "name",
						"samlClaimType": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name",
						"source":        "user",
					},
					map[string]interface{}{
						"ID":            "tenantcountry",
						"jwtClaimType":  "country",
						"samlClaimType": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country",
						"source":        "company",
					},
				},
				"includeBasicClaimSet": "true",
				"version":              1,
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = azuread.NewClaimsMappingPolicy(ctx, "my_policy", &azuread.ClaimsMappingPolicyArgs{
			Definitions: pulumi.StringArray{
				pulumi.String(json0),
			},
			DisplayName: pulumi.String("My Policy"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Claims Mapping Policy can be imported using the `id`, e.g.

```sh $ pulumi import azuread:index/claimsMappingPolicy:ClaimsMappingPolicy my_policy 00000000-0000-0000-0000-000000000000 ```

func GetClaimsMappingPolicy added in v5.19.0

func GetClaimsMappingPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ClaimsMappingPolicyState, opts ...pulumi.ResourceOption) (*ClaimsMappingPolicy, error)

GetClaimsMappingPolicy gets an existing ClaimsMappingPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClaimsMappingPolicy added in v5.19.0

func NewClaimsMappingPolicy(ctx *pulumi.Context,
	name string, args *ClaimsMappingPolicyArgs, opts ...pulumi.ResourceOption) (*ClaimsMappingPolicy, error)

NewClaimsMappingPolicy registers a new resource with the given unique name, arguments, and options.

func (*ClaimsMappingPolicy) ElementType added in v5.19.0

func (*ClaimsMappingPolicy) ElementType() reflect.Type

func (*ClaimsMappingPolicy) ToClaimsMappingPolicyOutput added in v5.19.0

func (i *ClaimsMappingPolicy) ToClaimsMappingPolicyOutput() ClaimsMappingPolicyOutput

func (*ClaimsMappingPolicy) ToClaimsMappingPolicyOutputWithContext added in v5.19.0

func (i *ClaimsMappingPolicy) ToClaimsMappingPolicyOutputWithContext(ctx context.Context) ClaimsMappingPolicyOutput

type ClaimsMappingPolicyArgs added in v5.19.0

type ClaimsMappingPolicyArgs struct {
	// The claims mapping policy. This is a JSON formatted string, for which the `jsonencode()` function can be used.
	Definitions pulumi.StringArrayInput
	// The display name for this Claims Mapping Policy.
	DisplayName pulumi.StringInput
}

The set of arguments for constructing a ClaimsMappingPolicy resource.

func (ClaimsMappingPolicyArgs) ElementType added in v5.19.0

func (ClaimsMappingPolicyArgs) ElementType() reflect.Type

type ClaimsMappingPolicyArray added in v5.19.0

type ClaimsMappingPolicyArray []ClaimsMappingPolicyInput

func (ClaimsMappingPolicyArray) ElementType added in v5.19.0

func (ClaimsMappingPolicyArray) ElementType() reflect.Type

func (ClaimsMappingPolicyArray) ToClaimsMappingPolicyArrayOutput added in v5.19.0

func (i ClaimsMappingPolicyArray) ToClaimsMappingPolicyArrayOutput() ClaimsMappingPolicyArrayOutput

func (ClaimsMappingPolicyArray) ToClaimsMappingPolicyArrayOutputWithContext added in v5.19.0

func (i ClaimsMappingPolicyArray) ToClaimsMappingPolicyArrayOutputWithContext(ctx context.Context) ClaimsMappingPolicyArrayOutput

type ClaimsMappingPolicyArrayInput added in v5.19.0

type ClaimsMappingPolicyArrayInput interface {
	pulumi.Input

	ToClaimsMappingPolicyArrayOutput() ClaimsMappingPolicyArrayOutput
	ToClaimsMappingPolicyArrayOutputWithContext(context.Context) ClaimsMappingPolicyArrayOutput
}

ClaimsMappingPolicyArrayInput is an input type that accepts ClaimsMappingPolicyArray and ClaimsMappingPolicyArrayOutput values. You can construct a concrete instance of `ClaimsMappingPolicyArrayInput` via:

ClaimsMappingPolicyArray{ ClaimsMappingPolicyArgs{...} }

type ClaimsMappingPolicyArrayOutput added in v5.19.0

type ClaimsMappingPolicyArrayOutput struct{ *pulumi.OutputState }

func (ClaimsMappingPolicyArrayOutput) ElementType added in v5.19.0

func (ClaimsMappingPolicyArrayOutput) Index added in v5.19.0

func (ClaimsMappingPolicyArrayOutput) ToClaimsMappingPolicyArrayOutput added in v5.19.0

func (o ClaimsMappingPolicyArrayOutput) ToClaimsMappingPolicyArrayOutput() ClaimsMappingPolicyArrayOutput

func (ClaimsMappingPolicyArrayOutput) ToClaimsMappingPolicyArrayOutputWithContext added in v5.19.0

func (o ClaimsMappingPolicyArrayOutput) ToClaimsMappingPolicyArrayOutputWithContext(ctx context.Context) ClaimsMappingPolicyArrayOutput

type ClaimsMappingPolicyInput added in v5.19.0

type ClaimsMappingPolicyInput interface {
	pulumi.Input

	ToClaimsMappingPolicyOutput() ClaimsMappingPolicyOutput
	ToClaimsMappingPolicyOutputWithContext(ctx context.Context) ClaimsMappingPolicyOutput
}

type ClaimsMappingPolicyMap added in v5.19.0

type ClaimsMappingPolicyMap map[string]ClaimsMappingPolicyInput

func (ClaimsMappingPolicyMap) ElementType added in v5.19.0

func (ClaimsMappingPolicyMap) ElementType() reflect.Type

func (ClaimsMappingPolicyMap) ToClaimsMappingPolicyMapOutput added in v5.19.0

func (i ClaimsMappingPolicyMap) ToClaimsMappingPolicyMapOutput() ClaimsMappingPolicyMapOutput

func (ClaimsMappingPolicyMap) ToClaimsMappingPolicyMapOutputWithContext added in v5.19.0

func (i ClaimsMappingPolicyMap) ToClaimsMappingPolicyMapOutputWithContext(ctx context.Context) ClaimsMappingPolicyMapOutput

type ClaimsMappingPolicyMapInput added in v5.19.0

type ClaimsMappingPolicyMapInput interface {
	pulumi.Input

	ToClaimsMappingPolicyMapOutput() ClaimsMappingPolicyMapOutput
	ToClaimsMappingPolicyMapOutputWithContext(context.Context) ClaimsMappingPolicyMapOutput
}

ClaimsMappingPolicyMapInput is an input type that accepts ClaimsMappingPolicyMap and ClaimsMappingPolicyMapOutput values. You can construct a concrete instance of `ClaimsMappingPolicyMapInput` via:

ClaimsMappingPolicyMap{ "key": ClaimsMappingPolicyArgs{...} }

type ClaimsMappingPolicyMapOutput added in v5.19.0

type ClaimsMappingPolicyMapOutput struct{ *pulumi.OutputState }

func (ClaimsMappingPolicyMapOutput) ElementType added in v5.19.0

func (ClaimsMappingPolicyMapOutput) MapIndex added in v5.19.0

func (ClaimsMappingPolicyMapOutput) ToClaimsMappingPolicyMapOutput added in v5.19.0

func (o ClaimsMappingPolicyMapOutput) ToClaimsMappingPolicyMapOutput() ClaimsMappingPolicyMapOutput

func (ClaimsMappingPolicyMapOutput) ToClaimsMappingPolicyMapOutputWithContext added in v5.19.0

func (o ClaimsMappingPolicyMapOutput) ToClaimsMappingPolicyMapOutputWithContext(ctx context.Context) ClaimsMappingPolicyMapOutput

type ClaimsMappingPolicyOutput added in v5.19.0

type ClaimsMappingPolicyOutput struct{ *pulumi.OutputState }

func (ClaimsMappingPolicyOutput) Definitions added in v5.22.0

The claims mapping policy. This is a JSON formatted string, for which the `jsonencode()` function can be used.

func (ClaimsMappingPolicyOutput) DisplayName added in v5.22.0

The display name for this Claims Mapping Policy.

func (ClaimsMappingPolicyOutput) ElementType added in v5.19.0

func (ClaimsMappingPolicyOutput) ElementType() reflect.Type

func (ClaimsMappingPolicyOutput) ToClaimsMappingPolicyOutput added in v5.19.0

func (o ClaimsMappingPolicyOutput) ToClaimsMappingPolicyOutput() ClaimsMappingPolicyOutput

func (ClaimsMappingPolicyOutput) ToClaimsMappingPolicyOutputWithContext added in v5.19.0

func (o ClaimsMappingPolicyOutput) ToClaimsMappingPolicyOutputWithContext(ctx context.Context) ClaimsMappingPolicyOutput

type ClaimsMappingPolicyState added in v5.19.0

type ClaimsMappingPolicyState struct {
	// The claims mapping policy. This is a JSON formatted string, for which the `jsonencode()` function can be used.
	Definitions pulumi.StringArrayInput
	// The display name for this Claims Mapping Policy.
	DisplayName pulumi.StringPtrInput
}

func (ClaimsMappingPolicyState) ElementType added in v5.19.0

func (ClaimsMappingPolicyState) ElementType() reflect.Type

type ConditionalAccessPolicy added in v5.2.0

type ConditionalAccessPolicy struct {
	pulumi.CustomResourceState

	// A `conditions` block as documented below, which specifies the rules that must be met for the policy to apply.
	Conditions ConditionalAccessPolicyConditionsOutput `pulumi:"conditions"`
	// The friendly name for this Conditional Access Policy.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// A `grantControls` block as documented below, which specifies the grant controls that must be fulfilled to pass the policy.
	GrantControls ConditionalAccessPolicyGrantControlsPtrOutput `pulumi:"grantControls"`
	// A `sessionControls` block as documented below, which specifies the session controls that are enforced after sign-in.
	//
	// > Note: At least one of `grantControls` and/or `sessionControls` blocks must be specified.
	SessionControls ConditionalAccessPolicySessionControlsPtrOutput `pulumi:"sessionControls"`
	// Specifies the state of the policy object. Possible values are: `enabled`, `disabled` and `enabledForReportingButNotEnforced`
	State pulumi.StringOutput `pulumi:"state"`
}

Manages a Conditional Access Policy within Azure Active Directory.

> **Licensing Requirements** Specifying `clientApplications` property requires the activation of Microsoft Entra on your tenant and the availability of sufficient Workload Identities Premium licences (one per service principal managed by a conditional access).

## 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 roles: `Policy.ReadWrite.ConditionalAccess` and `Policy.Read.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Conditional Access Administrator` or `Global Administrator`

## Example Usage

### All users except guests or external users

<!--Start PulumiCodeChooser --> ```go 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.NewConditionalAccessPolicy(ctx, "example", &azuread.ConditionalAccessPolicyArgs{
			DisplayName: pulumi.String("example policy"),
			State:       pulumi.String("disabled"),
			Conditions: &azuread.ConditionalAccessPolicyConditionsArgs{
				ClientAppTypes: pulumi.StringArray{
					pulumi.String("all"),
				},
				SignInRiskLevels: pulumi.StringArray{
					pulumi.String("medium"),
				},
				UserRiskLevels: pulumi.StringArray{
					pulumi.String("medium"),
				},
				Applications: &azuread.ConditionalAccessPolicyConditionsApplicationsArgs{
					IncludedApplications: pulumi.StringArray{
						pulumi.String("All"),
					},
					ExcludedApplications: pulumi.StringArray{},
				},
				Devices: &azuread.ConditionalAccessPolicyConditionsDevicesArgs{
					Filter: &azuread.ConditionalAccessPolicyConditionsDevicesFilterArgs{
						Mode: pulumi.String("exclude"),
						Rule: pulumi.String("device.operatingSystem eq \"Doors\""),
					},
				},
				Locations: &azuread.ConditionalAccessPolicyConditionsLocationsArgs{
					IncludedLocations: pulumi.StringArray{
						pulumi.String("All"),
					},
					ExcludedLocations: pulumi.StringArray{
						pulumi.String("AllTrusted"),
					},
				},
				Platforms: &azuread.ConditionalAccessPolicyConditionsPlatformsArgs{
					IncludedPlatforms: pulumi.StringArray{
						pulumi.String("android"),
					},
					ExcludedPlatforms: pulumi.StringArray{
						pulumi.String("iOS"),
					},
				},
				Users: &azuread.ConditionalAccessPolicyConditionsUsersArgs{
					IncludedUsers: pulumi.StringArray{
						pulumi.String("All"),
					},
					ExcludedUsers: pulumi.StringArray{
						pulumi.String("GuestsOrExternalUsers"),
					},
				},
			},
			GrantControls: &azuread.ConditionalAccessPolicyGrantControlsArgs{
				Operator: pulumi.String("OR"),
				BuiltInControls: pulumi.StringArray{
					pulumi.String("mfa"),
				},
			},
			SessionControls: &azuread.ConditionalAccessPolicySessionControlsArgs{
				ApplicationEnforcedRestrictionsEnabled: pulumi.Bool(true),
				DisableResilienceDefaults:              pulumi.Bool(false),
				SignInFrequency:                        pulumi.Int(10),
				SignInFrequencyPeriod:                  pulumi.String("hours"),
				CloudAppSecurityPolicy:                 pulumi.String("monitorOnly"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

### Included client applications / service principals

<!--Start PulumiCodeChooser --> ```go 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 {
		current, err := azuread.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = azuread.NewConditionalAccessPolicy(ctx, "example", &azuread.ConditionalAccessPolicyArgs{
			DisplayName: pulumi.String("example policy"),
			State:       pulumi.String("disabled"),
			Conditions: &azuread.ConditionalAccessPolicyConditionsArgs{
				ClientAppTypes: pulumi.StringArray{
					pulumi.String("all"),
				},
				Applications: &azuread.ConditionalAccessPolicyConditionsApplicationsArgs{
					IncludedApplications: pulumi.StringArray{
						pulumi.String("All"),
					},
				},
				ClientApplications: &azuread.ConditionalAccessPolicyConditionsClientApplicationsArgs{
					IncludedServicePrincipals: pulumi.StringArray{
						pulumi.String(current.ObjectId),
					},
					ExcludedServicePrincipals: pulumi.StringArray{},
				},
				Users: &azuread.ConditionalAccessPolicyConditionsUsersArgs{
					IncludedUsers: pulumi.StringArray{
						pulumi.String("None"),
					},
				},
			},
			GrantControls: &azuread.ConditionalAccessPolicyGrantControlsArgs{
				Operator: pulumi.String("OR"),
				BuiltInControls: pulumi.StringArray{
					pulumi.String("block"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

### Excluded client applications / service principals

<!--Start PulumiCodeChooser --> ```go 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 {
		current, err := azuread.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = azuread.NewConditionalAccessPolicy(ctx, "example", &azuread.ConditionalAccessPolicyArgs{
			DisplayName: pulumi.String("example policy"),
			State:       pulumi.String("disabled"),
			Conditions: &azuread.ConditionalAccessPolicyConditionsArgs{
				ClientAppTypes: pulumi.StringArray{
					pulumi.String("all"),
				},
				Applications: &azuread.ConditionalAccessPolicyConditionsApplicationsArgs{
					IncludedApplications: pulumi.StringArray{
						pulumi.String("All"),
					},
				},
				ClientApplications: &azuread.ConditionalAccessPolicyConditionsClientApplicationsArgs{
					IncludedServicePrincipals: pulumi.StringArray{
						pulumi.String("ServicePrincipalsInMyTenant"),
					},
					ExcludedServicePrincipals: pulumi.StringArray{
						pulumi.String(current.ObjectId),
					},
				},
				Users: &azuread.ConditionalAccessPolicyConditionsUsersArgs{
					IncludedUsers: pulumi.StringArray{
						pulumi.String("None"),
					},
				},
			},
			GrantControls: &azuread.ConditionalAccessPolicyGrantControlsArgs{
				Operator: pulumi.String("OR"),
				BuiltInControls: pulumi.StringArray{
					pulumi.String("block"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Conditional Access Policies can be imported using the `id`, e.g.

```sh $ pulumi import azuread:index/conditionalAccessPolicy:ConditionalAccessPolicy my_location 00000000-0000-0000-0000-000000000000 ```

func GetConditionalAccessPolicy added in v5.2.0

func GetConditionalAccessPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ConditionalAccessPolicyState, opts ...pulumi.ResourceOption) (*ConditionalAccessPolicy, error)

GetConditionalAccessPolicy gets an existing ConditionalAccessPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewConditionalAccessPolicy added in v5.2.0

func NewConditionalAccessPolicy(ctx *pulumi.Context,
	name string, args *ConditionalAccessPolicyArgs, opts ...pulumi.ResourceOption) (*ConditionalAccessPolicy, error)

NewConditionalAccessPolicy registers a new resource with the given unique name, arguments, and options.

func (*ConditionalAccessPolicy) ElementType added in v5.2.0

func (*ConditionalAccessPolicy) ElementType() reflect.Type

func (*ConditionalAccessPolicy) ToConditionalAccessPolicyOutput added in v5.2.0

func (i *ConditionalAccessPolicy) ToConditionalAccessPolicyOutput() ConditionalAccessPolicyOutput

func (*ConditionalAccessPolicy) ToConditionalAccessPolicyOutputWithContext added in v5.2.0

func (i *ConditionalAccessPolicy) ToConditionalAccessPolicyOutputWithContext(ctx context.Context) ConditionalAccessPolicyOutput

type ConditionalAccessPolicyArgs added in v5.2.0

type ConditionalAccessPolicyArgs struct {
	// A `conditions` block as documented below, which specifies the rules that must be met for the policy to apply.
	Conditions ConditionalAccessPolicyConditionsInput
	// The friendly name for this Conditional Access Policy.
	DisplayName pulumi.StringInput
	// A `grantControls` block as documented below, which specifies the grant controls that must be fulfilled to pass the policy.
	GrantControls ConditionalAccessPolicyGrantControlsPtrInput
	// A `sessionControls` block as documented below, which specifies the session controls that are enforced after sign-in.
	//
	// > Note: At least one of `grantControls` and/or `sessionControls` blocks must be specified.
	SessionControls ConditionalAccessPolicySessionControlsPtrInput
	// Specifies the state of the policy object. Possible values are: `enabled`, `disabled` and `enabledForReportingButNotEnforced`
	State pulumi.StringInput
}

The set of arguments for constructing a ConditionalAccessPolicy resource.

func (ConditionalAccessPolicyArgs) ElementType added in v5.2.0

type ConditionalAccessPolicyArray added in v5.2.0

type ConditionalAccessPolicyArray []ConditionalAccessPolicyInput

func (ConditionalAccessPolicyArray) ElementType added in v5.2.0

func (ConditionalAccessPolicyArray) ToConditionalAccessPolicyArrayOutput added in v5.2.0

func (i ConditionalAccessPolicyArray) ToConditionalAccessPolicyArrayOutput() ConditionalAccessPolicyArrayOutput

func (ConditionalAccessPolicyArray) ToConditionalAccessPolicyArrayOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyArray) ToConditionalAccessPolicyArrayOutputWithContext(ctx context.Context) ConditionalAccessPolicyArrayOutput

type ConditionalAccessPolicyArrayInput added in v5.2.0

type ConditionalAccessPolicyArrayInput interface {
	pulumi.Input

	ToConditionalAccessPolicyArrayOutput() ConditionalAccessPolicyArrayOutput
	ToConditionalAccessPolicyArrayOutputWithContext(context.Context) ConditionalAccessPolicyArrayOutput
}

ConditionalAccessPolicyArrayInput is an input type that accepts ConditionalAccessPolicyArray and ConditionalAccessPolicyArrayOutput values. You can construct a concrete instance of `ConditionalAccessPolicyArrayInput` via:

ConditionalAccessPolicyArray{ ConditionalAccessPolicyArgs{...} }

type ConditionalAccessPolicyArrayOutput added in v5.2.0

type ConditionalAccessPolicyArrayOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyArrayOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyArrayOutput) Index added in v5.2.0

func (ConditionalAccessPolicyArrayOutput) ToConditionalAccessPolicyArrayOutput added in v5.2.0

func (o ConditionalAccessPolicyArrayOutput) ToConditionalAccessPolicyArrayOutput() ConditionalAccessPolicyArrayOutput

func (ConditionalAccessPolicyArrayOutput) ToConditionalAccessPolicyArrayOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyArrayOutput) ToConditionalAccessPolicyArrayOutputWithContext(ctx context.Context) ConditionalAccessPolicyArrayOutput

type ConditionalAccessPolicyConditions added in v5.2.0

type ConditionalAccessPolicyConditions struct {
	// An `applications` block as documented below, which specifies applications and user actions included in and excluded from the policy.
	Applications ConditionalAccessPolicyConditionsApplications `pulumi:"applications"`
	// A list of client application types included in the policy. Possible values are: `all`, `browser`, `mobileAppsAndDesktopClients`, `exchangeActiveSync`, `easSupported` and `other`.
	ClientAppTypes []string `pulumi:"clientAppTypes"`
	// An `clientApplications` block as documented below, which specifies service principals included in and excluded from the policy.
	ClientApplications *ConditionalAccessPolicyConditionsClientApplications `pulumi:"clientApplications"`
	// A `devices` block as documented below, which describes devices to be included in and excluded from the policy. A `devices` block can be added to an existing policy, but removing the `devices` block forces a new resource to be created.
	Devices *ConditionalAccessPolicyConditionsDevices `pulumi:"devices"`
	// A `locations` block as documented below, which specifies locations included in and excluded from the policy.
	Locations *ConditionalAccessPolicyConditionsLocations `pulumi:"locations"`
	// A `platforms` block as documented below, which specifies platforms included in and excluded from the policy.
	Platforms *ConditionalAccessPolicyConditionsPlatforms `pulumi:"platforms"`
	// A list of service principal sign-in risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `none`, `unknownFutureValue`.
	ServicePrincipalRiskLevels []string `pulumi:"servicePrincipalRiskLevels"`
	// A list of user sign-in risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`.
	SignInRiskLevels []string `pulumi:"signInRiskLevels"`
	// A list of user risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`.
	UserRiskLevels []string `pulumi:"userRiskLevels"`
	// A `users` block as documented below, which specifies users, groups, and roles included in and excluded from the policy.
	Users ConditionalAccessPolicyConditionsUsers `pulumi:"users"`
}

type ConditionalAccessPolicyConditionsApplications added in v5.2.0

type ConditionalAccessPolicyConditionsApplications struct {
	// A list of application IDs explicitly excluded from the policy. Can also be set to `Office365`.
	ExcludedApplications []string `pulumi:"excludedApplications"`
	// A list of application IDs the policy applies to, unless explicitly excluded (in `excludedApplications`). Can also be set to `All`, `None` or `Office365`. Cannot be specified with `includedUserActions`. One of `includedApplications` or `includedUserActions` must be specified.
	IncludedApplications []string `pulumi:"includedApplications"`
	// A list of user actions to include. Supported values are `urn:user:registerdevice` and `urn:user:registersecurityinfo`. Cannot be specified with `includedApplications`. One of `includedApplications` or `includedUserActions` must be specified.
	IncludedUserActions []string `pulumi:"includedUserActions"`
}

type ConditionalAccessPolicyConditionsApplicationsArgs added in v5.2.0

type ConditionalAccessPolicyConditionsApplicationsArgs struct {
	// A list of application IDs explicitly excluded from the policy. Can also be set to `Office365`.
	ExcludedApplications pulumi.StringArrayInput `pulumi:"excludedApplications"`
	// A list of application IDs the policy applies to, unless explicitly excluded (in `excludedApplications`). Can also be set to `All`, `None` or `Office365`. Cannot be specified with `includedUserActions`. One of `includedApplications` or `includedUserActions` must be specified.
	IncludedApplications pulumi.StringArrayInput `pulumi:"includedApplications"`
	// A list of user actions to include. Supported values are `urn:user:registerdevice` and `urn:user:registersecurityinfo`. Cannot be specified with `includedApplications`. One of `includedApplications` or `includedUserActions` must be specified.
	IncludedUserActions pulumi.StringArrayInput `pulumi:"includedUserActions"`
}

func (ConditionalAccessPolicyConditionsApplicationsArgs) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsApplicationsArgs) ToConditionalAccessPolicyConditionsApplicationsOutput added in v5.2.0

func (i ConditionalAccessPolicyConditionsApplicationsArgs) ToConditionalAccessPolicyConditionsApplicationsOutput() ConditionalAccessPolicyConditionsApplicationsOutput

func (ConditionalAccessPolicyConditionsApplicationsArgs) ToConditionalAccessPolicyConditionsApplicationsOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyConditionsApplicationsArgs) ToConditionalAccessPolicyConditionsApplicationsOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsApplicationsOutput

func (ConditionalAccessPolicyConditionsApplicationsArgs) ToConditionalAccessPolicyConditionsApplicationsPtrOutput added in v5.2.0

func (i ConditionalAccessPolicyConditionsApplicationsArgs) ToConditionalAccessPolicyConditionsApplicationsPtrOutput() ConditionalAccessPolicyConditionsApplicationsPtrOutput

func (ConditionalAccessPolicyConditionsApplicationsArgs) ToConditionalAccessPolicyConditionsApplicationsPtrOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyConditionsApplicationsArgs) ToConditionalAccessPolicyConditionsApplicationsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsApplicationsPtrOutput

type ConditionalAccessPolicyConditionsApplicationsInput added in v5.2.0

type ConditionalAccessPolicyConditionsApplicationsInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsApplicationsOutput() ConditionalAccessPolicyConditionsApplicationsOutput
	ToConditionalAccessPolicyConditionsApplicationsOutputWithContext(context.Context) ConditionalAccessPolicyConditionsApplicationsOutput
}

ConditionalAccessPolicyConditionsApplicationsInput is an input type that accepts ConditionalAccessPolicyConditionsApplicationsArgs and ConditionalAccessPolicyConditionsApplicationsOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsApplicationsInput` via:

ConditionalAccessPolicyConditionsApplicationsArgs{...}

type ConditionalAccessPolicyConditionsApplicationsOutput added in v5.2.0

type ConditionalAccessPolicyConditionsApplicationsOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsApplicationsOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsApplicationsOutput) ExcludedApplications added in v5.2.0

A list of application IDs explicitly excluded from the policy. Can also be set to `Office365`.

func (ConditionalAccessPolicyConditionsApplicationsOutput) IncludedApplications added in v5.2.0

A list of application IDs the policy applies to, unless explicitly excluded (in `excludedApplications`). Can also be set to `All`, `None` or `Office365`. Cannot be specified with `includedUserActions`. One of `includedApplications` or `includedUserActions` must be specified.

func (ConditionalAccessPolicyConditionsApplicationsOutput) IncludedUserActions added in v5.2.0

A list of user actions to include. Supported values are `urn:user:registerdevice` and `urn:user:registersecurityinfo`. Cannot be specified with `includedApplications`. One of `includedApplications` or `includedUserActions` must be specified.

func (ConditionalAccessPolicyConditionsApplicationsOutput) ToConditionalAccessPolicyConditionsApplicationsOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsApplicationsOutput) ToConditionalAccessPolicyConditionsApplicationsOutput() ConditionalAccessPolicyConditionsApplicationsOutput

func (ConditionalAccessPolicyConditionsApplicationsOutput) ToConditionalAccessPolicyConditionsApplicationsOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsApplicationsOutput) ToConditionalAccessPolicyConditionsApplicationsOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsApplicationsOutput

func (ConditionalAccessPolicyConditionsApplicationsOutput) ToConditionalAccessPolicyConditionsApplicationsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsApplicationsOutput) ToConditionalAccessPolicyConditionsApplicationsPtrOutput() ConditionalAccessPolicyConditionsApplicationsPtrOutput

func (ConditionalAccessPolicyConditionsApplicationsOutput) ToConditionalAccessPolicyConditionsApplicationsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsApplicationsOutput) ToConditionalAccessPolicyConditionsApplicationsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsApplicationsPtrOutput

type ConditionalAccessPolicyConditionsApplicationsPtrInput added in v5.2.0

type ConditionalAccessPolicyConditionsApplicationsPtrInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsApplicationsPtrOutput() ConditionalAccessPolicyConditionsApplicationsPtrOutput
	ToConditionalAccessPolicyConditionsApplicationsPtrOutputWithContext(context.Context) ConditionalAccessPolicyConditionsApplicationsPtrOutput
}

ConditionalAccessPolicyConditionsApplicationsPtrInput is an input type that accepts ConditionalAccessPolicyConditionsApplicationsArgs, ConditionalAccessPolicyConditionsApplicationsPtr and ConditionalAccessPolicyConditionsApplicationsPtrOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsApplicationsPtrInput` via:

        ConditionalAccessPolicyConditionsApplicationsArgs{...}

or:

        nil

type ConditionalAccessPolicyConditionsApplicationsPtrOutput added in v5.2.0

type ConditionalAccessPolicyConditionsApplicationsPtrOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsApplicationsPtrOutput) Elem added in v5.2.0

func (ConditionalAccessPolicyConditionsApplicationsPtrOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsApplicationsPtrOutput) ExcludedApplications added in v5.2.0

A list of application IDs explicitly excluded from the policy. Can also be set to `Office365`.

func (ConditionalAccessPolicyConditionsApplicationsPtrOutput) IncludedApplications added in v5.2.0

A list of application IDs the policy applies to, unless explicitly excluded (in `excludedApplications`). Can also be set to `All`, `None` or `Office365`. Cannot be specified with `includedUserActions`. One of `includedApplications` or `includedUserActions` must be specified.

func (ConditionalAccessPolicyConditionsApplicationsPtrOutput) IncludedUserActions added in v5.2.0

A list of user actions to include. Supported values are `urn:user:registerdevice` and `urn:user:registersecurityinfo`. Cannot be specified with `includedApplications`. One of `includedApplications` or `includedUserActions` must be specified.

func (ConditionalAccessPolicyConditionsApplicationsPtrOutput) ToConditionalAccessPolicyConditionsApplicationsPtrOutput added in v5.2.0

func (ConditionalAccessPolicyConditionsApplicationsPtrOutput) ToConditionalAccessPolicyConditionsApplicationsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsApplicationsPtrOutput) ToConditionalAccessPolicyConditionsApplicationsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsApplicationsPtrOutput

type ConditionalAccessPolicyConditionsArgs added in v5.2.0

type ConditionalAccessPolicyConditionsArgs struct {
	// An `applications` block as documented below, which specifies applications and user actions included in and excluded from the policy.
	Applications ConditionalAccessPolicyConditionsApplicationsInput `pulumi:"applications"`
	// A list of client application types included in the policy. Possible values are: `all`, `browser`, `mobileAppsAndDesktopClients`, `exchangeActiveSync`, `easSupported` and `other`.
	ClientAppTypes pulumi.StringArrayInput `pulumi:"clientAppTypes"`
	// An `clientApplications` block as documented below, which specifies service principals included in and excluded from the policy.
	ClientApplications ConditionalAccessPolicyConditionsClientApplicationsPtrInput `pulumi:"clientApplications"`
	// A `devices` block as documented below, which describes devices to be included in and excluded from the policy. A `devices` block can be added to an existing policy, but removing the `devices` block forces a new resource to be created.
	Devices ConditionalAccessPolicyConditionsDevicesPtrInput `pulumi:"devices"`
	// A `locations` block as documented below, which specifies locations included in and excluded from the policy.
	Locations ConditionalAccessPolicyConditionsLocationsPtrInput `pulumi:"locations"`
	// A `platforms` block as documented below, which specifies platforms included in and excluded from the policy.
	Platforms ConditionalAccessPolicyConditionsPlatformsPtrInput `pulumi:"platforms"`
	// A list of service principal sign-in risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `none`, `unknownFutureValue`.
	ServicePrincipalRiskLevels pulumi.StringArrayInput `pulumi:"servicePrincipalRiskLevels"`
	// A list of user sign-in risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`.
	SignInRiskLevels pulumi.StringArrayInput `pulumi:"signInRiskLevels"`
	// A list of user risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`.
	UserRiskLevels pulumi.StringArrayInput `pulumi:"userRiskLevels"`
	// A `users` block as documented below, which specifies users, groups, and roles included in and excluded from the policy.
	Users ConditionalAccessPolicyConditionsUsersInput `pulumi:"users"`
}

func (ConditionalAccessPolicyConditionsArgs) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsArgs) ToConditionalAccessPolicyConditionsOutput added in v5.2.0

func (i ConditionalAccessPolicyConditionsArgs) ToConditionalAccessPolicyConditionsOutput() ConditionalAccessPolicyConditionsOutput

func (ConditionalAccessPolicyConditionsArgs) ToConditionalAccessPolicyConditionsOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyConditionsArgs) ToConditionalAccessPolicyConditionsOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsOutput

func (ConditionalAccessPolicyConditionsArgs) ToConditionalAccessPolicyConditionsPtrOutput added in v5.2.0

func (i ConditionalAccessPolicyConditionsArgs) ToConditionalAccessPolicyConditionsPtrOutput() ConditionalAccessPolicyConditionsPtrOutput

func (ConditionalAccessPolicyConditionsArgs) ToConditionalAccessPolicyConditionsPtrOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyConditionsArgs) ToConditionalAccessPolicyConditionsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsPtrOutput

type ConditionalAccessPolicyConditionsClientApplications added in v5.39.0

type ConditionalAccessPolicyConditionsClientApplications struct {
	// A list of service principal IDs explicitly excluded in the policy.
	ExcludedServicePrincipals []string `pulumi:"excludedServicePrincipals"`
	// A list of service principal IDs explicitly included in the policy. Can be set to `ServicePrincipalsInMyTenant` to include all service principals. This is mandatory value when at least one `excludedServicePrincipals` is set.
	IncludedServicePrincipals []string `pulumi:"includedServicePrincipals"`
}

type ConditionalAccessPolicyConditionsClientApplicationsArgs added in v5.39.0

type ConditionalAccessPolicyConditionsClientApplicationsArgs struct {
	// A list of service principal IDs explicitly excluded in the policy.
	ExcludedServicePrincipals pulumi.StringArrayInput `pulumi:"excludedServicePrincipals"`
	// A list of service principal IDs explicitly included in the policy. Can be set to `ServicePrincipalsInMyTenant` to include all service principals. This is mandatory value when at least one `excludedServicePrincipals` is set.
	IncludedServicePrincipals pulumi.StringArrayInput `pulumi:"includedServicePrincipals"`
}

func (ConditionalAccessPolicyConditionsClientApplicationsArgs) ElementType added in v5.39.0

func (ConditionalAccessPolicyConditionsClientApplicationsArgs) ToConditionalAccessPolicyConditionsClientApplicationsOutput added in v5.39.0

func (ConditionalAccessPolicyConditionsClientApplicationsArgs) ToConditionalAccessPolicyConditionsClientApplicationsOutputWithContext added in v5.39.0

func (i ConditionalAccessPolicyConditionsClientApplicationsArgs) ToConditionalAccessPolicyConditionsClientApplicationsOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsClientApplicationsOutput

func (ConditionalAccessPolicyConditionsClientApplicationsArgs) ToConditionalAccessPolicyConditionsClientApplicationsPtrOutput added in v5.39.0

func (i ConditionalAccessPolicyConditionsClientApplicationsArgs) ToConditionalAccessPolicyConditionsClientApplicationsPtrOutput() ConditionalAccessPolicyConditionsClientApplicationsPtrOutput

func (ConditionalAccessPolicyConditionsClientApplicationsArgs) ToConditionalAccessPolicyConditionsClientApplicationsPtrOutputWithContext added in v5.39.0

func (i ConditionalAccessPolicyConditionsClientApplicationsArgs) ToConditionalAccessPolicyConditionsClientApplicationsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsClientApplicationsPtrOutput

type ConditionalAccessPolicyConditionsClientApplicationsInput added in v5.39.0

type ConditionalAccessPolicyConditionsClientApplicationsInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsClientApplicationsOutput() ConditionalAccessPolicyConditionsClientApplicationsOutput
	ToConditionalAccessPolicyConditionsClientApplicationsOutputWithContext(context.Context) ConditionalAccessPolicyConditionsClientApplicationsOutput
}

ConditionalAccessPolicyConditionsClientApplicationsInput is an input type that accepts ConditionalAccessPolicyConditionsClientApplicationsArgs and ConditionalAccessPolicyConditionsClientApplicationsOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsClientApplicationsInput` via:

ConditionalAccessPolicyConditionsClientApplicationsArgs{...}

type ConditionalAccessPolicyConditionsClientApplicationsOutput added in v5.39.0

type ConditionalAccessPolicyConditionsClientApplicationsOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsClientApplicationsOutput) ElementType added in v5.39.0

func (ConditionalAccessPolicyConditionsClientApplicationsOutput) ExcludedServicePrincipals added in v5.39.0

A list of service principal IDs explicitly excluded in the policy.

func (ConditionalAccessPolicyConditionsClientApplicationsOutput) IncludedServicePrincipals added in v5.39.0

A list of service principal IDs explicitly included in the policy. Can be set to `ServicePrincipalsInMyTenant` to include all service principals. This is mandatory value when at least one `excludedServicePrincipals` is set.

func (ConditionalAccessPolicyConditionsClientApplicationsOutput) ToConditionalAccessPolicyConditionsClientApplicationsOutput added in v5.39.0

func (ConditionalAccessPolicyConditionsClientApplicationsOutput) ToConditionalAccessPolicyConditionsClientApplicationsOutputWithContext added in v5.39.0

func (o ConditionalAccessPolicyConditionsClientApplicationsOutput) ToConditionalAccessPolicyConditionsClientApplicationsOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsClientApplicationsOutput

func (ConditionalAccessPolicyConditionsClientApplicationsOutput) ToConditionalAccessPolicyConditionsClientApplicationsPtrOutput added in v5.39.0

func (ConditionalAccessPolicyConditionsClientApplicationsOutput) ToConditionalAccessPolicyConditionsClientApplicationsPtrOutputWithContext added in v5.39.0

func (o ConditionalAccessPolicyConditionsClientApplicationsOutput) ToConditionalAccessPolicyConditionsClientApplicationsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsClientApplicationsPtrOutput

type ConditionalAccessPolicyConditionsClientApplicationsPtrInput added in v5.39.0

type ConditionalAccessPolicyConditionsClientApplicationsPtrInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsClientApplicationsPtrOutput() ConditionalAccessPolicyConditionsClientApplicationsPtrOutput
	ToConditionalAccessPolicyConditionsClientApplicationsPtrOutputWithContext(context.Context) ConditionalAccessPolicyConditionsClientApplicationsPtrOutput
}

ConditionalAccessPolicyConditionsClientApplicationsPtrInput is an input type that accepts ConditionalAccessPolicyConditionsClientApplicationsArgs, ConditionalAccessPolicyConditionsClientApplicationsPtr and ConditionalAccessPolicyConditionsClientApplicationsPtrOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsClientApplicationsPtrInput` via:

        ConditionalAccessPolicyConditionsClientApplicationsArgs{...}

or:

        nil

type ConditionalAccessPolicyConditionsClientApplicationsPtrOutput added in v5.39.0

type ConditionalAccessPolicyConditionsClientApplicationsPtrOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsClientApplicationsPtrOutput) Elem added in v5.39.0

func (ConditionalAccessPolicyConditionsClientApplicationsPtrOutput) ElementType added in v5.39.0

func (ConditionalAccessPolicyConditionsClientApplicationsPtrOutput) ExcludedServicePrincipals added in v5.39.0

A list of service principal IDs explicitly excluded in the policy.

func (ConditionalAccessPolicyConditionsClientApplicationsPtrOutput) IncludedServicePrincipals added in v5.39.0

A list of service principal IDs explicitly included in the policy. Can be set to `ServicePrincipalsInMyTenant` to include all service principals. This is mandatory value when at least one `excludedServicePrincipals` is set.

func (ConditionalAccessPolicyConditionsClientApplicationsPtrOutput) ToConditionalAccessPolicyConditionsClientApplicationsPtrOutput added in v5.39.0

func (ConditionalAccessPolicyConditionsClientApplicationsPtrOutput) ToConditionalAccessPolicyConditionsClientApplicationsPtrOutputWithContext added in v5.39.0

func (o ConditionalAccessPolicyConditionsClientApplicationsPtrOutput) ToConditionalAccessPolicyConditionsClientApplicationsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsClientApplicationsPtrOutput

type ConditionalAccessPolicyConditionsDevices added in v5.10.0

type ConditionalAccessPolicyConditionsDevices struct {
	// A `filter` block as described below.
	Filter *ConditionalAccessPolicyConditionsDevicesFilter `pulumi:"filter"`
}

type ConditionalAccessPolicyConditionsDevicesArgs added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesArgs struct {
	// A `filter` block as described below.
	Filter ConditionalAccessPolicyConditionsDevicesFilterPtrInput `pulumi:"filter"`
}

func (ConditionalAccessPolicyConditionsDevicesArgs) ElementType added in v5.10.0

func (ConditionalAccessPolicyConditionsDevicesArgs) ToConditionalAccessPolicyConditionsDevicesOutput added in v5.10.0

func (i ConditionalAccessPolicyConditionsDevicesArgs) ToConditionalAccessPolicyConditionsDevicesOutput() ConditionalAccessPolicyConditionsDevicesOutput

func (ConditionalAccessPolicyConditionsDevicesArgs) ToConditionalAccessPolicyConditionsDevicesOutputWithContext added in v5.10.0

func (i ConditionalAccessPolicyConditionsDevicesArgs) ToConditionalAccessPolicyConditionsDevicesOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsDevicesOutput

func (ConditionalAccessPolicyConditionsDevicesArgs) ToConditionalAccessPolicyConditionsDevicesPtrOutput added in v5.10.0

func (i ConditionalAccessPolicyConditionsDevicesArgs) ToConditionalAccessPolicyConditionsDevicesPtrOutput() ConditionalAccessPolicyConditionsDevicesPtrOutput

func (ConditionalAccessPolicyConditionsDevicesArgs) ToConditionalAccessPolicyConditionsDevicesPtrOutputWithContext added in v5.10.0

func (i ConditionalAccessPolicyConditionsDevicesArgs) ToConditionalAccessPolicyConditionsDevicesPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsDevicesPtrOutput

type ConditionalAccessPolicyConditionsDevicesFilter added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesFilter struct {
	// Whether to include in, or exclude from, matching devices from the policy. Supported values are `include` or `exclude`.
	Mode string `pulumi:"mode"`
	// Condition filter to match devices. For more information, see [official documentation](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/concept-condition-filters-for-devices#supported-operators-and-device-properties-for-filters).
	Rule string `pulumi:"rule"`
}

type ConditionalAccessPolicyConditionsDevicesFilterArgs added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesFilterArgs struct {
	// Whether to include in, or exclude from, matching devices from the policy. Supported values are `include` or `exclude`.
	Mode pulumi.StringInput `pulumi:"mode"`
	// Condition filter to match devices. For more information, see [official documentation](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/concept-condition-filters-for-devices#supported-operators-and-device-properties-for-filters).
	Rule pulumi.StringInput `pulumi:"rule"`
}

func (ConditionalAccessPolicyConditionsDevicesFilterArgs) ElementType added in v5.10.0

func (ConditionalAccessPolicyConditionsDevicesFilterArgs) ToConditionalAccessPolicyConditionsDevicesFilterOutput added in v5.10.0

func (i ConditionalAccessPolicyConditionsDevicesFilterArgs) ToConditionalAccessPolicyConditionsDevicesFilterOutput() ConditionalAccessPolicyConditionsDevicesFilterOutput

func (ConditionalAccessPolicyConditionsDevicesFilterArgs) ToConditionalAccessPolicyConditionsDevicesFilterOutputWithContext added in v5.10.0

func (i ConditionalAccessPolicyConditionsDevicesFilterArgs) ToConditionalAccessPolicyConditionsDevicesFilterOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsDevicesFilterOutput

func (ConditionalAccessPolicyConditionsDevicesFilterArgs) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutput added in v5.10.0

func (i ConditionalAccessPolicyConditionsDevicesFilterArgs) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutput() ConditionalAccessPolicyConditionsDevicesFilterPtrOutput

func (ConditionalAccessPolicyConditionsDevicesFilterArgs) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutputWithContext added in v5.10.0

func (i ConditionalAccessPolicyConditionsDevicesFilterArgs) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsDevicesFilterPtrOutput

type ConditionalAccessPolicyConditionsDevicesFilterInput added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesFilterInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsDevicesFilterOutput() ConditionalAccessPolicyConditionsDevicesFilterOutput
	ToConditionalAccessPolicyConditionsDevicesFilterOutputWithContext(context.Context) ConditionalAccessPolicyConditionsDevicesFilterOutput
}

ConditionalAccessPolicyConditionsDevicesFilterInput is an input type that accepts ConditionalAccessPolicyConditionsDevicesFilterArgs and ConditionalAccessPolicyConditionsDevicesFilterOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsDevicesFilterInput` via:

ConditionalAccessPolicyConditionsDevicesFilterArgs{...}

type ConditionalAccessPolicyConditionsDevicesFilterOutput added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesFilterOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsDevicesFilterOutput) ElementType added in v5.10.0

func (ConditionalAccessPolicyConditionsDevicesFilterOutput) Mode added in v5.10.0

Whether to include in, or exclude from, matching devices from the policy. Supported values are `include` or `exclude`.

func (ConditionalAccessPolicyConditionsDevicesFilterOutput) Rule added in v5.10.0

Condition filter to match devices. For more information, see [official documentation](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/concept-condition-filters-for-devices#supported-operators-and-device-properties-for-filters).

func (ConditionalAccessPolicyConditionsDevicesFilterOutput) ToConditionalAccessPolicyConditionsDevicesFilterOutput added in v5.10.0

func (ConditionalAccessPolicyConditionsDevicesFilterOutput) ToConditionalAccessPolicyConditionsDevicesFilterOutputWithContext added in v5.10.0

func (o ConditionalAccessPolicyConditionsDevicesFilterOutput) ToConditionalAccessPolicyConditionsDevicesFilterOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsDevicesFilterOutput

func (ConditionalAccessPolicyConditionsDevicesFilterOutput) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutput added in v5.10.0

func (o ConditionalAccessPolicyConditionsDevicesFilterOutput) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutput() ConditionalAccessPolicyConditionsDevicesFilterPtrOutput

func (ConditionalAccessPolicyConditionsDevicesFilterOutput) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutputWithContext added in v5.10.0

func (o ConditionalAccessPolicyConditionsDevicesFilterOutput) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsDevicesFilterPtrOutput

type ConditionalAccessPolicyConditionsDevicesFilterPtrInput added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesFilterPtrInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsDevicesFilterPtrOutput() ConditionalAccessPolicyConditionsDevicesFilterPtrOutput
	ToConditionalAccessPolicyConditionsDevicesFilterPtrOutputWithContext(context.Context) ConditionalAccessPolicyConditionsDevicesFilterPtrOutput
}

ConditionalAccessPolicyConditionsDevicesFilterPtrInput is an input type that accepts ConditionalAccessPolicyConditionsDevicesFilterArgs, ConditionalAccessPolicyConditionsDevicesFilterPtr and ConditionalAccessPolicyConditionsDevicesFilterPtrOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsDevicesFilterPtrInput` via:

        ConditionalAccessPolicyConditionsDevicesFilterArgs{...}

or:

        nil

type ConditionalAccessPolicyConditionsDevicesFilterPtrOutput added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesFilterPtrOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsDevicesFilterPtrOutput) Elem added in v5.10.0

func (ConditionalAccessPolicyConditionsDevicesFilterPtrOutput) ElementType added in v5.10.0

func (ConditionalAccessPolicyConditionsDevicesFilterPtrOutput) Mode added in v5.10.0

Whether to include in, or exclude from, matching devices from the policy. Supported values are `include` or `exclude`.

func (ConditionalAccessPolicyConditionsDevicesFilterPtrOutput) Rule added in v5.10.0

Condition filter to match devices. For more information, see [official documentation](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/concept-condition-filters-for-devices#supported-operators-and-device-properties-for-filters).

func (ConditionalAccessPolicyConditionsDevicesFilterPtrOutput) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutput added in v5.10.0

func (ConditionalAccessPolicyConditionsDevicesFilterPtrOutput) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutputWithContext added in v5.10.0

func (o ConditionalAccessPolicyConditionsDevicesFilterPtrOutput) ToConditionalAccessPolicyConditionsDevicesFilterPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsDevicesFilterPtrOutput

type ConditionalAccessPolicyConditionsDevicesInput added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsDevicesOutput() ConditionalAccessPolicyConditionsDevicesOutput
	ToConditionalAccessPolicyConditionsDevicesOutputWithContext(context.Context) ConditionalAccessPolicyConditionsDevicesOutput
}

ConditionalAccessPolicyConditionsDevicesInput is an input type that accepts ConditionalAccessPolicyConditionsDevicesArgs and ConditionalAccessPolicyConditionsDevicesOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsDevicesInput` via:

ConditionalAccessPolicyConditionsDevicesArgs{...}

type ConditionalAccessPolicyConditionsDevicesOutput added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsDevicesOutput) ElementType added in v5.10.0

func (ConditionalAccessPolicyConditionsDevicesOutput) Filter added in v5.10.0

A `filter` block as described below.

func (ConditionalAccessPolicyConditionsDevicesOutput) ToConditionalAccessPolicyConditionsDevicesOutput added in v5.10.0

func (o ConditionalAccessPolicyConditionsDevicesOutput) ToConditionalAccessPolicyConditionsDevicesOutput() ConditionalAccessPolicyConditionsDevicesOutput

func (ConditionalAccessPolicyConditionsDevicesOutput) ToConditionalAccessPolicyConditionsDevicesOutputWithContext added in v5.10.0

func (o ConditionalAccessPolicyConditionsDevicesOutput) ToConditionalAccessPolicyConditionsDevicesOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsDevicesOutput

func (ConditionalAccessPolicyConditionsDevicesOutput) ToConditionalAccessPolicyConditionsDevicesPtrOutput added in v5.10.0

func (o ConditionalAccessPolicyConditionsDevicesOutput) ToConditionalAccessPolicyConditionsDevicesPtrOutput() ConditionalAccessPolicyConditionsDevicesPtrOutput

func (ConditionalAccessPolicyConditionsDevicesOutput) ToConditionalAccessPolicyConditionsDevicesPtrOutputWithContext added in v5.10.0

func (o ConditionalAccessPolicyConditionsDevicesOutput) ToConditionalAccessPolicyConditionsDevicesPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsDevicesPtrOutput

type ConditionalAccessPolicyConditionsDevicesPtrInput added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesPtrInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsDevicesPtrOutput() ConditionalAccessPolicyConditionsDevicesPtrOutput
	ToConditionalAccessPolicyConditionsDevicesPtrOutputWithContext(context.Context) ConditionalAccessPolicyConditionsDevicesPtrOutput
}

ConditionalAccessPolicyConditionsDevicesPtrInput is an input type that accepts ConditionalAccessPolicyConditionsDevicesArgs, ConditionalAccessPolicyConditionsDevicesPtr and ConditionalAccessPolicyConditionsDevicesPtrOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsDevicesPtrInput` via:

        ConditionalAccessPolicyConditionsDevicesArgs{...}

or:

        nil

type ConditionalAccessPolicyConditionsDevicesPtrOutput added in v5.10.0

type ConditionalAccessPolicyConditionsDevicesPtrOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsDevicesPtrOutput) Elem added in v5.10.0

func (ConditionalAccessPolicyConditionsDevicesPtrOutput) ElementType added in v5.10.0

func (ConditionalAccessPolicyConditionsDevicesPtrOutput) Filter added in v5.10.0

A `filter` block as described below.

func (ConditionalAccessPolicyConditionsDevicesPtrOutput) ToConditionalAccessPolicyConditionsDevicesPtrOutput added in v5.10.0

func (o ConditionalAccessPolicyConditionsDevicesPtrOutput) ToConditionalAccessPolicyConditionsDevicesPtrOutput() ConditionalAccessPolicyConditionsDevicesPtrOutput

func (ConditionalAccessPolicyConditionsDevicesPtrOutput) ToConditionalAccessPolicyConditionsDevicesPtrOutputWithContext added in v5.10.0

func (o ConditionalAccessPolicyConditionsDevicesPtrOutput) ToConditionalAccessPolicyConditionsDevicesPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsDevicesPtrOutput

type ConditionalAccessPolicyConditionsInput added in v5.2.0

type ConditionalAccessPolicyConditionsInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsOutput() ConditionalAccessPolicyConditionsOutput
	ToConditionalAccessPolicyConditionsOutputWithContext(context.Context) ConditionalAccessPolicyConditionsOutput
}

ConditionalAccessPolicyConditionsInput is an input type that accepts ConditionalAccessPolicyConditionsArgs and ConditionalAccessPolicyConditionsOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsInput` via:

ConditionalAccessPolicyConditionsArgs{...}

type ConditionalAccessPolicyConditionsLocations added in v5.2.0

type ConditionalAccessPolicyConditionsLocations struct {
	// A list of location IDs excluded from scope of policy. Can also be set to `AllTrusted`.
	ExcludedLocations []string `pulumi:"excludedLocations"`
	// A list of location IDs in scope of policy unless explicitly excluded. Can also be set to `All`, or `AllTrusted`.
	IncludedLocations []string `pulumi:"includedLocations"`
}

type ConditionalAccessPolicyConditionsLocationsArgs added in v5.2.0

type ConditionalAccessPolicyConditionsLocationsArgs struct {
	// A list of location IDs excluded from scope of policy. Can also be set to `AllTrusted`.
	ExcludedLocations pulumi.StringArrayInput `pulumi:"excludedLocations"`
	// A list of location IDs in scope of policy unless explicitly excluded. Can also be set to `All`, or `AllTrusted`.
	IncludedLocations pulumi.StringArrayInput `pulumi:"includedLocations"`
}

func (ConditionalAccessPolicyConditionsLocationsArgs) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsLocationsArgs) ToConditionalAccessPolicyConditionsLocationsOutput added in v5.2.0

func (i ConditionalAccessPolicyConditionsLocationsArgs) ToConditionalAccessPolicyConditionsLocationsOutput() ConditionalAccessPolicyConditionsLocationsOutput

func (ConditionalAccessPolicyConditionsLocationsArgs) ToConditionalAccessPolicyConditionsLocationsOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyConditionsLocationsArgs) ToConditionalAccessPolicyConditionsLocationsOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsLocationsOutput

func (ConditionalAccessPolicyConditionsLocationsArgs) ToConditionalAccessPolicyConditionsLocationsPtrOutput added in v5.2.0

func (i ConditionalAccessPolicyConditionsLocationsArgs) ToConditionalAccessPolicyConditionsLocationsPtrOutput() ConditionalAccessPolicyConditionsLocationsPtrOutput

func (ConditionalAccessPolicyConditionsLocationsArgs) ToConditionalAccessPolicyConditionsLocationsPtrOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyConditionsLocationsArgs) ToConditionalAccessPolicyConditionsLocationsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsLocationsPtrOutput

type ConditionalAccessPolicyConditionsLocationsInput added in v5.2.0

type ConditionalAccessPolicyConditionsLocationsInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsLocationsOutput() ConditionalAccessPolicyConditionsLocationsOutput
	ToConditionalAccessPolicyConditionsLocationsOutputWithContext(context.Context) ConditionalAccessPolicyConditionsLocationsOutput
}

ConditionalAccessPolicyConditionsLocationsInput is an input type that accepts ConditionalAccessPolicyConditionsLocationsArgs and ConditionalAccessPolicyConditionsLocationsOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsLocationsInput` via:

ConditionalAccessPolicyConditionsLocationsArgs{...}

type ConditionalAccessPolicyConditionsLocationsOutput added in v5.2.0

type ConditionalAccessPolicyConditionsLocationsOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsLocationsOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsLocationsOutput) ExcludedLocations added in v5.2.0

A list of location IDs excluded from scope of policy. Can also be set to `AllTrusted`.

func (ConditionalAccessPolicyConditionsLocationsOutput) IncludedLocations added in v5.2.0

A list of location IDs in scope of policy unless explicitly excluded. Can also be set to `All`, or `AllTrusted`.

func (ConditionalAccessPolicyConditionsLocationsOutput) ToConditionalAccessPolicyConditionsLocationsOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsLocationsOutput) ToConditionalAccessPolicyConditionsLocationsOutput() ConditionalAccessPolicyConditionsLocationsOutput

func (ConditionalAccessPolicyConditionsLocationsOutput) ToConditionalAccessPolicyConditionsLocationsOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsLocationsOutput) ToConditionalAccessPolicyConditionsLocationsOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsLocationsOutput

func (ConditionalAccessPolicyConditionsLocationsOutput) ToConditionalAccessPolicyConditionsLocationsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsLocationsOutput) ToConditionalAccessPolicyConditionsLocationsPtrOutput() ConditionalAccessPolicyConditionsLocationsPtrOutput

func (ConditionalAccessPolicyConditionsLocationsOutput) ToConditionalAccessPolicyConditionsLocationsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsLocationsOutput) ToConditionalAccessPolicyConditionsLocationsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsLocationsPtrOutput

type ConditionalAccessPolicyConditionsLocationsPtrInput added in v5.2.0

type ConditionalAccessPolicyConditionsLocationsPtrInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsLocationsPtrOutput() ConditionalAccessPolicyConditionsLocationsPtrOutput
	ToConditionalAccessPolicyConditionsLocationsPtrOutputWithContext(context.Context) ConditionalAccessPolicyConditionsLocationsPtrOutput
}

ConditionalAccessPolicyConditionsLocationsPtrInput is an input type that accepts ConditionalAccessPolicyConditionsLocationsArgs, ConditionalAccessPolicyConditionsLocationsPtr and ConditionalAccessPolicyConditionsLocationsPtrOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsLocationsPtrInput` via:

        ConditionalAccessPolicyConditionsLocationsArgs{...}

or:

        nil

type ConditionalAccessPolicyConditionsLocationsPtrOutput added in v5.2.0

type ConditionalAccessPolicyConditionsLocationsPtrOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsLocationsPtrOutput) Elem added in v5.2.0

func (ConditionalAccessPolicyConditionsLocationsPtrOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsLocationsPtrOutput) ExcludedLocations added in v5.2.0

A list of location IDs excluded from scope of policy. Can also be set to `AllTrusted`.

func (ConditionalAccessPolicyConditionsLocationsPtrOutput) IncludedLocations added in v5.2.0

A list of location IDs in scope of policy unless explicitly excluded. Can also be set to `All`, or `AllTrusted`.

func (ConditionalAccessPolicyConditionsLocationsPtrOutput) ToConditionalAccessPolicyConditionsLocationsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsLocationsPtrOutput) ToConditionalAccessPolicyConditionsLocationsPtrOutput() ConditionalAccessPolicyConditionsLocationsPtrOutput

func (ConditionalAccessPolicyConditionsLocationsPtrOutput) ToConditionalAccessPolicyConditionsLocationsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsLocationsPtrOutput) ToConditionalAccessPolicyConditionsLocationsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsLocationsPtrOutput

type ConditionalAccessPolicyConditionsOutput added in v5.2.0

type ConditionalAccessPolicyConditionsOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsOutput) Applications added in v5.2.0

An `applications` block as documented below, which specifies applications and user actions included in and excluded from the policy.

func (ConditionalAccessPolicyConditionsOutput) ClientAppTypes added in v5.2.0

A list of client application types included in the policy. Possible values are: `all`, `browser`, `mobileAppsAndDesktopClients`, `exchangeActiveSync`, `easSupported` and `other`.

func (ConditionalAccessPolicyConditionsOutput) ClientApplications added in v5.39.0

An `clientApplications` block as documented below, which specifies service principals included in and excluded from the policy.

func (ConditionalAccessPolicyConditionsOutput) Devices added in v5.10.0

A `devices` block as documented below, which describes devices to be included in and excluded from the policy. A `devices` block can be added to an existing policy, but removing the `devices` block forces a new resource to be created.

func (ConditionalAccessPolicyConditionsOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsOutput) Locations added in v5.2.0

A `locations` block as documented below, which specifies locations included in and excluded from the policy.

func (ConditionalAccessPolicyConditionsOutput) Platforms added in v5.2.0

A `platforms` block as documented below, which specifies platforms included in and excluded from the policy.

func (ConditionalAccessPolicyConditionsOutput) ServicePrincipalRiskLevels added in v5.40.0

func (o ConditionalAccessPolicyConditionsOutput) ServicePrincipalRiskLevels() pulumi.StringArrayOutput

A list of service principal sign-in risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `none`, `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsOutput) SignInRiskLevels added in v5.2.0

A list of user sign-in risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsOutput) ToConditionalAccessPolicyConditionsOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsOutput) ToConditionalAccessPolicyConditionsOutput() ConditionalAccessPolicyConditionsOutput

func (ConditionalAccessPolicyConditionsOutput) ToConditionalAccessPolicyConditionsOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsOutput) ToConditionalAccessPolicyConditionsOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsOutput

func (ConditionalAccessPolicyConditionsOutput) ToConditionalAccessPolicyConditionsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsOutput) ToConditionalAccessPolicyConditionsPtrOutput() ConditionalAccessPolicyConditionsPtrOutput

func (ConditionalAccessPolicyConditionsOutput) ToConditionalAccessPolicyConditionsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsOutput) ToConditionalAccessPolicyConditionsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsPtrOutput

func (ConditionalAccessPolicyConditionsOutput) UserRiskLevels added in v5.2.0

A list of user risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsOutput) Users added in v5.2.0

A `users` block as documented below, which specifies users, groups, and roles included in and excluded from the policy.

type ConditionalAccessPolicyConditionsPlatforms added in v5.2.0

type ConditionalAccessPolicyConditionsPlatforms struct {
	// A list of platforms explicitly excluded from the policy. Possible values are: `all`, `android`, `iOS`, `linux`, `macOS`, `windows`, `windowsPhone` or `unknownFutureValue`.
	ExcludedPlatforms []string `pulumi:"excludedPlatforms"`
	// A list of platforms the policy applies to, unless explicitly excluded. Possible values are: `all`, `android`, `iOS`, `linux`, `macOS`, `windows`, `windowsPhone` or `unknownFutureValue`.
	IncludedPlatforms []string `pulumi:"includedPlatforms"`
}

type ConditionalAccessPolicyConditionsPlatformsArgs added in v5.2.0

type ConditionalAccessPolicyConditionsPlatformsArgs struct {
	// A list of platforms explicitly excluded from the policy. Possible values are: `all`, `android`, `iOS`, `linux`, `macOS`, `windows`, `windowsPhone` or `unknownFutureValue`.
	ExcludedPlatforms pulumi.StringArrayInput `pulumi:"excludedPlatforms"`
	// A list of platforms the policy applies to, unless explicitly excluded. Possible values are: `all`, `android`, `iOS`, `linux`, `macOS`, `windows`, `windowsPhone` or `unknownFutureValue`.
	IncludedPlatforms pulumi.StringArrayInput `pulumi:"includedPlatforms"`
}

func (ConditionalAccessPolicyConditionsPlatformsArgs) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsPlatformsArgs) ToConditionalAccessPolicyConditionsPlatformsOutput added in v5.2.0

func (i ConditionalAccessPolicyConditionsPlatformsArgs) ToConditionalAccessPolicyConditionsPlatformsOutput() ConditionalAccessPolicyConditionsPlatformsOutput

func (ConditionalAccessPolicyConditionsPlatformsArgs) ToConditionalAccessPolicyConditionsPlatformsOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyConditionsPlatformsArgs) ToConditionalAccessPolicyConditionsPlatformsOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsPlatformsOutput

func (ConditionalAccessPolicyConditionsPlatformsArgs) ToConditionalAccessPolicyConditionsPlatformsPtrOutput added in v5.2.0

func (i ConditionalAccessPolicyConditionsPlatformsArgs) ToConditionalAccessPolicyConditionsPlatformsPtrOutput() ConditionalAccessPolicyConditionsPlatformsPtrOutput

func (ConditionalAccessPolicyConditionsPlatformsArgs) ToConditionalAccessPolicyConditionsPlatformsPtrOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyConditionsPlatformsArgs) ToConditionalAccessPolicyConditionsPlatformsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsPlatformsPtrOutput

type ConditionalAccessPolicyConditionsPlatformsInput added in v5.2.0

type ConditionalAccessPolicyConditionsPlatformsInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsPlatformsOutput() ConditionalAccessPolicyConditionsPlatformsOutput
	ToConditionalAccessPolicyConditionsPlatformsOutputWithContext(context.Context) ConditionalAccessPolicyConditionsPlatformsOutput
}

ConditionalAccessPolicyConditionsPlatformsInput is an input type that accepts ConditionalAccessPolicyConditionsPlatformsArgs and ConditionalAccessPolicyConditionsPlatformsOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsPlatformsInput` via:

ConditionalAccessPolicyConditionsPlatformsArgs{...}

type ConditionalAccessPolicyConditionsPlatformsOutput added in v5.2.0

type ConditionalAccessPolicyConditionsPlatformsOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsPlatformsOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsPlatformsOutput) ExcludedPlatforms added in v5.2.0

A list of platforms explicitly excluded from the policy. Possible values are: `all`, `android`, `iOS`, `linux`, `macOS`, `windows`, `windowsPhone` or `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsPlatformsOutput) IncludedPlatforms added in v5.2.0

A list of platforms the policy applies to, unless explicitly excluded. Possible values are: `all`, `android`, `iOS`, `linux`, `macOS`, `windows`, `windowsPhone` or `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsPlatformsOutput) ToConditionalAccessPolicyConditionsPlatformsOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsPlatformsOutput) ToConditionalAccessPolicyConditionsPlatformsOutput() ConditionalAccessPolicyConditionsPlatformsOutput

func (ConditionalAccessPolicyConditionsPlatformsOutput) ToConditionalAccessPolicyConditionsPlatformsOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsPlatformsOutput) ToConditionalAccessPolicyConditionsPlatformsOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsPlatformsOutput

func (ConditionalAccessPolicyConditionsPlatformsOutput) ToConditionalAccessPolicyConditionsPlatformsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsPlatformsOutput) ToConditionalAccessPolicyConditionsPlatformsPtrOutput() ConditionalAccessPolicyConditionsPlatformsPtrOutput

func (ConditionalAccessPolicyConditionsPlatformsOutput) ToConditionalAccessPolicyConditionsPlatformsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsPlatformsOutput) ToConditionalAccessPolicyConditionsPlatformsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsPlatformsPtrOutput

type ConditionalAccessPolicyConditionsPlatformsPtrInput added in v5.2.0

type ConditionalAccessPolicyConditionsPlatformsPtrInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsPlatformsPtrOutput() ConditionalAccessPolicyConditionsPlatformsPtrOutput
	ToConditionalAccessPolicyConditionsPlatformsPtrOutputWithContext(context.Context) ConditionalAccessPolicyConditionsPlatformsPtrOutput
}

ConditionalAccessPolicyConditionsPlatformsPtrInput is an input type that accepts ConditionalAccessPolicyConditionsPlatformsArgs, ConditionalAccessPolicyConditionsPlatformsPtr and ConditionalAccessPolicyConditionsPlatformsPtrOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsPlatformsPtrInput` via:

        ConditionalAccessPolicyConditionsPlatformsArgs{...}

or:

        nil

type ConditionalAccessPolicyConditionsPlatformsPtrOutput added in v5.2.0

type ConditionalAccessPolicyConditionsPlatformsPtrOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsPlatformsPtrOutput) Elem added in v5.2.0

func (ConditionalAccessPolicyConditionsPlatformsPtrOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsPlatformsPtrOutput) ExcludedPlatforms added in v5.2.0

A list of platforms explicitly excluded from the policy. Possible values are: `all`, `android`, `iOS`, `linux`, `macOS`, `windows`, `windowsPhone` or `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsPlatformsPtrOutput) IncludedPlatforms added in v5.2.0

A list of platforms the policy applies to, unless explicitly excluded. Possible values are: `all`, `android`, `iOS`, `linux`, `macOS`, `windows`, `windowsPhone` or `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsPlatformsPtrOutput) ToConditionalAccessPolicyConditionsPlatformsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsPlatformsPtrOutput) ToConditionalAccessPolicyConditionsPlatformsPtrOutput() ConditionalAccessPolicyConditionsPlatformsPtrOutput

func (ConditionalAccessPolicyConditionsPlatformsPtrOutput) ToConditionalAccessPolicyConditionsPlatformsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsPlatformsPtrOutput) ToConditionalAccessPolicyConditionsPlatformsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsPlatformsPtrOutput

type ConditionalAccessPolicyConditionsPtrInput added in v5.2.0

type ConditionalAccessPolicyConditionsPtrInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsPtrOutput() ConditionalAccessPolicyConditionsPtrOutput
	ToConditionalAccessPolicyConditionsPtrOutputWithContext(context.Context) ConditionalAccessPolicyConditionsPtrOutput
}

ConditionalAccessPolicyConditionsPtrInput is an input type that accepts ConditionalAccessPolicyConditionsArgs, ConditionalAccessPolicyConditionsPtr and ConditionalAccessPolicyConditionsPtrOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsPtrInput` via:

        ConditionalAccessPolicyConditionsArgs{...}

or:

        nil

type ConditionalAccessPolicyConditionsPtrOutput added in v5.2.0

type ConditionalAccessPolicyConditionsPtrOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsPtrOutput) Applications added in v5.2.0

An `applications` block as documented below, which specifies applications and user actions included in and excluded from the policy.

func (ConditionalAccessPolicyConditionsPtrOutput) ClientAppTypes added in v5.2.0

A list of client application types included in the policy. Possible values are: `all`, `browser`, `mobileAppsAndDesktopClients`, `exchangeActiveSync`, `easSupported` and `other`.

func (ConditionalAccessPolicyConditionsPtrOutput) ClientApplications added in v5.39.0

An `clientApplications` block as documented below, which specifies service principals included in and excluded from the policy.

func (ConditionalAccessPolicyConditionsPtrOutput) Devices added in v5.10.0

A `devices` block as documented below, which describes devices to be included in and excluded from the policy. A `devices` block can be added to an existing policy, but removing the `devices` block forces a new resource to be created.

func (ConditionalAccessPolicyConditionsPtrOutput) Elem added in v5.2.0

func (ConditionalAccessPolicyConditionsPtrOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsPtrOutput) Locations added in v5.2.0

A `locations` block as documented below, which specifies locations included in and excluded from the policy.

func (ConditionalAccessPolicyConditionsPtrOutput) Platforms added in v5.2.0

A `platforms` block as documented below, which specifies platforms included in and excluded from the policy.

func (ConditionalAccessPolicyConditionsPtrOutput) ServicePrincipalRiskLevels added in v5.40.0

A list of service principal sign-in risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `none`, `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsPtrOutput) SignInRiskLevels added in v5.2.0

A list of user sign-in risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsPtrOutput) ToConditionalAccessPolicyConditionsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsPtrOutput) ToConditionalAccessPolicyConditionsPtrOutput() ConditionalAccessPolicyConditionsPtrOutput

func (ConditionalAccessPolicyConditionsPtrOutput) ToConditionalAccessPolicyConditionsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsPtrOutput) ToConditionalAccessPolicyConditionsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsPtrOutput

func (ConditionalAccessPolicyConditionsPtrOutput) UserRiskLevels added in v5.2.0

A list of user risk levels included in the policy. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsPtrOutput) Users added in v5.2.0

A `users` block as documented below, which specifies users, groups, and roles included in and excluded from the policy.

type ConditionalAccessPolicyConditionsUsers added in v5.2.0

type ConditionalAccessPolicyConditionsUsers struct {
	// A list of group IDs excluded from scope of policy.
	ExcludedGroups []string `pulumi:"excludedGroups"`
	// A `guestsOrExternalUsers` block as documented below, which specifies internal guests and external users excluded from scope of policy.
	ExcludedGuestsOrExternalUsers []ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUser `pulumi:"excludedGuestsOrExternalUsers"`
	// A list of role IDs excluded from scope of policy.
	ExcludedRoles []string `pulumi:"excludedRoles"`
	// A list of user IDs excluded from scope of policy and/or `GuestsOrExternalUsers`.
	ExcludedUsers []string `pulumi:"excludedUsers"`
	// A list of group IDs in scope of policy unless explicitly excluded.
	IncludedGroups []string `pulumi:"includedGroups"`
	// A `guestsOrExternalUsers` block as documented below, which specifies internal guests and external users in scope of policy.
	IncludedGuestsOrExternalUsers []ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUser `pulumi:"includedGuestsOrExternalUsers"`
	// A list of role IDs in scope of policy unless explicitly excluded.
	IncludedRoles []string `pulumi:"includedRoles"`
	// A list of user IDs in scope of policy unless explicitly excluded, or `None` or `All` or `GuestsOrExternalUsers`.
	//
	// > At least one of `includedGroups`, `includedGuestsOrExternalUsers`, `includedRoles` or `includedUsers` must be specified.
	IncludedUsers []string `pulumi:"includedUsers"`
}

type ConditionalAccessPolicyConditionsUsersArgs added in v5.2.0

type ConditionalAccessPolicyConditionsUsersArgs struct {
	// A list of group IDs excluded from scope of policy.
	ExcludedGroups pulumi.StringArrayInput `pulumi:"excludedGroups"`
	// A `guestsOrExternalUsers` block as documented below, which specifies internal guests and external users excluded from scope of policy.
	ExcludedGuestsOrExternalUsers ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayInput `pulumi:"excludedGuestsOrExternalUsers"`
	// A list of role IDs excluded from scope of policy.
	ExcludedRoles pulumi.StringArrayInput `pulumi:"excludedRoles"`
	// A list of user IDs excluded from scope of policy and/or `GuestsOrExternalUsers`.
	ExcludedUsers pulumi.StringArrayInput `pulumi:"excludedUsers"`
	// A list of group IDs in scope of policy unless explicitly excluded.
	IncludedGroups pulumi.StringArrayInput `pulumi:"includedGroups"`
	// A `guestsOrExternalUsers` block as documented below, which specifies internal guests and external users in scope of policy.
	IncludedGuestsOrExternalUsers ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayInput `pulumi:"includedGuestsOrExternalUsers"`
	// A list of role IDs in scope of policy unless explicitly excluded.
	IncludedRoles pulumi.StringArrayInput `pulumi:"includedRoles"`
	// A list of user IDs in scope of policy unless explicitly excluded, or `None` or `All` or `GuestsOrExternalUsers`.
	//
	// > At least one of `includedGroups`, `includedGuestsOrExternalUsers`, `includedRoles` or `includedUsers` must be specified.
	IncludedUsers pulumi.StringArrayInput `pulumi:"includedUsers"`
}

func (ConditionalAccessPolicyConditionsUsersArgs) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsUsersArgs) ToConditionalAccessPolicyConditionsUsersOutput added in v5.2.0

func (i ConditionalAccessPolicyConditionsUsersArgs) ToConditionalAccessPolicyConditionsUsersOutput() ConditionalAccessPolicyConditionsUsersOutput

func (ConditionalAccessPolicyConditionsUsersArgs) ToConditionalAccessPolicyConditionsUsersOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyConditionsUsersArgs) ToConditionalAccessPolicyConditionsUsersOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsUsersOutput

func (ConditionalAccessPolicyConditionsUsersArgs) ToConditionalAccessPolicyConditionsUsersPtrOutput added in v5.2.0

func (i ConditionalAccessPolicyConditionsUsersArgs) ToConditionalAccessPolicyConditionsUsersPtrOutput() ConditionalAccessPolicyConditionsUsersPtrOutput

func (ConditionalAccessPolicyConditionsUsersArgs) ToConditionalAccessPolicyConditionsUsersPtrOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyConditionsUsersArgs) ToConditionalAccessPolicyConditionsUsersPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsUsersPtrOutput

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUser added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUser struct {
	// An `externalTenants` block as documented below, which specifies external tenants in a policy scope.
	ExternalTenants []ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenant `pulumi:"externalTenants"`
	// A list of guest or external user types. Possible values are: `b2bCollaborationGuest`, `b2bCollaborationMember`, `b2bDirectConnectUser`, `internalGuest`, `none`, `otherExternalUser`, `serviceProvider`, `unknownFutureValue`.
	GuestOrExternalUserTypes []string `pulumi:"guestOrExternalUserTypes"`
}

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArgs added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArgs struct {
	// An `externalTenants` block as documented below, which specifies external tenants in a policy scope.
	ExternalTenants ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayInput `pulumi:"externalTenants"`
	// A list of guest or external user types. Possible values are: `b2bCollaborationGuest`, `b2bCollaborationMember`, `b2bDirectConnectUser`, `internalGuest`, `none`, `otherExternalUser`, `serviceProvider`, `unknownFutureValue`.
	GuestOrExternalUserTypes pulumi.StringArrayInput `pulumi:"guestOrExternalUserTypes"`
}

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArgs) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArgs) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArgs) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutputWithContext added in v5.44.0

func (i ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArgs) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArray added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArray []ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserInput

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArray) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArray) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArray) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutputWithContext added in v5.44.0

func (i ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArray) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayInput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput() ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput
	ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutputWithContext(context.Context) ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput
}

ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayInput is an input type that accepts ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArray and ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayInput` via:

ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArray{ ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArgs{...} }

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput) Index added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutput) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArrayOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenant added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenant struct {
	// A list tenant IDs. Can only be specified if `membershipKind` is `enumerated`.
	Members []string `pulumi:"members"`
	// The external tenant membership kind. Possible values are: `all`, `enumerated`, `unknownFutureValue`.
	MembershipKind string `pulumi:"membershipKind"`
}

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArgs added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArgs struct {
	// A list tenant IDs. Can only be specified if `membershipKind` is `enumerated`.
	Members pulumi.StringArrayInput `pulumi:"members"`
	// The external tenant membership kind. Possible values are: `all`, `enumerated`, `unknownFutureValue`.
	MembershipKind pulumi.StringInput `pulumi:"membershipKind"`
}

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArgs) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArgs) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArgs) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArray added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArray []ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantInput

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArray) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArray) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArray) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayInput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput() ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput
	ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutputWithContext(context.Context) ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput
}

ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayInput is an input type that accepts ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArray and ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayInput` via:

ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArray{ ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArgs{...} }

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput) Index added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutput) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArrayOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantInput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput() ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput
	ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutputWithContext(context.Context) ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput
}

ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantInput is an input type that accepts ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArgs and ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantInput` via:

ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantArgs{...}

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput) Members added in v5.44.0

A list tenant IDs. Can only be specified if `membershipKind` is `enumerated`.

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput) MembershipKind added in v5.44.0

The external tenant membership kind. Possible values are: `all`, `enumerated`, `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutput) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserExternalTenantOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserInput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput() ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput
	ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutputWithContext(context.Context) ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput
}

ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserInput is an input type that accepts ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArgs and ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserInput` via:

ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserArgs{...}

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput) ExternalTenants added in v5.44.0

An `externalTenants` block as documented below, which specifies external tenants in a policy scope.

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput) GuestOrExternalUserTypes added in v5.44.0

A list of guest or external user types. Possible values are: `b2bCollaborationGuest`, `b2bCollaborationMember`, `b2bDirectConnectUser`, `internalGuest`, `none`, `otherExternalUser`, `serviceProvider`, `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutput) ToConditionalAccessPolicyConditionsUsersExcludedGuestsOrExternalUserOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUser added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUser struct {
	// An `externalTenants` block as documented below, which specifies external tenants in a policy scope.
	ExternalTenants []ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenant `pulumi:"externalTenants"`
	// A list of guest or external user types. Possible values are: `b2bCollaborationGuest`, `b2bCollaborationMember`, `b2bDirectConnectUser`, `internalGuest`, `none`, `otherExternalUser`, `serviceProvider`, `unknownFutureValue`.
	GuestOrExternalUserTypes []string `pulumi:"guestOrExternalUserTypes"`
}

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArgs added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArgs struct {
	// An `externalTenants` block as documented below, which specifies external tenants in a policy scope.
	ExternalTenants ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayInput `pulumi:"externalTenants"`
	// A list of guest or external user types. Possible values are: `b2bCollaborationGuest`, `b2bCollaborationMember`, `b2bDirectConnectUser`, `internalGuest`, `none`, `otherExternalUser`, `serviceProvider`, `unknownFutureValue`.
	GuestOrExternalUserTypes pulumi.StringArrayInput `pulumi:"guestOrExternalUserTypes"`
}

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArgs) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArgs) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArgs) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutputWithContext added in v5.44.0

func (i ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArgs) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArray added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArray []ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserInput

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArray) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArray) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArray) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutputWithContext added in v5.44.0

func (i ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArray) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayInput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput() ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput
	ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutputWithContext(context.Context) ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput
}

ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayInput is an input type that accepts ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArray and ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayInput` via:

ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArray{ ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArgs{...} }

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput) Index added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutput) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArrayOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenant added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenant struct {
	// A list tenant IDs. Can only be specified if `membershipKind` is `enumerated`.
	Members []string `pulumi:"members"`
	// The external tenant membership kind. Possible values are: `all`, `enumerated`, `unknownFutureValue`.
	MembershipKind string `pulumi:"membershipKind"`
}

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArgs added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArgs struct {
	// A list tenant IDs. Can only be specified if `membershipKind` is `enumerated`.
	Members pulumi.StringArrayInput `pulumi:"members"`
	// The external tenant membership kind. Possible values are: `all`, `enumerated`, `unknownFutureValue`.
	MembershipKind pulumi.StringInput `pulumi:"membershipKind"`
}

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArgs) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArgs) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArgs) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArray added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArray []ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantInput

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArray) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArray) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArray) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayInput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput() ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput
	ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutputWithContext(context.Context) ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput
}

ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayInput is an input type that accepts ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArray and ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayInput` via:

ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArray{ ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArgs{...} }

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput) Index added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutput) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArrayOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantInput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput() ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput
	ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutputWithContext(context.Context) ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput
}

ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantInput is an input type that accepts ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArgs and ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantInput` via:

ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantArgs{...}

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput) Members added in v5.44.0

A list tenant IDs. Can only be specified if `membershipKind` is `enumerated`.

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput) MembershipKind added in v5.44.0

The external tenant membership kind. Possible values are: `all`, `enumerated`, `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutput) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserExternalTenantOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserInput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput() ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput
	ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutputWithContext(context.Context) ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput
}

ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserInput is an input type that accepts ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArgs and ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserInput` via:

ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserArgs{...}

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput added in v5.44.0

type ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput) ElementType added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput) ExternalTenants added in v5.44.0

An `externalTenants` block as documented below, which specifies external tenants in a policy scope.

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput) GuestOrExternalUserTypes added in v5.44.0

A list of guest or external user types. Possible values are: `b2bCollaborationGuest`, `b2bCollaborationMember`, `b2bDirectConnectUser`, `internalGuest`, `none`, `otherExternalUser`, `serviceProvider`, `unknownFutureValue`.

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput added in v5.44.0

func (ConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutput) ToConditionalAccessPolicyConditionsUsersIncludedGuestsOrExternalUserOutputWithContext added in v5.44.0

type ConditionalAccessPolicyConditionsUsersInput added in v5.2.0

type ConditionalAccessPolicyConditionsUsersInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsUsersOutput() ConditionalAccessPolicyConditionsUsersOutput
	ToConditionalAccessPolicyConditionsUsersOutputWithContext(context.Context) ConditionalAccessPolicyConditionsUsersOutput
}

ConditionalAccessPolicyConditionsUsersInput is an input type that accepts ConditionalAccessPolicyConditionsUsersArgs and ConditionalAccessPolicyConditionsUsersOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsUsersInput` via:

ConditionalAccessPolicyConditionsUsersArgs{...}

type ConditionalAccessPolicyConditionsUsersOutput added in v5.2.0

type ConditionalAccessPolicyConditionsUsersOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsUsersOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsUsersOutput) ExcludedGroups added in v5.2.0

A list of group IDs excluded from scope of policy.

func (ConditionalAccessPolicyConditionsUsersOutput) ExcludedGuestsOrExternalUsers added in v5.44.0

A `guestsOrExternalUsers` block as documented below, which specifies internal guests and external users excluded from scope of policy.

func (ConditionalAccessPolicyConditionsUsersOutput) ExcludedRoles added in v5.2.0

A list of role IDs excluded from scope of policy.

func (ConditionalAccessPolicyConditionsUsersOutput) ExcludedUsers added in v5.2.0

A list of user IDs excluded from scope of policy and/or `GuestsOrExternalUsers`.

func (ConditionalAccessPolicyConditionsUsersOutput) IncludedGroups added in v5.2.0

A list of group IDs in scope of policy unless explicitly excluded.

func (ConditionalAccessPolicyConditionsUsersOutput) IncludedGuestsOrExternalUsers added in v5.44.0

A `guestsOrExternalUsers` block as documented below, which specifies internal guests and external users in scope of policy.

func (ConditionalAccessPolicyConditionsUsersOutput) IncludedRoles added in v5.2.0

A list of role IDs in scope of policy unless explicitly excluded.

func (ConditionalAccessPolicyConditionsUsersOutput) IncludedUsers added in v5.2.0

A list of user IDs in scope of policy unless explicitly excluded, or `None` or `All` or `GuestsOrExternalUsers`.

> At least one of `includedGroups`, `includedGuestsOrExternalUsers`, `includedRoles` or `includedUsers` must be specified.

func (ConditionalAccessPolicyConditionsUsersOutput) ToConditionalAccessPolicyConditionsUsersOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsUsersOutput) ToConditionalAccessPolicyConditionsUsersOutput() ConditionalAccessPolicyConditionsUsersOutput

func (ConditionalAccessPolicyConditionsUsersOutput) ToConditionalAccessPolicyConditionsUsersOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsUsersOutput) ToConditionalAccessPolicyConditionsUsersOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsUsersOutput

func (ConditionalAccessPolicyConditionsUsersOutput) ToConditionalAccessPolicyConditionsUsersPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsUsersOutput) ToConditionalAccessPolicyConditionsUsersPtrOutput() ConditionalAccessPolicyConditionsUsersPtrOutput

func (ConditionalAccessPolicyConditionsUsersOutput) ToConditionalAccessPolicyConditionsUsersPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsUsersOutput) ToConditionalAccessPolicyConditionsUsersPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsUsersPtrOutput

type ConditionalAccessPolicyConditionsUsersPtrInput added in v5.2.0

type ConditionalAccessPolicyConditionsUsersPtrInput interface {
	pulumi.Input

	ToConditionalAccessPolicyConditionsUsersPtrOutput() ConditionalAccessPolicyConditionsUsersPtrOutput
	ToConditionalAccessPolicyConditionsUsersPtrOutputWithContext(context.Context) ConditionalAccessPolicyConditionsUsersPtrOutput
}

ConditionalAccessPolicyConditionsUsersPtrInput is an input type that accepts ConditionalAccessPolicyConditionsUsersArgs, ConditionalAccessPolicyConditionsUsersPtr and ConditionalAccessPolicyConditionsUsersPtrOutput values. You can construct a concrete instance of `ConditionalAccessPolicyConditionsUsersPtrInput` via:

        ConditionalAccessPolicyConditionsUsersArgs{...}

or:

        nil

type ConditionalAccessPolicyConditionsUsersPtrOutput added in v5.2.0

type ConditionalAccessPolicyConditionsUsersPtrOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyConditionsUsersPtrOutput) Elem added in v5.2.0

func (ConditionalAccessPolicyConditionsUsersPtrOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyConditionsUsersPtrOutput) ExcludedGroups added in v5.2.0

A list of group IDs excluded from scope of policy.

func (ConditionalAccessPolicyConditionsUsersPtrOutput) ExcludedGuestsOrExternalUsers added in v5.44.0

A `guestsOrExternalUsers` block as documented below, which specifies internal guests and external users excluded from scope of policy.

func (ConditionalAccessPolicyConditionsUsersPtrOutput) ExcludedRoles added in v5.2.0

A list of role IDs excluded from scope of policy.

func (ConditionalAccessPolicyConditionsUsersPtrOutput) ExcludedUsers added in v5.2.0

A list of user IDs excluded from scope of policy and/or `GuestsOrExternalUsers`.

func (ConditionalAccessPolicyConditionsUsersPtrOutput) IncludedGroups added in v5.2.0

A list of group IDs in scope of policy unless explicitly excluded.

func (ConditionalAccessPolicyConditionsUsersPtrOutput) IncludedGuestsOrExternalUsers added in v5.44.0

A `guestsOrExternalUsers` block as documented below, which specifies internal guests and external users in scope of policy.

func (ConditionalAccessPolicyConditionsUsersPtrOutput) IncludedRoles added in v5.2.0

A list of role IDs in scope of policy unless explicitly excluded.

func (ConditionalAccessPolicyConditionsUsersPtrOutput) IncludedUsers added in v5.2.0

A list of user IDs in scope of policy unless explicitly excluded, or `None` or `All` or `GuestsOrExternalUsers`.

> At least one of `includedGroups`, `includedGuestsOrExternalUsers`, `includedRoles` or `includedUsers` must be specified.

func (ConditionalAccessPolicyConditionsUsersPtrOutput) ToConditionalAccessPolicyConditionsUsersPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyConditionsUsersPtrOutput) ToConditionalAccessPolicyConditionsUsersPtrOutput() ConditionalAccessPolicyConditionsUsersPtrOutput

func (ConditionalAccessPolicyConditionsUsersPtrOutput) ToConditionalAccessPolicyConditionsUsersPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyConditionsUsersPtrOutput) ToConditionalAccessPolicyConditionsUsersPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyConditionsUsersPtrOutput

type ConditionalAccessPolicyGrantControls added in v5.2.0

type ConditionalAccessPolicyGrantControls struct {
	// ID of an Authentication Strength Policy to use in this policy.
	AuthenticationStrengthPolicyId *string `pulumi:"authenticationStrengthPolicyId"`
	// List of built-in controls required by the policy. Possible values are: `block`, `mfa`, `approvedApplication`, `compliantApplication`, `compliantDevice`, `domainJoinedDevice`, `passwordChange` or `unknownFutureValue`.
	BuiltInControls []string `pulumi:"builtInControls"`
	// List of custom controls IDs required by the policy.
	CustomAuthenticationFactors []string `pulumi:"customAuthenticationFactors"`
	// Defines the relationship of the grant controls. Possible values are: `AND`, `OR`.
	Operator string `pulumi:"operator"`
	// List of terms of use IDs required by the policy.
	//
	// > At least one of `authenticationStrengthPolicyId`, `builtInControls` or `termsOfUse` must be specified.
	TermsOfUses []string `pulumi:"termsOfUses"`
}

type ConditionalAccessPolicyGrantControlsArgs added in v5.2.0

type ConditionalAccessPolicyGrantControlsArgs struct {
	// ID of an Authentication Strength Policy to use in this policy.
	AuthenticationStrengthPolicyId pulumi.StringPtrInput `pulumi:"authenticationStrengthPolicyId"`
	// List of built-in controls required by the policy. Possible values are: `block`, `mfa`, `approvedApplication`, `compliantApplication`, `compliantDevice`, `domainJoinedDevice`, `passwordChange` or `unknownFutureValue`.
	BuiltInControls pulumi.StringArrayInput `pulumi:"builtInControls"`
	// List of custom controls IDs required by the policy.
	CustomAuthenticationFactors pulumi.StringArrayInput `pulumi:"customAuthenticationFactors"`
	// Defines the relationship of the grant controls. Possible values are: `AND`, `OR`.
	Operator pulumi.StringInput `pulumi:"operator"`
	// List of terms of use IDs required by the policy.
	//
	// > At least one of `authenticationStrengthPolicyId`, `builtInControls` or `termsOfUse` must be specified.
	TermsOfUses pulumi.StringArrayInput `pulumi:"termsOfUses"`
}

func (ConditionalAccessPolicyGrantControlsArgs) ElementType added in v5.2.0

func (ConditionalAccessPolicyGrantControlsArgs) ToConditionalAccessPolicyGrantControlsOutput added in v5.2.0

func (i ConditionalAccessPolicyGrantControlsArgs) ToConditionalAccessPolicyGrantControlsOutput() ConditionalAccessPolicyGrantControlsOutput

func (ConditionalAccessPolicyGrantControlsArgs) ToConditionalAccessPolicyGrantControlsOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyGrantControlsArgs) ToConditionalAccessPolicyGrantControlsOutputWithContext(ctx context.Context) ConditionalAccessPolicyGrantControlsOutput

func (ConditionalAccessPolicyGrantControlsArgs) ToConditionalAccessPolicyGrantControlsPtrOutput added in v5.2.0

func (i ConditionalAccessPolicyGrantControlsArgs) ToConditionalAccessPolicyGrantControlsPtrOutput() ConditionalAccessPolicyGrantControlsPtrOutput

func (ConditionalAccessPolicyGrantControlsArgs) ToConditionalAccessPolicyGrantControlsPtrOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyGrantControlsArgs) ToConditionalAccessPolicyGrantControlsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyGrantControlsPtrOutput

type ConditionalAccessPolicyGrantControlsInput added in v5.2.0

type ConditionalAccessPolicyGrantControlsInput interface {
	pulumi.Input

	ToConditionalAccessPolicyGrantControlsOutput() ConditionalAccessPolicyGrantControlsOutput
	ToConditionalAccessPolicyGrantControlsOutputWithContext(context.Context) ConditionalAccessPolicyGrantControlsOutput
}

ConditionalAccessPolicyGrantControlsInput is an input type that accepts ConditionalAccessPolicyGrantControlsArgs and ConditionalAccessPolicyGrantControlsOutput values. You can construct a concrete instance of `ConditionalAccessPolicyGrantControlsInput` via:

ConditionalAccessPolicyGrantControlsArgs{...}

type ConditionalAccessPolicyGrantControlsOutput added in v5.2.0

type ConditionalAccessPolicyGrantControlsOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyGrantControlsOutput) AuthenticationStrengthPolicyId added in v5.43.0

func (o ConditionalAccessPolicyGrantControlsOutput) AuthenticationStrengthPolicyId() pulumi.StringPtrOutput

ID of an Authentication Strength Policy to use in this policy.

func (ConditionalAccessPolicyGrantControlsOutput) BuiltInControls added in v5.2.0

List of built-in controls required by the policy. Possible values are: `block`, `mfa`, `approvedApplication`, `compliantApplication`, `compliantDevice`, `domainJoinedDevice`, `passwordChange` or `unknownFutureValue`.

func (ConditionalAccessPolicyGrantControlsOutput) CustomAuthenticationFactors added in v5.2.0

List of custom controls IDs required by the policy.

func (ConditionalAccessPolicyGrantControlsOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyGrantControlsOutput) Operator added in v5.2.0

Defines the relationship of the grant controls. Possible values are: `AND`, `OR`.

func (ConditionalAccessPolicyGrantControlsOutput) TermsOfUses added in v5.2.0

List of terms of use IDs required by the policy.

> At least one of `authenticationStrengthPolicyId`, `builtInControls` or `termsOfUse` must be specified.

func (ConditionalAccessPolicyGrantControlsOutput) ToConditionalAccessPolicyGrantControlsOutput added in v5.2.0

func (o ConditionalAccessPolicyGrantControlsOutput) ToConditionalAccessPolicyGrantControlsOutput() ConditionalAccessPolicyGrantControlsOutput

func (ConditionalAccessPolicyGrantControlsOutput) ToConditionalAccessPolicyGrantControlsOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyGrantControlsOutput) ToConditionalAccessPolicyGrantControlsOutputWithContext(ctx context.Context) ConditionalAccessPolicyGrantControlsOutput

func (ConditionalAccessPolicyGrantControlsOutput) ToConditionalAccessPolicyGrantControlsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyGrantControlsOutput) ToConditionalAccessPolicyGrantControlsPtrOutput() ConditionalAccessPolicyGrantControlsPtrOutput

func (ConditionalAccessPolicyGrantControlsOutput) ToConditionalAccessPolicyGrantControlsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyGrantControlsOutput) ToConditionalAccessPolicyGrantControlsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyGrantControlsPtrOutput

type ConditionalAccessPolicyGrantControlsPtrInput added in v5.2.0

type ConditionalAccessPolicyGrantControlsPtrInput interface {
	pulumi.Input

	ToConditionalAccessPolicyGrantControlsPtrOutput() ConditionalAccessPolicyGrantControlsPtrOutput
	ToConditionalAccessPolicyGrantControlsPtrOutputWithContext(context.Context) ConditionalAccessPolicyGrantControlsPtrOutput
}

ConditionalAccessPolicyGrantControlsPtrInput is an input type that accepts ConditionalAccessPolicyGrantControlsArgs, ConditionalAccessPolicyGrantControlsPtr and ConditionalAccessPolicyGrantControlsPtrOutput values. You can construct a concrete instance of `ConditionalAccessPolicyGrantControlsPtrInput` via:

        ConditionalAccessPolicyGrantControlsArgs{...}

or:

        nil

type ConditionalAccessPolicyGrantControlsPtrOutput added in v5.2.0

type ConditionalAccessPolicyGrantControlsPtrOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyGrantControlsPtrOutput) AuthenticationStrengthPolicyId added in v5.43.0

func (o ConditionalAccessPolicyGrantControlsPtrOutput) AuthenticationStrengthPolicyId() pulumi.StringPtrOutput

ID of an Authentication Strength Policy to use in this policy.

func (ConditionalAccessPolicyGrantControlsPtrOutput) BuiltInControls added in v5.2.0

List of built-in controls required by the policy. Possible values are: `block`, `mfa`, `approvedApplication`, `compliantApplication`, `compliantDevice`, `domainJoinedDevice`, `passwordChange` or `unknownFutureValue`.

func (ConditionalAccessPolicyGrantControlsPtrOutput) CustomAuthenticationFactors added in v5.2.0

List of custom controls IDs required by the policy.

func (ConditionalAccessPolicyGrantControlsPtrOutput) Elem added in v5.2.0

func (ConditionalAccessPolicyGrantControlsPtrOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyGrantControlsPtrOutput) Operator added in v5.2.0

Defines the relationship of the grant controls. Possible values are: `AND`, `OR`.

func (ConditionalAccessPolicyGrantControlsPtrOutput) TermsOfUses added in v5.2.0

List of terms of use IDs required by the policy.

> At least one of `authenticationStrengthPolicyId`, `builtInControls` or `termsOfUse` must be specified.

func (ConditionalAccessPolicyGrantControlsPtrOutput) ToConditionalAccessPolicyGrantControlsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicyGrantControlsPtrOutput) ToConditionalAccessPolicyGrantControlsPtrOutput() ConditionalAccessPolicyGrantControlsPtrOutput

func (ConditionalAccessPolicyGrantControlsPtrOutput) ToConditionalAccessPolicyGrantControlsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyGrantControlsPtrOutput) ToConditionalAccessPolicyGrantControlsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicyGrantControlsPtrOutput

type ConditionalAccessPolicyInput added in v5.2.0

type ConditionalAccessPolicyInput interface {
	pulumi.Input

	ToConditionalAccessPolicyOutput() ConditionalAccessPolicyOutput
	ToConditionalAccessPolicyOutputWithContext(ctx context.Context) ConditionalAccessPolicyOutput
}

type ConditionalAccessPolicyMap added in v5.2.0

type ConditionalAccessPolicyMap map[string]ConditionalAccessPolicyInput

func (ConditionalAccessPolicyMap) ElementType added in v5.2.0

func (ConditionalAccessPolicyMap) ElementType() reflect.Type

func (ConditionalAccessPolicyMap) ToConditionalAccessPolicyMapOutput added in v5.2.0

func (i ConditionalAccessPolicyMap) ToConditionalAccessPolicyMapOutput() ConditionalAccessPolicyMapOutput

func (ConditionalAccessPolicyMap) ToConditionalAccessPolicyMapOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicyMap) ToConditionalAccessPolicyMapOutputWithContext(ctx context.Context) ConditionalAccessPolicyMapOutput

type ConditionalAccessPolicyMapInput added in v5.2.0

type ConditionalAccessPolicyMapInput interface {
	pulumi.Input

	ToConditionalAccessPolicyMapOutput() ConditionalAccessPolicyMapOutput
	ToConditionalAccessPolicyMapOutputWithContext(context.Context) ConditionalAccessPolicyMapOutput
}

ConditionalAccessPolicyMapInput is an input type that accepts ConditionalAccessPolicyMap and ConditionalAccessPolicyMapOutput values. You can construct a concrete instance of `ConditionalAccessPolicyMapInput` via:

ConditionalAccessPolicyMap{ "key": ConditionalAccessPolicyArgs{...} }

type ConditionalAccessPolicyMapOutput added in v5.2.0

type ConditionalAccessPolicyMapOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyMapOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyMapOutput) MapIndex added in v5.2.0

func (ConditionalAccessPolicyMapOutput) ToConditionalAccessPolicyMapOutput added in v5.2.0

func (o ConditionalAccessPolicyMapOutput) ToConditionalAccessPolicyMapOutput() ConditionalAccessPolicyMapOutput

func (ConditionalAccessPolicyMapOutput) ToConditionalAccessPolicyMapOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyMapOutput) ToConditionalAccessPolicyMapOutputWithContext(ctx context.Context) ConditionalAccessPolicyMapOutput

type ConditionalAccessPolicyOutput added in v5.2.0

type ConditionalAccessPolicyOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicyOutput) Conditions added in v5.22.0

A `conditions` block as documented below, which specifies the rules that must be met for the policy to apply.

func (ConditionalAccessPolicyOutput) DisplayName added in v5.22.0

The friendly name for this Conditional Access Policy.

func (ConditionalAccessPolicyOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicyOutput) GrantControls added in v5.22.0

A `grantControls` block as documented below, which specifies the grant controls that must be fulfilled to pass the policy.

func (ConditionalAccessPolicyOutput) SessionControls added in v5.22.0

A `sessionControls` block as documented below, which specifies the session controls that are enforced after sign-in.

> Note: At least one of `grantControls` and/or `sessionControls` blocks must be specified.

func (ConditionalAccessPolicyOutput) State added in v5.22.0

Specifies the state of the policy object. Possible values are: `enabled`, `disabled` and `enabledForReportingButNotEnforced`

func (ConditionalAccessPolicyOutput) ToConditionalAccessPolicyOutput added in v5.2.0

func (o ConditionalAccessPolicyOutput) ToConditionalAccessPolicyOutput() ConditionalAccessPolicyOutput

func (ConditionalAccessPolicyOutput) ToConditionalAccessPolicyOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicyOutput) ToConditionalAccessPolicyOutputWithContext(ctx context.Context) ConditionalAccessPolicyOutput

type ConditionalAccessPolicySessionControls added in v5.2.0

type ConditionalAccessPolicySessionControls struct {
	// Whether application enforced restrictions are enabled. Defaults to `false`.
	//
	// > Only Office 365, Exchange Online and Sharepoint Online support application enforced restrictions.
	ApplicationEnforcedRestrictionsEnabled *bool `pulumi:"applicationEnforcedRestrictionsEnabled"`
	// Enables cloud app security and specifies the cloud app security policy to use. Possible values are: `blockDownloads`, `mcasConfigured`, `monitorOnly` or `unknownFutureValue`.
	CloudAppSecurityPolicy *string `pulumi:"cloudAppSecurityPolicy"`
	// Disables [resilience defaults](https://learn.microsoft.com/en-us/azure/active-directory/conditional-access/resilience-defaults). Defaults to `false`.
	DisableResilienceDefaults *bool `pulumi:"disableResilienceDefaults"`
	// Session control to define whether to persist cookies. Possible values are: `always` or `never`.
	PersistentBrowserMode *string `pulumi:"persistentBrowserMode"`
	// Number of days or hours to enforce sign-in frequency. Required when `signInFrequencyPeriod` is specified.
	SignInFrequency *int `pulumi:"signInFrequency"`
	// Authentication type for enforcing sign-in frequency. Possible values are: `primaryAndSecondaryAuthentication` or `secondaryAuthentication`. Defaults to `primaryAndSecondaryAuthentication`.
	SignInFrequencyAuthenticationType *string `pulumi:"signInFrequencyAuthenticationType"`
	// The interval to apply to sign-in frequency control. Possible values are: `timeBased` or `everyTime`. Defaults to `timeBased`.
	SignInFrequencyInterval *string `pulumi:"signInFrequencyInterval"`
	// The time period to enforce sign-in frequency. Possible values are: `hours` or `days`. Required when `signInFrequencyPeriod` is specified.
	SignInFrequencyPeriod *string `pulumi:"signInFrequencyPeriod"`
}

type ConditionalAccessPolicySessionControlsArgs added in v5.2.0

type ConditionalAccessPolicySessionControlsArgs struct {
	// Whether application enforced restrictions are enabled. Defaults to `false`.
	//
	// > Only Office 365, Exchange Online and Sharepoint Online support application enforced restrictions.
	ApplicationEnforcedRestrictionsEnabled pulumi.BoolPtrInput `pulumi:"applicationEnforcedRestrictionsEnabled"`
	// Enables cloud app security and specifies the cloud app security policy to use. Possible values are: `blockDownloads`, `mcasConfigured`, `monitorOnly` or `unknownFutureValue`.
	CloudAppSecurityPolicy pulumi.StringPtrInput `pulumi:"cloudAppSecurityPolicy"`
	// Disables [resilience defaults](https://learn.microsoft.com/en-us/azure/active-directory/conditional-access/resilience-defaults). Defaults to `false`.
	DisableResilienceDefaults pulumi.BoolPtrInput `pulumi:"disableResilienceDefaults"`
	// Session control to define whether to persist cookies. Possible values are: `always` or `never`.
	PersistentBrowserMode pulumi.StringPtrInput `pulumi:"persistentBrowserMode"`
	// Number of days or hours to enforce sign-in frequency. Required when `signInFrequencyPeriod` is specified.
	SignInFrequency pulumi.IntPtrInput `pulumi:"signInFrequency"`
	// Authentication type for enforcing sign-in frequency. Possible values are: `primaryAndSecondaryAuthentication` or `secondaryAuthentication`. Defaults to `primaryAndSecondaryAuthentication`.
	SignInFrequencyAuthenticationType pulumi.StringPtrInput `pulumi:"signInFrequencyAuthenticationType"`
	// The interval to apply to sign-in frequency control. Possible values are: `timeBased` or `everyTime`. Defaults to `timeBased`.
	SignInFrequencyInterval pulumi.StringPtrInput `pulumi:"signInFrequencyInterval"`
	// The time period to enforce sign-in frequency. Possible values are: `hours` or `days`. Required when `signInFrequencyPeriod` is specified.
	SignInFrequencyPeriod pulumi.StringPtrInput `pulumi:"signInFrequencyPeriod"`
}

func (ConditionalAccessPolicySessionControlsArgs) ElementType added in v5.2.0

func (ConditionalAccessPolicySessionControlsArgs) ToConditionalAccessPolicySessionControlsOutput added in v5.2.0

func (i ConditionalAccessPolicySessionControlsArgs) ToConditionalAccessPolicySessionControlsOutput() ConditionalAccessPolicySessionControlsOutput

func (ConditionalAccessPolicySessionControlsArgs) ToConditionalAccessPolicySessionControlsOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicySessionControlsArgs) ToConditionalAccessPolicySessionControlsOutputWithContext(ctx context.Context) ConditionalAccessPolicySessionControlsOutput

func (ConditionalAccessPolicySessionControlsArgs) ToConditionalAccessPolicySessionControlsPtrOutput added in v5.2.0

func (i ConditionalAccessPolicySessionControlsArgs) ToConditionalAccessPolicySessionControlsPtrOutput() ConditionalAccessPolicySessionControlsPtrOutput

func (ConditionalAccessPolicySessionControlsArgs) ToConditionalAccessPolicySessionControlsPtrOutputWithContext added in v5.2.0

func (i ConditionalAccessPolicySessionControlsArgs) ToConditionalAccessPolicySessionControlsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicySessionControlsPtrOutput

type ConditionalAccessPolicySessionControlsInput added in v5.2.0

type ConditionalAccessPolicySessionControlsInput interface {
	pulumi.Input

	ToConditionalAccessPolicySessionControlsOutput() ConditionalAccessPolicySessionControlsOutput
	ToConditionalAccessPolicySessionControlsOutputWithContext(context.Context) ConditionalAccessPolicySessionControlsOutput
}

ConditionalAccessPolicySessionControlsInput is an input type that accepts ConditionalAccessPolicySessionControlsArgs and ConditionalAccessPolicySessionControlsOutput values. You can construct a concrete instance of `ConditionalAccessPolicySessionControlsInput` via:

ConditionalAccessPolicySessionControlsArgs{...}

type ConditionalAccessPolicySessionControlsOutput added in v5.2.0

type ConditionalAccessPolicySessionControlsOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicySessionControlsOutput) ApplicationEnforcedRestrictionsEnabled added in v5.2.0

func (o ConditionalAccessPolicySessionControlsOutput) ApplicationEnforcedRestrictionsEnabled() pulumi.BoolPtrOutput

Whether application enforced restrictions are enabled. Defaults to `false`.

> Only Office 365, Exchange Online and Sharepoint Online support application enforced restrictions.

func (ConditionalAccessPolicySessionControlsOutput) CloudAppSecurityPolicy added in v5.2.0

Enables cloud app security and specifies the cloud app security policy to use. Possible values are: `blockDownloads`, `mcasConfigured`, `monitorOnly` or `unknownFutureValue`.

func (ConditionalAccessPolicySessionControlsOutput) DisableResilienceDefaults added in v5.39.0

Disables [resilience defaults](https://learn.microsoft.com/en-us/azure/active-directory/conditional-access/resilience-defaults). Defaults to `false`.

func (ConditionalAccessPolicySessionControlsOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicySessionControlsOutput) PersistentBrowserMode added in v5.11.0

Session control to define whether to persist cookies. Possible values are: `always` or `never`.

func (ConditionalAccessPolicySessionControlsOutput) SignInFrequency added in v5.2.0

Number of days or hours to enforce sign-in frequency. Required when `signInFrequencyPeriod` is specified.

func (ConditionalAccessPolicySessionControlsOutput) SignInFrequencyAuthenticationType added in v5.44.0

func (o ConditionalAccessPolicySessionControlsOutput) SignInFrequencyAuthenticationType() pulumi.StringPtrOutput

Authentication type for enforcing sign-in frequency. Possible values are: `primaryAndSecondaryAuthentication` or `secondaryAuthentication`. Defaults to `primaryAndSecondaryAuthentication`.

func (ConditionalAccessPolicySessionControlsOutput) SignInFrequencyInterval added in v5.44.0

The interval to apply to sign-in frequency control. Possible values are: `timeBased` or `everyTime`. Defaults to `timeBased`.

func (ConditionalAccessPolicySessionControlsOutput) SignInFrequencyPeriod added in v5.2.0

The time period to enforce sign-in frequency. Possible values are: `hours` or `days`. Required when `signInFrequencyPeriod` is specified.

func (ConditionalAccessPolicySessionControlsOutput) ToConditionalAccessPolicySessionControlsOutput added in v5.2.0

func (o ConditionalAccessPolicySessionControlsOutput) ToConditionalAccessPolicySessionControlsOutput() ConditionalAccessPolicySessionControlsOutput

func (ConditionalAccessPolicySessionControlsOutput) ToConditionalAccessPolicySessionControlsOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicySessionControlsOutput) ToConditionalAccessPolicySessionControlsOutputWithContext(ctx context.Context) ConditionalAccessPolicySessionControlsOutput

func (ConditionalAccessPolicySessionControlsOutput) ToConditionalAccessPolicySessionControlsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicySessionControlsOutput) ToConditionalAccessPolicySessionControlsPtrOutput() ConditionalAccessPolicySessionControlsPtrOutput

func (ConditionalAccessPolicySessionControlsOutput) ToConditionalAccessPolicySessionControlsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicySessionControlsOutput) ToConditionalAccessPolicySessionControlsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicySessionControlsPtrOutput

type ConditionalAccessPolicySessionControlsPtrInput added in v5.2.0

type ConditionalAccessPolicySessionControlsPtrInput interface {
	pulumi.Input

	ToConditionalAccessPolicySessionControlsPtrOutput() ConditionalAccessPolicySessionControlsPtrOutput
	ToConditionalAccessPolicySessionControlsPtrOutputWithContext(context.Context) ConditionalAccessPolicySessionControlsPtrOutput
}

ConditionalAccessPolicySessionControlsPtrInput is an input type that accepts ConditionalAccessPolicySessionControlsArgs, ConditionalAccessPolicySessionControlsPtr and ConditionalAccessPolicySessionControlsPtrOutput values. You can construct a concrete instance of `ConditionalAccessPolicySessionControlsPtrInput` via:

        ConditionalAccessPolicySessionControlsArgs{...}

or:

        nil

type ConditionalAccessPolicySessionControlsPtrOutput added in v5.2.0

type ConditionalAccessPolicySessionControlsPtrOutput struct{ *pulumi.OutputState }

func (ConditionalAccessPolicySessionControlsPtrOutput) ApplicationEnforcedRestrictionsEnabled added in v5.2.0

func (o ConditionalAccessPolicySessionControlsPtrOutput) ApplicationEnforcedRestrictionsEnabled() pulumi.BoolPtrOutput

Whether application enforced restrictions are enabled. Defaults to `false`.

> Only Office 365, Exchange Online and Sharepoint Online support application enforced restrictions.

func (ConditionalAccessPolicySessionControlsPtrOutput) CloudAppSecurityPolicy added in v5.2.0

Enables cloud app security and specifies the cloud app security policy to use. Possible values are: `blockDownloads`, `mcasConfigured`, `monitorOnly` or `unknownFutureValue`.

func (ConditionalAccessPolicySessionControlsPtrOutput) DisableResilienceDefaults added in v5.39.0

Disables [resilience defaults](https://learn.microsoft.com/en-us/azure/active-directory/conditional-access/resilience-defaults). Defaults to `false`.

func (ConditionalAccessPolicySessionControlsPtrOutput) Elem added in v5.2.0

func (ConditionalAccessPolicySessionControlsPtrOutput) ElementType added in v5.2.0

func (ConditionalAccessPolicySessionControlsPtrOutput) PersistentBrowserMode added in v5.11.0

Session control to define whether to persist cookies. Possible values are: `always` or `never`.

func (ConditionalAccessPolicySessionControlsPtrOutput) SignInFrequency added in v5.2.0

Number of days or hours to enforce sign-in frequency. Required when `signInFrequencyPeriod` is specified.

func (ConditionalAccessPolicySessionControlsPtrOutput) SignInFrequencyAuthenticationType added in v5.44.0

func (o ConditionalAccessPolicySessionControlsPtrOutput) SignInFrequencyAuthenticationType() pulumi.StringPtrOutput

Authentication type for enforcing sign-in frequency. Possible values are: `primaryAndSecondaryAuthentication` or `secondaryAuthentication`. Defaults to `primaryAndSecondaryAuthentication`.

func (ConditionalAccessPolicySessionControlsPtrOutput) SignInFrequencyInterval added in v5.44.0

The interval to apply to sign-in frequency control. Possible values are: `timeBased` or `everyTime`. Defaults to `timeBased`.

func (ConditionalAccessPolicySessionControlsPtrOutput) SignInFrequencyPeriod added in v5.2.0

The time period to enforce sign-in frequency. Possible values are: `hours` or `days`. Required when `signInFrequencyPeriod` is specified.

func (ConditionalAccessPolicySessionControlsPtrOutput) ToConditionalAccessPolicySessionControlsPtrOutput added in v5.2.0

func (o ConditionalAccessPolicySessionControlsPtrOutput) ToConditionalAccessPolicySessionControlsPtrOutput() ConditionalAccessPolicySessionControlsPtrOutput

func (ConditionalAccessPolicySessionControlsPtrOutput) ToConditionalAccessPolicySessionControlsPtrOutputWithContext added in v5.2.0

func (o ConditionalAccessPolicySessionControlsPtrOutput) ToConditionalAccessPolicySessionControlsPtrOutputWithContext(ctx context.Context) ConditionalAccessPolicySessionControlsPtrOutput

type ConditionalAccessPolicyState added in v5.2.0

type ConditionalAccessPolicyState struct {
	// A `conditions` block as documented below, which specifies the rules that must be met for the policy to apply.
	Conditions ConditionalAccessPolicyConditionsPtrInput
	// The friendly name for this Conditional Access Policy.
	DisplayName pulumi.StringPtrInput
	// A `grantControls` block as documented below, which specifies the grant controls that must be fulfilled to pass the policy.
	GrantControls ConditionalAccessPolicyGrantControlsPtrInput
	// A `sessionControls` block as documented below, which specifies the session controls that are enforced after sign-in.
	//
	// > Note: At least one of `grantControls` and/or `sessionControls` blocks must be specified.
	SessionControls ConditionalAccessPolicySessionControlsPtrInput
	// Specifies the state of the policy object. Possible values are: `enabled`, `disabled` and `enabledForReportingButNotEnforced`
	State pulumi.StringPtrInput
}

func (ConditionalAccessPolicyState) ElementType added in v5.2.0

type CustomDirectoryRole added in v5.16.0

type CustomDirectoryRole struct {
	pulumi.CustomResourceState

	// The description of the custom directory role.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The display name of the custom directory role.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Indicates whether the role is enabled for assignment.
	Enabled pulumi.BoolOutput `pulumi:"enabled"`
	// The object ID of the custom directory role.
	ObjectId pulumi.StringOutput `pulumi:"objectId"`
	// A collection of `permissions` blocks as documented below.
	Permissions CustomDirectoryRolePermissionArrayOutput `pulumi:"permissions"`
	// Custom template identifier that is typically used if one needs an identifier to be the same across different directories. Changing this forces a new resource to be created.
	TemplateId pulumi.StringOutput `pulumi:"templateId"`
	// The version of the role definition. This can be any arbitrary string between 1-128 characters.
	Version pulumi.StringOutput `pulumi:"version"`
}

Manages a Custom Directory Role within Azure Active Directory.

This resource is for managing custom directory roles. For management of built-in roles, see the DirectoryRole resource.

## API Permissions

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

When authenticated with a service principal, this resource requires one of the following application roles: `RoleManagement.ReadWrite.Directory` or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Privileged Role Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.NewCustomDirectoryRole(ctx, "example", &azuread.CustomDirectoryRoleArgs{
			DisplayName: pulumi.String("My Custom Role"),
			Description: pulumi.String("Allows reading applications and updating groups"),
			Enabled:     pulumi.Bool(true),
			Version:     pulumi.String("1.0"),
			Permissions: azuread.CustomDirectoryRolePermissionArray{
				&azuread.CustomDirectoryRolePermissionArgs{
					AllowedResourceActions: pulumi.StringArray{
						pulumi.String("microsoft.directory/applications/basic/update"),
						pulumi.String("microsoft.directory/applications/create"),
						pulumi.String("microsoft.directory/applications/standard/read"),
					},
				},
				&azuread.CustomDirectoryRolePermissionArgs{
					AllowedResourceActions: pulumi.StringArray{
						pulumi.String("microsoft.directory/groups/allProperties/read"),
						pulumi.String("microsoft.directory/groups/allProperties/read"),
						pulumi.String("microsoft.directory/groups/basic/update"),
						pulumi.String("microsoft.directory/groups/create"),
						pulumi.String("microsoft.directory/groups/delete"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

This resource does not support importing.

func GetCustomDirectoryRole added in v5.16.0

func GetCustomDirectoryRole(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CustomDirectoryRoleState, opts ...pulumi.ResourceOption) (*CustomDirectoryRole, error)

GetCustomDirectoryRole gets an existing CustomDirectoryRole resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCustomDirectoryRole added in v5.16.0

func NewCustomDirectoryRole(ctx *pulumi.Context,
	name string, args *CustomDirectoryRoleArgs, opts ...pulumi.ResourceOption) (*CustomDirectoryRole, error)

NewCustomDirectoryRole registers a new resource with the given unique name, arguments, and options.

func (*CustomDirectoryRole) ElementType added in v5.16.0

func (*CustomDirectoryRole) ElementType() reflect.Type

func (*CustomDirectoryRole) ToCustomDirectoryRoleOutput added in v5.16.0

func (i *CustomDirectoryRole) ToCustomDirectoryRoleOutput() CustomDirectoryRoleOutput

func (*CustomDirectoryRole) ToCustomDirectoryRoleOutputWithContext added in v5.16.0

func (i *CustomDirectoryRole) ToCustomDirectoryRoleOutputWithContext(ctx context.Context) CustomDirectoryRoleOutput

type CustomDirectoryRoleArgs added in v5.16.0

type CustomDirectoryRoleArgs struct {
	// The description of the custom directory role.
	Description pulumi.StringPtrInput
	// The display name of the custom directory role.
	DisplayName pulumi.StringInput
	// Indicates whether the role is enabled for assignment.
	Enabled pulumi.BoolInput
	// A collection of `permissions` blocks as documented below.
	Permissions CustomDirectoryRolePermissionArrayInput
	// Custom template identifier that is typically used if one needs an identifier to be the same across different directories. Changing this forces a new resource to be created.
	TemplateId pulumi.StringPtrInput
	// The version of the role definition. This can be any arbitrary string between 1-128 characters.
	Version pulumi.StringInput
}

The set of arguments for constructing a CustomDirectoryRole resource.

func (CustomDirectoryRoleArgs) ElementType added in v5.16.0

func (CustomDirectoryRoleArgs) ElementType() reflect.Type

type CustomDirectoryRoleArray added in v5.16.0

type CustomDirectoryRoleArray []CustomDirectoryRoleInput

func (CustomDirectoryRoleArray) ElementType added in v5.16.0

func (CustomDirectoryRoleArray) ElementType() reflect.Type

func (CustomDirectoryRoleArray) ToCustomDirectoryRoleArrayOutput added in v5.16.0

func (i CustomDirectoryRoleArray) ToCustomDirectoryRoleArrayOutput() CustomDirectoryRoleArrayOutput

func (CustomDirectoryRoleArray) ToCustomDirectoryRoleArrayOutputWithContext added in v5.16.0

func (i CustomDirectoryRoleArray) ToCustomDirectoryRoleArrayOutputWithContext(ctx context.Context) CustomDirectoryRoleArrayOutput

type CustomDirectoryRoleArrayInput added in v5.16.0

type CustomDirectoryRoleArrayInput interface {
	pulumi.Input

	ToCustomDirectoryRoleArrayOutput() CustomDirectoryRoleArrayOutput
	ToCustomDirectoryRoleArrayOutputWithContext(context.Context) CustomDirectoryRoleArrayOutput
}

CustomDirectoryRoleArrayInput is an input type that accepts CustomDirectoryRoleArray and CustomDirectoryRoleArrayOutput values. You can construct a concrete instance of `CustomDirectoryRoleArrayInput` via:

CustomDirectoryRoleArray{ CustomDirectoryRoleArgs{...} }

type CustomDirectoryRoleArrayOutput added in v5.16.0

type CustomDirectoryRoleArrayOutput struct{ *pulumi.OutputState }

func (CustomDirectoryRoleArrayOutput) ElementType added in v5.16.0

func (CustomDirectoryRoleArrayOutput) Index added in v5.16.0

func (CustomDirectoryRoleArrayOutput) ToCustomDirectoryRoleArrayOutput added in v5.16.0

func (o CustomDirectoryRoleArrayOutput) ToCustomDirectoryRoleArrayOutput() CustomDirectoryRoleArrayOutput

func (CustomDirectoryRoleArrayOutput) ToCustomDirectoryRoleArrayOutputWithContext added in v5.16.0

func (o CustomDirectoryRoleArrayOutput) ToCustomDirectoryRoleArrayOutputWithContext(ctx context.Context) CustomDirectoryRoleArrayOutput

type CustomDirectoryRoleInput added in v5.16.0

type CustomDirectoryRoleInput interface {
	pulumi.Input

	ToCustomDirectoryRoleOutput() CustomDirectoryRoleOutput
	ToCustomDirectoryRoleOutputWithContext(ctx context.Context) CustomDirectoryRoleOutput
}

type CustomDirectoryRoleMap added in v5.16.0

type CustomDirectoryRoleMap map[string]CustomDirectoryRoleInput

func (CustomDirectoryRoleMap) ElementType added in v5.16.0

func (CustomDirectoryRoleMap) ElementType() reflect.Type

func (CustomDirectoryRoleMap) ToCustomDirectoryRoleMapOutput added in v5.16.0

func (i CustomDirectoryRoleMap) ToCustomDirectoryRoleMapOutput() CustomDirectoryRoleMapOutput

func (CustomDirectoryRoleMap) ToCustomDirectoryRoleMapOutputWithContext added in v5.16.0

func (i CustomDirectoryRoleMap) ToCustomDirectoryRoleMapOutputWithContext(ctx context.Context) CustomDirectoryRoleMapOutput

type CustomDirectoryRoleMapInput added in v5.16.0

type CustomDirectoryRoleMapInput interface {
	pulumi.Input

	ToCustomDirectoryRoleMapOutput() CustomDirectoryRoleMapOutput
	ToCustomDirectoryRoleMapOutputWithContext(context.Context) CustomDirectoryRoleMapOutput
}

CustomDirectoryRoleMapInput is an input type that accepts CustomDirectoryRoleMap and CustomDirectoryRoleMapOutput values. You can construct a concrete instance of `CustomDirectoryRoleMapInput` via:

CustomDirectoryRoleMap{ "key": CustomDirectoryRoleArgs{...} }

type CustomDirectoryRoleMapOutput added in v5.16.0

type CustomDirectoryRoleMapOutput struct{ *pulumi.OutputState }

func (CustomDirectoryRoleMapOutput) ElementType added in v5.16.0

func (CustomDirectoryRoleMapOutput) MapIndex added in v5.16.0

func (CustomDirectoryRoleMapOutput) ToCustomDirectoryRoleMapOutput added in v5.16.0

func (o CustomDirectoryRoleMapOutput) ToCustomDirectoryRoleMapOutput() CustomDirectoryRoleMapOutput

func (CustomDirectoryRoleMapOutput) ToCustomDirectoryRoleMapOutputWithContext added in v5.16.0

func (o CustomDirectoryRoleMapOutput) ToCustomDirectoryRoleMapOutputWithContext(ctx context.Context) CustomDirectoryRoleMapOutput

type CustomDirectoryRoleOutput added in v5.16.0

type CustomDirectoryRoleOutput struct{ *pulumi.OutputState }

func (CustomDirectoryRoleOutput) Description added in v5.22.0

The description of the custom directory role.

func (CustomDirectoryRoleOutput) DisplayName added in v5.22.0

The display name of the custom directory role.

func (CustomDirectoryRoleOutput) ElementType added in v5.16.0

func (CustomDirectoryRoleOutput) ElementType() reflect.Type

func (CustomDirectoryRoleOutput) Enabled added in v5.22.0

Indicates whether the role is enabled for assignment.

func (CustomDirectoryRoleOutput) ObjectId added in v5.22.0

The object ID of the custom directory role.

func (CustomDirectoryRoleOutput) Permissions added in v5.22.0

A collection of `permissions` blocks as documented below.

func (CustomDirectoryRoleOutput) TemplateId added in v5.22.0

Custom template identifier that is typically used if one needs an identifier to be the same across different directories. Changing this forces a new resource to be created.

func (CustomDirectoryRoleOutput) ToCustomDirectoryRoleOutput added in v5.16.0

func (o CustomDirectoryRoleOutput) ToCustomDirectoryRoleOutput() CustomDirectoryRoleOutput

func (CustomDirectoryRoleOutput) ToCustomDirectoryRoleOutputWithContext added in v5.16.0

func (o CustomDirectoryRoleOutput) ToCustomDirectoryRoleOutputWithContext(ctx context.Context) CustomDirectoryRoleOutput

func (CustomDirectoryRoleOutput) Version added in v5.22.0

The version of the role definition. This can be any arbitrary string between 1-128 characters.

type CustomDirectoryRolePermission added in v5.16.0

type CustomDirectoryRolePermission struct {
	// A set of tasks that can be performed on a resource. For more information, see the [Permissions Reference](https://docs.microsoft.com/en-us/azure/active-directory/roles/permissions-reference) documentation.
	AllowedResourceActions []string `pulumi:"allowedResourceActions"`
}

type CustomDirectoryRolePermissionArgs added in v5.16.0

type CustomDirectoryRolePermissionArgs struct {
	// A set of tasks that can be performed on a resource. For more information, see the [Permissions Reference](https://docs.microsoft.com/en-us/azure/active-directory/roles/permissions-reference) documentation.
	AllowedResourceActions pulumi.StringArrayInput `pulumi:"allowedResourceActions"`
}

func (CustomDirectoryRolePermissionArgs) ElementType added in v5.16.0

func (CustomDirectoryRolePermissionArgs) ToCustomDirectoryRolePermissionOutput added in v5.16.0

func (i CustomDirectoryRolePermissionArgs) ToCustomDirectoryRolePermissionOutput() CustomDirectoryRolePermissionOutput

func (CustomDirectoryRolePermissionArgs) ToCustomDirectoryRolePermissionOutputWithContext added in v5.16.0

func (i CustomDirectoryRolePermissionArgs) ToCustomDirectoryRolePermissionOutputWithContext(ctx context.Context) CustomDirectoryRolePermissionOutput

type CustomDirectoryRolePermissionArray added in v5.16.0

type CustomDirectoryRolePermissionArray []CustomDirectoryRolePermissionInput

func (CustomDirectoryRolePermissionArray) ElementType added in v5.16.0

func (CustomDirectoryRolePermissionArray) ToCustomDirectoryRolePermissionArrayOutput added in v5.16.0

func (i CustomDirectoryRolePermissionArray) ToCustomDirectoryRolePermissionArrayOutput() CustomDirectoryRolePermissionArrayOutput

func (CustomDirectoryRolePermissionArray) ToCustomDirectoryRolePermissionArrayOutputWithContext added in v5.16.0

func (i CustomDirectoryRolePermissionArray) ToCustomDirectoryRolePermissionArrayOutputWithContext(ctx context.Context) CustomDirectoryRolePermissionArrayOutput

type CustomDirectoryRolePermissionArrayInput added in v5.16.0

type CustomDirectoryRolePermissionArrayInput interface {
	pulumi.Input

	ToCustomDirectoryRolePermissionArrayOutput() CustomDirectoryRolePermissionArrayOutput
	ToCustomDirectoryRolePermissionArrayOutputWithContext(context.Context) CustomDirectoryRolePermissionArrayOutput
}

CustomDirectoryRolePermissionArrayInput is an input type that accepts CustomDirectoryRolePermissionArray and CustomDirectoryRolePermissionArrayOutput values. You can construct a concrete instance of `CustomDirectoryRolePermissionArrayInput` via:

CustomDirectoryRolePermissionArray{ CustomDirectoryRolePermissionArgs{...} }

type CustomDirectoryRolePermissionArrayOutput added in v5.16.0

type CustomDirectoryRolePermissionArrayOutput struct{ *pulumi.OutputState }

func (CustomDirectoryRolePermissionArrayOutput) ElementType added in v5.16.0

func (CustomDirectoryRolePermissionArrayOutput) Index added in v5.16.0

func (CustomDirectoryRolePermissionArrayOutput) ToCustomDirectoryRolePermissionArrayOutput added in v5.16.0

func (o CustomDirectoryRolePermissionArrayOutput) ToCustomDirectoryRolePermissionArrayOutput() CustomDirectoryRolePermissionArrayOutput

func (CustomDirectoryRolePermissionArrayOutput) ToCustomDirectoryRolePermissionArrayOutputWithContext added in v5.16.0

func (o CustomDirectoryRolePermissionArrayOutput) ToCustomDirectoryRolePermissionArrayOutputWithContext(ctx context.Context) CustomDirectoryRolePermissionArrayOutput

type CustomDirectoryRolePermissionInput added in v5.16.0

type CustomDirectoryRolePermissionInput interface {
	pulumi.Input

	ToCustomDirectoryRolePermissionOutput() CustomDirectoryRolePermissionOutput
	ToCustomDirectoryRolePermissionOutputWithContext(context.Context) CustomDirectoryRolePermissionOutput
}

CustomDirectoryRolePermissionInput is an input type that accepts CustomDirectoryRolePermissionArgs and CustomDirectoryRolePermissionOutput values. You can construct a concrete instance of `CustomDirectoryRolePermissionInput` via:

CustomDirectoryRolePermissionArgs{...}

type CustomDirectoryRolePermissionOutput added in v5.16.0

type CustomDirectoryRolePermissionOutput struct{ *pulumi.OutputState }

func (CustomDirectoryRolePermissionOutput) AllowedResourceActions added in v5.16.0

A set of tasks that can be performed on a resource. For more information, see the [Permissions Reference](https://docs.microsoft.com/en-us/azure/active-directory/roles/permissions-reference) documentation.

func (CustomDirectoryRolePermissionOutput) ElementType added in v5.16.0

func (CustomDirectoryRolePermissionOutput) ToCustomDirectoryRolePermissionOutput added in v5.16.0

func (o CustomDirectoryRolePermissionOutput) ToCustomDirectoryRolePermissionOutput() CustomDirectoryRolePermissionOutput

func (CustomDirectoryRolePermissionOutput) ToCustomDirectoryRolePermissionOutputWithContext added in v5.16.0

func (o CustomDirectoryRolePermissionOutput) ToCustomDirectoryRolePermissionOutputWithContext(ctx context.Context) CustomDirectoryRolePermissionOutput

type CustomDirectoryRoleState added in v5.16.0

type CustomDirectoryRoleState struct {
	// The description of the custom directory role.
	Description pulumi.StringPtrInput
	// The display name of the custom directory role.
	DisplayName pulumi.StringPtrInput
	// Indicates whether the role is enabled for assignment.
	Enabled pulumi.BoolPtrInput
	// The object ID of the custom directory role.
	ObjectId pulumi.StringPtrInput
	// A collection of `permissions` blocks as documented below.
	Permissions CustomDirectoryRolePermissionArrayInput
	// Custom template identifier that is typically used if one needs an identifier to be the same across different directories. Changing this forces a new resource to be created.
	TemplateId pulumi.StringPtrInput
	// The version of the role definition. This can be any arbitrary string between 1-128 characters.
	Version pulumi.StringPtrInput
}

func (CustomDirectoryRoleState) ElementType added in v5.16.0

func (CustomDirectoryRoleState) ElementType() reflect.Type

type DirectoryRole added in v5.3.0

type DirectoryRole struct {
	pulumi.CustomResourceState

	// The description of the directory role.
	Description pulumi.StringOutput `pulumi:"description"`
	// The display name of the directory role to activate. Changing this forces a new resource to be created.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The object ID of the directory role.
	ObjectId pulumi.StringOutput `pulumi:"objectId"`
	// The object ID of the role template from which to activate the directory role. Changing this forces a new resource to be created.
	//
	// > Either `displayName` or `templateId` must be specified.
	TemplateId pulumi.StringOutput `pulumi:"templateId"`
}

Manages a Directory Role within Azure Active Directory. Directory Roles are also known as Administrator Roles.

Directory Roles are built-in to Azure Active Directory and are immutable. However, by default they are not activated in a tenant (except for the Global Administrator role). This resource ensures a directory role is activated from its associated role template, and exports the object ID of the role, so that role assignments can be made for it.

Once activated, directory roles cannot be deactivated and so this resource does not perform any actions on destroy.

## API Permissions

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

When authenticated with a service principal, this resource requires one of the following application roles: `RoleManagement.ReadWrite.Directory` or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Privileged Role Administrator` or `Global Administrator`

## Example Usage

*Activate a directory role by its template ID*

<!--Start PulumiCodeChooser --> ```go 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.NewDirectoryRole(ctx, "example", &azuread.DirectoryRoleArgs{
			TemplateId: pulumi.String("00000000-0000-0000-0000-000000000000"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Activate a directory role by display name*

<!--Start PulumiCodeChooser --> ```go 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.NewDirectoryRole(ctx, "example", &azuread.DirectoryRoleArgs{
			DisplayName: pulumi.String("Printer administrator"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

This resource does not support importing.

func GetDirectoryRole added in v5.3.0

func GetDirectoryRole(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DirectoryRoleState, opts ...pulumi.ResourceOption) (*DirectoryRole, error)

GetDirectoryRole gets an existing DirectoryRole resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDirectoryRole added in v5.3.0

func NewDirectoryRole(ctx *pulumi.Context,
	name string, args *DirectoryRoleArgs, opts ...pulumi.ResourceOption) (*DirectoryRole, error)

NewDirectoryRole registers a new resource with the given unique name, arguments, and options.

func (*DirectoryRole) ElementType added in v5.3.0

func (*DirectoryRole) ElementType() reflect.Type

func (*DirectoryRole) ToDirectoryRoleOutput added in v5.3.0

func (i *DirectoryRole) ToDirectoryRoleOutput() DirectoryRoleOutput

func (*DirectoryRole) ToDirectoryRoleOutputWithContext added in v5.3.0

func (i *DirectoryRole) ToDirectoryRoleOutputWithContext(ctx context.Context) DirectoryRoleOutput

type DirectoryRoleArgs added in v5.3.0

type DirectoryRoleArgs struct {
	// The display name of the directory role to activate. Changing this forces a new resource to be created.
	DisplayName pulumi.StringPtrInput
	// The object ID of the role template from which to activate the directory role. Changing this forces a new resource to be created.
	//
	// > Either `displayName` or `templateId` must be specified.
	TemplateId pulumi.StringPtrInput
}

The set of arguments for constructing a DirectoryRole resource.

func (DirectoryRoleArgs) ElementType added in v5.3.0

func (DirectoryRoleArgs) ElementType() reflect.Type

type DirectoryRoleArray added in v5.3.0

type DirectoryRoleArray []DirectoryRoleInput

func (DirectoryRoleArray) ElementType added in v5.3.0

func (DirectoryRoleArray) ElementType() reflect.Type

func (DirectoryRoleArray) ToDirectoryRoleArrayOutput added in v5.3.0

func (i DirectoryRoleArray) ToDirectoryRoleArrayOutput() DirectoryRoleArrayOutput

func (DirectoryRoleArray) ToDirectoryRoleArrayOutputWithContext added in v5.3.0

func (i DirectoryRoleArray) ToDirectoryRoleArrayOutputWithContext(ctx context.Context) DirectoryRoleArrayOutput

type DirectoryRoleArrayInput added in v5.3.0

type DirectoryRoleArrayInput interface {
	pulumi.Input

	ToDirectoryRoleArrayOutput() DirectoryRoleArrayOutput
	ToDirectoryRoleArrayOutputWithContext(context.Context) DirectoryRoleArrayOutput
}

DirectoryRoleArrayInput is an input type that accepts DirectoryRoleArray and DirectoryRoleArrayOutput values. You can construct a concrete instance of `DirectoryRoleArrayInput` via:

DirectoryRoleArray{ DirectoryRoleArgs{...} }

type DirectoryRoleArrayOutput added in v5.3.0

type DirectoryRoleArrayOutput struct{ *pulumi.OutputState }

func (DirectoryRoleArrayOutput) ElementType added in v5.3.0

func (DirectoryRoleArrayOutput) ElementType() reflect.Type

func (DirectoryRoleArrayOutput) Index added in v5.3.0

func (DirectoryRoleArrayOutput) ToDirectoryRoleArrayOutput added in v5.3.0

func (o DirectoryRoleArrayOutput) ToDirectoryRoleArrayOutput() DirectoryRoleArrayOutput

func (DirectoryRoleArrayOutput) ToDirectoryRoleArrayOutputWithContext added in v5.3.0

func (o DirectoryRoleArrayOutput) ToDirectoryRoleArrayOutputWithContext(ctx context.Context) DirectoryRoleArrayOutput

type DirectoryRoleAssignment added in v5.25.0

type DirectoryRoleAssignment struct {
	pulumi.CustomResourceState

	// Identifier of the app-specific scope when the assignment scope is app-specific. Cannot be used with `directoryScopeId`. See [official documentation](https://docs.microsoft.com/en-us/graph/api/rbacapplication-post-roleassignments?view=graph-rest-1.0&tabs=http) for example usage. Changing this forces a new resource to be created.
	AppScopeId pulumi.StringOutput `pulumi:"appScopeId"`
	// Identifier of the app-specific scope when the assignment scope is app-specific
	//
	// Deprecated: `appScopeObjectId` has been renamed to `appScopeId` and will be removed in version 3.0 or the AzureAD Provider
	AppScopeObjectId pulumi.StringOutput `pulumi:"appScopeObjectId"`
	// Identifier of the directory object representing the scope of the assignment. Cannot be used with `appScopeId`. See [official documentation](https://docs.microsoft.com/en-us/graph/api/rbacapplication-post-roleassignments?view=graph-rest-1.0&tabs=http) for example usage. Changing this forces a new resource to be created.
	DirectoryScopeId pulumi.StringOutput `pulumi:"directoryScopeId"`
	// Identifier of the directory object representing the scope of the assignment
	DirectoryScopeObjectId pulumi.StringOutput `pulumi:"directoryScopeObjectId"`
	// The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	PrincipalObjectId pulumi.StringOutput `pulumi:"principalObjectId"`
	// The template ID (in the case of built-in roles) or object ID (in the case of custom roles) of the directory role you want to assign. Changing this forces a new resource to be created.
	RoleId pulumi.StringOutput `pulumi:"roleId"`
}

Manages a single directory role assignment within 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 one of the following application roles: `RoleManagement.ReadWrite.Directory` or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Privileged Role Administrator` or `Global Administrator`

## Example Usage

*Assignment for a built-in role*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.LookupUser(ctx, &azuread.LookupUserArgs{
			UserPrincipalName: pulumi.StringRef("jdoe@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		exampleDirectoryRole, err := azuread.NewDirectoryRole(ctx, "example", &azuread.DirectoryRoleArgs{
			DisplayName: pulumi.String("Security administrator"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewDirectoryRoleAssignment(ctx, "example", &azuread.DirectoryRoleAssignmentArgs{
			RoleId:            exampleDirectoryRole.TemplateId,
			PrincipalObjectId: pulumi.String(example.ObjectId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

> Note the use of the `templateId` attribute when referencing built-in roles.

*Assignment for a custom role*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.LookupUser(ctx, &azuread.LookupUserArgs{
			UserPrincipalName: pulumi.StringRef("jdoe@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		exampleCustomDirectoryRole, err := azuread.NewCustomDirectoryRole(ctx, "example", &azuread.CustomDirectoryRoleArgs{
			DisplayName: pulumi.String("My Custom Role"),
			Enabled:     pulumi.Bool(true),
			Version:     pulumi.String("1.0"),
			Permissions: azuread.CustomDirectoryRolePermissionArray{
				&azuread.CustomDirectoryRolePermissionArgs{
					AllowedResourceActions: pulumi.StringArray{
						pulumi.String("microsoft.directory/applications/basic/update"),
						pulumi.String("microsoft.directory/applications/standard/read"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewDirectoryRoleAssignment(ctx, "example", &azuread.DirectoryRoleAssignmentArgs{
			RoleId:            exampleCustomDirectoryRole.ObjectId,
			PrincipalObjectId: pulumi.String(example.ObjectId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Scoped assignment for an application*

## Import

Directory role assignments can be imported using the ID of the assignment, e.g.

```sh $ pulumi import azuread:index/directoryRoleAssignment:DirectoryRoleAssignment example ePROZI_iKE653D_d6aoLHyr-lKgHI8ZGiIdz8CLVcng-1 ```

func GetDirectoryRoleAssignment added in v5.25.0

func GetDirectoryRoleAssignment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DirectoryRoleAssignmentState, opts ...pulumi.ResourceOption) (*DirectoryRoleAssignment, error)

GetDirectoryRoleAssignment gets an existing DirectoryRoleAssignment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDirectoryRoleAssignment added in v5.25.0

func NewDirectoryRoleAssignment(ctx *pulumi.Context,
	name string, args *DirectoryRoleAssignmentArgs, opts ...pulumi.ResourceOption) (*DirectoryRoleAssignment, error)

NewDirectoryRoleAssignment registers a new resource with the given unique name, arguments, and options.

func (*DirectoryRoleAssignment) ElementType added in v5.25.0

func (*DirectoryRoleAssignment) ElementType() reflect.Type

func (*DirectoryRoleAssignment) ToDirectoryRoleAssignmentOutput added in v5.25.0

func (i *DirectoryRoleAssignment) ToDirectoryRoleAssignmentOutput() DirectoryRoleAssignmentOutput

func (*DirectoryRoleAssignment) ToDirectoryRoleAssignmentOutputWithContext added in v5.25.0

func (i *DirectoryRoleAssignment) ToDirectoryRoleAssignmentOutputWithContext(ctx context.Context) DirectoryRoleAssignmentOutput

type DirectoryRoleAssignmentArgs added in v5.25.0

type DirectoryRoleAssignmentArgs struct {
	// Identifier of the app-specific scope when the assignment scope is app-specific. Cannot be used with `directoryScopeId`. See [official documentation](https://docs.microsoft.com/en-us/graph/api/rbacapplication-post-roleassignments?view=graph-rest-1.0&tabs=http) for example usage. Changing this forces a new resource to be created.
	AppScopeId pulumi.StringPtrInput
	// Identifier of the app-specific scope when the assignment scope is app-specific
	//
	// Deprecated: `appScopeObjectId` has been renamed to `appScopeId` and will be removed in version 3.0 or the AzureAD Provider
	AppScopeObjectId pulumi.StringPtrInput
	// Identifier of the directory object representing the scope of the assignment. Cannot be used with `appScopeId`. See [official documentation](https://docs.microsoft.com/en-us/graph/api/rbacapplication-post-roleassignments?view=graph-rest-1.0&tabs=http) for example usage. Changing this forces a new resource to be created.
	DirectoryScopeId pulumi.StringPtrInput
	// Identifier of the directory object representing the scope of the assignment
	DirectoryScopeObjectId pulumi.StringPtrInput
	// The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	PrincipalObjectId pulumi.StringInput
	// The template ID (in the case of built-in roles) or object ID (in the case of custom roles) of the directory role you want to assign. Changing this forces a new resource to be created.
	RoleId pulumi.StringInput
}

The set of arguments for constructing a DirectoryRoleAssignment resource.

func (DirectoryRoleAssignmentArgs) ElementType added in v5.25.0

type DirectoryRoleAssignmentArray added in v5.25.0

type DirectoryRoleAssignmentArray []DirectoryRoleAssignmentInput

func (DirectoryRoleAssignmentArray) ElementType added in v5.25.0

func (DirectoryRoleAssignmentArray) ToDirectoryRoleAssignmentArrayOutput added in v5.25.0

func (i DirectoryRoleAssignmentArray) ToDirectoryRoleAssignmentArrayOutput() DirectoryRoleAssignmentArrayOutput

func (DirectoryRoleAssignmentArray) ToDirectoryRoleAssignmentArrayOutputWithContext added in v5.25.0

func (i DirectoryRoleAssignmentArray) ToDirectoryRoleAssignmentArrayOutputWithContext(ctx context.Context) DirectoryRoleAssignmentArrayOutput

type DirectoryRoleAssignmentArrayInput added in v5.25.0

type DirectoryRoleAssignmentArrayInput interface {
	pulumi.Input

	ToDirectoryRoleAssignmentArrayOutput() DirectoryRoleAssignmentArrayOutput
	ToDirectoryRoleAssignmentArrayOutputWithContext(context.Context) DirectoryRoleAssignmentArrayOutput
}

DirectoryRoleAssignmentArrayInput is an input type that accepts DirectoryRoleAssignmentArray and DirectoryRoleAssignmentArrayOutput values. You can construct a concrete instance of `DirectoryRoleAssignmentArrayInput` via:

DirectoryRoleAssignmentArray{ DirectoryRoleAssignmentArgs{...} }

type DirectoryRoleAssignmentArrayOutput added in v5.25.0

type DirectoryRoleAssignmentArrayOutput struct{ *pulumi.OutputState }

func (DirectoryRoleAssignmentArrayOutput) ElementType added in v5.25.0

func (DirectoryRoleAssignmentArrayOutput) Index added in v5.25.0

func (DirectoryRoleAssignmentArrayOutput) ToDirectoryRoleAssignmentArrayOutput added in v5.25.0

func (o DirectoryRoleAssignmentArrayOutput) ToDirectoryRoleAssignmentArrayOutput() DirectoryRoleAssignmentArrayOutput

func (DirectoryRoleAssignmentArrayOutput) ToDirectoryRoleAssignmentArrayOutputWithContext added in v5.25.0

func (o DirectoryRoleAssignmentArrayOutput) ToDirectoryRoleAssignmentArrayOutputWithContext(ctx context.Context) DirectoryRoleAssignmentArrayOutput

type DirectoryRoleAssignmentInput added in v5.25.0

type DirectoryRoleAssignmentInput interface {
	pulumi.Input

	ToDirectoryRoleAssignmentOutput() DirectoryRoleAssignmentOutput
	ToDirectoryRoleAssignmentOutputWithContext(ctx context.Context) DirectoryRoleAssignmentOutput
}

type DirectoryRoleAssignmentMap added in v5.25.0

type DirectoryRoleAssignmentMap map[string]DirectoryRoleAssignmentInput

func (DirectoryRoleAssignmentMap) ElementType added in v5.25.0

func (DirectoryRoleAssignmentMap) ElementType() reflect.Type

func (DirectoryRoleAssignmentMap) ToDirectoryRoleAssignmentMapOutput added in v5.25.0

func (i DirectoryRoleAssignmentMap) ToDirectoryRoleAssignmentMapOutput() DirectoryRoleAssignmentMapOutput

func (DirectoryRoleAssignmentMap) ToDirectoryRoleAssignmentMapOutputWithContext added in v5.25.0

func (i DirectoryRoleAssignmentMap) ToDirectoryRoleAssignmentMapOutputWithContext(ctx context.Context) DirectoryRoleAssignmentMapOutput

type DirectoryRoleAssignmentMapInput added in v5.25.0

type DirectoryRoleAssignmentMapInput interface {
	pulumi.Input

	ToDirectoryRoleAssignmentMapOutput() DirectoryRoleAssignmentMapOutput
	ToDirectoryRoleAssignmentMapOutputWithContext(context.Context) DirectoryRoleAssignmentMapOutput
}

DirectoryRoleAssignmentMapInput is an input type that accepts DirectoryRoleAssignmentMap and DirectoryRoleAssignmentMapOutput values. You can construct a concrete instance of `DirectoryRoleAssignmentMapInput` via:

DirectoryRoleAssignmentMap{ "key": DirectoryRoleAssignmentArgs{...} }

type DirectoryRoleAssignmentMapOutput added in v5.25.0

type DirectoryRoleAssignmentMapOutput struct{ *pulumi.OutputState }

func (DirectoryRoleAssignmentMapOutput) ElementType added in v5.25.0

func (DirectoryRoleAssignmentMapOutput) MapIndex added in v5.25.0

func (DirectoryRoleAssignmentMapOutput) ToDirectoryRoleAssignmentMapOutput added in v5.25.0

func (o DirectoryRoleAssignmentMapOutput) ToDirectoryRoleAssignmentMapOutput() DirectoryRoleAssignmentMapOutput

func (DirectoryRoleAssignmentMapOutput) ToDirectoryRoleAssignmentMapOutputWithContext added in v5.25.0

func (o DirectoryRoleAssignmentMapOutput) ToDirectoryRoleAssignmentMapOutputWithContext(ctx context.Context) DirectoryRoleAssignmentMapOutput

type DirectoryRoleAssignmentOutput added in v5.25.0

type DirectoryRoleAssignmentOutput struct{ *pulumi.OutputState }

func (DirectoryRoleAssignmentOutput) AppScopeId added in v5.26.0

Identifier of the app-specific scope when the assignment scope is app-specific. Cannot be used with `directoryScopeId`. See [official documentation](https://docs.microsoft.com/en-us/graph/api/rbacapplication-post-roleassignments?view=graph-rest-1.0&tabs=http) for example usage. Changing this forces a new resource to be created.

func (DirectoryRoleAssignmentOutput) AppScopeObjectId deprecated added in v5.25.0

func (o DirectoryRoleAssignmentOutput) AppScopeObjectId() pulumi.StringOutput

Identifier of the app-specific scope when the assignment scope is app-specific

Deprecated: `appScopeObjectId` has been renamed to `appScopeId` and will be removed in version 3.0 or the AzureAD Provider

func (DirectoryRoleAssignmentOutput) DirectoryScopeId added in v5.26.0

func (o DirectoryRoleAssignmentOutput) DirectoryScopeId() pulumi.StringOutput

Identifier of the directory object representing the scope of the assignment. Cannot be used with `appScopeId`. See [official documentation](https://docs.microsoft.com/en-us/graph/api/rbacapplication-post-roleassignments?view=graph-rest-1.0&tabs=http) for example usage. Changing this forces a new resource to be created.

func (DirectoryRoleAssignmentOutput) DirectoryScopeObjectId added in v5.25.0

func (o DirectoryRoleAssignmentOutput) DirectoryScopeObjectId() pulumi.StringOutput

Identifier of the directory object representing the scope of the assignment

func (DirectoryRoleAssignmentOutput) ElementType added in v5.25.0

func (DirectoryRoleAssignmentOutput) PrincipalObjectId added in v5.25.0

func (o DirectoryRoleAssignmentOutput) PrincipalObjectId() pulumi.StringOutput

The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.

func (DirectoryRoleAssignmentOutput) RoleId added in v5.25.0

The template ID (in the case of built-in roles) or object ID (in the case of custom roles) of the directory role you want to assign. Changing this forces a new resource to be created.

func (DirectoryRoleAssignmentOutput) ToDirectoryRoleAssignmentOutput added in v5.25.0

func (o DirectoryRoleAssignmentOutput) ToDirectoryRoleAssignmentOutput() DirectoryRoleAssignmentOutput

func (DirectoryRoleAssignmentOutput) ToDirectoryRoleAssignmentOutputWithContext added in v5.25.0

func (o DirectoryRoleAssignmentOutput) ToDirectoryRoleAssignmentOutputWithContext(ctx context.Context) DirectoryRoleAssignmentOutput

type DirectoryRoleAssignmentState added in v5.25.0

type DirectoryRoleAssignmentState struct {
	// Identifier of the app-specific scope when the assignment scope is app-specific. Cannot be used with `directoryScopeId`. See [official documentation](https://docs.microsoft.com/en-us/graph/api/rbacapplication-post-roleassignments?view=graph-rest-1.0&tabs=http) for example usage. Changing this forces a new resource to be created.
	AppScopeId pulumi.StringPtrInput
	// Identifier of the app-specific scope when the assignment scope is app-specific
	//
	// Deprecated: `appScopeObjectId` has been renamed to `appScopeId` and will be removed in version 3.0 or the AzureAD Provider
	AppScopeObjectId pulumi.StringPtrInput
	// Identifier of the directory object representing the scope of the assignment. Cannot be used with `appScopeId`. See [official documentation](https://docs.microsoft.com/en-us/graph/api/rbacapplication-post-roleassignments?view=graph-rest-1.0&tabs=http) for example usage. Changing this forces a new resource to be created.
	DirectoryScopeId pulumi.StringPtrInput
	// Identifier of the directory object representing the scope of the assignment
	DirectoryScopeObjectId pulumi.StringPtrInput
	// The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	PrincipalObjectId pulumi.StringPtrInput
	// The template ID (in the case of built-in roles) or object ID (in the case of custom roles) of the directory role you want to assign. Changing this forces a new resource to be created.
	RoleId pulumi.StringPtrInput
}

func (DirectoryRoleAssignmentState) ElementType added in v5.25.0

type DirectoryRoleEligibilityScheduleRequest added in v5.42.0

type DirectoryRoleEligibilityScheduleRequest struct {
	pulumi.CustomResourceState

	// Identifier of the directory object representing the scope of the role eligibility. Changing this forces a new resource to be created.
	DirectoryScopeId pulumi.StringOutput `pulumi:"directoryScopeId"`
	// Justification for why the principal is granted the role eligibility. Changing this forces a new resource to be created.
	Justification pulumi.StringOutput `pulumi:"justification"`
	// The object ID of the principal to granted the role eligibility. Changing this forces a new resource to be created.
	PrincipalId pulumi.StringOutput `pulumi:"principalId"`
	// The template ID (in the case of built-in roles) or object ID (in the case of custom roles) of the directory role you want to assign. Changing this forces a new resource to be created.
	RoleDefinitionId pulumi.StringOutput `pulumi:"roleDefinitionId"`
}

Manages a single directory role eligibility schedule request within Azure Active Directory.

## API Permissions

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

The calling principal requires one of the following application roles: `RoleEligibilitySchedule.ReadWrite.Directory` or `RoleManagement.ReadWrite.Directory`.

The calling principal requires one of the following directory roles: `Privileged Role Administrator` or `Global Administrator`.

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.LookupUser(ctx, &azuread.LookupUserArgs{
			UserPrincipalName: pulumi.StringRef("jdoe@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		exampleDirectoryRole, err := azuread.NewDirectoryRole(ctx, "example", &azuread.DirectoryRoleArgs{
			DisplayName: pulumi.String("Application Administrator"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewDirectoryRoleEligibilityScheduleRequest(ctx, "example", &azuread.DirectoryRoleEligibilityScheduleRequestArgs{
			RoleDefinitionId: exampleDirectoryRole.TemplateId,
			PrincipalId:      pulumi.Any(exampleAzureadUser.ObjectId),
			DirectoryScopeId: pulumi.String("/"),
			Justification:    pulumi.String("Example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

> Note the use of the `templateId` attribute when referencing built-in roles.

## Import

Directory role eligibility schedule requests can be imported using the ID of the assignment, e.g.

```sh $ pulumi import azuread:index/directoryRoleEligibilityScheduleRequest:DirectoryRoleEligibilityScheduleRequest example 822ec710-4c9f-4f71-a27a-451759cc7522 ```

func GetDirectoryRoleEligibilityScheduleRequest added in v5.42.0

func GetDirectoryRoleEligibilityScheduleRequest(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DirectoryRoleEligibilityScheduleRequestState, opts ...pulumi.ResourceOption) (*DirectoryRoleEligibilityScheduleRequest, error)

GetDirectoryRoleEligibilityScheduleRequest gets an existing DirectoryRoleEligibilityScheduleRequest resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDirectoryRoleEligibilityScheduleRequest added in v5.42.0

func NewDirectoryRoleEligibilityScheduleRequest(ctx *pulumi.Context,
	name string, args *DirectoryRoleEligibilityScheduleRequestArgs, opts ...pulumi.ResourceOption) (*DirectoryRoleEligibilityScheduleRequest, error)

NewDirectoryRoleEligibilityScheduleRequest registers a new resource with the given unique name, arguments, and options.

func (*DirectoryRoleEligibilityScheduleRequest) ElementType added in v5.42.0

func (*DirectoryRoleEligibilityScheduleRequest) ToDirectoryRoleEligibilityScheduleRequestOutput added in v5.42.0

func (i *DirectoryRoleEligibilityScheduleRequest) ToDirectoryRoleEligibilityScheduleRequestOutput() DirectoryRoleEligibilityScheduleRequestOutput

func (*DirectoryRoleEligibilityScheduleRequest) ToDirectoryRoleEligibilityScheduleRequestOutputWithContext added in v5.42.0

func (i *DirectoryRoleEligibilityScheduleRequest) ToDirectoryRoleEligibilityScheduleRequestOutputWithContext(ctx context.Context) DirectoryRoleEligibilityScheduleRequestOutput

type DirectoryRoleEligibilityScheduleRequestArgs added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestArgs struct {
	// Identifier of the directory object representing the scope of the role eligibility. Changing this forces a new resource to be created.
	DirectoryScopeId pulumi.StringInput
	// Justification for why the principal is granted the role eligibility. Changing this forces a new resource to be created.
	Justification pulumi.StringInput
	// The object ID of the principal to granted the role eligibility. Changing this forces a new resource to be created.
	PrincipalId pulumi.StringInput
	// The template ID (in the case of built-in roles) or object ID (in the case of custom roles) of the directory role you want to assign. Changing this forces a new resource to be created.
	RoleDefinitionId pulumi.StringInput
}

The set of arguments for constructing a DirectoryRoleEligibilityScheduleRequest resource.

func (DirectoryRoleEligibilityScheduleRequestArgs) ElementType added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestArray added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestArray []DirectoryRoleEligibilityScheduleRequestInput

func (DirectoryRoleEligibilityScheduleRequestArray) ElementType added in v5.42.0

func (DirectoryRoleEligibilityScheduleRequestArray) ToDirectoryRoleEligibilityScheduleRequestArrayOutput added in v5.42.0

func (i DirectoryRoleEligibilityScheduleRequestArray) ToDirectoryRoleEligibilityScheduleRequestArrayOutput() DirectoryRoleEligibilityScheduleRequestArrayOutput

func (DirectoryRoleEligibilityScheduleRequestArray) ToDirectoryRoleEligibilityScheduleRequestArrayOutputWithContext added in v5.42.0

func (i DirectoryRoleEligibilityScheduleRequestArray) ToDirectoryRoleEligibilityScheduleRequestArrayOutputWithContext(ctx context.Context) DirectoryRoleEligibilityScheduleRequestArrayOutput

type DirectoryRoleEligibilityScheduleRequestArrayInput added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestArrayInput interface {
	pulumi.Input

	ToDirectoryRoleEligibilityScheduleRequestArrayOutput() DirectoryRoleEligibilityScheduleRequestArrayOutput
	ToDirectoryRoleEligibilityScheduleRequestArrayOutputWithContext(context.Context) DirectoryRoleEligibilityScheduleRequestArrayOutput
}

DirectoryRoleEligibilityScheduleRequestArrayInput is an input type that accepts DirectoryRoleEligibilityScheduleRequestArray and DirectoryRoleEligibilityScheduleRequestArrayOutput values. You can construct a concrete instance of `DirectoryRoleEligibilityScheduleRequestArrayInput` via:

DirectoryRoleEligibilityScheduleRequestArray{ DirectoryRoleEligibilityScheduleRequestArgs{...} }

type DirectoryRoleEligibilityScheduleRequestArrayOutput added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestArrayOutput struct{ *pulumi.OutputState }

func (DirectoryRoleEligibilityScheduleRequestArrayOutput) ElementType added in v5.42.0

func (DirectoryRoleEligibilityScheduleRequestArrayOutput) Index added in v5.42.0

func (DirectoryRoleEligibilityScheduleRequestArrayOutput) ToDirectoryRoleEligibilityScheduleRequestArrayOutput added in v5.42.0

func (o DirectoryRoleEligibilityScheduleRequestArrayOutput) ToDirectoryRoleEligibilityScheduleRequestArrayOutput() DirectoryRoleEligibilityScheduleRequestArrayOutput

func (DirectoryRoleEligibilityScheduleRequestArrayOutput) ToDirectoryRoleEligibilityScheduleRequestArrayOutputWithContext added in v5.42.0

func (o DirectoryRoleEligibilityScheduleRequestArrayOutput) ToDirectoryRoleEligibilityScheduleRequestArrayOutputWithContext(ctx context.Context) DirectoryRoleEligibilityScheduleRequestArrayOutput

type DirectoryRoleEligibilityScheduleRequestInput added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestInput interface {
	pulumi.Input

	ToDirectoryRoleEligibilityScheduleRequestOutput() DirectoryRoleEligibilityScheduleRequestOutput
	ToDirectoryRoleEligibilityScheduleRequestOutputWithContext(ctx context.Context) DirectoryRoleEligibilityScheduleRequestOutput
}

type DirectoryRoleEligibilityScheduleRequestMap added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestMap map[string]DirectoryRoleEligibilityScheduleRequestInput

func (DirectoryRoleEligibilityScheduleRequestMap) ElementType added in v5.42.0

func (DirectoryRoleEligibilityScheduleRequestMap) ToDirectoryRoleEligibilityScheduleRequestMapOutput added in v5.42.0

func (i DirectoryRoleEligibilityScheduleRequestMap) ToDirectoryRoleEligibilityScheduleRequestMapOutput() DirectoryRoleEligibilityScheduleRequestMapOutput

func (DirectoryRoleEligibilityScheduleRequestMap) ToDirectoryRoleEligibilityScheduleRequestMapOutputWithContext added in v5.42.0

func (i DirectoryRoleEligibilityScheduleRequestMap) ToDirectoryRoleEligibilityScheduleRequestMapOutputWithContext(ctx context.Context) DirectoryRoleEligibilityScheduleRequestMapOutput

type DirectoryRoleEligibilityScheduleRequestMapInput added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestMapInput interface {
	pulumi.Input

	ToDirectoryRoleEligibilityScheduleRequestMapOutput() DirectoryRoleEligibilityScheduleRequestMapOutput
	ToDirectoryRoleEligibilityScheduleRequestMapOutputWithContext(context.Context) DirectoryRoleEligibilityScheduleRequestMapOutput
}

DirectoryRoleEligibilityScheduleRequestMapInput is an input type that accepts DirectoryRoleEligibilityScheduleRequestMap and DirectoryRoleEligibilityScheduleRequestMapOutput values. You can construct a concrete instance of `DirectoryRoleEligibilityScheduleRequestMapInput` via:

DirectoryRoleEligibilityScheduleRequestMap{ "key": DirectoryRoleEligibilityScheduleRequestArgs{...} }

type DirectoryRoleEligibilityScheduleRequestMapOutput added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestMapOutput struct{ *pulumi.OutputState }

func (DirectoryRoleEligibilityScheduleRequestMapOutput) ElementType added in v5.42.0

func (DirectoryRoleEligibilityScheduleRequestMapOutput) MapIndex added in v5.42.0

func (DirectoryRoleEligibilityScheduleRequestMapOutput) ToDirectoryRoleEligibilityScheduleRequestMapOutput added in v5.42.0

func (o DirectoryRoleEligibilityScheduleRequestMapOutput) ToDirectoryRoleEligibilityScheduleRequestMapOutput() DirectoryRoleEligibilityScheduleRequestMapOutput

func (DirectoryRoleEligibilityScheduleRequestMapOutput) ToDirectoryRoleEligibilityScheduleRequestMapOutputWithContext added in v5.42.0

func (o DirectoryRoleEligibilityScheduleRequestMapOutput) ToDirectoryRoleEligibilityScheduleRequestMapOutputWithContext(ctx context.Context) DirectoryRoleEligibilityScheduleRequestMapOutput

type DirectoryRoleEligibilityScheduleRequestOutput added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestOutput struct{ *pulumi.OutputState }

func (DirectoryRoleEligibilityScheduleRequestOutput) DirectoryScopeId added in v5.42.0

Identifier of the directory object representing the scope of the role eligibility. Changing this forces a new resource to be created.

func (DirectoryRoleEligibilityScheduleRequestOutput) ElementType added in v5.42.0

func (DirectoryRoleEligibilityScheduleRequestOutput) Justification added in v5.42.0

Justification for why the principal is granted the role eligibility. Changing this forces a new resource to be created.

func (DirectoryRoleEligibilityScheduleRequestOutput) PrincipalId added in v5.42.0

The object ID of the principal to granted the role eligibility. Changing this forces a new resource to be created.

func (DirectoryRoleEligibilityScheduleRequestOutput) RoleDefinitionId added in v5.42.0

The template ID (in the case of built-in roles) or object ID (in the case of custom roles) of the directory role you want to assign. Changing this forces a new resource to be created.

func (DirectoryRoleEligibilityScheduleRequestOutput) ToDirectoryRoleEligibilityScheduleRequestOutput added in v5.42.0

func (o DirectoryRoleEligibilityScheduleRequestOutput) ToDirectoryRoleEligibilityScheduleRequestOutput() DirectoryRoleEligibilityScheduleRequestOutput

func (DirectoryRoleEligibilityScheduleRequestOutput) ToDirectoryRoleEligibilityScheduleRequestOutputWithContext added in v5.42.0

func (o DirectoryRoleEligibilityScheduleRequestOutput) ToDirectoryRoleEligibilityScheduleRequestOutputWithContext(ctx context.Context) DirectoryRoleEligibilityScheduleRequestOutput

type DirectoryRoleEligibilityScheduleRequestState added in v5.42.0

type DirectoryRoleEligibilityScheduleRequestState struct {
	// Identifier of the directory object representing the scope of the role eligibility. Changing this forces a new resource to be created.
	DirectoryScopeId pulumi.StringPtrInput
	// Justification for why the principal is granted the role eligibility. Changing this forces a new resource to be created.
	Justification pulumi.StringPtrInput
	// The object ID of the principal to granted the role eligibility. Changing this forces a new resource to be created.
	PrincipalId pulumi.StringPtrInput
	// The template ID (in the case of built-in roles) or object ID (in the case of custom roles) of the directory role you want to assign. Changing this forces a new resource to be created.
	RoleDefinitionId pulumi.StringPtrInput
}

func (DirectoryRoleEligibilityScheduleRequestState) ElementType added in v5.42.0

type DirectoryRoleInput added in v5.3.0

type DirectoryRoleInput interface {
	pulumi.Input

	ToDirectoryRoleOutput() DirectoryRoleOutput
	ToDirectoryRoleOutputWithContext(ctx context.Context) DirectoryRoleOutput
}

type DirectoryRoleMap added in v5.3.0

type DirectoryRoleMap map[string]DirectoryRoleInput

func (DirectoryRoleMap) ElementType added in v5.3.0

func (DirectoryRoleMap) ElementType() reflect.Type

func (DirectoryRoleMap) ToDirectoryRoleMapOutput added in v5.3.0

func (i DirectoryRoleMap) ToDirectoryRoleMapOutput() DirectoryRoleMapOutput

func (DirectoryRoleMap) ToDirectoryRoleMapOutputWithContext added in v5.3.0

func (i DirectoryRoleMap) ToDirectoryRoleMapOutputWithContext(ctx context.Context) DirectoryRoleMapOutput

type DirectoryRoleMapInput added in v5.3.0

type DirectoryRoleMapInput interface {
	pulumi.Input

	ToDirectoryRoleMapOutput() DirectoryRoleMapOutput
	ToDirectoryRoleMapOutputWithContext(context.Context) DirectoryRoleMapOutput
}

DirectoryRoleMapInput is an input type that accepts DirectoryRoleMap and DirectoryRoleMapOutput values. You can construct a concrete instance of `DirectoryRoleMapInput` via:

DirectoryRoleMap{ "key": DirectoryRoleArgs{...} }

type DirectoryRoleMapOutput added in v5.3.0

type DirectoryRoleMapOutput struct{ *pulumi.OutputState }

func (DirectoryRoleMapOutput) ElementType added in v5.3.0

func (DirectoryRoleMapOutput) ElementType() reflect.Type

func (DirectoryRoleMapOutput) MapIndex added in v5.3.0

func (DirectoryRoleMapOutput) ToDirectoryRoleMapOutput added in v5.3.0

func (o DirectoryRoleMapOutput) ToDirectoryRoleMapOutput() DirectoryRoleMapOutput

func (DirectoryRoleMapOutput) ToDirectoryRoleMapOutputWithContext added in v5.3.0

func (o DirectoryRoleMapOutput) ToDirectoryRoleMapOutputWithContext(ctx context.Context) DirectoryRoleMapOutput

type DirectoryRoleMember added in v5.3.0

type DirectoryRoleMember struct {
	pulumi.CustomResourceState

	// The object ID of the principal you want to add as a member to the directory role. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringPtrOutput `pulumi:"memberObjectId"`
	// The object ID of the directory role you want to add the member to. Changing this forces a new resource to be created.
	RoleObjectId pulumi.StringPtrOutput `pulumi:"roleObjectId"`
}

Manages a single directory role membership (assignment) within Azure Active Directory.

> **Deprecation Warning:** This resource has been superseded by the DirectoryRoleAssignment resource and will be removed in version 3.0 of the AzureAD provider

## API Permissions

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

When authenticated with a service principal, this resource requires one of the following application roles: `RoleManagement.ReadWrite.Directory` or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Privileged Role Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.LookupUser(ctx, &azuread.LookupUserArgs{
			UserPrincipalName: pulumi.StringRef("jdoe@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		exampleDirectoryRole, err := azuread.NewDirectoryRole(ctx, "example", &azuread.DirectoryRoleArgs{
			DisplayName: pulumi.String("Security administrator"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewDirectoryRoleMember(ctx, "example", &azuread.DirectoryRoleMemberArgs{
			RoleObjectId:   exampleDirectoryRole.ObjectId,
			MemberObjectId: pulumi.String(example.ObjectId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Directory role members can be imported using the object ID of the role and the object ID of the member, e.g.

```sh $ pulumi import azuread:index/directoryRoleMember:DirectoryRoleMember example 00000000-0000-0000-0000-000000000000/member/11111111-1111-1111-1111-111111111111 ```

-> This ID format is unique to Terraform and is composed of the Directory Role Object ID and the target Member Object ID in the format `{RoleObjectID}/member/{MemberObjectID}`.

func GetDirectoryRoleMember added in v5.3.0

func GetDirectoryRoleMember(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DirectoryRoleMemberState, opts ...pulumi.ResourceOption) (*DirectoryRoleMember, error)

GetDirectoryRoleMember gets an existing DirectoryRoleMember resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDirectoryRoleMember added in v5.3.0

func NewDirectoryRoleMember(ctx *pulumi.Context,
	name string, args *DirectoryRoleMemberArgs, opts ...pulumi.ResourceOption) (*DirectoryRoleMember, error)

NewDirectoryRoleMember registers a new resource with the given unique name, arguments, and options.

func (*DirectoryRoleMember) ElementType added in v5.3.0

func (*DirectoryRoleMember) ElementType() reflect.Type

func (*DirectoryRoleMember) ToDirectoryRoleMemberOutput added in v5.3.0

func (i *DirectoryRoleMember) ToDirectoryRoleMemberOutput() DirectoryRoleMemberOutput

func (*DirectoryRoleMember) ToDirectoryRoleMemberOutputWithContext added in v5.3.0

func (i *DirectoryRoleMember) ToDirectoryRoleMemberOutputWithContext(ctx context.Context) DirectoryRoleMemberOutput

type DirectoryRoleMemberArgs added in v5.3.0

type DirectoryRoleMemberArgs struct {
	// The object ID of the principal you want to add as a member to the directory role. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringPtrInput
	// The object ID of the directory role you want to add the member to. Changing this forces a new resource to be created.
	RoleObjectId pulumi.StringPtrInput
}

The set of arguments for constructing a DirectoryRoleMember resource.

func (DirectoryRoleMemberArgs) ElementType added in v5.3.0

func (DirectoryRoleMemberArgs) ElementType() reflect.Type

type DirectoryRoleMemberArray added in v5.3.0

type DirectoryRoleMemberArray []DirectoryRoleMemberInput

func (DirectoryRoleMemberArray) ElementType added in v5.3.0

func (DirectoryRoleMemberArray) ElementType() reflect.Type

func (DirectoryRoleMemberArray) ToDirectoryRoleMemberArrayOutput added in v5.3.0

func (i DirectoryRoleMemberArray) ToDirectoryRoleMemberArrayOutput() DirectoryRoleMemberArrayOutput

func (DirectoryRoleMemberArray) ToDirectoryRoleMemberArrayOutputWithContext added in v5.3.0

func (i DirectoryRoleMemberArray) ToDirectoryRoleMemberArrayOutputWithContext(ctx context.Context) DirectoryRoleMemberArrayOutput

type DirectoryRoleMemberArrayInput added in v5.3.0

type DirectoryRoleMemberArrayInput interface {
	pulumi.Input

	ToDirectoryRoleMemberArrayOutput() DirectoryRoleMemberArrayOutput
	ToDirectoryRoleMemberArrayOutputWithContext(context.Context) DirectoryRoleMemberArrayOutput
}

DirectoryRoleMemberArrayInput is an input type that accepts DirectoryRoleMemberArray and DirectoryRoleMemberArrayOutput values. You can construct a concrete instance of `DirectoryRoleMemberArrayInput` via:

DirectoryRoleMemberArray{ DirectoryRoleMemberArgs{...} }

type DirectoryRoleMemberArrayOutput added in v5.3.0

type DirectoryRoleMemberArrayOutput struct{ *pulumi.OutputState }

func (DirectoryRoleMemberArrayOutput) ElementType added in v5.3.0

func (DirectoryRoleMemberArrayOutput) Index added in v5.3.0

func (DirectoryRoleMemberArrayOutput) ToDirectoryRoleMemberArrayOutput added in v5.3.0

func (o DirectoryRoleMemberArrayOutput) ToDirectoryRoleMemberArrayOutput() DirectoryRoleMemberArrayOutput

func (DirectoryRoleMemberArrayOutput) ToDirectoryRoleMemberArrayOutputWithContext added in v5.3.0

func (o DirectoryRoleMemberArrayOutput) ToDirectoryRoleMemberArrayOutputWithContext(ctx context.Context) DirectoryRoleMemberArrayOutput

type DirectoryRoleMemberInput added in v5.3.0

type DirectoryRoleMemberInput interface {
	pulumi.Input

	ToDirectoryRoleMemberOutput() DirectoryRoleMemberOutput
	ToDirectoryRoleMemberOutputWithContext(ctx context.Context) DirectoryRoleMemberOutput
}

type DirectoryRoleMemberMap added in v5.3.0

type DirectoryRoleMemberMap map[string]DirectoryRoleMemberInput

func (DirectoryRoleMemberMap) ElementType added in v5.3.0

func (DirectoryRoleMemberMap) ElementType() reflect.Type

func (DirectoryRoleMemberMap) ToDirectoryRoleMemberMapOutput added in v5.3.0

func (i DirectoryRoleMemberMap) ToDirectoryRoleMemberMapOutput() DirectoryRoleMemberMapOutput

func (DirectoryRoleMemberMap) ToDirectoryRoleMemberMapOutputWithContext added in v5.3.0

func (i DirectoryRoleMemberMap) ToDirectoryRoleMemberMapOutputWithContext(ctx context.Context) DirectoryRoleMemberMapOutput

type DirectoryRoleMemberMapInput added in v5.3.0

type DirectoryRoleMemberMapInput interface {
	pulumi.Input

	ToDirectoryRoleMemberMapOutput() DirectoryRoleMemberMapOutput
	ToDirectoryRoleMemberMapOutputWithContext(context.Context) DirectoryRoleMemberMapOutput
}

DirectoryRoleMemberMapInput is an input type that accepts DirectoryRoleMemberMap and DirectoryRoleMemberMapOutput values. You can construct a concrete instance of `DirectoryRoleMemberMapInput` via:

DirectoryRoleMemberMap{ "key": DirectoryRoleMemberArgs{...} }

type DirectoryRoleMemberMapOutput added in v5.3.0

type DirectoryRoleMemberMapOutput struct{ *pulumi.OutputState }

func (DirectoryRoleMemberMapOutput) ElementType added in v5.3.0

func (DirectoryRoleMemberMapOutput) MapIndex added in v5.3.0

func (DirectoryRoleMemberMapOutput) ToDirectoryRoleMemberMapOutput added in v5.3.0

func (o DirectoryRoleMemberMapOutput) ToDirectoryRoleMemberMapOutput() DirectoryRoleMemberMapOutput

func (DirectoryRoleMemberMapOutput) ToDirectoryRoleMemberMapOutputWithContext added in v5.3.0

func (o DirectoryRoleMemberMapOutput) ToDirectoryRoleMemberMapOutputWithContext(ctx context.Context) DirectoryRoleMemberMapOutput

type DirectoryRoleMemberOutput added in v5.3.0

type DirectoryRoleMemberOutput struct{ *pulumi.OutputState }

func (DirectoryRoleMemberOutput) ElementType added in v5.3.0

func (DirectoryRoleMemberOutput) ElementType() reflect.Type

func (DirectoryRoleMemberOutput) MemberObjectId added in v5.22.0

The object ID of the principal you want to add as a member to the directory role. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.

func (DirectoryRoleMemberOutput) RoleObjectId added in v5.22.0

The object ID of the directory role you want to add the member to. Changing this forces a new resource to be created.

func (DirectoryRoleMemberOutput) ToDirectoryRoleMemberOutput added in v5.3.0

func (o DirectoryRoleMemberOutput) ToDirectoryRoleMemberOutput() DirectoryRoleMemberOutput

func (DirectoryRoleMemberOutput) ToDirectoryRoleMemberOutputWithContext added in v5.3.0

func (o DirectoryRoleMemberOutput) ToDirectoryRoleMemberOutputWithContext(ctx context.Context) DirectoryRoleMemberOutput

type DirectoryRoleMemberState added in v5.3.0

type DirectoryRoleMemberState struct {
	// The object ID of the principal you want to add as a member to the directory role. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringPtrInput
	// The object ID of the directory role you want to add the member to. Changing this forces a new resource to be created.
	RoleObjectId pulumi.StringPtrInput
}

func (DirectoryRoleMemberState) ElementType added in v5.3.0

func (DirectoryRoleMemberState) ElementType() reflect.Type

type DirectoryRoleOutput added in v5.3.0

type DirectoryRoleOutput struct{ *pulumi.OutputState }

func (DirectoryRoleOutput) Description added in v5.22.0

func (o DirectoryRoleOutput) Description() pulumi.StringOutput

The description of the directory role.

func (DirectoryRoleOutput) DisplayName added in v5.22.0

func (o DirectoryRoleOutput) DisplayName() pulumi.StringOutput

The display name of the directory role to activate. Changing this forces a new resource to be created.

func (DirectoryRoleOutput) ElementType added in v5.3.0

func (DirectoryRoleOutput) ElementType() reflect.Type

func (DirectoryRoleOutput) ObjectId added in v5.22.0

The object ID of the directory role.

func (DirectoryRoleOutput) TemplateId added in v5.22.0

func (o DirectoryRoleOutput) TemplateId() pulumi.StringOutput

The object ID of the role template from which to activate the directory role. Changing this forces a new resource to be created.

> Either `displayName` or `templateId` must be specified.

func (DirectoryRoleOutput) ToDirectoryRoleOutput added in v5.3.0

func (o DirectoryRoleOutput) ToDirectoryRoleOutput() DirectoryRoleOutput

func (DirectoryRoleOutput) ToDirectoryRoleOutputWithContext added in v5.3.0

func (o DirectoryRoleOutput) ToDirectoryRoleOutputWithContext(ctx context.Context) DirectoryRoleOutput

type DirectoryRoleState added in v5.3.0

type DirectoryRoleState struct {
	// The description of the directory role.
	Description pulumi.StringPtrInput
	// The display name of the directory role to activate. Changing this forces a new resource to be created.
	DisplayName pulumi.StringPtrInput
	// The object ID of the directory role.
	ObjectId pulumi.StringPtrInput
	// The object ID of the role template from which to activate the directory role. Changing this forces a new resource to be created.
	//
	// > Either `displayName` or `templateId` must be specified.
	TemplateId pulumi.StringPtrInput
}

func (DirectoryRoleState) ElementType added in v5.3.0

func (DirectoryRoleState) ElementType() reflect.Type

type GetAccessPackageCatalogRoleArgs added in v5.38.0

type GetAccessPackageCatalogRoleArgs struct {
	// Specifies the display name of the role.
	DisplayName *string `pulumi:"displayName"`
	// Specifies the object ID of the role.
	//
	// > One of `displayName` or `objectId` must be specified.
	ObjectId *string `pulumi:"objectId"`
}

A collection of arguments for invoking getAccessPackageCatalogRole.

type GetAccessPackageCatalogRoleOutputArgs added in v5.38.0

type GetAccessPackageCatalogRoleOutputArgs struct {
	// Specifies the display name of the role.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// Specifies the object ID of the role.
	//
	// > One of `displayName` or `objectId` must be specified.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
}

A collection of arguments for invoking getAccessPackageCatalogRole.

func (GetAccessPackageCatalogRoleOutputArgs) ElementType added in v5.38.0

type GetAccessPackageCatalogRoleResult added in v5.38.0

type GetAccessPackageCatalogRoleResult struct {
	// The description of the role.
	Description string `pulumi:"description"`
	// The display name of the role.
	DisplayName string `pulumi:"displayName"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The object ID of the role.
	ObjectId string `pulumi:"objectId"`
	// The object ID of the role.
	TemplateId string `pulumi:"templateId"`
}

A collection of values returned by getAccessPackageCatalogRole.

func GetAccessPackageCatalogRole added in v5.38.0

func GetAccessPackageCatalogRole(ctx *pulumi.Context, args *GetAccessPackageCatalogRoleArgs, opts ...pulumi.InvokeOption) (*GetAccessPackageCatalogRoleResult, error)

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* <!--Start PulumiCodeChooser --> ```go 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.GetAccessPackageCatalogRole(ctx, &azuread.GetAccessPackageCatalogRoleArgs{
			DisplayName: pulumi.StringRef("Catalog owner"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up by object ID* <!--Start PulumiCodeChooser --> ```go 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.GetAccessPackageCatalogRole(ctx, &azuread.GetAccessPackageCatalogRoleArgs{
			ObjectId: pulumi.StringRef("00000000-0000-0000-0000-000000000000"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetAccessPackageCatalogRoleResultOutput added in v5.38.0

type GetAccessPackageCatalogRoleResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAccessPackageCatalogRole.

func (GetAccessPackageCatalogRoleResultOutput) Description added in v5.38.0

The description of the role.

func (GetAccessPackageCatalogRoleResultOutput) DisplayName added in v5.38.0

The display name of the role.

func (GetAccessPackageCatalogRoleResultOutput) ElementType added in v5.38.0

func (GetAccessPackageCatalogRoleResultOutput) Id added in v5.38.0

The provider-assigned unique ID for this managed resource.

func (GetAccessPackageCatalogRoleResultOutput) ObjectId added in v5.38.0

The object ID of the role.

func (GetAccessPackageCatalogRoleResultOutput) TemplateId added in v5.38.0

The object ID of the role.

func (GetAccessPackageCatalogRoleResultOutput) ToGetAccessPackageCatalogRoleResultOutput added in v5.38.0

func (o GetAccessPackageCatalogRoleResultOutput) ToGetAccessPackageCatalogRoleResultOutput() GetAccessPackageCatalogRoleResultOutput

func (GetAccessPackageCatalogRoleResultOutput) ToGetAccessPackageCatalogRoleResultOutputWithContext added in v5.38.0

func (o GetAccessPackageCatalogRoleResultOutput) ToGetAccessPackageCatalogRoleResultOutputWithContext(ctx context.Context) GetAccessPackageCatalogRoleResultOutput

type GetApplicationApi

type GetApplicationApi struct {
	// A set of application IDs (client IDs), used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.
	KnownClientApplications []string `pulumi:"knownClientApplications"`
	// Allows an application to use claims mapping without specifying a custom signing key.
	MappedClaimsEnabled bool `pulumi:"mappedClaimsEnabled"`
	// One or more `oauth2PermissionScope` blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.
	Oauth2PermissionScopes []GetApplicationApiOauth2PermissionScope `pulumi:"oauth2PermissionScopes"`
	// The access token version expected by this resource. Possible values are `1` or `2`.
	RequestedAccessTokenVersion int `pulumi:"requestedAccessTokenVersion"`
}

type GetApplicationApiArgs

type GetApplicationApiArgs struct {
	// A set of application IDs (client IDs), used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.
	KnownClientApplications pulumi.StringArrayInput `pulumi:"knownClientApplications"`
	// Allows an application to use claims mapping without specifying a custom signing key.
	MappedClaimsEnabled pulumi.BoolInput `pulumi:"mappedClaimsEnabled"`
	// One or more `oauth2PermissionScope` blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.
	Oauth2PermissionScopes GetApplicationApiOauth2PermissionScopeArrayInput `pulumi:"oauth2PermissionScopes"`
	// The access token version expected by this resource. Possible values are `1` or `2`.
	RequestedAccessTokenVersion pulumi.IntInput `pulumi:"requestedAccessTokenVersion"`
}

func (GetApplicationApiArgs) ElementType

func (GetApplicationApiArgs) ElementType() reflect.Type

func (GetApplicationApiArgs) ToGetApplicationApiOutput

func (i GetApplicationApiArgs) ToGetApplicationApiOutput() GetApplicationApiOutput

func (GetApplicationApiArgs) ToGetApplicationApiOutputWithContext

func (i GetApplicationApiArgs) ToGetApplicationApiOutputWithContext(ctx context.Context) GetApplicationApiOutput

type GetApplicationApiArray

type GetApplicationApiArray []GetApplicationApiInput

func (GetApplicationApiArray) ElementType

func (GetApplicationApiArray) ElementType() reflect.Type

func (GetApplicationApiArray) ToGetApplicationApiArrayOutput

func (i GetApplicationApiArray) ToGetApplicationApiArrayOutput() GetApplicationApiArrayOutput

func (GetApplicationApiArray) ToGetApplicationApiArrayOutputWithContext

func (i GetApplicationApiArray) ToGetApplicationApiArrayOutputWithContext(ctx context.Context) GetApplicationApiArrayOutput

type GetApplicationApiArrayInput

type GetApplicationApiArrayInput interface {
	pulumi.Input

	ToGetApplicationApiArrayOutput() GetApplicationApiArrayOutput
	ToGetApplicationApiArrayOutputWithContext(context.Context) GetApplicationApiArrayOutput
}

GetApplicationApiArrayInput is an input type that accepts GetApplicationApiArray and GetApplicationApiArrayOutput values. You can construct a concrete instance of `GetApplicationApiArrayInput` via:

GetApplicationApiArray{ GetApplicationApiArgs{...} }

type GetApplicationApiArrayOutput

type GetApplicationApiArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationApiArrayOutput) ElementType

func (GetApplicationApiArrayOutput) Index

func (GetApplicationApiArrayOutput) ToGetApplicationApiArrayOutput

func (o GetApplicationApiArrayOutput) ToGetApplicationApiArrayOutput() GetApplicationApiArrayOutput

func (GetApplicationApiArrayOutput) ToGetApplicationApiArrayOutputWithContext

func (o GetApplicationApiArrayOutput) ToGetApplicationApiArrayOutputWithContext(ctx context.Context) GetApplicationApiArrayOutput

type GetApplicationApiInput

type GetApplicationApiInput interface {
	pulumi.Input

	ToGetApplicationApiOutput() GetApplicationApiOutput
	ToGetApplicationApiOutputWithContext(context.Context) GetApplicationApiOutput
}

GetApplicationApiInput is an input type that accepts GetApplicationApiArgs and GetApplicationApiOutput values. You can construct a concrete instance of `GetApplicationApiInput` via:

GetApplicationApiArgs{...}

type GetApplicationApiOauth2PermissionScope

type GetApplicationApiOauth2PermissionScope struct {
	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription string `pulumi:"adminConsentDescription"`
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName string `pulumi:"adminConsentDisplayName"`
	// Determines if the app role is enabled.
	Enabled bool `pulumi:"enabled"`
	// The unique identifier for an app role or OAuth2 permission scope published by the resource application.
	Id string `pulumi:"id"`
	// Specifies whether the `id` property references an app role or an OAuth2 permission scope. Possible values are `Role` or `Scope`.
	Type string `pulumi:"type"`
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription string `pulumi:"userConsentDescription"`
	// Display name for the delegated permission that appears in the end user consent experience.
	UserConsentDisplayName string `pulumi:"userConsentDisplayName"`
	// The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal.
	Value string `pulumi:"value"`
}

type GetApplicationApiOauth2PermissionScopeArgs

type GetApplicationApiOauth2PermissionScopeArgs struct {
	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription pulumi.StringInput `pulumi:"adminConsentDescription"`
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName pulumi.StringInput `pulumi:"adminConsentDisplayName"`
	// Determines if the app role is enabled.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The unique identifier for an app role or OAuth2 permission scope published by the resource application.
	Id pulumi.StringInput `pulumi:"id"`
	// Specifies whether the `id` property references an app role or an OAuth2 permission scope. Possible values are `Role` or `Scope`.
	Type pulumi.StringInput `pulumi:"type"`
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription pulumi.StringInput `pulumi:"userConsentDescription"`
	// Display name for the delegated permission that appears in the end user consent experience.
	UserConsentDisplayName pulumi.StringInput `pulumi:"userConsentDisplayName"`
	// The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal.
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetApplicationApiOauth2PermissionScopeArgs) ElementType

func (GetApplicationApiOauth2PermissionScopeArgs) ToGetApplicationApiOauth2PermissionScopeOutput

func (i GetApplicationApiOauth2PermissionScopeArgs) ToGetApplicationApiOauth2PermissionScopeOutput() GetApplicationApiOauth2PermissionScopeOutput

func (GetApplicationApiOauth2PermissionScopeArgs) ToGetApplicationApiOauth2PermissionScopeOutputWithContext

func (i GetApplicationApiOauth2PermissionScopeArgs) ToGetApplicationApiOauth2PermissionScopeOutputWithContext(ctx context.Context) GetApplicationApiOauth2PermissionScopeOutput

type GetApplicationApiOauth2PermissionScopeArray

type GetApplicationApiOauth2PermissionScopeArray []GetApplicationApiOauth2PermissionScopeInput

func (GetApplicationApiOauth2PermissionScopeArray) ElementType

func (GetApplicationApiOauth2PermissionScopeArray) ToGetApplicationApiOauth2PermissionScopeArrayOutput

func (i GetApplicationApiOauth2PermissionScopeArray) ToGetApplicationApiOauth2PermissionScopeArrayOutput() GetApplicationApiOauth2PermissionScopeArrayOutput

func (GetApplicationApiOauth2PermissionScopeArray) ToGetApplicationApiOauth2PermissionScopeArrayOutputWithContext

func (i GetApplicationApiOauth2PermissionScopeArray) ToGetApplicationApiOauth2PermissionScopeArrayOutputWithContext(ctx context.Context) GetApplicationApiOauth2PermissionScopeArrayOutput

type GetApplicationApiOauth2PermissionScopeArrayInput

type GetApplicationApiOauth2PermissionScopeArrayInput interface {
	pulumi.Input

	ToGetApplicationApiOauth2PermissionScopeArrayOutput() GetApplicationApiOauth2PermissionScopeArrayOutput
	ToGetApplicationApiOauth2PermissionScopeArrayOutputWithContext(context.Context) GetApplicationApiOauth2PermissionScopeArrayOutput
}

GetApplicationApiOauth2PermissionScopeArrayInput is an input type that accepts GetApplicationApiOauth2PermissionScopeArray and GetApplicationApiOauth2PermissionScopeArrayOutput values. You can construct a concrete instance of `GetApplicationApiOauth2PermissionScopeArrayInput` via:

GetApplicationApiOauth2PermissionScopeArray{ GetApplicationApiOauth2PermissionScopeArgs{...} }

type GetApplicationApiOauth2PermissionScopeArrayOutput

type GetApplicationApiOauth2PermissionScopeArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationApiOauth2PermissionScopeArrayOutput) ElementType

func (GetApplicationApiOauth2PermissionScopeArrayOutput) Index

func (GetApplicationApiOauth2PermissionScopeArrayOutput) ToGetApplicationApiOauth2PermissionScopeArrayOutput

func (o GetApplicationApiOauth2PermissionScopeArrayOutput) ToGetApplicationApiOauth2PermissionScopeArrayOutput() GetApplicationApiOauth2PermissionScopeArrayOutput

func (GetApplicationApiOauth2PermissionScopeArrayOutput) ToGetApplicationApiOauth2PermissionScopeArrayOutputWithContext

func (o GetApplicationApiOauth2PermissionScopeArrayOutput) ToGetApplicationApiOauth2PermissionScopeArrayOutputWithContext(ctx context.Context) GetApplicationApiOauth2PermissionScopeArrayOutput

type GetApplicationApiOauth2PermissionScopeInput

type GetApplicationApiOauth2PermissionScopeInput interface {
	pulumi.Input

	ToGetApplicationApiOauth2PermissionScopeOutput() GetApplicationApiOauth2PermissionScopeOutput
	ToGetApplicationApiOauth2PermissionScopeOutputWithContext(context.Context) GetApplicationApiOauth2PermissionScopeOutput
}

GetApplicationApiOauth2PermissionScopeInput is an input type that accepts GetApplicationApiOauth2PermissionScopeArgs and GetApplicationApiOauth2PermissionScopeOutput values. You can construct a concrete instance of `GetApplicationApiOauth2PermissionScopeInput` via:

GetApplicationApiOauth2PermissionScopeArgs{...}

type GetApplicationApiOauth2PermissionScopeOutput

type GetApplicationApiOauth2PermissionScopeOutput struct{ *pulumi.OutputState }

func (GetApplicationApiOauth2PermissionScopeOutput) AdminConsentDescription

Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.

func (GetApplicationApiOauth2PermissionScopeOutput) AdminConsentDisplayName

Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.

func (GetApplicationApiOauth2PermissionScopeOutput) ElementType

func (GetApplicationApiOauth2PermissionScopeOutput) Enabled

Determines if the app role is enabled.

func (GetApplicationApiOauth2PermissionScopeOutput) Id

The unique identifier for an app role or OAuth2 permission scope published by the resource application.

func (GetApplicationApiOauth2PermissionScopeOutput) ToGetApplicationApiOauth2PermissionScopeOutput

func (o GetApplicationApiOauth2PermissionScopeOutput) ToGetApplicationApiOauth2PermissionScopeOutput() GetApplicationApiOauth2PermissionScopeOutput

func (GetApplicationApiOauth2PermissionScopeOutput) ToGetApplicationApiOauth2PermissionScopeOutputWithContext

func (o GetApplicationApiOauth2PermissionScopeOutput) ToGetApplicationApiOauth2PermissionScopeOutputWithContext(ctx context.Context) GetApplicationApiOauth2PermissionScopeOutput

func (GetApplicationApiOauth2PermissionScopeOutput) Type

Specifies whether the `id` property references an app role or an OAuth2 permission scope. Possible values are `Role` or `Scope`.

func (GetApplicationApiOauth2PermissionScopeOutput) UserConsentDescription

Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.

func (GetApplicationApiOauth2PermissionScopeOutput) UserConsentDisplayName

Display name for the delegated permission that appears in the end user consent experience.

func (GetApplicationApiOauth2PermissionScopeOutput) Value

The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal.

type GetApplicationApiOutput

type GetApplicationApiOutput struct{ *pulumi.OutputState }

func (GetApplicationApiOutput) ElementType

func (GetApplicationApiOutput) ElementType() reflect.Type

func (GetApplicationApiOutput) KnownClientApplications

func (o GetApplicationApiOutput) KnownClientApplications() pulumi.StringArrayOutput

A set of application IDs (client IDs), used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.

func (GetApplicationApiOutput) MappedClaimsEnabled

func (o GetApplicationApiOutput) MappedClaimsEnabled() pulumi.BoolOutput

Allows an application to use claims mapping without specifying a custom signing key.

func (GetApplicationApiOutput) Oauth2PermissionScopes

One or more `oauth2PermissionScope` blocks as documented below, to describe delegated permissions exposed by the web API represented by this application.

func (GetApplicationApiOutput) RequestedAccessTokenVersion

func (o GetApplicationApiOutput) RequestedAccessTokenVersion() pulumi.IntOutput

The access token version expected by this resource. Possible values are `1` or `2`.

func (GetApplicationApiOutput) ToGetApplicationApiOutput

func (o GetApplicationApiOutput) ToGetApplicationApiOutput() GetApplicationApiOutput

func (GetApplicationApiOutput) ToGetApplicationApiOutputWithContext

func (o GetApplicationApiOutput) ToGetApplicationApiOutputWithContext(ctx context.Context) GetApplicationApiOutput

type GetApplicationAppRoleType added in v5.43.0

type GetApplicationAppRoleType struct {
	// Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in a standalone scenario). Possible values are `User` or `Application`, or both.
	AllowedMemberTypes []string `pulumi:"allowedMemberTypes"`
	// Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences.
	Description string `pulumi:"description"`
	// Specifies the display name of the application.
	DisplayName string `pulumi:"displayName"`
	// Determines if the app role is enabled.
	Enabled bool `pulumi:"enabled"`
	// The unique identifier for an app role or OAuth2 permission scope published by the resource application.
	Id string `pulumi:"id"`
	// The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal.
	Value string `pulumi:"value"`
}

type GetApplicationAppRoleTypeArgs added in v5.43.0

type GetApplicationAppRoleTypeArgs struct {
	// Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in a standalone scenario). Possible values are `User` or `Application`, or both.
	AllowedMemberTypes pulumi.StringArrayInput `pulumi:"allowedMemberTypes"`
	// Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences.
	Description pulumi.StringInput `pulumi:"description"`
	// Specifies the display name of the application.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Determines if the app role is enabled.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The unique identifier for an app role or OAuth2 permission scope published by the resource application.
	Id pulumi.StringInput `pulumi:"id"`
	// The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal.
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetApplicationAppRoleTypeArgs) ElementType added in v5.43.0

func (GetApplicationAppRoleTypeArgs) ToGetApplicationAppRoleTypeOutput added in v5.43.0

func (i GetApplicationAppRoleTypeArgs) ToGetApplicationAppRoleTypeOutput() GetApplicationAppRoleTypeOutput

func (GetApplicationAppRoleTypeArgs) ToGetApplicationAppRoleTypeOutputWithContext added in v5.43.0

func (i GetApplicationAppRoleTypeArgs) ToGetApplicationAppRoleTypeOutputWithContext(ctx context.Context) GetApplicationAppRoleTypeOutput

type GetApplicationAppRoleTypeArray added in v5.43.0

type GetApplicationAppRoleTypeArray []GetApplicationAppRoleTypeInput

func (GetApplicationAppRoleTypeArray) ElementType added in v5.43.0

func (GetApplicationAppRoleTypeArray) ToGetApplicationAppRoleTypeArrayOutput added in v5.43.0

func (i GetApplicationAppRoleTypeArray) ToGetApplicationAppRoleTypeArrayOutput() GetApplicationAppRoleTypeArrayOutput

func (GetApplicationAppRoleTypeArray) ToGetApplicationAppRoleTypeArrayOutputWithContext added in v5.43.0

func (i GetApplicationAppRoleTypeArray) ToGetApplicationAppRoleTypeArrayOutputWithContext(ctx context.Context) GetApplicationAppRoleTypeArrayOutput

type GetApplicationAppRoleTypeArrayInput added in v5.43.0

type GetApplicationAppRoleTypeArrayInput interface {
	pulumi.Input

	ToGetApplicationAppRoleTypeArrayOutput() GetApplicationAppRoleTypeArrayOutput
	ToGetApplicationAppRoleTypeArrayOutputWithContext(context.Context) GetApplicationAppRoleTypeArrayOutput
}

GetApplicationAppRoleTypeArrayInput is an input type that accepts GetApplicationAppRoleTypeArray and GetApplicationAppRoleTypeArrayOutput values. You can construct a concrete instance of `GetApplicationAppRoleTypeArrayInput` via:

GetApplicationAppRoleTypeArray{ GetApplicationAppRoleTypeArgs{...} }

type GetApplicationAppRoleTypeArrayOutput added in v5.43.0

type GetApplicationAppRoleTypeArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationAppRoleTypeArrayOutput) ElementType added in v5.43.0

func (GetApplicationAppRoleTypeArrayOutput) Index added in v5.43.0

func (GetApplicationAppRoleTypeArrayOutput) ToGetApplicationAppRoleTypeArrayOutput added in v5.43.0

func (o GetApplicationAppRoleTypeArrayOutput) ToGetApplicationAppRoleTypeArrayOutput() GetApplicationAppRoleTypeArrayOutput

func (GetApplicationAppRoleTypeArrayOutput) ToGetApplicationAppRoleTypeArrayOutputWithContext added in v5.43.0

func (o GetApplicationAppRoleTypeArrayOutput) ToGetApplicationAppRoleTypeArrayOutputWithContext(ctx context.Context) GetApplicationAppRoleTypeArrayOutput

type GetApplicationAppRoleTypeInput added in v5.43.0

type GetApplicationAppRoleTypeInput interface {
	pulumi.Input

	ToGetApplicationAppRoleTypeOutput() GetApplicationAppRoleTypeOutput
	ToGetApplicationAppRoleTypeOutputWithContext(context.Context) GetApplicationAppRoleTypeOutput
}

GetApplicationAppRoleTypeInput is an input type that accepts GetApplicationAppRoleTypeArgs and GetApplicationAppRoleTypeOutput values. You can construct a concrete instance of `GetApplicationAppRoleTypeInput` via:

GetApplicationAppRoleTypeArgs{...}

type GetApplicationAppRoleTypeOutput added in v5.43.0

type GetApplicationAppRoleTypeOutput struct{ *pulumi.OutputState }

func (GetApplicationAppRoleTypeOutput) AllowedMemberTypes added in v5.43.0

Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in a standalone scenario). Possible values are `User` or `Application`, or both.

func (GetApplicationAppRoleTypeOutput) Description added in v5.43.0

Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences.

func (GetApplicationAppRoleTypeOutput) DisplayName added in v5.43.0

Specifies the display name of the application.

func (GetApplicationAppRoleTypeOutput) ElementType added in v5.43.0

func (GetApplicationAppRoleTypeOutput) Enabled added in v5.43.0

Determines if the app role is enabled.

func (GetApplicationAppRoleTypeOutput) Id added in v5.43.0

The unique identifier for an app role or OAuth2 permission scope published by the resource application.

func (GetApplicationAppRoleTypeOutput) ToGetApplicationAppRoleTypeOutput added in v5.43.0

func (o GetApplicationAppRoleTypeOutput) ToGetApplicationAppRoleTypeOutput() GetApplicationAppRoleTypeOutput

func (GetApplicationAppRoleTypeOutput) ToGetApplicationAppRoleTypeOutputWithContext added in v5.43.0

func (o GetApplicationAppRoleTypeOutput) ToGetApplicationAppRoleTypeOutputWithContext(ctx context.Context) GetApplicationAppRoleTypeOutput

func (GetApplicationAppRoleTypeOutput) Value added in v5.43.0

The value that is used for the `roles` claim in ID tokens and OAuth 2.0 access tokens that are authenticating an assigned service or user principal.

type GetApplicationFeatureTag added in v5.6.0

type GetApplicationFeatureTag struct {
	// Whether this application represents a custom SAML application for linked service principals.
	CustomSingleSignOn *bool `pulumi:"customSingleSignOn"`
	// Whether this application represents an Enterprise Application for linked service principals.
	Enterprise *bool `pulumi:"enterprise"`
	// Whether this application represents a gallery application for linked service principals.
	Gallery *bool `pulumi:"gallery"`
	// Whether this app is visible to users in My Apps and Office 365 Launcher.
	Hide *bool `pulumi:"hide"`
}

type GetApplicationFeatureTagArgs added in v5.6.0

type GetApplicationFeatureTagArgs struct {
	// Whether this application represents a custom SAML application for linked service principals.
	CustomSingleSignOn pulumi.BoolPtrInput `pulumi:"customSingleSignOn"`
	// Whether this application represents an Enterprise Application for linked service principals.
	Enterprise pulumi.BoolPtrInput `pulumi:"enterprise"`
	// Whether this application represents a gallery application for linked service principals.
	Gallery pulumi.BoolPtrInput `pulumi:"gallery"`
	// Whether this app is visible to users in My Apps and Office 365 Launcher.
	Hide pulumi.BoolPtrInput `pulumi:"hide"`
}

func (GetApplicationFeatureTagArgs) ElementType added in v5.6.0

func (GetApplicationFeatureTagArgs) ToGetApplicationFeatureTagOutput added in v5.6.0

func (i GetApplicationFeatureTagArgs) ToGetApplicationFeatureTagOutput() GetApplicationFeatureTagOutput

func (GetApplicationFeatureTagArgs) ToGetApplicationFeatureTagOutputWithContext added in v5.6.0

func (i GetApplicationFeatureTagArgs) ToGetApplicationFeatureTagOutputWithContext(ctx context.Context) GetApplicationFeatureTagOutput

type GetApplicationFeatureTagArray added in v5.6.0

type GetApplicationFeatureTagArray []GetApplicationFeatureTagInput

func (GetApplicationFeatureTagArray) ElementType added in v5.6.0

func (GetApplicationFeatureTagArray) ToGetApplicationFeatureTagArrayOutput added in v5.6.0

func (i GetApplicationFeatureTagArray) ToGetApplicationFeatureTagArrayOutput() GetApplicationFeatureTagArrayOutput

func (GetApplicationFeatureTagArray) ToGetApplicationFeatureTagArrayOutputWithContext added in v5.6.0

func (i GetApplicationFeatureTagArray) ToGetApplicationFeatureTagArrayOutputWithContext(ctx context.Context) GetApplicationFeatureTagArrayOutput

type GetApplicationFeatureTagArrayInput added in v5.6.0

type GetApplicationFeatureTagArrayInput interface {
	pulumi.Input

	ToGetApplicationFeatureTagArrayOutput() GetApplicationFeatureTagArrayOutput
	ToGetApplicationFeatureTagArrayOutputWithContext(context.Context) GetApplicationFeatureTagArrayOutput
}

GetApplicationFeatureTagArrayInput is an input type that accepts GetApplicationFeatureTagArray and GetApplicationFeatureTagArrayOutput values. You can construct a concrete instance of `GetApplicationFeatureTagArrayInput` via:

GetApplicationFeatureTagArray{ GetApplicationFeatureTagArgs{...} }

type GetApplicationFeatureTagArrayOutput added in v5.6.0

type GetApplicationFeatureTagArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationFeatureTagArrayOutput) ElementType added in v5.6.0

func (GetApplicationFeatureTagArrayOutput) Index added in v5.6.0

func (GetApplicationFeatureTagArrayOutput) ToGetApplicationFeatureTagArrayOutput added in v5.6.0

func (o GetApplicationFeatureTagArrayOutput) ToGetApplicationFeatureTagArrayOutput() GetApplicationFeatureTagArrayOutput

func (GetApplicationFeatureTagArrayOutput) ToGetApplicationFeatureTagArrayOutputWithContext added in v5.6.0

func (o GetApplicationFeatureTagArrayOutput) ToGetApplicationFeatureTagArrayOutputWithContext(ctx context.Context) GetApplicationFeatureTagArrayOutput

type GetApplicationFeatureTagInput added in v5.6.0

type GetApplicationFeatureTagInput interface {
	pulumi.Input

	ToGetApplicationFeatureTagOutput() GetApplicationFeatureTagOutput
	ToGetApplicationFeatureTagOutputWithContext(context.Context) GetApplicationFeatureTagOutput
}

GetApplicationFeatureTagInput is an input type that accepts GetApplicationFeatureTagArgs and GetApplicationFeatureTagOutput values. You can construct a concrete instance of `GetApplicationFeatureTagInput` via:

GetApplicationFeatureTagArgs{...}

type GetApplicationFeatureTagOutput added in v5.6.0

type GetApplicationFeatureTagOutput struct{ *pulumi.OutputState }

func (GetApplicationFeatureTagOutput) CustomSingleSignOn added in v5.6.0

func (o GetApplicationFeatureTagOutput) CustomSingleSignOn() pulumi.BoolPtrOutput

Whether this application represents a custom SAML application for linked service principals.

func (GetApplicationFeatureTagOutput) ElementType added in v5.6.0

func (GetApplicationFeatureTagOutput) Enterprise added in v5.6.0

Whether this application represents an Enterprise Application for linked service principals.

func (GetApplicationFeatureTagOutput) Gallery added in v5.6.0

Whether this application represents a gallery application for linked service principals.

func (GetApplicationFeatureTagOutput) Hide added in v5.6.0

Whether this app is visible to users in My Apps and Office 365 Launcher.

func (GetApplicationFeatureTagOutput) ToGetApplicationFeatureTagOutput added in v5.6.0

func (o GetApplicationFeatureTagOutput) ToGetApplicationFeatureTagOutput() GetApplicationFeatureTagOutput

func (GetApplicationFeatureTagOutput) ToGetApplicationFeatureTagOutputWithContext added in v5.6.0

func (o GetApplicationFeatureTagOutput) ToGetApplicationFeatureTagOutputWithContext(ctx context.Context) GetApplicationFeatureTagOutput

type GetApplicationOptionalClaim

type GetApplicationOptionalClaim struct {
	// One or more `accessToken` blocks as documented below.
	AccessTokens []GetApplicationOptionalClaimAccessToken `pulumi:"accessTokens"`
	// One or more `idToken` blocks as documented below.
	IdTokens []GetApplicationOptionalClaimIdToken `pulumi:"idTokens"`
	// One or more `saml2Token` blocks as documented below.
	Saml2Tokens []GetApplicationOptionalClaimSaml2Token `pulumi:"saml2Tokens"`
}

type GetApplicationOptionalClaimAccessToken

type GetApplicationOptionalClaimAccessToken struct {
	// List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.
	AdditionalProperties []string `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential *bool `pulumi:"essential"`
	// The name of the optional claim.
	Name string `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source *string `pulumi:"source"`
}

type GetApplicationOptionalClaimAccessTokenArgs

type GetApplicationOptionalClaimAccessTokenArgs struct {
	// List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.
	AdditionalProperties pulumi.StringArrayInput `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential pulumi.BoolPtrInput `pulumi:"essential"`
	// The name of the optional claim.
	Name pulumi.StringInput `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source pulumi.StringPtrInput `pulumi:"source"`
}

func (GetApplicationOptionalClaimAccessTokenArgs) ElementType

func (GetApplicationOptionalClaimAccessTokenArgs) ToGetApplicationOptionalClaimAccessTokenOutput

func (i GetApplicationOptionalClaimAccessTokenArgs) ToGetApplicationOptionalClaimAccessTokenOutput() GetApplicationOptionalClaimAccessTokenOutput

func (GetApplicationOptionalClaimAccessTokenArgs) ToGetApplicationOptionalClaimAccessTokenOutputWithContext

func (i GetApplicationOptionalClaimAccessTokenArgs) ToGetApplicationOptionalClaimAccessTokenOutputWithContext(ctx context.Context) GetApplicationOptionalClaimAccessTokenOutput

type GetApplicationOptionalClaimAccessTokenArray

type GetApplicationOptionalClaimAccessTokenArray []GetApplicationOptionalClaimAccessTokenInput

func (GetApplicationOptionalClaimAccessTokenArray) ElementType

func (GetApplicationOptionalClaimAccessTokenArray) ToGetApplicationOptionalClaimAccessTokenArrayOutput

func (i GetApplicationOptionalClaimAccessTokenArray) ToGetApplicationOptionalClaimAccessTokenArrayOutput() GetApplicationOptionalClaimAccessTokenArrayOutput

func (GetApplicationOptionalClaimAccessTokenArray) ToGetApplicationOptionalClaimAccessTokenArrayOutputWithContext

func (i GetApplicationOptionalClaimAccessTokenArray) ToGetApplicationOptionalClaimAccessTokenArrayOutputWithContext(ctx context.Context) GetApplicationOptionalClaimAccessTokenArrayOutput

type GetApplicationOptionalClaimAccessTokenArrayInput

type GetApplicationOptionalClaimAccessTokenArrayInput interface {
	pulumi.Input

	ToGetApplicationOptionalClaimAccessTokenArrayOutput() GetApplicationOptionalClaimAccessTokenArrayOutput
	ToGetApplicationOptionalClaimAccessTokenArrayOutputWithContext(context.Context) GetApplicationOptionalClaimAccessTokenArrayOutput
}

GetApplicationOptionalClaimAccessTokenArrayInput is an input type that accepts GetApplicationOptionalClaimAccessTokenArray and GetApplicationOptionalClaimAccessTokenArrayOutput values. You can construct a concrete instance of `GetApplicationOptionalClaimAccessTokenArrayInput` via:

GetApplicationOptionalClaimAccessTokenArray{ GetApplicationOptionalClaimAccessTokenArgs{...} }

type GetApplicationOptionalClaimAccessTokenArrayOutput

type GetApplicationOptionalClaimAccessTokenArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationOptionalClaimAccessTokenArrayOutput) ElementType

func (GetApplicationOptionalClaimAccessTokenArrayOutput) Index

func (GetApplicationOptionalClaimAccessTokenArrayOutput) ToGetApplicationOptionalClaimAccessTokenArrayOutput

func (o GetApplicationOptionalClaimAccessTokenArrayOutput) ToGetApplicationOptionalClaimAccessTokenArrayOutput() GetApplicationOptionalClaimAccessTokenArrayOutput

func (GetApplicationOptionalClaimAccessTokenArrayOutput) ToGetApplicationOptionalClaimAccessTokenArrayOutputWithContext

func (o GetApplicationOptionalClaimAccessTokenArrayOutput) ToGetApplicationOptionalClaimAccessTokenArrayOutputWithContext(ctx context.Context) GetApplicationOptionalClaimAccessTokenArrayOutput

type GetApplicationOptionalClaimAccessTokenInput

type GetApplicationOptionalClaimAccessTokenInput interface {
	pulumi.Input

	ToGetApplicationOptionalClaimAccessTokenOutput() GetApplicationOptionalClaimAccessTokenOutput
	ToGetApplicationOptionalClaimAccessTokenOutputWithContext(context.Context) GetApplicationOptionalClaimAccessTokenOutput
}

GetApplicationOptionalClaimAccessTokenInput is an input type that accepts GetApplicationOptionalClaimAccessTokenArgs and GetApplicationOptionalClaimAccessTokenOutput values. You can construct a concrete instance of `GetApplicationOptionalClaimAccessTokenInput` via:

GetApplicationOptionalClaimAccessTokenArgs{...}

type GetApplicationOptionalClaimAccessTokenOutput

type GetApplicationOptionalClaimAccessTokenOutput struct{ *pulumi.OutputState }

func (GetApplicationOptionalClaimAccessTokenOutput) AdditionalProperties

List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.

func (GetApplicationOptionalClaimAccessTokenOutput) ElementType

func (GetApplicationOptionalClaimAccessTokenOutput) Essential

Whether the claim specified by the client is necessary to ensure a smooth authorization experience.

func (GetApplicationOptionalClaimAccessTokenOutput) Name

The name of the optional claim.

func (GetApplicationOptionalClaimAccessTokenOutput) Source

The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.

func (GetApplicationOptionalClaimAccessTokenOutput) ToGetApplicationOptionalClaimAccessTokenOutput

func (o GetApplicationOptionalClaimAccessTokenOutput) ToGetApplicationOptionalClaimAccessTokenOutput() GetApplicationOptionalClaimAccessTokenOutput

func (GetApplicationOptionalClaimAccessTokenOutput) ToGetApplicationOptionalClaimAccessTokenOutputWithContext

func (o GetApplicationOptionalClaimAccessTokenOutput) ToGetApplicationOptionalClaimAccessTokenOutputWithContext(ctx context.Context) GetApplicationOptionalClaimAccessTokenOutput

type GetApplicationOptionalClaimArgs

type GetApplicationOptionalClaimArgs struct {
	// One or more `accessToken` blocks as documented below.
	AccessTokens GetApplicationOptionalClaimAccessTokenArrayInput `pulumi:"accessTokens"`
	// One or more `idToken` blocks as documented below.
	IdTokens GetApplicationOptionalClaimIdTokenArrayInput `pulumi:"idTokens"`
	// One or more `saml2Token` blocks as documented below.
	Saml2Tokens GetApplicationOptionalClaimSaml2TokenArrayInput `pulumi:"saml2Tokens"`
}

func (GetApplicationOptionalClaimArgs) ElementType

func (GetApplicationOptionalClaimArgs) ToGetApplicationOptionalClaimOutput

func (i GetApplicationOptionalClaimArgs) ToGetApplicationOptionalClaimOutput() GetApplicationOptionalClaimOutput

func (GetApplicationOptionalClaimArgs) ToGetApplicationOptionalClaimOutputWithContext

func (i GetApplicationOptionalClaimArgs) ToGetApplicationOptionalClaimOutputWithContext(ctx context.Context) GetApplicationOptionalClaimOutput

type GetApplicationOptionalClaimArray

type GetApplicationOptionalClaimArray []GetApplicationOptionalClaimInput

func (GetApplicationOptionalClaimArray) ElementType

func (GetApplicationOptionalClaimArray) ToGetApplicationOptionalClaimArrayOutput

func (i GetApplicationOptionalClaimArray) ToGetApplicationOptionalClaimArrayOutput() GetApplicationOptionalClaimArrayOutput

func (GetApplicationOptionalClaimArray) ToGetApplicationOptionalClaimArrayOutputWithContext

func (i GetApplicationOptionalClaimArray) ToGetApplicationOptionalClaimArrayOutputWithContext(ctx context.Context) GetApplicationOptionalClaimArrayOutput

type GetApplicationOptionalClaimArrayInput

type GetApplicationOptionalClaimArrayInput interface {
	pulumi.Input

	ToGetApplicationOptionalClaimArrayOutput() GetApplicationOptionalClaimArrayOutput
	ToGetApplicationOptionalClaimArrayOutputWithContext(context.Context) GetApplicationOptionalClaimArrayOutput
}

GetApplicationOptionalClaimArrayInput is an input type that accepts GetApplicationOptionalClaimArray and GetApplicationOptionalClaimArrayOutput values. You can construct a concrete instance of `GetApplicationOptionalClaimArrayInput` via:

GetApplicationOptionalClaimArray{ GetApplicationOptionalClaimArgs{...} }

type GetApplicationOptionalClaimArrayOutput

type GetApplicationOptionalClaimArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationOptionalClaimArrayOutput) ElementType

func (GetApplicationOptionalClaimArrayOutput) Index

func (GetApplicationOptionalClaimArrayOutput) ToGetApplicationOptionalClaimArrayOutput

func (o GetApplicationOptionalClaimArrayOutput) ToGetApplicationOptionalClaimArrayOutput() GetApplicationOptionalClaimArrayOutput

func (GetApplicationOptionalClaimArrayOutput) ToGetApplicationOptionalClaimArrayOutputWithContext

func (o GetApplicationOptionalClaimArrayOutput) ToGetApplicationOptionalClaimArrayOutputWithContext(ctx context.Context) GetApplicationOptionalClaimArrayOutput

type GetApplicationOptionalClaimIdToken

type GetApplicationOptionalClaimIdToken struct {
	// List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.
	AdditionalProperties []string `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential *bool `pulumi:"essential"`
	// The name of the optional claim.
	Name string `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source *string `pulumi:"source"`
}

type GetApplicationOptionalClaimIdTokenArgs

type GetApplicationOptionalClaimIdTokenArgs struct {
	// List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.
	AdditionalProperties pulumi.StringArrayInput `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential pulumi.BoolPtrInput `pulumi:"essential"`
	// The name of the optional claim.
	Name pulumi.StringInput `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source pulumi.StringPtrInput `pulumi:"source"`
}

func (GetApplicationOptionalClaimIdTokenArgs) ElementType

func (GetApplicationOptionalClaimIdTokenArgs) ToGetApplicationOptionalClaimIdTokenOutput

func (i GetApplicationOptionalClaimIdTokenArgs) ToGetApplicationOptionalClaimIdTokenOutput() GetApplicationOptionalClaimIdTokenOutput

func (GetApplicationOptionalClaimIdTokenArgs) ToGetApplicationOptionalClaimIdTokenOutputWithContext

func (i GetApplicationOptionalClaimIdTokenArgs) ToGetApplicationOptionalClaimIdTokenOutputWithContext(ctx context.Context) GetApplicationOptionalClaimIdTokenOutput

type GetApplicationOptionalClaimIdTokenArray

type GetApplicationOptionalClaimIdTokenArray []GetApplicationOptionalClaimIdTokenInput

func (GetApplicationOptionalClaimIdTokenArray) ElementType

func (GetApplicationOptionalClaimIdTokenArray) ToGetApplicationOptionalClaimIdTokenArrayOutput

func (i GetApplicationOptionalClaimIdTokenArray) ToGetApplicationOptionalClaimIdTokenArrayOutput() GetApplicationOptionalClaimIdTokenArrayOutput

func (GetApplicationOptionalClaimIdTokenArray) ToGetApplicationOptionalClaimIdTokenArrayOutputWithContext

func (i GetApplicationOptionalClaimIdTokenArray) ToGetApplicationOptionalClaimIdTokenArrayOutputWithContext(ctx context.Context) GetApplicationOptionalClaimIdTokenArrayOutput

type GetApplicationOptionalClaimIdTokenArrayInput

type GetApplicationOptionalClaimIdTokenArrayInput interface {
	pulumi.Input

	ToGetApplicationOptionalClaimIdTokenArrayOutput() GetApplicationOptionalClaimIdTokenArrayOutput
	ToGetApplicationOptionalClaimIdTokenArrayOutputWithContext(context.Context) GetApplicationOptionalClaimIdTokenArrayOutput
}

GetApplicationOptionalClaimIdTokenArrayInput is an input type that accepts GetApplicationOptionalClaimIdTokenArray and GetApplicationOptionalClaimIdTokenArrayOutput values. You can construct a concrete instance of `GetApplicationOptionalClaimIdTokenArrayInput` via:

GetApplicationOptionalClaimIdTokenArray{ GetApplicationOptionalClaimIdTokenArgs{...} }

type GetApplicationOptionalClaimIdTokenArrayOutput

type GetApplicationOptionalClaimIdTokenArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationOptionalClaimIdTokenArrayOutput) ElementType

func (GetApplicationOptionalClaimIdTokenArrayOutput) Index

func (GetApplicationOptionalClaimIdTokenArrayOutput) ToGetApplicationOptionalClaimIdTokenArrayOutput

func (o GetApplicationOptionalClaimIdTokenArrayOutput) ToGetApplicationOptionalClaimIdTokenArrayOutput() GetApplicationOptionalClaimIdTokenArrayOutput

func (GetApplicationOptionalClaimIdTokenArrayOutput) ToGetApplicationOptionalClaimIdTokenArrayOutputWithContext

func (o GetApplicationOptionalClaimIdTokenArrayOutput) ToGetApplicationOptionalClaimIdTokenArrayOutputWithContext(ctx context.Context) GetApplicationOptionalClaimIdTokenArrayOutput

type GetApplicationOptionalClaimIdTokenInput

type GetApplicationOptionalClaimIdTokenInput interface {
	pulumi.Input

	ToGetApplicationOptionalClaimIdTokenOutput() GetApplicationOptionalClaimIdTokenOutput
	ToGetApplicationOptionalClaimIdTokenOutputWithContext(context.Context) GetApplicationOptionalClaimIdTokenOutput
}

GetApplicationOptionalClaimIdTokenInput is an input type that accepts GetApplicationOptionalClaimIdTokenArgs and GetApplicationOptionalClaimIdTokenOutput values. You can construct a concrete instance of `GetApplicationOptionalClaimIdTokenInput` via:

GetApplicationOptionalClaimIdTokenArgs{...}

type GetApplicationOptionalClaimIdTokenOutput

type GetApplicationOptionalClaimIdTokenOutput struct{ *pulumi.OutputState }

func (GetApplicationOptionalClaimIdTokenOutput) AdditionalProperties

List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.

func (GetApplicationOptionalClaimIdTokenOutput) ElementType

func (GetApplicationOptionalClaimIdTokenOutput) Essential

Whether the claim specified by the client is necessary to ensure a smooth authorization experience.

func (GetApplicationOptionalClaimIdTokenOutput) Name

The name of the optional claim.

func (GetApplicationOptionalClaimIdTokenOutput) Source

The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.

func (GetApplicationOptionalClaimIdTokenOutput) ToGetApplicationOptionalClaimIdTokenOutput

func (o GetApplicationOptionalClaimIdTokenOutput) ToGetApplicationOptionalClaimIdTokenOutput() GetApplicationOptionalClaimIdTokenOutput

func (GetApplicationOptionalClaimIdTokenOutput) ToGetApplicationOptionalClaimIdTokenOutputWithContext

func (o GetApplicationOptionalClaimIdTokenOutput) ToGetApplicationOptionalClaimIdTokenOutputWithContext(ctx context.Context) GetApplicationOptionalClaimIdTokenOutput

type GetApplicationOptionalClaimInput

type GetApplicationOptionalClaimInput interface {
	pulumi.Input

	ToGetApplicationOptionalClaimOutput() GetApplicationOptionalClaimOutput
	ToGetApplicationOptionalClaimOutputWithContext(context.Context) GetApplicationOptionalClaimOutput
}

GetApplicationOptionalClaimInput is an input type that accepts GetApplicationOptionalClaimArgs and GetApplicationOptionalClaimOutput values. You can construct a concrete instance of `GetApplicationOptionalClaimInput` via:

GetApplicationOptionalClaimArgs{...}

type GetApplicationOptionalClaimOutput

type GetApplicationOptionalClaimOutput struct{ *pulumi.OutputState }

func (GetApplicationOptionalClaimOutput) AccessTokens

One or more `accessToken` blocks as documented below.

func (GetApplicationOptionalClaimOutput) ElementType

func (GetApplicationOptionalClaimOutput) IdTokens

One or more `idToken` blocks as documented below.

func (GetApplicationOptionalClaimOutput) Saml2Tokens

One or more `saml2Token` blocks as documented below.

func (GetApplicationOptionalClaimOutput) ToGetApplicationOptionalClaimOutput

func (o GetApplicationOptionalClaimOutput) ToGetApplicationOptionalClaimOutput() GetApplicationOptionalClaimOutput

func (GetApplicationOptionalClaimOutput) ToGetApplicationOptionalClaimOutputWithContext

func (o GetApplicationOptionalClaimOutput) ToGetApplicationOptionalClaimOutputWithContext(ctx context.Context) GetApplicationOptionalClaimOutput

type GetApplicationOptionalClaimSaml2Token

type GetApplicationOptionalClaimSaml2Token struct {
	// List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.
	AdditionalProperties []string `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential *bool `pulumi:"essential"`
	// The name of the optional claim.
	Name string `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source *string `pulumi:"source"`
}

type GetApplicationOptionalClaimSaml2TokenArgs

type GetApplicationOptionalClaimSaml2TokenArgs struct {
	// List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.
	AdditionalProperties pulumi.StringArrayInput `pulumi:"additionalProperties"`
	// Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
	Essential pulumi.BoolPtrInput `pulumi:"essential"`
	// The name of the optional claim.
	Name pulumi.StringInput `pulumi:"name"`
	// The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.
	Source pulumi.StringPtrInput `pulumi:"source"`
}

func (GetApplicationOptionalClaimSaml2TokenArgs) ElementType

func (GetApplicationOptionalClaimSaml2TokenArgs) ToGetApplicationOptionalClaimSaml2TokenOutput

func (i GetApplicationOptionalClaimSaml2TokenArgs) ToGetApplicationOptionalClaimSaml2TokenOutput() GetApplicationOptionalClaimSaml2TokenOutput

func (GetApplicationOptionalClaimSaml2TokenArgs) ToGetApplicationOptionalClaimSaml2TokenOutputWithContext

func (i GetApplicationOptionalClaimSaml2TokenArgs) ToGetApplicationOptionalClaimSaml2TokenOutputWithContext(ctx context.Context) GetApplicationOptionalClaimSaml2TokenOutput

type GetApplicationOptionalClaimSaml2TokenArray

type GetApplicationOptionalClaimSaml2TokenArray []GetApplicationOptionalClaimSaml2TokenInput

func (GetApplicationOptionalClaimSaml2TokenArray) ElementType

func (GetApplicationOptionalClaimSaml2TokenArray) ToGetApplicationOptionalClaimSaml2TokenArrayOutput

func (i GetApplicationOptionalClaimSaml2TokenArray) ToGetApplicationOptionalClaimSaml2TokenArrayOutput() GetApplicationOptionalClaimSaml2TokenArrayOutput

func (GetApplicationOptionalClaimSaml2TokenArray) ToGetApplicationOptionalClaimSaml2TokenArrayOutputWithContext

func (i GetApplicationOptionalClaimSaml2TokenArray) ToGetApplicationOptionalClaimSaml2TokenArrayOutputWithContext(ctx context.Context) GetApplicationOptionalClaimSaml2TokenArrayOutput

type GetApplicationOptionalClaimSaml2TokenArrayInput

type GetApplicationOptionalClaimSaml2TokenArrayInput interface {
	pulumi.Input

	ToGetApplicationOptionalClaimSaml2TokenArrayOutput() GetApplicationOptionalClaimSaml2TokenArrayOutput
	ToGetApplicationOptionalClaimSaml2TokenArrayOutputWithContext(context.Context) GetApplicationOptionalClaimSaml2TokenArrayOutput
}

GetApplicationOptionalClaimSaml2TokenArrayInput is an input type that accepts GetApplicationOptionalClaimSaml2TokenArray and GetApplicationOptionalClaimSaml2TokenArrayOutput values. You can construct a concrete instance of `GetApplicationOptionalClaimSaml2TokenArrayInput` via:

GetApplicationOptionalClaimSaml2TokenArray{ GetApplicationOptionalClaimSaml2TokenArgs{...} }

type GetApplicationOptionalClaimSaml2TokenArrayOutput

type GetApplicationOptionalClaimSaml2TokenArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationOptionalClaimSaml2TokenArrayOutput) ElementType

func (GetApplicationOptionalClaimSaml2TokenArrayOutput) Index

func (GetApplicationOptionalClaimSaml2TokenArrayOutput) ToGetApplicationOptionalClaimSaml2TokenArrayOutput

func (o GetApplicationOptionalClaimSaml2TokenArrayOutput) ToGetApplicationOptionalClaimSaml2TokenArrayOutput() GetApplicationOptionalClaimSaml2TokenArrayOutput

func (GetApplicationOptionalClaimSaml2TokenArrayOutput) ToGetApplicationOptionalClaimSaml2TokenArrayOutputWithContext

func (o GetApplicationOptionalClaimSaml2TokenArrayOutput) ToGetApplicationOptionalClaimSaml2TokenArrayOutputWithContext(ctx context.Context) GetApplicationOptionalClaimSaml2TokenArrayOutput

type GetApplicationOptionalClaimSaml2TokenInput

type GetApplicationOptionalClaimSaml2TokenInput interface {
	pulumi.Input

	ToGetApplicationOptionalClaimSaml2TokenOutput() GetApplicationOptionalClaimSaml2TokenOutput
	ToGetApplicationOptionalClaimSaml2TokenOutputWithContext(context.Context) GetApplicationOptionalClaimSaml2TokenOutput
}

GetApplicationOptionalClaimSaml2TokenInput is an input type that accepts GetApplicationOptionalClaimSaml2TokenArgs and GetApplicationOptionalClaimSaml2TokenOutput values. You can construct a concrete instance of `GetApplicationOptionalClaimSaml2TokenInput` via:

GetApplicationOptionalClaimSaml2TokenArgs{...}

type GetApplicationOptionalClaimSaml2TokenOutput

type GetApplicationOptionalClaimSaml2TokenOutput struct{ *pulumi.OutputState }

func (GetApplicationOptionalClaimSaml2TokenOutput) AdditionalProperties

List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.

func (GetApplicationOptionalClaimSaml2TokenOutput) ElementType

func (GetApplicationOptionalClaimSaml2TokenOutput) Essential

Whether the claim specified by the client is necessary to ensure a smooth authorization experience.

func (GetApplicationOptionalClaimSaml2TokenOutput) Name

The name of the optional claim.

func (GetApplicationOptionalClaimSaml2TokenOutput) Source

The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object.

func (GetApplicationOptionalClaimSaml2TokenOutput) ToGetApplicationOptionalClaimSaml2TokenOutput

func (o GetApplicationOptionalClaimSaml2TokenOutput) ToGetApplicationOptionalClaimSaml2TokenOutput() GetApplicationOptionalClaimSaml2TokenOutput

func (GetApplicationOptionalClaimSaml2TokenOutput) ToGetApplicationOptionalClaimSaml2TokenOutputWithContext

func (o GetApplicationOptionalClaimSaml2TokenOutput) ToGetApplicationOptionalClaimSaml2TokenOutputWithContext(ctx context.Context) GetApplicationOptionalClaimSaml2TokenOutput

type GetApplicationPublicClient

type GetApplicationPublicClient struct {
	// A list of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.
	RedirectUris []string `pulumi:"redirectUris"`
}

type GetApplicationPublicClientArgs

type GetApplicationPublicClientArgs struct {
	// A list of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.
	RedirectUris pulumi.StringArrayInput `pulumi:"redirectUris"`
}

func (GetApplicationPublicClientArgs) ElementType

func (GetApplicationPublicClientArgs) ToGetApplicationPublicClientOutput

func (i GetApplicationPublicClientArgs) ToGetApplicationPublicClientOutput() GetApplicationPublicClientOutput

func (GetApplicationPublicClientArgs) ToGetApplicationPublicClientOutputWithContext

func (i GetApplicationPublicClientArgs) ToGetApplicationPublicClientOutputWithContext(ctx context.Context) GetApplicationPublicClientOutput

type GetApplicationPublicClientArray

type GetApplicationPublicClientArray []GetApplicationPublicClientInput

func (GetApplicationPublicClientArray) ElementType

func (GetApplicationPublicClientArray) ToGetApplicationPublicClientArrayOutput

func (i GetApplicationPublicClientArray) ToGetApplicationPublicClientArrayOutput() GetApplicationPublicClientArrayOutput

func (GetApplicationPublicClientArray) ToGetApplicationPublicClientArrayOutputWithContext

func (i GetApplicationPublicClientArray) ToGetApplicationPublicClientArrayOutputWithContext(ctx context.Context) GetApplicationPublicClientArrayOutput

type GetApplicationPublicClientArrayInput

type GetApplicationPublicClientArrayInput interface {
	pulumi.Input

	ToGetApplicationPublicClientArrayOutput() GetApplicationPublicClientArrayOutput
	ToGetApplicationPublicClientArrayOutputWithContext(context.Context) GetApplicationPublicClientArrayOutput
}

GetApplicationPublicClientArrayInput is an input type that accepts GetApplicationPublicClientArray and GetApplicationPublicClientArrayOutput values. You can construct a concrete instance of `GetApplicationPublicClientArrayInput` via:

GetApplicationPublicClientArray{ GetApplicationPublicClientArgs{...} }

type GetApplicationPublicClientArrayOutput

type GetApplicationPublicClientArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationPublicClientArrayOutput) ElementType

func (GetApplicationPublicClientArrayOutput) Index

func (GetApplicationPublicClientArrayOutput) ToGetApplicationPublicClientArrayOutput

func (o GetApplicationPublicClientArrayOutput) ToGetApplicationPublicClientArrayOutput() GetApplicationPublicClientArrayOutput

func (GetApplicationPublicClientArrayOutput) ToGetApplicationPublicClientArrayOutputWithContext

func (o GetApplicationPublicClientArrayOutput) ToGetApplicationPublicClientArrayOutputWithContext(ctx context.Context) GetApplicationPublicClientArrayOutput

type GetApplicationPublicClientInput

type GetApplicationPublicClientInput interface {
	pulumi.Input

	ToGetApplicationPublicClientOutput() GetApplicationPublicClientOutput
	ToGetApplicationPublicClientOutputWithContext(context.Context) GetApplicationPublicClientOutput
}

GetApplicationPublicClientInput is an input type that accepts GetApplicationPublicClientArgs and GetApplicationPublicClientOutput values. You can construct a concrete instance of `GetApplicationPublicClientInput` via:

GetApplicationPublicClientArgs{...}

type GetApplicationPublicClientOutput

type GetApplicationPublicClientOutput struct{ *pulumi.OutputState }

func (GetApplicationPublicClientOutput) ElementType

func (GetApplicationPublicClientOutput) RedirectUris

A list of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.

func (GetApplicationPublicClientOutput) ToGetApplicationPublicClientOutput

func (o GetApplicationPublicClientOutput) ToGetApplicationPublicClientOutput() GetApplicationPublicClientOutput

func (GetApplicationPublicClientOutput) ToGetApplicationPublicClientOutputWithContext

func (o GetApplicationPublicClientOutput) ToGetApplicationPublicClientOutputWithContext(ctx context.Context) GetApplicationPublicClientOutput

type GetApplicationPublishedAppIdsResult

type GetApplicationPublishedAppIdsResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A map of application names to application IDs.
	Result map[string]string `pulumi:"result"`
}

A collection of values returned by getApplicationPublishedAppIds.

func GetApplicationPublishedAppIds

func GetApplicationPublishedAppIds(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetApplicationPublishedAppIdsResult, error)

## Example Usage

*Listing well-known application IDs*

<!--Start PulumiCodeChooser --> ```go 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 {
		wellKnown, err := azuread.GetApplicationPublishedAppIds(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("publishedAppIds", wellKnown.Result)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Granting access to an application*

<!--Start PulumiCodeChooser --> ```go 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 {
		wellKnown, err := azuread.GetApplicationPublishedAppIds(ctx, nil, nil)
		if err != nil {
			return err
		}
		msgraph, err := azuread.NewServicePrincipal(ctx, "msgraph", &azuread.ServicePrincipalArgs{
			ClientId:    pulumi.String(wellKnown.Result.MicrosoftGraph),
			UseExisting: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			RequiredResourceAccesses: azuread.ApplicationRequiredResourceAccessArray{
				&azuread.ApplicationRequiredResourceAccessArgs{
					ResourceAppId: pulumi.String(wellKnown.Result.MicrosoftGraph),
					ResourceAccesses: azuread.ApplicationRequiredResourceAccessResourceAccessArray{
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id: msgraph.AppRoleIds.ApplyT(func(appRoleIds map[string]string) (string, error) {
								return appRoleIds.User.Read.All, nil
							}).(pulumi.StringOutput),
							Type: pulumi.String("Role"),
						},
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id: msgraph.Oauth2PermissionScopeIds.ApplyT(func(oauth2PermissionScopeIds map[string]string) (string, error) {
								return oauth2PermissionScopeIds.User.ReadWrite, nil
							}).(pulumi.StringOutput),
							Type: pulumi.String("Scope"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetApplicationPublishedAppIdsResultOutput added in v5.43.0

type GetApplicationPublishedAppIdsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getApplicationPublishedAppIds.

func GetApplicationPublishedAppIdsOutput added in v5.43.0

func GetApplicationPublishedAppIdsOutput(ctx *pulumi.Context, opts ...pulumi.InvokeOption) GetApplicationPublishedAppIdsResultOutput

func (GetApplicationPublishedAppIdsResultOutput) ElementType added in v5.43.0

func (GetApplicationPublishedAppIdsResultOutput) Id added in v5.43.0

The provider-assigned unique ID for this managed resource.

func (GetApplicationPublishedAppIdsResultOutput) Result added in v5.43.0

A map of application names to application IDs.

func (GetApplicationPublishedAppIdsResultOutput) ToGetApplicationPublishedAppIdsResultOutput added in v5.43.0

func (o GetApplicationPublishedAppIdsResultOutput) ToGetApplicationPublishedAppIdsResultOutput() GetApplicationPublishedAppIdsResultOutput

func (GetApplicationPublishedAppIdsResultOutput) ToGetApplicationPublishedAppIdsResultOutputWithContext added in v5.43.0

func (o GetApplicationPublishedAppIdsResultOutput) ToGetApplicationPublishedAppIdsResultOutputWithContext(ctx context.Context) GetApplicationPublishedAppIdsResultOutput

type GetApplicationRequiredResourceAccess

type GetApplicationRequiredResourceAccess struct {
	// A collection of `resourceAccess` blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
	ResourceAccesses []GetApplicationRequiredResourceAccessResourceAccess `pulumi:"resourceAccesses"`
	// The unique identifier for the resource that the application requires access to. This is the Application ID of the target application.
	ResourceAppId string `pulumi:"resourceAppId"`
}

type GetApplicationRequiredResourceAccessArgs

type GetApplicationRequiredResourceAccessArgs struct {
	// A collection of `resourceAccess` blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
	ResourceAccesses GetApplicationRequiredResourceAccessResourceAccessArrayInput `pulumi:"resourceAccesses"`
	// The unique identifier for the resource that the application requires access to. This is the Application ID of the target application.
	ResourceAppId pulumi.StringInput `pulumi:"resourceAppId"`
}

func (GetApplicationRequiredResourceAccessArgs) ElementType

func (GetApplicationRequiredResourceAccessArgs) ToGetApplicationRequiredResourceAccessOutput

func (i GetApplicationRequiredResourceAccessArgs) ToGetApplicationRequiredResourceAccessOutput() GetApplicationRequiredResourceAccessOutput

func (GetApplicationRequiredResourceAccessArgs) ToGetApplicationRequiredResourceAccessOutputWithContext

func (i GetApplicationRequiredResourceAccessArgs) ToGetApplicationRequiredResourceAccessOutputWithContext(ctx context.Context) GetApplicationRequiredResourceAccessOutput

type GetApplicationRequiredResourceAccessArray

type GetApplicationRequiredResourceAccessArray []GetApplicationRequiredResourceAccessInput

func (GetApplicationRequiredResourceAccessArray) ElementType

func (GetApplicationRequiredResourceAccessArray) ToGetApplicationRequiredResourceAccessArrayOutput

func (i GetApplicationRequiredResourceAccessArray) ToGetApplicationRequiredResourceAccessArrayOutput() GetApplicationRequiredResourceAccessArrayOutput

func (GetApplicationRequiredResourceAccessArray) ToGetApplicationRequiredResourceAccessArrayOutputWithContext

func (i GetApplicationRequiredResourceAccessArray) ToGetApplicationRequiredResourceAccessArrayOutputWithContext(ctx context.Context) GetApplicationRequiredResourceAccessArrayOutput

type GetApplicationRequiredResourceAccessArrayInput

type GetApplicationRequiredResourceAccessArrayInput interface {
	pulumi.Input

	ToGetApplicationRequiredResourceAccessArrayOutput() GetApplicationRequiredResourceAccessArrayOutput
	ToGetApplicationRequiredResourceAccessArrayOutputWithContext(context.Context) GetApplicationRequiredResourceAccessArrayOutput
}

GetApplicationRequiredResourceAccessArrayInput is an input type that accepts GetApplicationRequiredResourceAccessArray and GetApplicationRequiredResourceAccessArrayOutput values. You can construct a concrete instance of `GetApplicationRequiredResourceAccessArrayInput` via:

GetApplicationRequiredResourceAccessArray{ GetApplicationRequiredResourceAccessArgs{...} }

type GetApplicationRequiredResourceAccessArrayOutput

type GetApplicationRequiredResourceAccessArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationRequiredResourceAccessArrayOutput) ElementType

func (GetApplicationRequiredResourceAccessArrayOutput) Index

func (GetApplicationRequiredResourceAccessArrayOutput) ToGetApplicationRequiredResourceAccessArrayOutput

func (o GetApplicationRequiredResourceAccessArrayOutput) ToGetApplicationRequiredResourceAccessArrayOutput() GetApplicationRequiredResourceAccessArrayOutput

func (GetApplicationRequiredResourceAccessArrayOutput) ToGetApplicationRequiredResourceAccessArrayOutputWithContext

func (o GetApplicationRequiredResourceAccessArrayOutput) ToGetApplicationRequiredResourceAccessArrayOutputWithContext(ctx context.Context) GetApplicationRequiredResourceAccessArrayOutput

type GetApplicationRequiredResourceAccessInput

type GetApplicationRequiredResourceAccessInput interface {
	pulumi.Input

	ToGetApplicationRequiredResourceAccessOutput() GetApplicationRequiredResourceAccessOutput
	ToGetApplicationRequiredResourceAccessOutputWithContext(context.Context) GetApplicationRequiredResourceAccessOutput
}

GetApplicationRequiredResourceAccessInput is an input type that accepts GetApplicationRequiredResourceAccessArgs and GetApplicationRequiredResourceAccessOutput values. You can construct a concrete instance of `GetApplicationRequiredResourceAccessInput` via:

GetApplicationRequiredResourceAccessArgs{...}

type GetApplicationRequiredResourceAccessOutput

type GetApplicationRequiredResourceAccessOutput struct{ *pulumi.OutputState }

func (GetApplicationRequiredResourceAccessOutput) ElementType

func (GetApplicationRequiredResourceAccessOutput) ResourceAccesses

A collection of `resourceAccess` blocks as documented below, describing OAuth2.0 permission scopes and app roles that the application requires from the specified resource.

func (GetApplicationRequiredResourceAccessOutput) ResourceAppId

The unique identifier for the resource that the application requires access to. This is the Application ID of the target application.

func (GetApplicationRequiredResourceAccessOutput) ToGetApplicationRequiredResourceAccessOutput

func (o GetApplicationRequiredResourceAccessOutput) ToGetApplicationRequiredResourceAccessOutput() GetApplicationRequiredResourceAccessOutput

func (GetApplicationRequiredResourceAccessOutput) ToGetApplicationRequiredResourceAccessOutputWithContext

func (o GetApplicationRequiredResourceAccessOutput) ToGetApplicationRequiredResourceAccessOutputWithContext(ctx context.Context) GetApplicationRequiredResourceAccessOutput

type GetApplicationRequiredResourceAccessResourceAccess

type GetApplicationRequiredResourceAccessResourceAccess struct {
	// The unique identifier for an app role or OAuth2 permission scope published by the resource application.
	Id string `pulumi:"id"`
	// Specifies whether the `id` property references an app role or an OAuth2 permission scope. Possible values are `Role` or `Scope`.
	Type string `pulumi:"type"`
}

type GetApplicationRequiredResourceAccessResourceAccessArgs

type GetApplicationRequiredResourceAccessResourceAccessArgs struct {
	// The unique identifier for an app role or OAuth2 permission scope published by the resource application.
	Id pulumi.StringInput `pulumi:"id"`
	// Specifies whether the `id` property references an app role or an OAuth2 permission scope. Possible values are `Role` or `Scope`.
	Type pulumi.StringInput `pulumi:"type"`
}

func (GetApplicationRequiredResourceAccessResourceAccessArgs) ElementType

func (GetApplicationRequiredResourceAccessResourceAccessArgs) ToGetApplicationRequiredResourceAccessResourceAccessOutput

func (GetApplicationRequiredResourceAccessResourceAccessArgs) ToGetApplicationRequiredResourceAccessResourceAccessOutputWithContext

func (i GetApplicationRequiredResourceAccessResourceAccessArgs) ToGetApplicationRequiredResourceAccessResourceAccessOutputWithContext(ctx context.Context) GetApplicationRequiredResourceAccessResourceAccessOutput

type GetApplicationRequiredResourceAccessResourceAccessArray

type GetApplicationRequiredResourceAccessResourceAccessArray []GetApplicationRequiredResourceAccessResourceAccessInput

func (GetApplicationRequiredResourceAccessResourceAccessArray) ElementType

func (GetApplicationRequiredResourceAccessResourceAccessArray) ToGetApplicationRequiredResourceAccessResourceAccessArrayOutput

func (i GetApplicationRequiredResourceAccessResourceAccessArray) ToGetApplicationRequiredResourceAccessResourceAccessArrayOutput() GetApplicationRequiredResourceAccessResourceAccessArrayOutput

func (GetApplicationRequiredResourceAccessResourceAccessArray) ToGetApplicationRequiredResourceAccessResourceAccessArrayOutputWithContext

func (i GetApplicationRequiredResourceAccessResourceAccessArray) ToGetApplicationRequiredResourceAccessResourceAccessArrayOutputWithContext(ctx context.Context) GetApplicationRequiredResourceAccessResourceAccessArrayOutput

type GetApplicationRequiredResourceAccessResourceAccessArrayInput

type GetApplicationRequiredResourceAccessResourceAccessArrayInput interface {
	pulumi.Input

	ToGetApplicationRequiredResourceAccessResourceAccessArrayOutput() GetApplicationRequiredResourceAccessResourceAccessArrayOutput
	ToGetApplicationRequiredResourceAccessResourceAccessArrayOutputWithContext(context.Context) GetApplicationRequiredResourceAccessResourceAccessArrayOutput
}

GetApplicationRequiredResourceAccessResourceAccessArrayInput is an input type that accepts GetApplicationRequiredResourceAccessResourceAccessArray and GetApplicationRequiredResourceAccessResourceAccessArrayOutput values. You can construct a concrete instance of `GetApplicationRequiredResourceAccessResourceAccessArrayInput` via:

GetApplicationRequiredResourceAccessResourceAccessArray{ GetApplicationRequiredResourceAccessResourceAccessArgs{...} }

type GetApplicationRequiredResourceAccessResourceAccessArrayOutput

type GetApplicationRequiredResourceAccessResourceAccessArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationRequiredResourceAccessResourceAccessArrayOutput) ElementType

func (GetApplicationRequiredResourceAccessResourceAccessArrayOutput) Index

func (GetApplicationRequiredResourceAccessResourceAccessArrayOutput) ToGetApplicationRequiredResourceAccessResourceAccessArrayOutput

func (GetApplicationRequiredResourceAccessResourceAccessArrayOutput) ToGetApplicationRequiredResourceAccessResourceAccessArrayOutputWithContext

func (o GetApplicationRequiredResourceAccessResourceAccessArrayOutput) ToGetApplicationRequiredResourceAccessResourceAccessArrayOutputWithContext(ctx context.Context) GetApplicationRequiredResourceAccessResourceAccessArrayOutput

type GetApplicationRequiredResourceAccessResourceAccessInput

type GetApplicationRequiredResourceAccessResourceAccessInput interface {
	pulumi.Input

	ToGetApplicationRequiredResourceAccessResourceAccessOutput() GetApplicationRequiredResourceAccessResourceAccessOutput
	ToGetApplicationRequiredResourceAccessResourceAccessOutputWithContext(context.Context) GetApplicationRequiredResourceAccessResourceAccessOutput
}

GetApplicationRequiredResourceAccessResourceAccessInput is an input type that accepts GetApplicationRequiredResourceAccessResourceAccessArgs and GetApplicationRequiredResourceAccessResourceAccessOutput values. You can construct a concrete instance of `GetApplicationRequiredResourceAccessResourceAccessInput` via:

GetApplicationRequiredResourceAccessResourceAccessArgs{...}

type GetApplicationRequiredResourceAccessResourceAccessOutput

type GetApplicationRequiredResourceAccessResourceAccessOutput struct{ *pulumi.OutputState }

func (GetApplicationRequiredResourceAccessResourceAccessOutput) ElementType

func (GetApplicationRequiredResourceAccessResourceAccessOutput) Id

The unique identifier for an app role or OAuth2 permission scope published by the resource application.

func (GetApplicationRequiredResourceAccessResourceAccessOutput) ToGetApplicationRequiredResourceAccessResourceAccessOutput

func (GetApplicationRequiredResourceAccessResourceAccessOutput) ToGetApplicationRequiredResourceAccessResourceAccessOutputWithContext

func (o GetApplicationRequiredResourceAccessResourceAccessOutput) ToGetApplicationRequiredResourceAccessResourceAccessOutputWithContext(ctx context.Context) GetApplicationRequiredResourceAccessResourceAccessOutput

func (GetApplicationRequiredResourceAccessResourceAccessOutput) Type

Specifies whether the `id` property references an app role or an OAuth2 permission scope. Possible values are `Role` or `Scope`.

type GetApplicationSinglePageApplication

type GetApplicationSinglePageApplication struct {
	// A list of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.
	RedirectUris []string `pulumi:"redirectUris"`
}

type GetApplicationSinglePageApplicationArgs

type GetApplicationSinglePageApplicationArgs struct {
	// A list of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.
	RedirectUris pulumi.StringArrayInput `pulumi:"redirectUris"`
}

func (GetApplicationSinglePageApplicationArgs) ElementType

func (GetApplicationSinglePageApplicationArgs) ToGetApplicationSinglePageApplicationOutput

func (i GetApplicationSinglePageApplicationArgs) ToGetApplicationSinglePageApplicationOutput() GetApplicationSinglePageApplicationOutput

func (GetApplicationSinglePageApplicationArgs) ToGetApplicationSinglePageApplicationOutputWithContext

func (i GetApplicationSinglePageApplicationArgs) ToGetApplicationSinglePageApplicationOutputWithContext(ctx context.Context) GetApplicationSinglePageApplicationOutput

type GetApplicationSinglePageApplicationArray

type GetApplicationSinglePageApplicationArray []GetApplicationSinglePageApplicationInput

func (GetApplicationSinglePageApplicationArray) ElementType

func (GetApplicationSinglePageApplicationArray) ToGetApplicationSinglePageApplicationArrayOutput

func (i GetApplicationSinglePageApplicationArray) ToGetApplicationSinglePageApplicationArrayOutput() GetApplicationSinglePageApplicationArrayOutput

func (GetApplicationSinglePageApplicationArray) ToGetApplicationSinglePageApplicationArrayOutputWithContext

func (i GetApplicationSinglePageApplicationArray) ToGetApplicationSinglePageApplicationArrayOutputWithContext(ctx context.Context) GetApplicationSinglePageApplicationArrayOutput

type GetApplicationSinglePageApplicationArrayInput

type GetApplicationSinglePageApplicationArrayInput interface {
	pulumi.Input

	ToGetApplicationSinglePageApplicationArrayOutput() GetApplicationSinglePageApplicationArrayOutput
	ToGetApplicationSinglePageApplicationArrayOutputWithContext(context.Context) GetApplicationSinglePageApplicationArrayOutput
}

GetApplicationSinglePageApplicationArrayInput is an input type that accepts GetApplicationSinglePageApplicationArray and GetApplicationSinglePageApplicationArrayOutput values. You can construct a concrete instance of `GetApplicationSinglePageApplicationArrayInput` via:

GetApplicationSinglePageApplicationArray{ GetApplicationSinglePageApplicationArgs{...} }

type GetApplicationSinglePageApplicationArrayOutput

type GetApplicationSinglePageApplicationArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationSinglePageApplicationArrayOutput) ElementType

func (GetApplicationSinglePageApplicationArrayOutput) Index

func (GetApplicationSinglePageApplicationArrayOutput) ToGetApplicationSinglePageApplicationArrayOutput

func (o GetApplicationSinglePageApplicationArrayOutput) ToGetApplicationSinglePageApplicationArrayOutput() GetApplicationSinglePageApplicationArrayOutput

func (GetApplicationSinglePageApplicationArrayOutput) ToGetApplicationSinglePageApplicationArrayOutputWithContext

func (o GetApplicationSinglePageApplicationArrayOutput) ToGetApplicationSinglePageApplicationArrayOutputWithContext(ctx context.Context) GetApplicationSinglePageApplicationArrayOutput

type GetApplicationSinglePageApplicationInput

type GetApplicationSinglePageApplicationInput interface {
	pulumi.Input

	ToGetApplicationSinglePageApplicationOutput() GetApplicationSinglePageApplicationOutput
	ToGetApplicationSinglePageApplicationOutputWithContext(context.Context) GetApplicationSinglePageApplicationOutput
}

GetApplicationSinglePageApplicationInput is an input type that accepts GetApplicationSinglePageApplicationArgs and GetApplicationSinglePageApplicationOutput values. You can construct a concrete instance of `GetApplicationSinglePageApplicationInput` via:

GetApplicationSinglePageApplicationArgs{...}

type GetApplicationSinglePageApplicationOutput

type GetApplicationSinglePageApplicationOutput struct{ *pulumi.OutputState }

func (GetApplicationSinglePageApplicationOutput) ElementType

func (GetApplicationSinglePageApplicationOutput) RedirectUris

A list of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.

func (GetApplicationSinglePageApplicationOutput) ToGetApplicationSinglePageApplicationOutput

func (o GetApplicationSinglePageApplicationOutput) ToGetApplicationSinglePageApplicationOutput() GetApplicationSinglePageApplicationOutput

func (GetApplicationSinglePageApplicationOutput) ToGetApplicationSinglePageApplicationOutputWithContext

func (o GetApplicationSinglePageApplicationOutput) ToGetApplicationSinglePageApplicationOutputWithContext(ctx context.Context) GetApplicationSinglePageApplicationOutput

type GetApplicationTemplateArgs added in v5.2.0

type GetApplicationTemplateArgs struct {
	// Specifies the display name of the templated application.
	DisplayName *string `pulumi:"displayName"`
	// Specifies the ID of the templated application.
	//
	// > One of `templateId` or `displayName` must be specified.
	TemplateId *string `pulumi:"templateId"`
}

A collection of arguments for invoking getApplicationTemplate.

type GetApplicationTemplateOutputArgs added in v5.3.0

type GetApplicationTemplateOutputArgs struct {
	// Specifies the display name of the templated application.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// Specifies the ID of the templated application.
	//
	// > One of `templateId` or `displayName` must be specified.
	TemplateId pulumi.StringPtrInput `pulumi:"templateId"`
}

A collection of arguments for invoking getApplicationTemplate.

func (GetApplicationTemplateOutputArgs) ElementType added in v5.3.0

type GetApplicationTemplateResult added in v5.2.0

type GetApplicationTemplateResult struct {
	// List of categories for this templated application.
	Categories []string `pulumi:"categories"`
	// The display name for the templated application.
	DisplayName string `pulumi:"displayName"`
	// Home page URL of the templated application.
	HomepageUrl string `pulumi:"homepageUrl"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// URL to retrieve the logo for this templated application.
	LogoUrl string `pulumi:"logoUrl"`
	// Name of the publisher for this templated application.
	Publisher string `pulumi:"publisher"`
	// List of provisioning modes supported by this templated application.
	SupportedProvisioningTypes []string `pulumi:"supportedProvisioningTypes"`
	// List of single sign on modes supported by this templated application.
	SupportedSingleSignOnModes []string `pulumi:"supportedSingleSignOnModes"`
	// The ID of the templated application.
	TemplateId string `pulumi:"templateId"`
}

A collection of values returned by getApplicationTemplate.

func GetApplicationTemplate added in v5.2.0

func GetApplicationTemplate(ctx *pulumi.Context, args *GetApplicationTemplateArgs, opts ...pulumi.InvokeOption) (*GetApplicationTemplateResult, error)

Use this data source to access information about an Application Template from the [Azure AD App Gallery](https://azuremarketplace.microsoft.com/en-US/marketplace/apps/category/azure-active-directory-apps).

## API Permissions

This data source does not require any additional roles.

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.GetApplicationTemplate(ctx, &azuread.GetApplicationTemplateArgs{
			DisplayName: pulumi.StringRef("Marketo"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("applicationTemplateId", example.TemplateId)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetApplicationTemplateResultOutput added in v5.3.0

type GetApplicationTemplateResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getApplicationTemplate.

func GetApplicationTemplateOutput added in v5.3.0

func (GetApplicationTemplateResultOutput) Categories added in v5.3.0

List of categories for this templated application.

func (GetApplicationTemplateResultOutput) DisplayName added in v5.3.0

The display name for the templated application.

func (GetApplicationTemplateResultOutput) ElementType added in v5.3.0

func (GetApplicationTemplateResultOutput) HomepageUrl added in v5.3.0

Home page URL of the templated application.

func (GetApplicationTemplateResultOutput) Id added in v5.3.0

The provider-assigned unique ID for this managed resource.

func (GetApplicationTemplateResultOutput) LogoUrl added in v5.3.0

URL to retrieve the logo for this templated application.

func (GetApplicationTemplateResultOutput) Publisher added in v5.3.0

Name of the publisher for this templated application.

func (GetApplicationTemplateResultOutput) SupportedProvisioningTypes added in v5.3.0

func (o GetApplicationTemplateResultOutput) SupportedProvisioningTypes() pulumi.StringArrayOutput

List of provisioning modes supported by this templated application.

func (GetApplicationTemplateResultOutput) SupportedSingleSignOnModes added in v5.3.0

func (o GetApplicationTemplateResultOutput) SupportedSingleSignOnModes() pulumi.StringArrayOutput

List of single sign on modes supported by this templated application.

func (GetApplicationTemplateResultOutput) TemplateId added in v5.3.0

The ID of the templated application.

func (GetApplicationTemplateResultOutput) ToGetApplicationTemplateResultOutput added in v5.3.0

func (o GetApplicationTemplateResultOutput) ToGetApplicationTemplateResultOutput() GetApplicationTemplateResultOutput

func (GetApplicationTemplateResultOutput) ToGetApplicationTemplateResultOutputWithContext added in v5.3.0

func (o GetApplicationTemplateResultOutput) ToGetApplicationTemplateResultOutputWithContext(ctx context.Context) GetApplicationTemplateResultOutput

type GetApplicationWeb

type GetApplicationWeb struct {
	// Home page or landing page of the application.
	HomepageUrl string `pulumi:"homepageUrl"`
	// An `implicitGrant` block as documented above.
	ImplicitGrants []GetApplicationWebImplicitGrant `pulumi:"implicitGrants"`
	// The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
	LogoutUrl string `pulumi:"logoutUrl"`
	// A list of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.
	RedirectUris []string `pulumi:"redirectUris"`
}

type GetApplicationWebArgs

type GetApplicationWebArgs struct {
	// Home page or landing page of the application.
	HomepageUrl pulumi.StringInput `pulumi:"homepageUrl"`
	// An `implicitGrant` block as documented above.
	ImplicitGrants GetApplicationWebImplicitGrantArrayInput `pulumi:"implicitGrants"`
	// The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.
	LogoutUrl pulumi.StringInput `pulumi:"logoutUrl"`
	// A list of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.
	RedirectUris pulumi.StringArrayInput `pulumi:"redirectUris"`
}

func (GetApplicationWebArgs) ElementType

func (GetApplicationWebArgs) ElementType() reflect.Type

func (GetApplicationWebArgs) ToGetApplicationWebOutput

func (i GetApplicationWebArgs) ToGetApplicationWebOutput() GetApplicationWebOutput

func (GetApplicationWebArgs) ToGetApplicationWebOutputWithContext

func (i GetApplicationWebArgs) ToGetApplicationWebOutputWithContext(ctx context.Context) GetApplicationWebOutput

type GetApplicationWebArray

type GetApplicationWebArray []GetApplicationWebInput

func (GetApplicationWebArray) ElementType

func (GetApplicationWebArray) ElementType() reflect.Type

func (GetApplicationWebArray) ToGetApplicationWebArrayOutput

func (i GetApplicationWebArray) ToGetApplicationWebArrayOutput() GetApplicationWebArrayOutput

func (GetApplicationWebArray) ToGetApplicationWebArrayOutputWithContext

func (i GetApplicationWebArray) ToGetApplicationWebArrayOutputWithContext(ctx context.Context) GetApplicationWebArrayOutput

type GetApplicationWebArrayInput

type GetApplicationWebArrayInput interface {
	pulumi.Input

	ToGetApplicationWebArrayOutput() GetApplicationWebArrayOutput
	ToGetApplicationWebArrayOutputWithContext(context.Context) GetApplicationWebArrayOutput
}

GetApplicationWebArrayInput is an input type that accepts GetApplicationWebArray and GetApplicationWebArrayOutput values. You can construct a concrete instance of `GetApplicationWebArrayInput` via:

GetApplicationWebArray{ GetApplicationWebArgs{...} }

type GetApplicationWebArrayOutput

type GetApplicationWebArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationWebArrayOutput) ElementType

func (GetApplicationWebArrayOutput) Index

func (GetApplicationWebArrayOutput) ToGetApplicationWebArrayOutput

func (o GetApplicationWebArrayOutput) ToGetApplicationWebArrayOutput() GetApplicationWebArrayOutput

func (GetApplicationWebArrayOutput) ToGetApplicationWebArrayOutputWithContext

func (o GetApplicationWebArrayOutput) ToGetApplicationWebArrayOutputWithContext(ctx context.Context) GetApplicationWebArrayOutput

type GetApplicationWebImplicitGrant

type GetApplicationWebImplicitGrant struct {
	// Whether this web application can request an access token using OAuth 2.0 implicit flow.
	AccessTokenIssuanceEnabled bool `pulumi:"accessTokenIssuanceEnabled"`
	// Whether this web application can request an ID token using OAuth 2.0 implicit flow.
	IdTokenIssuanceEnabled bool `pulumi:"idTokenIssuanceEnabled"`
}

type GetApplicationWebImplicitGrantArgs

type GetApplicationWebImplicitGrantArgs struct {
	// Whether this web application can request an access token using OAuth 2.0 implicit flow.
	AccessTokenIssuanceEnabled pulumi.BoolInput `pulumi:"accessTokenIssuanceEnabled"`
	// Whether this web application can request an ID token using OAuth 2.0 implicit flow.
	IdTokenIssuanceEnabled pulumi.BoolInput `pulumi:"idTokenIssuanceEnabled"`
}

func (GetApplicationWebImplicitGrantArgs) ElementType

func (GetApplicationWebImplicitGrantArgs) ToGetApplicationWebImplicitGrantOutput

func (i GetApplicationWebImplicitGrantArgs) ToGetApplicationWebImplicitGrantOutput() GetApplicationWebImplicitGrantOutput

func (GetApplicationWebImplicitGrantArgs) ToGetApplicationWebImplicitGrantOutputWithContext

func (i GetApplicationWebImplicitGrantArgs) ToGetApplicationWebImplicitGrantOutputWithContext(ctx context.Context) GetApplicationWebImplicitGrantOutput

type GetApplicationWebImplicitGrantArray

type GetApplicationWebImplicitGrantArray []GetApplicationWebImplicitGrantInput

func (GetApplicationWebImplicitGrantArray) ElementType

func (GetApplicationWebImplicitGrantArray) ToGetApplicationWebImplicitGrantArrayOutput

func (i GetApplicationWebImplicitGrantArray) ToGetApplicationWebImplicitGrantArrayOutput() GetApplicationWebImplicitGrantArrayOutput

func (GetApplicationWebImplicitGrantArray) ToGetApplicationWebImplicitGrantArrayOutputWithContext

func (i GetApplicationWebImplicitGrantArray) ToGetApplicationWebImplicitGrantArrayOutputWithContext(ctx context.Context) GetApplicationWebImplicitGrantArrayOutput

type GetApplicationWebImplicitGrantArrayInput

type GetApplicationWebImplicitGrantArrayInput interface {
	pulumi.Input

	ToGetApplicationWebImplicitGrantArrayOutput() GetApplicationWebImplicitGrantArrayOutput
	ToGetApplicationWebImplicitGrantArrayOutputWithContext(context.Context) GetApplicationWebImplicitGrantArrayOutput
}

GetApplicationWebImplicitGrantArrayInput is an input type that accepts GetApplicationWebImplicitGrantArray and GetApplicationWebImplicitGrantArrayOutput values. You can construct a concrete instance of `GetApplicationWebImplicitGrantArrayInput` via:

GetApplicationWebImplicitGrantArray{ GetApplicationWebImplicitGrantArgs{...} }

type GetApplicationWebImplicitGrantArrayOutput

type GetApplicationWebImplicitGrantArrayOutput struct{ *pulumi.OutputState }

func (GetApplicationWebImplicitGrantArrayOutput) ElementType

func (GetApplicationWebImplicitGrantArrayOutput) Index

func (GetApplicationWebImplicitGrantArrayOutput) ToGetApplicationWebImplicitGrantArrayOutput

func (o GetApplicationWebImplicitGrantArrayOutput) ToGetApplicationWebImplicitGrantArrayOutput() GetApplicationWebImplicitGrantArrayOutput

func (GetApplicationWebImplicitGrantArrayOutput) ToGetApplicationWebImplicitGrantArrayOutputWithContext

func (o GetApplicationWebImplicitGrantArrayOutput) ToGetApplicationWebImplicitGrantArrayOutputWithContext(ctx context.Context) GetApplicationWebImplicitGrantArrayOutput

type GetApplicationWebImplicitGrantInput

type GetApplicationWebImplicitGrantInput interface {
	pulumi.Input

	ToGetApplicationWebImplicitGrantOutput() GetApplicationWebImplicitGrantOutput
	ToGetApplicationWebImplicitGrantOutputWithContext(context.Context) GetApplicationWebImplicitGrantOutput
}

GetApplicationWebImplicitGrantInput is an input type that accepts GetApplicationWebImplicitGrantArgs and GetApplicationWebImplicitGrantOutput values. You can construct a concrete instance of `GetApplicationWebImplicitGrantInput` via:

GetApplicationWebImplicitGrantArgs{...}

type GetApplicationWebImplicitGrantOutput

type GetApplicationWebImplicitGrantOutput struct{ *pulumi.OutputState }

func (GetApplicationWebImplicitGrantOutput) AccessTokenIssuanceEnabled

func (o GetApplicationWebImplicitGrantOutput) AccessTokenIssuanceEnabled() pulumi.BoolOutput

Whether this web application can request an access token using OAuth 2.0 implicit flow.

func (GetApplicationWebImplicitGrantOutput) ElementType

func (GetApplicationWebImplicitGrantOutput) IdTokenIssuanceEnabled

func (o GetApplicationWebImplicitGrantOutput) IdTokenIssuanceEnabled() pulumi.BoolOutput

Whether this web application can request an ID token using OAuth 2.0 implicit flow.

func (GetApplicationWebImplicitGrantOutput) ToGetApplicationWebImplicitGrantOutput

func (o GetApplicationWebImplicitGrantOutput) ToGetApplicationWebImplicitGrantOutput() GetApplicationWebImplicitGrantOutput

func (GetApplicationWebImplicitGrantOutput) ToGetApplicationWebImplicitGrantOutputWithContext

func (o GetApplicationWebImplicitGrantOutput) ToGetApplicationWebImplicitGrantOutputWithContext(ctx context.Context) GetApplicationWebImplicitGrantOutput

type GetApplicationWebInput

type GetApplicationWebInput interface {
	pulumi.Input

	ToGetApplicationWebOutput() GetApplicationWebOutput
	ToGetApplicationWebOutputWithContext(context.Context) GetApplicationWebOutput
}

GetApplicationWebInput is an input type that accepts GetApplicationWebArgs and GetApplicationWebOutput values. You can construct a concrete instance of `GetApplicationWebInput` via:

GetApplicationWebArgs{...}

type GetApplicationWebOutput

type GetApplicationWebOutput struct{ *pulumi.OutputState }

func (GetApplicationWebOutput) ElementType

func (GetApplicationWebOutput) ElementType() reflect.Type

func (GetApplicationWebOutput) HomepageUrl

Home page or landing page of the application.

func (GetApplicationWebOutput) ImplicitGrants

An `implicitGrant` block as documented above.

func (GetApplicationWebOutput) LogoutUrl

The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols.

func (GetApplicationWebOutput) RedirectUris

A list of URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.

func (GetApplicationWebOutput) ToGetApplicationWebOutput

func (o GetApplicationWebOutput) ToGetApplicationWebOutput() GetApplicationWebOutput

func (GetApplicationWebOutput) ToGetApplicationWebOutputWithContext

func (o GetApplicationWebOutput) ToGetApplicationWebOutputWithContext(ctx context.Context) GetApplicationWebOutput

type GetClientConfigResult

type GetClientConfigResult struct {
	// The client ID (application ID) linked to the authenticated principal, or the application used for delegated authentication.
	ClientId string `pulumi:"clientId"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The object ID of the authenticated principal.
	ObjectId string `pulumi:"objectId"`
	// The tenant ID of the authenticated principal.
	TenantId string `pulumi:"tenantId"`
}

A collection of values returned by getClientConfig.

func GetClientConfig

func GetClientConfig(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetClientConfigResult, error)

Use this data source to access the configuration of the AzureAD provider.

## API Permissions

No additional roles are required to use this data source.

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		current, err := azuread.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("objectId", current.ObjectId)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetClientConfigResultOutput added in v5.43.0

type GetClientConfigResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getClientConfig.

func GetClientConfigOutput added in v5.43.0

func GetClientConfigOutput(ctx *pulumi.Context, opts ...pulumi.InvokeOption) GetClientConfigResultOutput

func (GetClientConfigResultOutput) ClientId added in v5.43.0

The client ID (application ID) linked to the authenticated principal, or the application used for delegated authentication.

func (GetClientConfigResultOutput) ElementType added in v5.43.0

func (GetClientConfigResultOutput) Id added in v5.43.0

The provider-assigned unique ID for this managed resource.

func (GetClientConfigResultOutput) ObjectId added in v5.43.0

The object ID of the authenticated principal.

func (GetClientConfigResultOutput) TenantId added in v5.43.0

The tenant ID of the authenticated principal.

func (GetClientConfigResultOutput) ToGetClientConfigResultOutput added in v5.43.0

func (o GetClientConfigResultOutput) ToGetClientConfigResultOutput() GetClientConfigResultOutput

func (GetClientConfigResultOutput) ToGetClientConfigResultOutputWithContext added in v5.43.0

func (o GetClientConfigResultOutput) ToGetClientConfigResultOutputWithContext(ctx context.Context) GetClientConfigResultOutput

type GetDirectoryObjectArgs added in v5.28.0

type GetDirectoryObjectArgs struct {
	// Specifies the Object ID of the directory object to look up.
	ObjectId string `pulumi:"objectId"`
}

A collection of arguments for invoking getDirectoryObject.

type GetDirectoryObjectOutputArgs added in v5.28.0

type GetDirectoryObjectOutputArgs struct {
	// Specifies the Object ID of the directory object to look up.
	ObjectId pulumi.StringInput `pulumi:"objectId"`
}

A collection of arguments for invoking getDirectoryObject.

func (GetDirectoryObjectOutputArgs) ElementType added in v5.28.0

type GetDirectoryObjectResult added in v5.28.0

type GetDirectoryObjectResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id       string `pulumi:"id"`
	ObjectId string `pulumi:"objectId"`
	Type     string `pulumi:"type"`
}

A collection of values returned by getDirectoryObject.

func GetDirectoryObject added in v5.28.0

func GetDirectoryObject(ctx *pulumi.Context, args *GetDirectoryObjectArgs, opts ...pulumi.InvokeOption) (*GetDirectoryObjectResult, error)

Retrieves the OData type for a generic directory object having the provided object ID.

## 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 either `User.Read.All`, `Group.Read.All` or `Directory.Read.All`, depending on the type of object being queried.

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

## Example Usage

*Look up and output type of object by ID* <!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.GetDirectoryObject(ctx, &azuread.GetDirectoryObjectArgs{
			ObjectId: "00000000-0000-0000-0000-000000000000",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("objectType", example.Type)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Attributes Reference

The following attributes are exported:

*`objectId` - The object ID of the directory object. *`type` - The shortened OData type of the directory object. Possible values include: `Group`, `User` or `ServicePrincipal`.

type GetDirectoryObjectResultOutput added in v5.28.0

type GetDirectoryObjectResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDirectoryObject.

func GetDirectoryObjectOutput added in v5.28.0

func (GetDirectoryObjectResultOutput) ElementType added in v5.28.0

func (GetDirectoryObjectResultOutput) Id added in v5.28.0

The provider-assigned unique ID for this managed resource.

func (GetDirectoryObjectResultOutput) ObjectId added in v5.28.0

func (GetDirectoryObjectResultOutput) ToGetDirectoryObjectResultOutput added in v5.28.0

func (o GetDirectoryObjectResultOutput) ToGetDirectoryObjectResultOutput() GetDirectoryObjectResultOutput

func (GetDirectoryObjectResultOutput) ToGetDirectoryObjectResultOutputWithContext added in v5.28.0

func (o GetDirectoryObjectResultOutput) ToGetDirectoryObjectResultOutputWithContext(ctx context.Context) GetDirectoryObjectResultOutput

func (GetDirectoryObjectResultOutput) Type added in v5.28.0

type GetDirectoryRoleTemplatesResult added in v5.40.0

type GetDirectoryRoleTemplatesResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The object IDs of the role templates.
	ObjectIds []string `pulumi:"objectIds"`
	// A list of role templates. Each `roleTemplate` object provides the attributes documented below.
	RoleTemplates []GetDirectoryRoleTemplatesRoleTemplate `pulumi:"roleTemplates"`
}

A collection of values returned by getDirectoryRoleTemplates.

func GetDirectoryRoleTemplates added in v5.40.0

func GetDirectoryRoleTemplates(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetDirectoryRoleTemplatesResult, error)

Use this data source to access information about directory role templates within 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 one of the following application roles: `RoleManagement.Read.Directory` or `Directory.Read.All`

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

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		current, err := azuread.GetDirectoryRoleTemplates(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("roles", current.ObjectIds)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetDirectoryRoleTemplatesResultOutput added in v5.43.0

type GetDirectoryRoleTemplatesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDirectoryRoleTemplates.

func GetDirectoryRoleTemplatesOutput added in v5.43.0

func GetDirectoryRoleTemplatesOutput(ctx *pulumi.Context, opts ...pulumi.InvokeOption) GetDirectoryRoleTemplatesResultOutput

func (GetDirectoryRoleTemplatesResultOutput) ElementType added in v5.43.0

func (GetDirectoryRoleTemplatesResultOutput) Id added in v5.43.0

The provider-assigned unique ID for this managed resource.

func (GetDirectoryRoleTemplatesResultOutput) ObjectIds added in v5.43.0

The object IDs of the role templates.

func (GetDirectoryRoleTemplatesResultOutput) RoleTemplates added in v5.43.0

A list of role templates. Each `roleTemplate` object provides the attributes documented below.

func (GetDirectoryRoleTemplatesResultOutput) ToGetDirectoryRoleTemplatesResultOutput added in v5.43.0

func (o GetDirectoryRoleTemplatesResultOutput) ToGetDirectoryRoleTemplatesResultOutput() GetDirectoryRoleTemplatesResultOutput

func (GetDirectoryRoleTemplatesResultOutput) ToGetDirectoryRoleTemplatesResultOutputWithContext added in v5.43.0

func (o GetDirectoryRoleTemplatesResultOutput) ToGetDirectoryRoleTemplatesResultOutputWithContext(ctx context.Context) GetDirectoryRoleTemplatesResultOutput

type GetDirectoryRoleTemplatesRoleTemplate added in v5.40.0

type GetDirectoryRoleTemplatesRoleTemplate struct {
	// The description of the directory role template.
	Description string `pulumi:"description"`
	// The display name of the directory role template.
	DisplayName string `pulumi:"displayName"`
	// The object ID of the directory role template.
	ObjectId string `pulumi:"objectId"`
}

type GetDirectoryRoleTemplatesRoleTemplateArgs added in v5.40.0

type GetDirectoryRoleTemplatesRoleTemplateArgs struct {
	// The description of the directory role template.
	Description pulumi.StringInput `pulumi:"description"`
	// The display name of the directory role template.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The object ID of the directory role template.
	ObjectId pulumi.StringInput `pulumi:"objectId"`
}

func (GetDirectoryRoleTemplatesRoleTemplateArgs) ElementType added in v5.40.0

func (GetDirectoryRoleTemplatesRoleTemplateArgs) ToGetDirectoryRoleTemplatesRoleTemplateOutput added in v5.40.0

func (i GetDirectoryRoleTemplatesRoleTemplateArgs) ToGetDirectoryRoleTemplatesRoleTemplateOutput() GetDirectoryRoleTemplatesRoleTemplateOutput

func (GetDirectoryRoleTemplatesRoleTemplateArgs) ToGetDirectoryRoleTemplatesRoleTemplateOutputWithContext added in v5.40.0

func (i GetDirectoryRoleTemplatesRoleTemplateArgs) ToGetDirectoryRoleTemplatesRoleTemplateOutputWithContext(ctx context.Context) GetDirectoryRoleTemplatesRoleTemplateOutput

type GetDirectoryRoleTemplatesRoleTemplateArray added in v5.40.0

type GetDirectoryRoleTemplatesRoleTemplateArray []GetDirectoryRoleTemplatesRoleTemplateInput

func (GetDirectoryRoleTemplatesRoleTemplateArray) ElementType added in v5.40.0

func (GetDirectoryRoleTemplatesRoleTemplateArray) ToGetDirectoryRoleTemplatesRoleTemplateArrayOutput added in v5.40.0

func (i GetDirectoryRoleTemplatesRoleTemplateArray) ToGetDirectoryRoleTemplatesRoleTemplateArrayOutput() GetDirectoryRoleTemplatesRoleTemplateArrayOutput

func (GetDirectoryRoleTemplatesRoleTemplateArray) ToGetDirectoryRoleTemplatesRoleTemplateArrayOutputWithContext added in v5.40.0

func (i GetDirectoryRoleTemplatesRoleTemplateArray) ToGetDirectoryRoleTemplatesRoleTemplateArrayOutputWithContext(ctx context.Context) GetDirectoryRoleTemplatesRoleTemplateArrayOutput

type GetDirectoryRoleTemplatesRoleTemplateArrayInput added in v5.40.0

type GetDirectoryRoleTemplatesRoleTemplateArrayInput interface {
	pulumi.Input

	ToGetDirectoryRoleTemplatesRoleTemplateArrayOutput() GetDirectoryRoleTemplatesRoleTemplateArrayOutput
	ToGetDirectoryRoleTemplatesRoleTemplateArrayOutputWithContext(context.Context) GetDirectoryRoleTemplatesRoleTemplateArrayOutput
}

GetDirectoryRoleTemplatesRoleTemplateArrayInput is an input type that accepts GetDirectoryRoleTemplatesRoleTemplateArray and GetDirectoryRoleTemplatesRoleTemplateArrayOutput values. You can construct a concrete instance of `GetDirectoryRoleTemplatesRoleTemplateArrayInput` via:

GetDirectoryRoleTemplatesRoleTemplateArray{ GetDirectoryRoleTemplatesRoleTemplateArgs{...} }

type GetDirectoryRoleTemplatesRoleTemplateArrayOutput added in v5.40.0

type GetDirectoryRoleTemplatesRoleTemplateArrayOutput struct{ *pulumi.OutputState }

func (GetDirectoryRoleTemplatesRoleTemplateArrayOutput) ElementType added in v5.40.0

func (GetDirectoryRoleTemplatesRoleTemplateArrayOutput) Index added in v5.40.0

func (GetDirectoryRoleTemplatesRoleTemplateArrayOutput) ToGetDirectoryRoleTemplatesRoleTemplateArrayOutput added in v5.40.0

func (o GetDirectoryRoleTemplatesRoleTemplateArrayOutput) ToGetDirectoryRoleTemplatesRoleTemplateArrayOutput() GetDirectoryRoleTemplatesRoleTemplateArrayOutput

func (GetDirectoryRoleTemplatesRoleTemplateArrayOutput) ToGetDirectoryRoleTemplatesRoleTemplateArrayOutputWithContext added in v5.40.0

func (o GetDirectoryRoleTemplatesRoleTemplateArrayOutput) ToGetDirectoryRoleTemplatesRoleTemplateArrayOutputWithContext(ctx context.Context) GetDirectoryRoleTemplatesRoleTemplateArrayOutput

type GetDirectoryRoleTemplatesRoleTemplateInput added in v5.40.0

type GetDirectoryRoleTemplatesRoleTemplateInput interface {
	pulumi.Input

	ToGetDirectoryRoleTemplatesRoleTemplateOutput() GetDirectoryRoleTemplatesRoleTemplateOutput
	ToGetDirectoryRoleTemplatesRoleTemplateOutputWithContext(context.Context) GetDirectoryRoleTemplatesRoleTemplateOutput
}

GetDirectoryRoleTemplatesRoleTemplateInput is an input type that accepts GetDirectoryRoleTemplatesRoleTemplateArgs and GetDirectoryRoleTemplatesRoleTemplateOutput values. You can construct a concrete instance of `GetDirectoryRoleTemplatesRoleTemplateInput` via:

GetDirectoryRoleTemplatesRoleTemplateArgs{...}

type GetDirectoryRoleTemplatesRoleTemplateOutput added in v5.40.0

type GetDirectoryRoleTemplatesRoleTemplateOutput struct{ *pulumi.OutputState }

func (GetDirectoryRoleTemplatesRoleTemplateOutput) Description added in v5.40.0

The description of the directory role template.

func (GetDirectoryRoleTemplatesRoleTemplateOutput) DisplayName added in v5.40.0

The display name of the directory role template.

func (GetDirectoryRoleTemplatesRoleTemplateOutput) ElementType added in v5.40.0

func (GetDirectoryRoleTemplatesRoleTemplateOutput) ObjectId added in v5.40.0

The object ID of the directory role template.

func (GetDirectoryRoleTemplatesRoleTemplateOutput) ToGetDirectoryRoleTemplatesRoleTemplateOutput added in v5.40.0

func (o GetDirectoryRoleTemplatesRoleTemplateOutput) ToGetDirectoryRoleTemplatesRoleTemplateOutput() GetDirectoryRoleTemplatesRoleTemplateOutput

func (GetDirectoryRoleTemplatesRoleTemplateOutput) ToGetDirectoryRoleTemplatesRoleTemplateOutputWithContext added in v5.40.0

func (o GetDirectoryRoleTemplatesRoleTemplateOutput) ToGetDirectoryRoleTemplatesRoleTemplateOutputWithContext(ctx context.Context) GetDirectoryRoleTemplatesRoleTemplateOutput

type GetDirectoryRolesResult added in v5.33.0

type GetDirectoryRolesResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The object IDs of the roles.
	ObjectIds []string `pulumi:"objectIds"`
	// A list of users. Each `role` object provides the attributes documented below.
	Roles []GetDirectoryRolesRole `pulumi:"roles"`
	// The template IDs of the roles.
	TemplateIds []string `pulumi:"templateIds"`
}

A collection of values returned by getDirectoryRoles.

func GetDirectoryRoles added in v5.33.0

func GetDirectoryRoles(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetDirectoryRolesResult, error)

Use this data source to access information about activated directory roles within 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 one of the following application roles: `RoleManagement.Read.Directory` or `Directory.Read.All`

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

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		current, err := azuread.GetDirectoryRoles(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("roles", current.ObjectIds)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetDirectoryRolesResultOutput added in v5.43.0

type GetDirectoryRolesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDirectoryRoles.

func GetDirectoryRolesOutput added in v5.43.0

func GetDirectoryRolesOutput(ctx *pulumi.Context, opts ...pulumi.InvokeOption) GetDirectoryRolesResultOutput

func (GetDirectoryRolesResultOutput) ElementType added in v5.43.0

func (GetDirectoryRolesResultOutput) Id added in v5.43.0

The provider-assigned unique ID for this managed resource.

func (GetDirectoryRolesResultOutput) ObjectIds added in v5.43.0

The object IDs of the roles.

func (GetDirectoryRolesResultOutput) Roles added in v5.43.0

A list of users. Each `role` object provides the attributes documented below.

func (GetDirectoryRolesResultOutput) TemplateIds added in v5.43.0

The template IDs of the roles.

func (GetDirectoryRolesResultOutput) ToGetDirectoryRolesResultOutput added in v5.43.0

func (o GetDirectoryRolesResultOutput) ToGetDirectoryRolesResultOutput() GetDirectoryRolesResultOutput

func (GetDirectoryRolesResultOutput) ToGetDirectoryRolesResultOutputWithContext added in v5.43.0

func (o GetDirectoryRolesResultOutput) ToGetDirectoryRolesResultOutputWithContext(ctx context.Context) GetDirectoryRolesResultOutput

type GetDirectoryRolesRole added in v5.33.0

type GetDirectoryRolesRole struct {
	// The description of the directory role.
	Description string `pulumi:"description"`
	// The display name of the directory role.
	DisplayName string `pulumi:"displayName"`
	// The object ID of the directory role.
	ObjectId string `pulumi:"objectId"`
	// The template ID of the directory role.
	TemplateId string `pulumi:"templateId"`
}

type GetDirectoryRolesRoleArgs added in v5.33.0

type GetDirectoryRolesRoleArgs struct {
	// The description of the directory role.
	Description pulumi.StringInput `pulumi:"description"`
	// The display name of the directory role.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The object ID of the directory role.
	ObjectId pulumi.StringInput `pulumi:"objectId"`
	// The template ID of the directory role.
	TemplateId pulumi.StringInput `pulumi:"templateId"`
}

func (GetDirectoryRolesRoleArgs) ElementType added in v5.33.0

func (GetDirectoryRolesRoleArgs) ElementType() reflect.Type

func (GetDirectoryRolesRoleArgs) ToGetDirectoryRolesRoleOutput added in v5.33.0

func (i GetDirectoryRolesRoleArgs) ToGetDirectoryRolesRoleOutput() GetDirectoryRolesRoleOutput

func (GetDirectoryRolesRoleArgs) ToGetDirectoryRolesRoleOutputWithContext added in v5.33.0

func (i GetDirectoryRolesRoleArgs) ToGetDirectoryRolesRoleOutputWithContext(ctx context.Context) GetDirectoryRolesRoleOutput

type GetDirectoryRolesRoleArray added in v5.33.0

type GetDirectoryRolesRoleArray []GetDirectoryRolesRoleInput

func (GetDirectoryRolesRoleArray) ElementType added in v5.33.0

func (GetDirectoryRolesRoleArray) ElementType() reflect.Type

func (GetDirectoryRolesRoleArray) ToGetDirectoryRolesRoleArrayOutput added in v5.33.0

func (i GetDirectoryRolesRoleArray) ToGetDirectoryRolesRoleArrayOutput() GetDirectoryRolesRoleArrayOutput

func (GetDirectoryRolesRoleArray) ToGetDirectoryRolesRoleArrayOutputWithContext added in v5.33.0

func (i GetDirectoryRolesRoleArray) ToGetDirectoryRolesRoleArrayOutputWithContext(ctx context.Context) GetDirectoryRolesRoleArrayOutput

type GetDirectoryRolesRoleArrayInput added in v5.33.0

type GetDirectoryRolesRoleArrayInput interface {
	pulumi.Input

	ToGetDirectoryRolesRoleArrayOutput() GetDirectoryRolesRoleArrayOutput
	ToGetDirectoryRolesRoleArrayOutputWithContext(context.Context) GetDirectoryRolesRoleArrayOutput
}

GetDirectoryRolesRoleArrayInput is an input type that accepts GetDirectoryRolesRoleArray and GetDirectoryRolesRoleArrayOutput values. You can construct a concrete instance of `GetDirectoryRolesRoleArrayInput` via:

GetDirectoryRolesRoleArray{ GetDirectoryRolesRoleArgs{...} }

type GetDirectoryRolesRoleArrayOutput added in v5.33.0

type GetDirectoryRolesRoleArrayOutput struct{ *pulumi.OutputState }

func (GetDirectoryRolesRoleArrayOutput) ElementType added in v5.33.0

func (GetDirectoryRolesRoleArrayOutput) Index added in v5.33.0

func (GetDirectoryRolesRoleArrayOutput) ToGetDirectoryRolesRoleArrayOutput added in v5.33.0

func (o GetDirectoryRolesRoleArrayOutput) ToGetDirectoryRolesRoleArrayOutput() GetDirectoryRolesRoleArrayOutput

func (GetDirectoryRolesRoleArrayOutput) ToGetDirectoryRolesRoleArrayOutputWithContext added in v5.33.0

func (o GetDirectoryRolesRoleArrayOutput) ToGetDirectoryRolesRoleArrayOutputWithContext(ctx context.Context) GetDirectoryRolesRoleArrayOutput

type GetDirectoryRolesRoleInput added in v5.33.0

type GetDirectoryRolesRoleInput interface {
	pulumi.Input

	ToGetDirectoryRolesRoleOutput() GetDirectoryRolesRoleOutput
	ToGetDirectoryRolesRoleOutputWithContext(context.Context) GetDirectoryRolesRoleOutput
}

GetDirectoryRolesRoleInput is an input type that accepts GetDirectoryRolesRoleArgs and GetDirectoryRolesRoleOutput values. You can construct a concrete instance of `GetDirectoryRolesRoleInput` via:

GetDirectoryRolesRoleArgs{...}

type GetDirectoryRolesRoleOutput added in v5.33.0

type GetDirectoryRolesRoleOutput struct{ *pulumi.OutputState }

func (GetDirectoryRolesRoleOutput) Description added in v5.33.0

The description of the directory role.

func (GetDirectoryRolesRoleOutput) DisplayName added in v5.33.0

The display name of the directory role.

func (GetDirectoryRolesRoleOutput) ElementType added in v5.33.0

func (GetDirectoryRolesRoleOutput) ObjectId added in v5.33.0

The object ID of the directory role.

func (GetDirectoryRolesRoleOutput) TemplateId added in v5.33.0

The template ID of the directory role.

func (GetDirectoryRolesRoleOutput) ToGetDirectoryRolesRoleOutput added in v5.33.0

func (o GetDirectoryRolesRoleOutput) ToGetDirectoryRolesRoleOutput() GetDirectoryRolesRoleOutput

func (GetDirectoryRolesRoleOutput) ToGetDirectoryRolesRoleOutputWithContext added in v5.33.0

func (o GetDirectoryRolesRoleOutput) ToGetDirectoryRolesRoleOutputWithContext(ctx context.Context) GetDirectoryRolesRoleOutput

type GetDomainsArgs

type GetDomainsArgs struct {
	// Set to `true` to only return domains whose DNS is managed by Microsoft 365. Defaults to `false`.
	AdminManaged *bool `pulumi:"adminManaged"`
	// Set to `true` if unverified Azure AD domains should be included. Defaults to `false`.
	IncludeUnverified *bool `pulumi:"includeUnverified"`
	// Set to `true` to only return the default domain.
	OnlyDefault *bool `pulumi:"onlyDefault"`
	// Set to `true` to only return the initial domain, which is your primary Azure Active Directory tenant domain. Defaults to `false`.
	OnlyInitial *bool `pulumi:"onlyInitial"`
	// Set to `true` to only return verified root domains. Excludes subdomains and unverified domains.
	OnlyRoot *bool `pulumi:"onlyRoot"`
	// A list of supported services that must be supported by a domain. Possible values include `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer` and `Intune`.
	//
	// > **Note on filters** If `includeUnverified` is set to `true`, you cannot specify `onlyDefault` or `onlyInitial`. Additionally, you cannot combine `onlyDefault` with `onlyInitial`.
	SupportsServices []string `pulumi:"supportsServices"`
}

A collection of arguments for invoking getDomains.

type GetDomainsDomain

type GetDomainsDomain struct {
	// Set to `true` to only return domains whose DNS is managed by Microsoft 365. Defaults to `false`.
	AdminManaged bool `pulumi:"adminManaged"`
	// The authentication type of the domain. Possible values include `Managed` or `Federated`.
	AuthenticationType string `pulumi:"authenticationType"`
	// Whether this is the default domain that is used for user creation.
	Default bool `pulumi:"default"`
	// The name of the domain.
	DomainName string `pulumi:"domainName"`
	// Whether this is the initial domain created by Azure Active Directory.
	Initial bool `pulumi:"initial"`
	// Whether the domain is a verified root domain (not a subdomain).
	Root bool `pulumi:"root"`
	// A list of capabilities / services supported by the domain. Possible values include `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer` and `Intune`.
	SupportedServices []string `pulumi:"supportedServices"`
	// Whether the domain has completed domain ownership verification.
	Verified bool `pulumi:"verified"`
}

type GetDomainsDomainArgs

type GetDomainsDomainArgs struct {
	// Set to `true` to only return domains whose DNS is managed by Microsoft 365. Defaults to `false`.
	AdminManaged pulumi.BoolInput `pulumi:"adminManaged"`
	// The authentication type of the domain. Possible values include `Managed` or `Federated`.
	AuthenticationType pulumi.StringInput `pulumi:"authenticationType"`
	// Whether this is the default domain that is used for user creation.
	Default pulumi.BoolInput `pulumi:"default"`
	// The name of the domain.
	DomainName pulumi.StringInput `pulumi:"domainName"`
	// Whether this is the initial domain created by Azure Active Directory.
	Initial pulumi.BoolInput `pulumi:"initial"`
	// Whether the domain is a verified root domain (not a subdomain).
	Root pulumi.BoolInput `pulumi:"root"`
	// A list of capabilities / services supported by the domain. Possible values include `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer` and `Intune`.
	SupportedServices pulumi.StringArrayInput `pulumi:"supportedServices"`
	// Whether the domain has completed domain ownership verification.
	Verified pulumi.BoolInput `pulumi:"verified"`
}

func (GetDomainsDomainArgs) ElementType

func (GetDomainsDomainArgs) ElementType() reflect.Type

func (GetDomainsDomainArgs) ToGetDomainsDomainOutput

func (i GetDomainsDomainArgs) ToGetDomainsDomainOutput() GetDomainsDomainOutput

func (GetDomainsDomainArgs) ToGetDomainsDomainOutputWithContext

func (i GetDomainsDomainArgs) ToGetDomainsDomainOutputWithContext(ctx context.Context) GetDomainsDomainOutput

type GetDomainsDomainArray

type GetDomainsDomainArray []GetDomainsDomainInput

func (GetDomainsDomainArray) ElementType

func (GetDomainsDomainArray) ElementType() reflect.Type

func (GetDomainsDomainArray) ToGetDomainsDomainArrayOutput

func (i GetDomainsDomainArray) ToGetDomainsDomainArrayOutput() GetDomainsDomainArrayOutput

func (GetDomainsDomainArray) ToGetDomainsDomainArrayOutputWithContext

func (i GetDomainsDomainArray) ToGetDomainsDomainArrayOutputWithContext(ctx context.Context) GetDomainsDomainArrayOutput

type GetDomainsDomainArrayInput

type GetDomainsDomainArrayInput interface {
	pulumi.Input

	ToGetDomainsDomainArrayOutput() GetDomainsDomainArrayOutput
	ToGetDomainsDomainArrayOutputWithContext(context.Context) GetDomainsDomainArrayOutput
}

GetDomainsDomainArrayInput is an input type that accepts GetDomainsDomainArray and GetDomainsDomainArrayOutput values. You can construct a concrete instance of `GetDomainsDomainArrayInput` via:

GetDomainsDomainArray{ GetDomainsDomainArgs{...} }

type GetDomainsDomainArrayOutput

type GetDomainsDomainArrayOutput struct{ *pulumi.OutputState }

func (GetDomainsDomainArrayOutput) ElementType

func (GetDomainsDomainArrayOutput) Index

func (GetDomainsDomainArrayOutput) ToGetDomainsDomainArrayOutput

func (o GetDomainsDomainArrayOutput) ToGetDomainsDomainArrayOutput() GetDomainsDomainArrayOutput

func (GetDomainsDomainArrayOutput) ToGetDomainsDomainArrayOutputWithContext

func (o GetDomainsDomainArrayOutput) ToGetDomainsDomainArrayOutputWithContext(ctx context.Context) GetDomainsDomainArrayOutput

type GetDomainsDomainInput

type GetDomainsDomainInput interface {
	pulumi.Input

	ToGetDomainsDomainOutput() GetDomainsDomainOutput
	ToGetDomainsDomainOutputWithContext(context.Context) GetDomainsDomainOutput
}

GetDomainsDomainInput is an input type that accepts GetDomainsDomainArgs and GetDomainsDomainOutput values. You can construct a concrete instance of `GetDomainsDomainInput` via:

GetDomainsDomainArgs{...}

type GetDomainsDomainOutput

type GetDomainsDomainOutput struct{ *pulumi.OutputState }

func (GetDomainsDomainOutput) AdminManaged

func (o GetDomainsDomainOutput) AdminManaged() pulumi.BoolOutput

Set to `true` to only return domains whose DNS is managed by Microsoft 365. Defaults to `false`.

func (GetDomainsDomainOutput) AuthenticationType

func (o GetDomainsDomainOutput) AuthenticationType() pulumi.StringOutput

The authentication type of the domain. Possible values include `Managed` or `Federated`.

func (GetDomainsDomainOutput) Default

Whether this is the default domain that is used for user creation.

func (GetDomainsDomainOutput) DomainName

The name of the domain.

func (GetDomainsDomainOutput) ElementType

func (GetDomainsDomainOutput) ElementType() reflect.Type

func (GetDomainsDomainOutput) Initial

Whether this is the initial domain created by Azure Active Directory.

func (GetDomainsDomainOutput) Root

Whether the domain is a verified root domain (not a subdomain).

func (GetDomainsDomainOutput) SupportedServices

func (o GetDomainsDomainOutput) SupportedServices() pulumi.StringArrayOutput

A list of capabilities / services supported by the domain. Possible values include `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer` and `Intune`.

func (GetDomainsDomainOutput) ToGetDomainsDomainOutput

func (o GetDomainsDomainOutput) ToGetDomainsDomainOutput() GetDomainsDomainOutput

func (GetDomainsDomainOutput) ToGetDomainsDomainOutputWithContext

func (o GetDomainsDomainOutput) ToGetDomainsDomainOutputWithContext(ctx context.Context) GetDomainsDomainOutput

func (GetDomainsDomainOutput) Verified

Whether the domain has completed domain ownership verification.

type GetDomainsOutputArgs added in v5.3.0

type GetDomainsOutputArgs struct {
	// Set to `true` to only return domains whose DNS is managed by Microsoft 365. Defaults to `false`.
	AdminManaged pulumi.BoolPtrInput `pulumi:"adminManaged"`
	// Set to `true` if unverified Azure AD domains should be included. Defaults to `false`.
	IncludeUnverified pulumi.BoolPtrInput `pulumi:"includeUnverified"`
	// Set to `true` to only return the default domain.
	OnlyDefault pulumi.BoolPtrInput `pulumi:"onlyDefault"`
	// Set to `true` to only return the initial domain, which is your primary Azure Active Directory tenant domain. Defaults to `false`.
	OnlyInitial pulumi.BoolPtrInput `pulumi:"onlyInitial"`
	// Set to `true` to only return verified root domains. Excludes subdomains and unverified domains.
	OnlyRoot pulumi.BoolPtrInput `pulumi:"onlyRoot"`
	// A list of supported services that must be supported by a domain. Possible values include `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer` and `Intune`.
	//
	// > **Note on filters** If `includeUnverified` is set to `true`, you cannot specify `onlyDefault` or `onlyInitial`. Additionally, you cannot combine `onlyDefault` with `onlyInitial`.
	SupportsServices pulumi.StringArrayInput `pulumi:"supportsServices"`
}

A collection of arguments for invoking getDomains.

func (GetDomainsOutputArgs) ElementType added in v5.3.0

func (GetDomainsOutputArgs) ElementType() reflect.Type

type GetDomainsResult

type GetDomainsResult struct {
	// Whether the DNS for the domain is managed by Microsoft 365.
	AdminManaged *bool `pulumi:"adminManaged"`
	// A list of tenant domains. Each `domain` object provides the attributes documented below.
	Domains []GetDomainsDomain `pulumi:"domains"`
	// The provider-assigned unique ID for this managed resource.
	Id                string   `pulumi:"id"`
	IncludeUnverified *bool    `pulumi:"includeUnverified"`
	OnlyDefault       *bool    `pulumi:"onlyDefault"`
	OnlyInitial       *bool    `pulumi:"onlyInitial"`
	OnlyRoot          *bool    `pulumi:"onlyRoot"`
	SupportsServices  []string `pulumi:"supportsServices"`
}

A collection of values returned by getDomains.

func GetDomains

func GetDomains(ctx *pulumi.Context, args *GetDomainsArgs, opts ...pulumi.InvokeOption) (*GetDomainsResult, error)

Use this data source to access information about existing Domains within 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: `Domain.Read.All` or `Directory.Read.All`

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

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		aadDomains, err := azuread.GetDomains(ctx, nil, nil)
		if err != nil {
			return err
		}
		var splat0 []*string
		for _, val0 := range aadDomains.Domains {
			splat0 = append(splat0, val0.DomainName)
		}
		ctx.Export("domainNames", splat0)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetDomainsResultOutput added in v5.3.0

type GetDomainsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDomains.

func GetDomainsOutput added in v5.3.0

func GetDomainsOutput(ctx *pulumi.Context, args GetDomainsOutputArgs, opts ...pulumi.InvokeOption) GetDomainsResultOutput

func (GetDomainsResultOutput) AdminManaged added in v5.3.0

func (o GetDomainsResultOutput) AdminManaged() pulumi.BoolPtrOutput

Whether the DNS for the domain is managed by Microsoft 365.

func (GetDomainsResultOutput) Domains added in v5.3.0

A list of tenant domains. Each `domain` object provides the attributes documented below.

func (GetDomainsResultOutput) ElementType added in v5.3.0

func (GetDomainsResultOutput) ElementType() reflect.Type

func (GetDomainsResultOutput) Id added in v5.3.0

The provider-assigned unique ID for this managed resource.

func (GetDomainsResultOutput) IncludeUnverified added in v5.3.0

func (o GetDomainsResultOutput) IncludeUnverified() pulumi.BoolPtrOutput

func (GetDomainsResultOutput) OnlyDefault added in v5.3.0

func (GetDomainsResultOutput) OnlyInitial added in v5.3.0

func (GetDomainsResultOutput) OnlyRoot added in v5.3.0

func (GetDomainsResultOutput) SupportsServices added in v5.3.0

func (o GetDomainsResultOutput) SupportsServices() pulumi.StringArrayOutput

func (GetDomainsResultOutput) ToGetDomainsResultOutput added in v5.3.0

func (o GetDomainsResultOutput) ToGetDomainsResultOutput() GetDomainsResultOutput

func (GetDomainsResultOutput) ToGetDomainsResultOutputWithContext added in v5.3.0

func (o GetDomainsResultOutput) ToGetDomainsResultOutputWithContext(ctx context.Context) GetDomainsResultOutput

type GetGroupDynamicMembership added in v5.12.0

type GetGroupDynamicMembership struct {
	// Whether rule processing is "On" (true) or "Paused" (false).
	Enabled bool `pulumi:"enabled"`
	// The rule that determines membership of this group.
	Rule string `pulumi:"rule"`
}

type GetGroupDynamicMembershipArgs added in v5.12.0

type GetGroupDynamicMembershipArgs struct {
	// Whether rule processing is "On" (true) or "Paused" (false).
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The rule that determines membership of this group.
	Rule pulumi.StringInput `pulumi:"rule"`
}

func (GetGroupDynamicMembershipArgs) ElementType added in v5.12.0

func (GetGroupDynamicMembershipArgs) ToGetGroupDynamicMembershipOutput added in v5.12.0

func (i GetGroupDynamicMembershipArgs) ToGetGroupDynamicMembershipOutput() GetGroupDynamicMembershipOutput

func (GetGroupDynamicMembershipArgs) ToGetGroupDynamicMembershipOutputWithContext added in v5.12.0

func (i GetGroupDynamicMembershipArgs) ToGetGroupDynamicMembershipOutputWithContext(ctx context.Context) GetGroupDynamicMembershipOutput

type GetGroupDynamicMembershipArray added in v5.12.0

type GetGroupDynamicMembershipArray []GetGroupDynamicMembershipInput

func (GetGroupDynamicMembershipArray) ElementType added in v5.12.0

func (GetGroupDynamicMembershipArray) ToGetGroupDynamicMembershipArrayOutput added in v5.12.0

func (i GetGroupDynamicMembershipArray) ToGetGroupDynamicMembershipArrayOutput() GetGroupDynamicMembershipArrayOutput

func (GetGroupDynamicMembershipArray) ToGetGroupDynamicMembershipArrayOutputWithContext added in v5.12.0

func (i GetGroupDynamicMembershipArray) ToGetGroupDynamicMembershipArrayOutputWithContext(ctx context.Context) GetGroupDynamicMembershipArrayOutput

type GetGroupDynamicMembershipArrayInput added in v5.12.0

type GetGroupDynamicMembershipArrayInput interface {
	pulumi.Input

	ToGetGroupDynamicMembershipArrayOutput() GetGroupDynamicMembershipArrayOutput
	ToGetGroupDynamicMembershipArrayOutputWithContext(context.Context) GetGroupDynamicMembershipArrayOutput
}

GetGroupDynamicMembershipArrayInput is an input type that accepts GetGroupDynamicMembershipArray and GetGroupDynamicMembershipArrayOutput values. You can construct a concrete instance of `GetGroupDynamicMembershipArrayInput` via:

GetGroupDynamicMembershipArray{ GetGroupDynamicMembershipArgs{...} }

type GetGroupDynamicMembershipArrayOutput added in v5.12.0

type GetGroupDynamicMembershipArrayOutput struct{ *pulumi.OutputState }

func (GetGroupDynamicMembershipArrayOutput) ElementType added in v5.12.0

func (GetGroupDynamicMembershipArrayOutput) Index added in v5.12.0

func (GetGroupDynamicMembershipArrayOutput) ToGetGroupDynamicMembershipArrayOutput added in v5.12.0

func (o GetGroupDynamicMembershipArrayOutput) ToGetGroupDynamicMembershipArrayOutput() GetGroupDynamicMembershipArrayOutput

func (GetGroupDynamicMembershipArrayOutput) ToGetGroupDynamicMembershipArrayOutputWithContext added in v5.12.0

func (o GetGroupDynamicMembershipArrayOutput) ToGetGroupDynamicMembershipArrayOutputWithContext(ctx context.Context) GetGroupDynamicMembershipArrayOutput

type GetGroupDynamicMembershipInput added in v5.12.0

type GetGroupDynamicMembershipInput interface {
	pulumi.Input

	ToGetGroupDynamicMembershipOutput() GetGroupDynamicMembershipOutput
	ToGetGroupDynamicMembershipOutputWithContext(context.Context) GetGroupDynamicMembershipOutput
}

GetGroupDynamicMembershipInput is an input type that accepts GetGroupDynamicMembershipArgs and GetGroupDynamicMembershipOutput values. You can construct a concrete instance of `GetGroupDynamicMembershipInput` via:

GetGroupDynamicMembershipArgs{...}

type GetGroupDynamicMembershipOutput added in v5.12.0

type GetGroupDynamicMembershipOutput struct{ *pulumi.OutputState }

func (GetGroupDynamicMembershipOutput) ElementType added in v5.12.0

func (GetGroupDynamicMembershipOutput) Enabled added in v5.12.0

Whether rule processing is "On" (true) or "Paused" (false).

func (GetGroupDynamicMembershipOutput) Rule added in v5.12.0

The rule that determines membership of this group.

func (GetGroupDynamicMembershipOutput) ToGetGroupDynamicMembershipOutput added in v5.12.0

func (o GetGroupDynamicMembershipOutput) ToGetGroupDynamicMembershipOutput() GetGroupDynamicMembershipOutput

func (GetGroupDynamicMembershipOutput) ToGetGroupDynamicMembershipOutputWithContext added in v5.12.0

func (o GetGroupDynamicMembershipOutput) ToGetGroupDynamicMembershipOutputWithContext(ctx context.Context) GetGroupDynamicMembershipOutput

type GetGroupsArgs

type GetGroupsArgs struct {
	// A common display name prefix to match when returning groups.
	DisplayNamePrefix *string `pulumi:"displayNamePrefix"`
	// The display names of the groups.
	DisplayNames []string `pulumi:"displayNames"`
	// Ignore missing groups and return groups that were found. The data source will still fail if no groups are found. Cannot be specified with `returnAll`. Defaults to `false`.
	IgnoreMissing *bool `pulumi:"ignoreMissing"`
	// Whether the returned groups should be mail-enabled. By itself this does not exclude security-enabled groups. Setting this to `true` ensures all groups are mail-enabled, and setting to `false` ensures that all groups are _not_ mail-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `objectIds`.
	MailEnabled *bool `pulumi:"mailEnabled"`
	// The object IDs of the groups.
	ObjectIds []string `pulumi:"objectIds"`
	// A flag to denote if all groups should be fetched and returned. Cannot be specified wth `ignoreMissing`. Defaults to `false`.
	ReturnAll *bool `pulumi:"returnAll"`
	// Whether the returned groups should be security-enabled. By itself this does not exclude mail-enabled groups. Setting this to `true` ensures all groups are security-enabled, and setting to `false` ensures that all groups are _not_ security-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `objectIds`.
	//
	// > One of `displayNames`, `displayNamePrefix`, `objectIds` or `returnAll` should be specified. Either `displayName` or `objectIds` _may_ be specified as an empty list, in which case no results will be returned.
	SecurityEnabled *bool `pulumi:"securityEnabled"`
}

A collection of arguments for invoking getGroups.

type GetGroupsOutputArgs added in v5.3.0

type GetGroupsOutputArgs struct {
	// A common display name prefix to match when returning groups.
	DisplayNamePrefix pulumi.StringPtrInput `pulumi:"displayNamePrefix"`
	// The display names of the groups.
	DisplayNames pulumi.StringArrayInput `pulumi:"displayNames"`
	// Ignore missing groups and return groups that were found. The data source will still fail if no groups are found. Cannot be specified with `returnAll`. Defaults to `false`.
	IgnoreMissing pulumi.BoolPtrInput `pulumi:"ignoreMissing"`
	// Whether the returned groups should be mail-enabled. By itself this does not exclude security-enabled groups. Setting this to `true` ensures all groups are mail-enabled, and setting to `false` ensures that all groups are _not_ mail-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `objectIds`.
	MailEnabled pulumi.BoolPtrInput `pulumi:"mailEnabled"`
	// The object IDs of the groups.
	ObjectIds pulumi.StringArrayInput `pulumi:"objectIds"`
	// A flag to denote if all groups should be fetched and returned. Cannot be specified wth `ignoreMissing`. Defaults to `false`.
	ReturnAll pulumi.BoolPtrInput `pulumi:"returnAll"`
	// Whether the returned groups should be security-enabled. By itself this does not exclude mail-enabled groups. Setting this to `true` ensures all groups are security-enabled, and setting to `false` ensures that all groups are _not_ security-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `objectIds`.
	//
	// > One of `displayNames`, `displayNamePrefix`, `objectIds` or `returnAll` should be specified. Either `displayName` or `objectIds` _may_ be specified as an empty list, in which case no results will be returned.
	SecurityEnabled pulumi.BoolPtrInput `pulumi:"securityEnabled"`
}

A collection of arguments for invoking getGroups.

func (GetGroupsOutputArgs) ElementType added in v5.3.0

func (GetGroupsOutputArgs) ElementType() reflect.Type

type GetGroupsResult

type GetGroupsResult struct {
	DisplayNamePrefix string `pulumi:"displayNamePrefix"`
	// The display names of the groups.
	DisplayNames []string `pulumi:"displayNames"`
	// The provider-assigned unique ID for this managed resource.
	Id            string `pulumi:"id"`
	IgnoreMissing *bool  `pulumi:"ignoreMissing"`
	MailEnabled   bool   `pulumi:"mailEnabled"`
	// The object IDs of the groups.
	ObjectIds       []string `pulumi:"objectIds"`
	ReturnAll       *bool    `pulumi:"returnAll"`
	SecurityEnabled bool     `pulumi:"securityEnabled"`
}

A collection of values returned by getGroups.

func GetGroups

func GetGroups(ctx *pulumi.Context, args *GetGroupsArgs, opts ...pulumi.InvokeOption) (*GetGroupsResult, error)

Gets Object IDs or Display Names for multiple Azure Active Directory groups.

## 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: `Group.Read.All` or `Directory.Read.All`

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

## Example Usage

*Look up by group name* <!--Start PulumiCodeChooser --> ```go 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.GetGroups(ctx, &azuread.GetGroupsArgs{
			DisplayNames: []string{
				"group-a",
				"group-b",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up by display name prefix* <!--Start PulumiCodeChooser --> ```go 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.GetGroups(ctx, &azuread.GetGroupsArgs{
			DisplayNamePrefix: pulumi.StringRef("sales-"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up all groups* <!--Start PulumiCodeChooser --> ```go 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.GetGroups(ctx, &azuread.GetGroupsArgs{
			ReturnAll: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up all mail-enabled groups* <!--Start PulumiCodeChooser --> ```go 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.GetGroups(ctx, &azuread.GetGroupsArgs{
			MailEnabled: pulumi.BoolRef(true),
			ReturnAll:   pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up all security-enabled groups that are not mail-enabled* <!--Start PulumiCodeChooser --> ```go 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.GetGroups(ctx, &azuread.GetGroupsArgs{
			MailEnabled:     pulumi.BoolRef(false),
			ReturnAll:       pulumi.BoolRef(true),
			SecurityEnabled: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetGroupsResultOutput added in v5.3.0

type GetGroupsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getGroups.

func GetGroupsOutput added in v5.3.0

func GetGroupsOutput(ctx *pulumi.Context, args GetGroupsOutputArgs, opts ...pulumi.InvokeOption) GetGroupsResultOutput

func (GetGroupsResultOutput) DisplayNamePrefix added in v5.15.0

func (o GetGroupsResultOutput) DisplayNamePrefix() pulumi.StringOutput

func (GetGroupsResultOutput) DisplayNames added in v5.3.0

The display names of the groups.

func (GetGroupsResultOutput) ElementType added in v5.3.0

func (GetGroupsResultOutput) ElementType() reflect.Type

func (GetGroupsResultOutput) Id added in v5.3.0

The provider-assigned unique ID for this managed resource.

func (GetGroupsResultOutput) IgnoreMissing added in v5.21.0

func (o GetGroupsResultOutput) IgnoreMissing() pulumi.BoolPtrOutput

func (GetGroupsResultOutput) MailEnabled added in v5.4.0

func (o GetGroupsResultOutput) MailEnabled() pulumi.BoolOutput

func (GetGroupsResultOutput) ObjectIds added in v5.3.0

The object IDs of the groups.

func (GetGroupsResultOutput) ReturnAll added in v5.3.0

func (GetGroupsResultOutput) SecurityEnabled added in v5.4.0

func (o GetGroupsResultOutput) SecurityEnabled() pulumi.BoolOutput

func (GetGroupsResultOutput) ToGetGroupsResultOutput added in v5.3.0

func (o GetGroupsResultOutput) ToGetGroupsResultOutput() GetGroupsResultOutput

func (GetGroupsResultOutput) ToGetGroupsResultOutputWithContext added in v5.3.0

func (o GetGroupsResultOutput) ToGetGroupsResultOutputWithContext(ctx context.Context) GetGroupsResultOutput

type GetNamedLocationCountry added in v5.40.0

type GetNamedLocationCountry struct {
	CountriesAndRegions               []string `pulumi:"countriesAndRegions"`
	IncludeUnknownCountriesAndRegions bool     `pulumi:"includeUnknownCountriesAndRegions"`
}

type GetNamedLocationCountryArgs added in v5.40.0

type GetNamedLocationCountryArgs struct {
	CountriesAndRegions               pulumi.StringArrayInput `pulumi:"countriesAndRegions"`
	IncludeUnknownCountriesAndRegions pulumi.BoolInput        `pulumi:"includeUnknownCountriesAndRegions"`
}

func (GetNamedLocationCountryArgs) ElementType added in v5.40.0

func (GetNamedLocationCountryArgs) ToGetNamedLocationCountryOutput added in v5.40.0

func (i GetNamedLocationCountryArgs) ToGetNamedLocationCountryOutput() GetNamedLocationCountryOutput

func (GetNamedLocationCountryArgs) ToGetNamedLocationCountryOutputWithContext added in v5.40.0

func (i GetNamedLocationCountryArgs) ToGetNamedLocationCountryOutputWithContext(ctx context.Context) GetNamedLocationCountryOutput

type GetNamedLocationCountryArray added in v5.40.0

type GetNamedLocationCountryArray []GetNamedLocationCountryInput

func (GetNamedLocationCountryArray) ElementType added in v5.40.0

func (GetNamedLocationCountryArray) ToGetNamedLocationCountryArrayOutput added in v5.40.0

func (i GetNamedLocationCountryArray) ToGetNamedLocationCountryArrayOutput() GetNamedLocationCountryArrayOutput

func (GetNamedLocationCountryArray) ToGetNamedLocationCountryArrayOutputWithContext added in v5.40.0

func (i GetNamedLocationCountryArray) ToGetNamedLocationCountryArrayOutputWithContext(ctx context.Context) GetNamedLocationCountryArrayOutput

type GetNamedLocationCountryArrayInput added in v5.40.0

type GetNamedLocationCountryArrayInput interface {
	pulumi.Input

	ToGetNamedLocationCountryArrayOutput() GetNamedLocationCountryArrayOutput
	ToGetNamedLocationCountryArrayOutputWithContext(context.Context) GetNamedLocationCountryArrayOutput
}

GetNamedLocationCountryArrayInput is an input type that accepts GetNamedLocationCountryArray and GetNamedLocationCountryArrayOutput values. You can construct a concrete instance of `GetNamedLocationCountryArrayInput` via:

GetNamedLocationCountryArray{ GetNamedLocationCountryArgs{...} }

type GetNamedLocationCountryArrayOutput added in v5.40.0

type GetNamedLocationCountryArrayOutput struct{ *pulumi.OutputState }

func (GetNamedLocationCountryArrayOutput) ElementType added in v5.40.0

func (GetNamedLocationCountryArrayOutput) Index added in v5.40.0

func (GetNamedLocationCountryArrayOutput) ToGetNamedLocationCountryArrayOutput added in v5.40.0

func (o GetNamedLocationCountryArrayOutput) ToGetNamedLocationCountryArrayOutput() GetNamedLocationCountryArrayOutput

func (GetNamedLocationCountryArrayOutput) ToGetNamedLocationCountryArrayOutputWithContext added in v5.40.0

func (o GetNamedLocationCountryArrayOutput) ToGetNamedLocationCountryArrayOutputWithContext(ctx context.Context) GetNamedLocationCountryArrayOutput

type GetNamedLocationCountryInput added in v5.40.0

type GetNamedLocationCountryInput interface {
	pulumi.Input

	ToGetNamedLocationCountryOutput() GetNamedLocationCountryOutput
	ToGetNamedLocationCountryOutputWithContext(context.Context) GetNamedLocationCountryOutput
}

GetNamedLocationCountryInput is an input type that accepts GetNamedLocationCountryArgs and GetNamedLocationCountryOutput values. You can construct a concrete instance of `GetNamedLocationCountryInput` via:

GetNamedLocationCountryArgs{...}

type GetNamedLocationCountryOutput added in v5.40.0

type GetNamedLocationCountryOutput struct{ *pulumi.OutputState }

func (GetNamedLocationCountryOutput) CountriesAndRegions added in v5.40.0

func (o GetNamedLocationCountryOutput) CountriesAndRegions() pulumi.StringArrayOutput

func (GetNamedLocationCountryOutput) ElementType added in v5.40.0

func (GetNamedLocationCountryOutput) IncludeUnknownCountriesAndRegions added in v5.40.0

func (o GetNamedLocationCountryOutput) IncludeUnknownCountriesAndRegions() pulumi.BoolOutput

func (GetNamedLocationCountryOutput) ToGetNamedLocationCountryOutput added in v5.40.0

func (o GetNamedLocationCountryOutput) ToGetNamedLocationCountryOutput() GetNamedLocationCountryOutput

func (GetNamedLocationCountryOutput) ToGetNamedLocationCountryOutputWithContext added in v5.40.0

func (o GetNamedLocationCountryOutput) ToGetNamedLocationCountryOutputWithContext(ctx context.Context) GetNamedLocationCountryOutput

type GetNamedLocationIp added in v5.40.0

type GetNamedLocationIp struct {
	IpRanges []string `pulumi:"ipRanges"`
	Trusted  bool     `pulumi:"trusted"`
}

type GetNamedLocationIpArgs added in v5.40.0

type GetNamedLocationIpArgs struct {
	IpRanges pulumi.StringArrayInput `pulumi:"ipRanges"`
	Trusted  pulumi.BoolInput        `pulumi:"trusted"`
}

func (GetNamedLocationIpArgs) ElementType added in v5.40.0

func (GetNamedLocationIpArgs) ElementType() reflect.Type

func (GetNamedLocationIpArgs) ToGetNamedLocationIpOutput added in v5.40.0

func (i GetNamedLocationIpArgs) ToGetNamedLocationIpOutput() GetNamedLocationIpOutput

func (GetNamedLocationIpArgs) ToGetNamedLocationIpOutputWithContext added in v5.40.0

func (i GetNamedLocationIpArgs) ToGetNamedLocationIpOutputWithContext(ctx context.Context) GetNamedLocationIpOutput

type GetNamedLocationIpArray added in v5.40.0

type GetNamedLocationIpArray []GetNamedLocationIpInput

func (GetNamedLocationIpArray) ElementType added in v5.40.0

func (GetNamedLocationIpArray) ElementType() reflect.Type

func (GetNamedLocationIpArray) ToGetNamedLocationIpArrayOutput added in v5.40.0

func (i GetNamedLocationIpArray) ToGetNamedLocationIpArrayOutput() GetNamedLocationIpArrayOutput

func (GetNamedLocationIpArray) ToGetNamedLocationIpArrayOutputWithContext added in v5.40.0

func (i GetNamedLocationIpArray) ToGetNamedLocationIpArrayOutputWithContext(ctx context.Context) GetNamedLocationIpArrayOutput

type GetNamedLocationIpArrayInput added in v5.40.0

type GetNamedLocationIpArrayInput interface {
	pulumi.Input

	ToGetNamedLocationIpArrayOutput() GetNamedLocationIpArrayOutput
	ToGetNamedLocationIpArrayOutputWithContext(context.Context) GetNamedLocationIpArrayOutput
}

GetNamedLocationIpArrayInput is an input type that accepts GetNamedLocationIpArray and GetNamedLocationIpArrayOutput values. You can construct a concrete instance of `GetNamedLocationIpArrayInput` via:

GetNamedLocationIpArray{ GetNamedLocationIpArgs{...} }

type GetNamedLocationIpArrayOutput added in v5.40.0

type GetNamedLocationIpArrayOutput struct{ *pulumi.OutputState }

func (GetNamedLocationIpArrayOutput) ElementType added in v5.40.0

func (GetNamedLocationIpArrayOutput) Index added in v5.40.0

func (GetNamedLocationIpArrayOutput) ToGetNamedLocationIpArrayOutput added in v5.40.0

func (o GetNamedLocationIpArrayOutput) ToGetNamedLocationIpArrayOutput() GetNamedLocationIpArrayOutput

func (GetNamedLocationIpArrayOutput) ToGetNamedLocationIpArrayOutputWithContext added in v5.40.0

func (o GetNamedLocationIpArrayOutput) ToGetNamedLocationIpArrayOutputWithContext(ctx context.Context) GetNamedLocationIpArrayOutput

type GetNamedLocationIpInput added in v5.40.0

type GetNamedLocationIpInput interface {
	pulumi.Input

	ToGetNamedLocationIpOutput() GetNamedLocationIpOutput
	ToGetNamedLocationIpOutputWithContext(context.Context) GetNamedLocationIpOutput
}

GetNamedLocationIpInput is an input type that accepts GetNamedLocationIpArgs and GetNamedLocationIpOutput values. You can construct a concrete instance of `GetNamedLocationIpInput` via:

GetNamedLocationIpArgs{...}

type GetNamedLocationIpOutput added in v5.40.0

type GetNamedLocationIpOutput struct{ *pulumi.OutputState }

func (GetNamedLocationIpOutput) ElementType added in v5.40.0

func (GetNamedLocationIpOutput) ElementType() reflect.Type

func (GetNamedLocationIpOutput) IpRanges added in v5.40.0

func (GetNamedLocationIpOutput) ToGetNamedLocationIpOutput added in v5.40.0

func (o GetNamedLocationIpOutput) ToGetNamedLocationIpOutput() GetNamedLocationIpOutput

func (GetNamedLocationIpOutput) ToGetNamedLocationIpOutputWithContext added in v5.40.0

func (o GetNamedLocationIpOutput) ToGetNamedLocationIpOutputWithContext(ctx context.Context) GetNamedLocationIpOutput

func (GetNamedLocationIpOutput) Trusted added in v5.40.0

type GetServicePrincipalAppRole

type GetServicePrincipalAppRole struct {
	// Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in daemon service scenarios). Possible values are: `User` and `Application`, or both.
	AllowedMemberTypes []string `pulumi:"allowedMemberTypes"`
	// Permission help text that appears in the admin app assignment and consent experiences.
	Description string `pulumi:"description"`
	// The display name of the application associated with this service principal.
	DisplayName string `pulumi:"displayName"`
	// Determines if the permission scope is enabled.
	Enabled bool `pulumi:"enabled"`
	// The unique identifier of the delegated permission. Must be a valid UUID.
	Id string `pulumi:"id"`
	// The value that is used for the `scp` claim in OAuth 2.0 access tokens.
	Value string `pulumi:"value"`
}

type GetServicePrincipalAppRoleArgs

type GetServicePrincipalAppRoleArgs struct {
	// Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in daemon service scenarios). Possible values are: `User` and `Application`, or both.
	AllowedMemberTypes pulumi.StringArrayInput `pulumi:"allowedMemberTypes"`
	// Permission help text that appears in the admin app assignment and consent experiences.
	Description pulumi.StringInput `pulumi:"description"`
	// The display name of the application associated with this service principal.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Determines if the permission scope is enabled.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The unique identifier of the delegated permission. Must be a valid UUID.
	Id pulumi.StringInput `pulumi:"id"`
	// The value that is used for the `scp` claim in OAuth 2.0 access tokens.
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetServicePrincipalAppRoleArgs) ElementType

func (GetServicePrincipalAppRoleArgs) ToGetServicePrincipalAppRoleOutput

func (i GetServicePrincipalAppRoleArgs) ToGetServicePrincipalAppRoleOutput() GetServicePrincipalAppRoleOutput

func (GetServicePrincipalAppRoleArgs) ToGetServicePrincipalAppRoleOutputWithContext

func (i GetServicePrincipalAppRoleArgs) ToGetServicePrincipalAppRoleOutputWithContext(ctx context.Context) GetServicePrincipalAppRoleOutput

type GetServicePrincipalAppRoleArray

type GetServicePrincipalAppRoleArray []GetServicePrincipalAppRoleInput

func (GetServicePrincipalAppRoleArray) ElementType

func (GetServicePrincipalAppRoleArray) ToGetServicePrincipalAppRoleArrayOutput

func (i GetServicePrincipalAppRoleArray) ToGetServicePrincipalAppRoleArrayOutput() GetServicePrincipalAppRoleArrayOutput

func (GetServicePrincipalAppRoleArray) ToGetServicePrincipalAppRoleArrayOutputWithContext

func (i GetServicePrincipalAppRoleArray) ToGetServicePrincipalAppRoleArrayOutputWithContext(ctx context.Context) GetServicePrincipalAppRoleArrayOutput

type GetServicePrincipalAppRoleArrayInput

type GetServicePrincipalAppRoleArrayInput interface {
	pulumi.Input

	ToGetServicePrincipalAppRoleArrayOutput() GetServicePrincipalAppRoleArrayOutput
	ToGetServicePrincipalAppRoleArrayOutputWithContext(context.Context) GetServicePrincipalAppRoleArrayOutput
}

GetServicePrincipalAppRoleArrayInput is an input type that accepts GetServicePrincipalAppRoleArray and GetServicePrincipalAppRoleArrayOutput values. You can construct a concrete instance of `GetServicePrincipalAppRoleArrayInput` via:

GetServicePrincipalAppRoleArray{ GetServicePrincipalAppRoleArgs{...} }

type GetServicePrincipalAppRoleArrayOutput

type GetServicePrincipalAppRoleArrayOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalAppRoleArrayOutput) ElementType

func (GetServicePrincipalAppRoleArrayOutput) Index

func (GetServicePrincipalAppRoleArrayOutput) ToGetServicePrincipalAppRoleArrayOutput

func (o GetServicePrincipalAppRoleArrayOutput) ToGetServicePrincipalAppRoleArrayOutput() GetServicePrincipalAppRoleArrayOutput

func (GetServicePrincipalAppRoleArrayOutput) ToGetServicePrincipalAppRoleArrayOutputWithContext

func (o GetServicePrincipalAppRoleArrayOutput) ToGetServicePrincipalAppRoleArrayOutputWithContext(ctx context.Context) GetServicePrincipalAppRoleArrayOutput

type GetServicePrincipalAppRoleInput

type GetServicePrincipalAppRoleInput interface {
	pulumi.Input

	ToGetServicePrincipalAppRoleOutput() GetServicePrincipalAppRoleOutput
	ToGetServicePrincipalAppRoleOutputWithContext(context.Context) GetServicePrincipalAppRoleOutput
}

GetServicePrincipalAppRoleInput is an input type that accepts GetServicePrincipalAppRoleArgs and GetServicePrincipalAppRoleOutput values. You can construct a concrete instance of `GetServicePrincipalAppRoleInput` via:

GetServicePrincipalAppRoleArgs{...}

type GetServicePrincipalAppRoleOutput

type GetServicePrincipalAppRoleOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalAppRoleOutput) AllowedMemberTypes

Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in daemon service scenarios). Possible values are: `User` and `Application`, or both.

func (GetServicePrincipalAppRoleOutput) Description

Permission help text that appears in the admin app assignment and consent experiences.

func (GetServicePrincipalAppRoleOutput) DisplayName

The display name of the application associated with this service principal.

func (GetServicePrincipalAppRoleOutput) ElementType

func (GetServicePrincipalAppRoleOutput) Enabled

Determines if the permission scope is enabled.

func (GetServicePrincipalAppRoleOutput) Id

The unique identifier of the delegated permission. Must be a valid UUID.

func (GetServicePrincipalAppRoleOutput) ToGetServicePrincipalAppRoleOutput

func (o GetServicePrincipalAppRoleOutput) ToGetServicePrincipalAppRoleOutput() GetServicePrincipalAppRoleOutput

func (GetServicePrincipalAppRoleOutput) ToGetServicePrincipalAppRoleOutputWithContext

func (o GetServicePrincipalAppRoleOutput) ToGetServicePrincipalAppRoleOutputWithContext(ctx context.Context) GetServicePrincipalAppRoleOutput

func (GetServicePrincipalAppRoleOutput) Value

The value that is used for the `scp` claim in OAuth 2.0 access tokens.

type GetServicePrincipalFeature added in v5.3.0

type GetServicePrincipalFeature struct {
	// Whether this service principal represents a custom SAML application.
	CustomSingleSignOnApp bool `pulumi:"customSingleSignOnApp"`
	// Whether this service principal represents an Enterprise Application.
	EnterpriseApplication bool `pulumi:"enterpriseApplication"`
	// Whether this service principal represents a gallery application.
	GalleryApplication bool `pulumi:"galleryApplication"`
	// Whether this app is visible to users in My Apps and Office 365 Launcher.
	VisibleToUsers bool `pulumi:"visibleToUsers"`
}

type GetServicePrincipalFeatureArgs added in v5.3.0

type GetServicePrincipalFeatureArgs struct {
	// Whether this service principal represents a custom SAML application.
	CustomSingleSignOnApp pulumi.BoolInput `pulumi:"customSingleSignOnApp"`
	// Whether this service principal represents an Enterprise Application.
	EnterpriseApplication pulumi.BoolInput `pulumi:"enterpriseApplication"`
	// Whether this service principal represents a gallery application.
	GalleryApplication pulumi.BoolInput `pulumi:"galleryApplication"`
	// Whether this app is visible to users in My Apps and Office 365 Launcher.
	VisibleToUsers pulumi.BoolInput `pulumi:"visibleToUsers"`
}

func (GetServicePrincipalFeatureArgs) ElementType added in v5.3.0

func (GetServicePrincipalFeatureArgs) ToGetServicePrincipalFeatureOutput added in v5.3.0

func (i GetServicePrincipalFeatureArgs) ToGetServicePrincipalFeatureOutput() GetServicePrincipalFeatureOutput

func (GetServicePrincipalFeatureArgs) ToGetServicePrincipalFeatureOutputWithContext added in v5.3.0

func (i GetServicePrincipalFeatureArgs) ToGetServicePrincipalFeatureOutputWithContext(ctx context.Context) GetServicePrincipalFeatureOutput

type GetServicePrincipalFeatureArray added in v5.3.0

type GetServicePrincipalFeatureArray []GetServicePrincipalFeatureInput

func (GetServicePrincipalFeatureArray) ElementType added in v5.3.0

func (GetServicePrincipalFeatureArray) ToGetServicePrincipalFeatureArrayOutput added in v5.3.0

func (i GetServicePrincipalFeatureArray) ToGetServicePrincipalFeatureArrayOutput() GetServicePrincipalFeatureArrayOutput

func (GetServicePrincipalFeatureArray) ToGetServicePrincipalFeatureArrayOutputWithContext added in v5.3.0

func (i GetServicePrincipalFeatureArray) ToGetServicePrincipalFeatureArrayOutputWithContext(ctx context.Context) GetServicePrincipalFeatureArrayOutput

type GetServicePrincipalFeatureArrayInput added in v5.3.0

type GetServicePrincipalFeatureArrayInput interface {
	pulumi.Input

	ToGetServicePrincipalFeatureArrayOutput() GetServicePrincipalFeatureArrayOutput
	ToGetServicePrincipalFeatureArrayOutputWithContext(context.Context) GetServicePrincipalFeatureArrayOutput
}

GetServicePrincipalFeatureArrayInput is an input type that accepts GetServicePrincipalFeatureArray and GetServicePrincipalFeatureArrayOutput values. You can construct a concrete instance of `GetServicePrincipalFeatureArrayInput` via:

GetServicePrincipalFeatureArray{ GetServicePrincipalFeatureArgs{...} }

type GetServicePrincipalFeatureArrayOutput added in v5.3.0

type GetServicePrincipalFeatureArrayOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalFeatureArrayOutput) ElementType added in v5.3.0

func (GetServicePrincipalFeatureArrayOutput) Index added in v5.3.0

func (GetServicePrincipalFeatureArrayOutput) ToGetServicePrincipalFeatureArrayOutput added in v5.3.0

func (o GetServicePrincipalFeatureArrayOutput) ToGetServicePrincipalFeatureArrayOutput() GetServicePrincipalFeatureArrayOutput

func (GetServicePrincipalFeatureArrayOutput) ToGetServicePrincipalFeatureArrayOutputWithContext added in v5.3.0

func (o GetServicePrincipalFeatureArrayOutput) ToGetServicePrincipalFeatureArrayOutputWithContext(ctx context.Context) GetServicePrincipalFeatureArrayOutput

type GetServicePrincipalFeatureInput added in v5.3.0

type GetServicePrincipalFeatureInput interface {
	pulumi.Input

	ToGetServicePrincipalFeatureOutput() GetServicePrincipalFeatureOutput
	ToGetServicePrincipalFeatureOutputWithContext(context.Context) GetServicePrincipalFeatureOutput
}

GetServicePrincipalFeatureInput is an input type that accepts GetServicePrincipalFeatureArgs and GetServicePrincipalFeatureOutput values. You can construct a concrete instance of `GetServicePrincipalFeatureInput` via:

GetServicePrincipalFeatureArgs{...}

type GetServicePrincipalFeatureOutput added in v5.3.0

type GetServicePrincipalFeatureOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalFeatureOutput) CustomSingleSignOnApp added in v5.3.0

func (o GetServicePrincipalFeatureOutput) CustomSingleSignOnApp() pulumi.BoolOutput

Whether this service principal represents a custom SAML application.

func (GetServicePrincipalFeatureOutput) ElementType added in v5.3.0

func (GetServicePrincipalFeatureOutput) EnterpriseApplication added in v5.3.0

func (o GetServicePrincipalFeatureOutput) EnterpriseApplication() pulumi.BoolOutput

Whether this service principal represents an Enterprise Application.

func (GetServicePrincipalFeatureOutput) GalleryApplication added in v5.3.0

func (o GetServicePrincipalFeatureOutput) GalleryApplication() pulumi.BoolOutput

Whether this service principal represents a gallery application.

func (GetServicePrincipalFeatureOutput) ToGetServicePrincipalFeatureOutput added in v5.3.0

func (o GetServicePrincipalFeatureOutput) ToGetServicePrincipalFeatureOutput() GetServicePrincipalFeatureOutput

func (GetServicePrincipalFeatureOutput) ToGetServicePrincipalFeatureOutputWithContext added in v5.3.0

func (o GetServicePrincipalFeatureOutput) ToGetServicePrincipalFeatureOutputWithContext(ctx context.Context) GetServicePrincipalFeatureOutput

func (GetServicePrincipalFeatureOutput) VisibleToUsers added in v5.3.0

Whether this app is visible to users in My Apps and Office 365 Launcher.

type GetServicePrincipalFeatureTag added in v5.6.0

type GetServicePrincipalFeatureTag struct {
	// Whether this service principal represents a custom SAML application
	CustomSingleSignOn bool `pulumi:"customSingleSignOn"`
	// Whether this service principal represents an Enterprise Application
	Enterprise bool `pulumi:"enterprise"`
	// Whether this service principal represents a gallery application
	Gallery bool `pulumi:"gallery"`
	// Whether this app is invisible to users in My Apps and Office 365 Launcher
	Hide bool `pulumi:"hide"`
}

type GetServicePrincipalFeatureTagArgs added in v5.6.0

type GetServicePrincipalFeatureTagArgs struct {
	// Whether this service principal represents a custom SAML application
	CustomSingleSignOn pulumi.BoolInput `pulumi:"customSingleSignOn"`
	// Whether this service principal represents an Enterprise Application
	Enterprise pulumi.BoolInput `pulumi:"enterprise"`
	// Whether this service principal represents a gallery application
	Gallery pulumi.BoolInput `pulumi:"gallery"`
	// Whether this app is invisible to users in My Apps and Office 365 Launcher
	Hide pulumi.BoolInput `pulumi:"hide"`
}

func (GetServicePrincipalFeatureTagArgs) ElementType added in v5.6.0

func (GetServicePrincipalFeatureTagArgs) ToGetServicePrincipalFeatureTagOutput added in v5.6.0

func (i GetServicePrincipalFeatureTagArgs) ToGetServicePrincipalFeatureTagOutput() GetServicePrincipalFeatureTagOutput

func (GetServicePrincipalFeatureTagArgs) ToGetServicePrincipalFeatureTagOutputWithContext added in v5.6.0

func (i GetServicePrincipalFeatureTagArgs) ToGetServicePrincipalFeatureTagOutputWithContext(ctx context.Context) GetServicePrincipalFeatureTagOutput

type GetServicePrincipalFeatureTagArray added in v5.6.0

type GetServicePrincipalFeatureTagArray []GetServicePrincipalFeatureTagInput

func (GetServicePrincipalFeatureTagArray) ElementType added in v5.6.0

func (GetServicePrincipalFeatureTagArray) ToGetServicePrincipalFeatureTagArrayOutput added in v5.6.0

func (i GetServicePrincipalFeatureTagArray) ToGetServicePrincipalFeatureTagArrayOutput() GetServicePrincipalFeatureTagArrayOutput

func (GetServicePrincipalFeatureTagArray) ToGetServicePrincipalFeatureTagArrayOutputWithContext added in v5.6.0

func (i GetServicePrincipalFeatureTagArray) ToGetServicePrincipalFeatureTagArrayOutputWithContext(ctx context.Context) GetServicePrincipalFeatureTagArrayOutput

type GetServicePrincipalFeatureTagArrayInput added in v5.6.0

type GetServicePrincipalFeatureTagArrayInput interface {
	pulumi.Input

	ToGetServicePrincipalFeatureTagArrayOutput() GetServicePrincipalFeatureTagArrayOutput
	ToGetServicePrincipalFeatureTagArrayOutputWithContext(context.Context) GetServicePrincipalFeatureTagArrayOutput
}

GetServicePrincipalFeatureTagArrayInput is an input type that accepts GetServicePrincipalFeatureTagArray and GetServicePrincipalFeatureTagArrayOutput values. You can construct a concrete instance of `GetServicePrincipalFeatureTagArrayInput` via:

GetServicePrincipalFeatureTagArray{ GetServicePrincipalFeatureTagArgs{...} }

type GetServicePrincipalFeatureTagArrayOutput added in v5.6.0

type GetServicePrincipalFeatureTagArrayOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalFeatureTagArrayOutput) ElementType added in v5.6.0

func (GetServicePrincipalFeatureTagArrayOutput) Index added in v5.6.0

func (GetServicePrincipalFeatureTagArrayOutput) ToGetServicePrincipalFeatureTagArrayOutput added in v5.6.0

func (o GetServicePrincipalFeatureTagArrayOutput) ToGetServicePrincipalFeatureTagArrayOutput() GetServicePrincipalFeatureTagArrayOutput

func (GetServicePrincipalFeatureTagArrayOutput) ToGetServicePrincipalFeatureTagArrayOutputWithContext added in v5.6.0

func (o GetServicePrincipalFeatureTagArrayOutput) ToGetServicePrincipalFeatureTagArrayOutputWithContext(ctx context.Context) GetServicePrincipalFeatureTagArrayOutput

type GetServicePrincipalFeatureTagInput added in v5.6.0

type GetServicePrincipalFeatureTagInput interface {
	pulumi.Input

	ToGetServicePrincipalFeatureTagOutput() GetServicePrincipalFeatureTagOutput
	ToGetServicePrincipalFeatureTagOutputWithContext(context.Context) GetServicePrincipalFeatureTagOutput
}

GetServicePrincipalFeatureTagInput is an input type that accepts GetServicePrincipalFeatureTagArgs and GetServicePrincipalFeatureTagOutput values. You can construct a concrete instance of `GetServicePrincipalFeatureTagInput` via:

GetServicePrincipalFeatureTagArgs{...}

type GetServicePrincipalFeatureTagOutput added in v5.6.0

type GetServicePrincipalFeatureTagOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalFeatureTagOutput) CustomSingleSignOn added in v5.6.0

func (o GetServicePrincipalFeatureTagOutput) CustomSingleSignOn() pulumi.BoolOutput

Whether this service principal represents a custom SAML application

func (GetServicePrincipalFeatureTagOutput) ElementType added in v5.6.0

func (GetServicePrincipalFeatureTagOutput) Enterprise added in v5.6.0

Whether this service principal represents an Enterprise Application

func (GetServicePrincipalFeatureTagOutput) Gallery added in v5.6.0

Whether this service principal represents a gallery application

func (GetServicePrincipalFeatureTagOutput) Hide added in v5.6.0

Whether this app is invisible to users in My Apps and Office 365 Launcher

func (GetServicePrincipalFeatureTagOutput) ToGetServicePrincipalFeatureTagOutput added in v5.6.0

func (o GetServicePrincipalFeatureTagOutput) ToGetServicePrincipalFeatureTagOutput() GetServicePrincipalFeatureTagOutput

func (GetServicePrincipalFeatureTagOutput) ToGetServicePrincipalFeatureTagOutputWithContext added in v5.6.0

func (o GetServicePrincipalFeatureTagOutput) ToGetServicePrincipalFeatureTagOutputWithContext(ctx context.Context) GetServicePrincipalFeatureTagOutput

type GetServicePrincipalOauth2PermissionScope

type GetServicePrincipalOauth2PermissionScope struct {
	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription string `pulumi:"adminConsentDescription"`
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName string `pulumi:"adminConsentDisplayName"`
	// Determines if the permission scope is enabled.
	Enabled bool `pulumi:"enabled"`
	// The unique identifier of the delegated permission. Must be a valid UUID.
	Id string `pulumi:"id"`
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.
	Type string `pulumi:"type"`
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription string `pulumi:"userConsentDescription"`
	// Display name for the delegated permission that appears in the end user consent experience.
	UserConsentDisplayName string `pulumi:"userConsentDisplayName"`
	// The value that is used for the `scp` claim in OAuth 2.0 access tokens.
	Value string `pulumi:"value"`
}

type GetServicePrincipalOauth2PermissionScopeArgs

type GetServicePrincipalOauth2PermissionScopeArgs struct {
	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription pulumi.StringInput `pulumi:"adminConsentDescription"`
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName pulumi.StringInput `pulumi:"adminConsentDisplayName"`
	// Determines if the permission scope is enabled.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The unique identifier of the delegated permission. Must be a valid UUID.
	Id pulumi.StringInput `pulumi:"id"`
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.
	Type pulumi.StringInput `pulumi:"type"`
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription pulumi.StringInput `pulumi:"userConsentDescription"`
	// Display name for the delegated permission that appears in the end user consent experience.
	UserConsentDisplayName pulumi.StringInput `pulumi:"userConsentDisplayName"`
	// The value that is used for the `scp` claim in OAuth 2.0 access tokens.
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetServicePrincipalOauth2PermissionScopeArgs) ElementType

func (GetServicePrincipalOauth2PermissionScopeArgs) ToGetServicePrincipalOauth2PermissionScopeOutput

func (i GetServicePrincipalOauth2PermissionScopeArgs) ToGetServicePrincipalOauth2PermissionScopeOutput() GetServicePrincipalOauth2PermissionScopeOutput

func (GetServicePrincipalOauth2PermissionScopeArgs) ToGetServicePrincipalOauth2PermissionScopeOutputWithContext

func (i GetServicePrincipalOauth2PermissionScopeArgs) ToGetServicePrincipalOauth2PermissionScopeOutputWithContext(ctx context.Context) GetServicePrincipalOauth2PermissionScopeOutput

type GetServicePrincipalOauth2PermissionScopeArray

type GetServicePrincipalOauth2PermissionScopeArray []GetServicePrincipalOauth2PermissionScopeInput

func (GetServicePrincipalOauth2PermissionScopeArray) ElementType

func (GetServicePrincipalOauth2PermissionScopeArray) ToGetServicePrincipalOauth2PermissionScopeArrayOutput

func (i GetServicePrincipalOauth2PermissionScopeArray) ToGetServicePrincipalOauth2PermissionScopeArrayOutput() GetServicePrincipalOauth2PermissionScopeArrayOutput

func (GetServicePrincipalOauth2PermissionScopeArray) ToGetServicePrincipalOauth2PermissionScopeArrayOutputWithContext

func (i GetServicePrincipalOauth2PermissionScopeArray) ToGetServicePrincipalOauth2PermissionScopeArrayOutputWithContext(ctx context.Context) GetServicePrincipalOauth2PermissionScopeArrayOutput

type GetServicePrincipalOauth2PermissionScopeArrayInput

type GetServicePrincipalOauth2PermissionScopeArrayInput interface {
	pulumi.Input

	ToGetServicePrincipalOauth2PermissionScopeArrayOutput() GetServicePrincipalOauth2PermissionScopeArrayOutput
	ToGetServicePrincipalOauth2PermissionScopeArrayOutputWithContext(context.Context) GetServicePrincipalOauth2PermissionScopeArrayOutput
}

GetServicePrincipalOauth2PermissionScopeArrayInput is an input type that accepts GetServicePrincipalOauth2PermissionScopeArray and GetServicePrincipalOauth2PermissionScopeArrayOutput values. You can construct a concrete instance of `GetServicePrincipalOauth2PermissionScopeArrayInput` via:

GetServicePrincipalOauth2PermissionScopeArray{ GetServicePrincipalOauth2PermissionScopeArgs{...} }

type GetServicePrincipalOauth2PermissionScopeArrayOutput

type GetServicePrincipalOauth2PermissionScopeArrayOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalOauth2PermissionScopeArrayOutput) ElementType

func (GetServicePrincipalOauth2PermissionScopeArrayOutput) Index

func (GetServicePrincipalOauth2PermissionScopeArrayOutput) ToGetServicePrincipalOauth2PermissionScopeArrayOutput

func (o GetServicePrincipalOauth2PermissionScopeArrayOutput) ToGetServicePrincipalOauth2PermissionScopeArrayOutput() GetServicePrincipalOauth2PermissionScopeArrayOutput

func (GetServicePrincipalOauth2PermissionScopeArrayOutput) ToGetServicePrincipalOauth2PermissionScopeArrayOutputWithContext

func (o GetServicePrincipalOauth2PermissionScopeArrayOutput) ToGetServicePrincipalOauth2PermissionScopeArrayOutputWithContext(ctx context.Context) GetServicePrincipalOauth2PermissionScopeArrayOutput

type GetServicePrincipalOauth2PermissionScopeInput

type GetServicePrincipalOauth2PermissionScopeInput interface {
	pulumi.Input

	ToGetServicePrincipalOauth2PermissionScopeOutput() GetServicePrincipalOauth2PermissionScopeOutput
	ToGetServicePrincipalOauth2PermissionScopeOutputWithContext(context.Context) GetServicePrincipalOauth2PermissionScopeOutput
}

GetServicePrincipalOauth2PermissionScopeInput is an input type that accepts GetServicePrincipalOauth2PermissionScopeArgs and GetServicePrincipalOauth2PermissionScopeOutput values. You can construct a concrete instance of `GetServicePrincipalOauth2PermissionScopeInput` via:

GetServicePrincipalOauth2PermissionScopeArgs{...}

type GetServicePrincipalOauth2PermissionScopeOutput

type GetServicePrincipalOauth2PermissionScopeOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalOauth2PermissionScopeOutput) AdminConsentDescription

Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.

func (GetServicePrincipalOauth2PermissionScopeOutput) AdminConsentDisplayName

Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.

func (GetServicePrincipalOauth2PermissionScopeOutput) ElementType

func (GetServicePrincipalOauth2PermissionScopeOutput) Enabled

Determines if the permission scope is enabled.

func (GetServicePrincipalOauth2PermissionScopeOutput) Id

The unique identifier of the delegated permission. Must be a valid UUID.

func (GetServicePrincipalOauth2PermissionScopeOutput) ToGetServicePrincipalOauth2PermissionScopeOutput

func (o GetServicePrincipalOauth2PermissionScopeOutput) ToGetServicePrincipalOauth2PermissionScopeOutput() GetServicePrincipalOauth2PermissionScopeOutput

func (GetServicePrincipalOauth2PermissionScopeOutput) ToGetServicePrincipalOauth2PermissionScopeOutputWithContext

func (o GetServicePrincipalOauth2PermissionScopeOutput) ToGetServicePrincipalOauth2PermissionScopeOutputWithContext(ctx context.Context) GetServicePrincipalOauth2PermissionScopeOutput

func (GetServicePrincipalOauth2PermissionScopeOutput) Type

Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.

func (GetServicePrincipalOauth2PermissionScopeOutput) UserConsentDescription

Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.

func (GetServicePrincipalOauth2PermissionScopeOutput) UserConsentDisplayName

Display name for the delegated permission that appears in the end user consent experience.

func (GetServicePrincipalOauth2PermissionScopeOutput) Value

The value that is used for the `scp` claim in OAuth 2.0 access tokens.

type GetServicePrincipalSamlSingleSignOn added in v5.2.0

type GetServicePrincipalSamlSingleSignOn struct {
	// The relative URI the service provider would redirect to after completion of the single sign-on flow.
	RelayState string `pulumi:"relayState"`
}

type GetServicePrincipalSamlSingleSignOnArgs added in v5.2.0

type GetServicePrincipalSamlSingleSignOnArgs struct {
	// The relative URI the service provider would redirect to after completion of the single sign-on flow.
	RelayState pulumi.StringInput `pulumi:"relayState"`
}

func (GetServicePrincipalSamlSingleSignOnArgs) ElementType added in v5.2.0

func (GetServicePrincipalSamlSingleSignOnArgs) ToGetServicePrincipalSamlSingleSignOnOutput added in v5.2.0

func (i GetServicePrincipalSamlSingleSignOnArgs) ToGetServicePrincipalSamlSingleSignOnOutput() GetServicePrincipalSamlSingleSignOnOutput

func (GetServicePrincipalSamlSingleSignOnArgs) ToGetServicePrincipalSamlSingleSignOnOutputWithContext added in v5.2.0

func (i GetServicePrincipalSamlSingleSignOnArgs) ToGetServicePrincipalSamlSingleSignOnOutputWithContext(ctx context.Context) GetServicePrincipalSamlSingleSignOnOutput

type GetServicePrincipalSamlSingleSignOnArray added in v5.2.0

type GetServicePrincipalSamlSingleSignOnArray []GetServicePrincipalSamlSingleSignOnInput

func (GetServicePrincipalSamlSingleSignOnArray) ElementType added in v5.2.0

func (GetServicePrincipalSamlSingleSignOnArray) ToGetServicePrincipalSamlSingleSignOnArrayOutput added in v5.2.0

func (i GetServicePrincipalSamlSingleSignOnArray) ToGetServicePrincipalSamlSingleSignOnArrayOutput() GetServicePrincipalSamlSingleSignOnArrayOutput

func (GetServicePrincipalSamlSingleSignOnArray) ToGetServicePrincipalSamlSingleSignOnArrayOutputWithContext added in v5.2.0

func (i GetServicePrincipalSamlSingleSignOnArray) ToGetServicePrincipalSamlSingleSignOnArrayOutputWithContext(ctx context.Context) GetServicePrincipalSamlSingleSignOnArrayOutput

type GetServicePrincipalSamlSingleSignOnArrayInput added in v5.2.0

type GetServicePrincipalSamlSingleSignOnArrayInput interface {
	pulumi.Input

	ToGetServicePrincipalSamlSingleSignOnArrayOutput() GetServicePrincipalSamlSingleSignOnArrayOutput
	ToGetServicePrincipalSamlSingleSignOnArrayOutputWithContext(context.Context) GetServicePrincipalSamlSingleSignOnArrayOutput
}

GetServicePrincipalSamlSingleSignOnArrayInput is an input type that accepts GetServicePrincipalSamlSingleSignOnArray and GetServicePrincipalSamlSingleSignOnArrayOutput values. You can construct a concrete instance of `GetServicePrincipalSamlSingleSignOnArrayInput` via:

GetServicePrincipalSamlSingleSignOnArray{ GetServicePrincipalSamlSingleSignOnArgs{...} }

type GetServicePrincipalSamlSingleSignOnArrayOutput added in v5.2.0

type GetServicePrincipalSamlSingleSignOnArrayOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalSamlSingleSignOnArrayOutput) ElementType added in v5.2.0

func (GetServicePrincipalSamlSingleSignOnArrayOutput) Index added in v5.2.0

func (GetServicePrincipalSamlSingleSignOnArrayOutput) ToGetServicePrincipalSamlSingleSignOnArrayOutput added in v5.2.0

func (o GetServicePrincipalSamlSingleSignOnArrayOutput) ToGetServicePrincipalSamlSingleSignOnArrayOutput() GetServicePrincipalSamlSingleSignOnArrayOutput

func (GetServicePrincipalSamlSingleSignOnArrayOutput) ToGetServicePrincipalSamlSingleSignOnArrayOutputWithContext added in v5.2.0

func (o GetServicePrincipalSamlSingleSignOnArrayOutput) ToGetServicePrincipalSamlSingleSignOnArrayOutputWithContext(ctx context.Context) GetServicePrincipalSamlSingleSignOnArrayOutput

type GetServicePrincipalSamlSingleSignOnInput added in v5.2.0

type GetServicePrincipalSamlSingleSignOnInput interface {
	pulumi.Input

	ToGetServicePrincipalSamlSingleSignOnOutput() GetServicePrincipalSamlSingleSignOnOutput
	ToGetServicePrincipalSamlSingleSignOnOutputWithContext(context.Context) GetServicePrincipalSamlSingleSignOnOutput
}

GetServicePrincipalSamlSingleSignOnInput is an input type that accepts GetServicePrincipalSamlSingleSignOnArgs and GetServicePrincipalSamlSingleSignOnOutput values. You can construct a concrete instance of `GetServicePrincipalSamlSingleSignOnInput` via:

GetServicePrincipalSamlSingleSignOnArgs{...}

type GetServicePrincipalSamlSingleSignOnOutput added in v5.2.0

type GetServicePrincipalSamlSingleSignOnOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalSamlSingleSignOnOutput) ElementType added in v5.2.0

func (GetServicePrincipalSamlSingleSignOnOutput) RelayState added in v5.2.0

The relative URI the service provider would redirect to after completion of the single sign-on flow.

func (GetServicePrincipalSamlSingleSignOnOutput) ToGetServicePrincipalSamlSingleSignOnOutput added in v5.2.0

func (o GetServicePrincipalSamlSingleSignOnOutput) ToGetServicePrincipalSamlSingleSignOnOutput() GetServicePrincipalSamlSingleSignOnOutput

func (GetServicePrincipalSamlSingleSignOnOutput) ToGetServicePrincipalSamlSingleSignOnOutputWithContext added in v5.2.0

func (o GetServicePrincipalSamlSingleSignOnOutput) ToGetServicePrincipalSamlSingleSignOnOutputWithContext(ctx context.Context) GetServicePrincipalSamlSingleSignOnOutput

type GetServicePrincipalsArgs added in v5.2.0

type GetServicePrincipalsArgs struct {
	// A list of client IDs of the applications associated with the service principals.
	//
	// Deprecated: The `applicationIds` property has been replaced with the `clientIds` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationIds []string `pulumi:"applicationIds"`
	// A list of client IDs of the applications associated with the service principals.
	ClientIds []string `pulumi:"clientIds"`
	// A list of display names of the applications associated with the service principals.
	DisplayNames []string `pulumi:"displayNames"`
	// Ignore missing service principals and return all service principals that are found. The data source will still fail if no service principals are found. Defaults to false.
	IgnoreMissing *bool `pulumi:"ignoreMissing"`
	// The object IDs of the service principals.
	ObjectIds []string `pulumi:"objectIds"`
	// When `true`, the data source will return all service principals. Cannot be used with `ignoreMissing`. Defaults to false.
	//
	// > Either `returnAll`, or one of `clientIds`, `displayNames` or `objectIds` must be specified. These _may_ be specified as an empty list, in which case no results will be returned.
	ReturnAll *bool `pulumi:"returnAll"`
}

A collection of arguments for invoking getServicePrincipals.

type GetServicePrincipalsOutputArgs added in v5.3.0

type GetServicePrincipalsOutputArgs struct {
	// A list of client IDs of the applications associated with the service principals.
	//
	// Deprecated: The `applicationIds` property has been replaced with the `clientIds` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationIds pulumi.StringArrayInput `pulumi:"applicationIds"`
	// A list of client IDs of the applications associated with the service principals.
	ClientIds pulumi.StringArrayInput `pulumi:"clientIds"`
	// A list of display names of the applications associated with the service principals.
	DisplayNames pulumi.StringArrayInput `pulumi:"displayNames"`
	// Ignore missing service principals and return all service principals that are found. The data source will still fail if no service principals are found. Defaults to false.
	IgnoreMissing pulumi.BoolPtrInput `pulumi:"ignoreMissing"`
	// The object IDs of the service principals.
	ObjectIds pulumi.StringArrayInput `pulumi:"objectIds"`
	// When `true`, the data source will return all service principals. Cannot be used with `ignoreMissing`. Defaults to false.
	//
	// > Either `returnAll`, or one of `clientIds`, `displayNames` or `objectIds` must be specified. These _may_ be specified as an empty list, in which case no results will be returned.
	ReturnAll pulumi.BoolPtrInput `pulumi:"returnAll"`
}

A collection of arguments for invoking getServicePrincipals.

func (GetServicePrincipalsOutputArgs) ElementType added in v5.3.0

type GetServicePrincipalsResult added in v5.2.0

type GetServicePrincipalsResult struct {
	// A list of client IDs of the applications associated with the service principals.
	//
	// Deprecated: The `applicationIds` property has been replaced with the `clientIds` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationIds []string `pulumi:"applicationIds"`
	// The client ID of the application associated with this service principal.
	ClientIds []string `pulumi:"clientIds"`
	// A list of display names of the applications associated with the service principals.
	DisplayNames []string `pulumi:"displayNames"`
	// The provider-assigned unique ID for this managed resource.
	Id            string `pulumi:"id"`
	IgnoreMissing *bool  `pulumi:"ignoreMissing"`
	// The object IDs of the service principals.
	ObjectIds []string `pulumi:"objectIds"`
	ReturnAll *bool    `pulumi:"returnAll"`
	// A list of service principals. Each `servicePrincipal` object provides the attributes documented below.
	ServicePrincipals []GetServicePrincipalsServicePrincipal `pulumi:"servicePrincipals"`
}

A collection of values returned by getServicePrincipals.

func GetServicePrincipals added in v5.2.0

func GetServicePrincipals(ctx *pulumi.Context, args *GetServicePrincipalsArgs, opts ...pulumi.InvokeOption) (*GetServicePrincipalsResult, error)

Gets basic information for multiple Azure Active Directory service principals.

## 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: `Application.Read.All` or `Directory.Read.All`

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

## Example Usage

*Look up by application display names*

<!--Start PulumiCodeChooser --> ```go 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.GetServicePrincipals(ctx, &azuread.GetServicePrincipalsArgs{
			DisplayNames: []string{
				"example-app",
				"another-app",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up by application IDs (client IDs*

<!--Start PulumiCodeChooser --> ```go 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.GetServicePrincipals(ctx, &azuread.GetServicePrincipalsArgs{
			ClientIds: []string{
				"11111111-0000-0000-0000-000000000000",
				"22222222-0000-0000-0000-000000000000",
				"33333333-0000-0000-0000-000000000000",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up by service principal object IDs*

<!--Start PulumiCodeChooser --> ```go 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.GetServicePrincipals(ctx, &azuread.GetServicePrincipalsArgs{
			ObjectIds: []string{
				"00000000-0000-0000-0000-000000000000",
				"00000000-0000-0000-0000-111111111111",
				"00000000-0000-0000-0000-222222222222",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetServicePrincipalsResultOutput added in v5.3.0

type GetServicePrincipalsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getServicePrincipals.

func GetServicePrincipalsOutput added in v5.3.0

func (GetServicePrincipalsResultOutput) ApplicationIds deprecated added in v5.3.0

A list of client IDs of the applications associated with the service principals.

Deprecated: The `applicationIds` property has been replaced with the `clientIds` property and will be removed in version 3.0 of the AzureAD provider

func (GetServicePrincipalsResultOutput) ClientIds added in v5.43.0

The client ID of the application associated with this service principal.

func (GetServicePrincipalsResultOutput) DisplayNames added in v5.3.0

A list of display names of the applications associated with the service principals.

func (GetServicePrincipalsResultOutput) ElementType added in v5.3.0

func (GetServicePrincipalsResultOutput) Id added in v5.3.0

The provider-assigned unique ID for this managed resource.

func (GetServicePrincipalsResultOutput) IgnoreMissing added in v5.3.0

func (GetServicePrincipalsResultOutput) ObjectIds added in v5.3.0

The object IDs of the service principals.

func (GetServicePrincipalsResultOutput) ReturnAll added in v5.3.0

func (GetServicePrincipalsResultOutput) ServicePrincipals added in v5.3.0

A list of service principals. Each `servicePrincipal` object provides the attributes documented below.

func (GetServicePrincipalsResultOutput) ToGetServicePrincipalsResultOutput added in v5.3.0

func (o GetServicePrincipalsResultOutput) ToGetServicePrincipalsResultOutput() GetServicePrincipalsResultOutput

func (GetServicePrincipalsResultOutput) ToGetServicePrincipalsResultOutputWithContext added in v5.3.0

func (o GetServicePrincipalsResultOutput) ToGetServicePrincipalsResultOutputWithContext(ctx context.Context) GetServicePrincipalsResultOutput

type GetServicePrincipalsServicePrincipal added in v5.2.0

type GetServicePrincipalsServicePrincipal struct {
	// Whether the service principal account is enabled.
	AccountEnabled bool `pulumi:"accountEnabled"`
	// Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application.
	AppRoleAssignmentRequired bool `pulumi:"appRoleAssignmentRequired"`
	// The application ID (client ID) for the associated application
	//
	// Deprecated: The `applicationId` attribute has been replaced by the `clientId` attribute and will be removed in version 3.0 of the AzureAD provider
	ApplicationId string `pulumi:"applicationId"`
	// The tenant ID where the associated application is registered.
	ApplicationTenantId string `pulumi:"applicationTenantId"`
	// The application ID (client ID) for the associated application
	ClientId string `pulumi:"clientId"`
	// The display name of the application associated with this service principal.
	DisplayName string `pulumi:"displayName"`
	// The object ID of the service principal.
	ObjectId string `pulumi:"objectId"`
	// The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps.
	PreferredSingleSignOnMode string `pulumi:"preferredSingleSignOnMode"`
	// The URL where the service exposes SAML metadata for federation.
	SamlMetadataUrl string `pulumi:"samlMetadataUrl"`
	// A list of identifier URI(s), copied over from the associated application.
	ServicePrincipalNames []string `pulumi:"servicePrincipalNames"`
	// The Microsoft account types that are supported for the associated application. Possible values include `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.
	SignInAudience string `pulumi:"signInAudience"`
	// A list of tags applied to the service principal.
	Tags []string `pulumi:"tags"`
	// Identifies whether the service principal represents an application or a managed identity. Possible values include `Application` or `ManagedIdentity`.
	Type string `pulumi:"type"`
}

type GetServicePrincipalsServicePrincipalArgs added in v5.2.0

type GetServicePrincipalsServicePrincipalArgs struct {
	// Whether the service principal account is enabled.
	AccountEnabled pulumi.BoolInput `pulumi:"accountEnabled"`
	// Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application.
	AppRoleAssignmentRequired pulumi.BoolInput `pulumi:"appRoleAssignmentRequired"`
	// The application ID (client ID) for the associated application
	//
	// Deprecated: The `applicationId` attribute has been replaced by the `clientId` attribute and will be removed in version 3.0 of the AzureAD provider
	ApplicationId pulumi.StringInput `pulumi:"applicationId"`
	// The tenant ID where the associated application is registered.
	ApplicationTenantId pulumi.StringInput `pulumi:"applicationTenantId"`
	// The application ID (client ID) for the associated application
	ClientId pulumi.StringInput `pulumi:"clientId"`
	// The display name of the application associated with this service principal.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The object ID of the service principal.
	ObjectId pulumi.StringInput `pulumi:"objectId"`
	// The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps.
	PreferredSingleSignOnMode pulumi.StringInput `pulumi:"preferredSingleSignOnMode"`
	// The URL where the service exposes SAML metadata for federation.
	SamlMetadataUrl pulumi.StringInput `pulumi:"samlMetadataUrl"`
	// A list of identifier URI(s), copied over from the associated application.
	ServicePrincipalNames pulumi.StringArrayInput `pulumi:"servicePrincipalNames"`
	// The Microsoft account types that are supported for the associated application. Possible values include `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.
	SignInAudience pulumi.StringInput `pulumi:"signInAudience"`
	// A list of tags applied to the service principal.
	Tags pulumi.StringArrayInput `pulumi:"tags"`
	// Identifies whether the service principal represents an application or a managed identity. Possible values include `Application` or `ManagedIdentity`.
	Type pulumi.StringInput `pulumi:"type"`
}

func (GetServicePrincipalsServicePrincipalArgs) ElementType added in v5.2.0

func (GetServicePrincipalsServicePrincipalArgs) ToGetServicePrincipalsServicePrincipalOutput added in v5.2.0

func (i GetServicePrincipalsServicePrincipalArgs) ToGetServicePrincipalsServicePrincipalOutput() GetServicePrincipalsServicePrincipalOutput

func (GetServicePrincipalsServicePrincipalArgs) ToGetServicePrincipalsServicePrincipalOutputWithContext added in v5.2.0

func (i GetServicePrincipalsServicePrincipalArgs) ToGetServicePrincipalsServicePrincipalOutputWithContext(ctx context.Context) GetServicePrincipalsServicePrincipalOutput

type GetServicePrincipalsServicePrincipalArray added in v5.2.0

type GetServicePrincipalsServicePrincipalArray []GetServicePrincipalsServicePrincipalInput

func (GetServicePrincipalsServicePrincipalArray) ElementType added in v5.2.0

func (GetServicePrincipalsServicePrincipalArray) ToGetServicePrincipalsServicePrincipalArrayOutput added in v5.2.0

func (i GetServicePrincipalsServicePrincipalArray) ToGetServicePrincipalsServicePrincipalArrayOutput() GetServicePrincipalsServicePrincipalArrayOutput

func (GetServicePrincipalsServicePrincipalArray) ToGetServicePrincipalsServicePrincipalArrayOutputWithContext added in v5.2.0

func (i GetServicePrincipalsServicePrincipalArray) ToGetServicePrincipalsServicePrincipalArrayOutputWithContext(ctx context.Context) GetServicePrincipalsServicePrincipalArrayOutput

type GetServicePrincipalsServicePrincipalArrayInput added in v5.2.0

type GetServicePrincipalsServicePrincipalArrayInput interface {
	pulumi.Input

	ToGetServicePrincipalsServicePrincipalArrayOutput() GetServicePrincipalsServicePrincipalArrayOutput
	ToGetServicePrincipalsServicePrincipalArrayOutputWithContext(context.Context) GetServicePrincipalsServicePrincipalArrayOutput
}

GetServicePrincipalsServicePrincipalArrayInput is an input type that accepts GetServicePrincipalsServicePrincipalArray and GetServicePrincipalsServicePrincipalArrayOutput values. You can construct a concrete instance of `GetServicePrincipalsServicePrincipalArrayInput` via:

GetServicePrincipalsServicePrincipalArray{ GetServicePrincipalsServicePrincipalArgs{...} }

type GetServicePrincipalsServicePrincipalArrayOutput added in v5.2.0

type GetServicePrincipalsServicePrincipalArrayOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalsServicePrincipalArrayOutput) ElementType added in v5.2.0

func (GetServicePrincipalsServicePrincipalArrayOutput) Index added in v5.2.0

func (GetServicePrincipalsServicePrincipalArrayOutput) ToGetServicePrincipalsServicePrincipalArrayOutput added in v5.2.0

func (o GetServicePrincipalsServicePrincipalArrayOutput) ToGetServicePrincipalsServicePrincipalArrayOutput() GetServicePrincipalsServicePrincipalArrayOutput

func (GetServicePrincipalsServicePrincipalArrayOutput) ToGetServicePrincipalsServicePrincipalArrayOutputWithContext added in v5.2.0

func (o GetServicePrincipalsServicePrincipalArrayOutput) ToGetServicePrincipalsServicePrincipalArrayOutputWithContext(ctx context.Context) GetServicePrincipalsServicePrincipalArrayOutput

type GetServicePrincipalsServicePrincipalInput added in v5.2.0

type GetServicePrincipalsServicePrincipalInput interface {
	pulumi.Input

	ToGetServicePrincipalsServicePrincipalOutput() GetServicePrincipalsServicePrincipalOutput
	ToGetServicePrincipalsServicePrincipalOutputWithContext(context.Context) GetServicePrincipalsServicePrincipalOutput
}

GetServicePrincipalsServicePrincipalInput is an input type that accepts GetServicePrincipalsServicePrincipalArgs and GetServicePrincipalsServicePrincipalOutput values. You can construct a concrete instance of `GetServicePrincipalsServicePrincipalInput` via:

GetServicePrincipalsServicePrincipalArgs{...}

type GetServicePrincipalsServicePrincipalOutput added in v5.2.0

type GetServicePrincipalsServicePrincipalOutput struct{ *pulumi.OutputState }

func (GetServicePrincipalsServicePrincipalOutput) AccountEnabled added in v5.2.0

Whether the service principal account is enabled.

func (GetServicePrincipalsServicePrincipalOutput) AppRoleAssignmentRequired added in v5.2.0

func (o GetServicePrincipalsServicePrincipalOutput) AppRoleAssignmentRequired() pulumi.BoolOutput

Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application.

func (GetServicePrincipalsServicePrincipalOutput) ApplicationId deprecated added in v5.2.0

The application ID (client ID) for the associated application

Deprecated: The `applicationId` attribute has been replaced by the `clientId` attribute and will be removed in version 3.0 of the AzureAD provider

func (GetServicePrincipalsServicePrincipalOutput) ApplicationTenantId added in v5.2.0

The tenant ID where the associated application is registered.

func (GetServicePrincipalsServicePrincipalOutput) ClientId added in v5.43.0

The application ID (client ID) for the associated application

func (GetServicePrincipalsServicePrincipalOutput) DisplayName added in v5.2.0

The display name of the application associated with this service principal.

func (GetServicePrincipalsServicePrincipalOutput) ElementType added in v5.2.0

func (GetServicePrincipalsServicePrincipalOutput) ObjectId added in v5.19.0

The object ID of the service principal.

func (GetServicePrincipalsServicePrincipalOutput) PreferredSingleSignOnMode added in v5.2.0

func (o GetServicePrincipalsServicePrincipalOutput) PreferredSingleSignOnMode() pulumi.StringOutput

The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps.

func (GetServicePrincipalsServicePrincipalOutput) SamlMetadataUrl added in v5.2.0

The URL where the service exposes SAML metadata for federation.

func (GetServicePrincipalsServicePrincipalOutput) ServicePrincipalNames added in v5.2.0

A list of identifier URI(s), copied over from the associated application.

func (GetServicePrincipalsServicePrincipalOutput) SignInAudience added in v5.2.0

The Microsoft account types that are supported for the associated application. Possible values include `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.

func (GetServicePrincipalsServicePrincipalOutput) Tags added in v5.2.0

A list of tags applied to the service principal.

func (GetServicePrincipalsServicePrincipalOutput) ToGetServicePrincipalsServicePrincipalOutput added in v5.2.0

func (o GetServicePrincipalsServicePrincipalOutput) ToGetServicePrincipalsServicePrincipalOutput() GetServicePrincipalsServicePrincipalOutput

func (GetServicePrincipalsServicePrincipalOutput) ToGetServicePrincipalsServicePrincipalOutputWithContext added in v5.2.0

func (o GetServicePrincipalsServicePrincipalOutput) ToGetServicePrincipalsServicePrincipalOutputWithContext(ctx context.Context) GetServicePrincipalsServicePrincipalOutput

func (GetServicePrincipalsServicePrincipalOutput) Type added in v5.2.0

Identifies whether the service principal represents an application or a managed identity. Possible values include `Application` or `ManagedIdentity`.

type GetUsersArgs

type GetUsersArgs struct {
	// The employee identifiers assigned to the users by the organisation.
	EmployeeIds []string `pulumi:"employeeIds"`
	// Ignore missing users and return users that were found. The data source will still fail if no users are found. Cannot be specified with `returnAll`. Defaults to `false`.
	IgnoreMissing *bool `pulumi:"ignoreMissing"`
	// The email aliases of the users.
	MailNicknames []string `pulumi:"mailNicknames"`
	// The object IDs of the users.
	ObjectIds []string `pulumi:"objectIds"`
	// When `true`, the data source will return all users. Cannot be used with `ignoreMissing`. Defaults to `false`.
	ReturnAll *bool `pulumi:"returnAll"`
	// The user principal names (UPNs) of the users.
	//
	// > Either `returnAll`, or one of `userPrincipalNames`, `objectIds`, `mailNicknames` or `employeeIds` must be specified. These _may_ be specified as an empty list, in which case no results will be returned.
	UserPrincipalNames []string `pulumi:"userPrincipalNames"`
}

A collection of arguments for invoking getUsers.

type GetUsersOutputArgs added in v5.3.0

type GetUsersOutputArgs struct {
	// The employee identifiers assigned to the users by the organisation.
	EmployeeIds pulumi.StringArrayInput `pulumi:"employeeIds"`
	// Ignore missing users and return users that were found. The data source will still fail if no users are found. Cannot be specified with `returnAll`. Defaults to `false`.
	IgnoreMissing pulumi.BoolPtrInput `pulumi:"ignoreMissing"`
	// The email aliases of the users.
	MailNicknames pulumi.StringArrayInput `pulumi:"mailNicknames"`
	// The object IDs of the users.
	ObjectIds pulumi.StringArrayInput `pulumi:"objectIds"`
	// When `true`, the data source will return all users. Cannot be used with `ignoreMissing`. Defaults to `false`.
	ReturnAll pulumi.BoolPtrInput `pulumi:"returnAll"`
	// The user principal names (UPNs) of the users.
	//
	// > Either `returnAll`, or one of `userPrincipalNames`, `objectIds`, `mailNicknames` or `employeeIds` must be specified. These _may_ be specified as an empty list, in which case no results will be returned.
	UserPrincipalNames pulumi.StringArrayInput `pulumi:"userPrincipalNames"`
}

A collection of arguments for invoking getUsers.

func (GetUsersOutputArgs) ElementType added in v5.3.0

func (GetUsersOutputArgs) ElementType() reflect.Type

type GetUsersResult

type GetUsersResult struct {
	// The employee identifiers assigned to the users by the organisation.
	EmployeeIds []string `pulumi:"employeeIds"`
	// The provider-assigned unique ID for this managed resource.
	Id            string `pulumi:"id"`
	IgnoreMissing *bool  `pulumi:"ignoreMissing"`
	// The email aliases of the users.
	MailNicknames []string `pulumi:"mailNicknames"`
	// The object IDs of the users.
	ObjectIds []string `pulumi:"objectIds"`
	ReturnAll *bool    `pulumi:"returnAll"`
	// The user principal names (UPNs) of the users.
	UserPrincipalNames []string `pulumi:"userPrincipalNames"`
	// A list of users. Each `user` object provides the attributes documented below.
	Users []GetUsersUser `pulumi:"users"`
}

A collection of values returned by getUsers.

func GetUsers

func GetUsers(ctx *pulumi.Context, args *GetUsersArgs, opts ...pulumi.InvokeOption) (*GetUsersResult, error)

Gets basic information for multiple Azure Active Directory users.

## 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: `User.ReadBasic.All`, `User.Read.All` or `Directory.Read.All`

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

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.GetUsers(ctx, &azuread.GetUsersArgs{
			UserPrincipalNames: []string{
				"kat@example.com",
				"byte@example.com",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetUsersResultOutput added in v5.3.0

type GetUsersResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getUsers.

func GetUsersOutput added in v5.3.0

func GetUsersOutput(ctx *pulumi.Context, args GetUsersOutputArgs, opts ...pulumi.InvokeOption) GetUsersResultOutput

func (GetUsersResultOutput) ElementType added in v5.3.0

func (GetUsersResultOutput) ElementType() reflect.Type

func (GetUsersResultOutput) EmployeeIds added in v5.39.0

The employee identifiers assigned to the users by the organisation.

func (GetUsersResultOutput) Id added in v5.3.0

The provider-assigned unique ID for this managed resource.

func (GetUsersResultOutput) IgnoreMissing added in v5.3.0

func (o GetUsersResultOutput) IgnoreMissing() pulumi.BoolPtrOutput

func (GetUsersResultOutput) MailNicknames added in v5.3.0

func (o GetUsersResultOutput) MailNicknames() pulumi.StringArrayOutput

The email aliases of the users.

func (GetUsersResultOutput) ObjectIds added in v5.3.0

The object IDs of the users.

func (GetUsersResultOutput) ReturnAll added in v5.3.0

func (GetUsersResultOutput) ToGetUsersResultOutput added in v5.3.0

func (o GetUsersResultOutput) ToGetUsersResultOutput() GetUsersResultOutput

func (GetUsersResultOutput) ToGetUsersResultOutputWithContext added in v5.3.0

func (o GetUsersResultOutput) ToGetUsersResultOutputWithContext(ctx context.Context) GetUsersResultOutput

func (GetUsersResultOutput) UserPrincipalNames added in v5.3.0

func (o GetUsersResultOutput) UserPrincipalNames() pulumi.StringArrayOutput

The user principal names (UPNs) of the users.

func (GetUsersResultOutput) Users added in v5.3.0

A list of users. Each `user` object provides the attributes documented below.

type GetUsersUser

type GetUsersUser struct {
	// Whether or not the account is enabled.
	AccountEnabled bool `pulumi:"accountEnabled"`
	// The display name of the user.
	DisplayName string `pulumi:"displayName"`
	// The employee identifier assigned to the user by the organisation.
	EmployeeId string `pulumi:"employeeId"`
	// The primary email address of the user.
	Mail string `pulumi:"mail"`
	// The email alias of the user.
	MailNickname string `pulumi:"mailNickname"`
	// The object ID of the user.
	ObjectId string `pulumi:"objectId"`
	// The value used to associate an on-premises Active Directory user account with their Azure AD user object.
	OnpremisesImmutableId string `pulumi:"onpremisesImmutableId"`
	// The on-premise SAM account name of the user.
	OnpremisesSamAccountName string `pulumi:"onpremisesSamAccountName"`
	// The on-premise user principal name of the user.
	OnpremisesUserPrincipalName string `pulumi:"onpremisesUserPrincipalName"`
	// The usage location of the user.
	UsageLocation string `pulumi:"usageLocation"`
	// The user principal name (UPN) of the user.
	UserPrincipalName string `pulumi:"userPrincipalName"`
}

type GetUsersUserArgs

type GetUsersUserArgs struct {
	// Whether or not the account is enabled.
	AccountEnabled pulumi.BoolInput `pulumi:"accountEnabled"`
	// The display name of the user.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The employee identifier assigned to the user by the organisation.
	EmployeeId pulumi.StringInput `pulumi:"employeeId"`
	// The primary email address of the user.
	Mail pulumi.StringInput `pulumi:"mail"`
	// The email alias of the user.
	MailNickname pulumi.StringInput `pulumi:"mailNickname"`
	// The object ID of the user.
	ObjectId pulumi.StringInput `pulumi:"objectId"`
	// The value used to associate an on-premises Active Directory user account with their Azure AD user object.
	OnpremisesImmutableId pulumi.StringInput `pulumi:"onpremisesImmutableId"`
	// The on-premise SAM account name of the user.
	OnpremisesSamAccountName pulumi.StringInput `pulumi:"onpremisesSamAccountName"`
	// The on-premise user principal name of the user.
	OnpremisesUserPrincipalName pulumi.StringInput `pulumi:"onpremisesUserPrincipalName"`
	// The usage location of the user.
	UsageLocation pulumi.StringInput `pulumi:"usageLocation"`
	// The user principal name (UPN) of the user.
	UserPrincipalName pulumi.StringInput `pulumi:"userPrincipalName"`
}

func (GetUsersUserArgs) ElementType

func (GetUsersUserArgs) ElementType() reflect.Type

func (GetUsersUserArgs) ToGetUsersUserOutput

func (i GetUsersUserArgs) ToGetUsersUserOutput() GetUsersUserOutput

func (GetUsersUserArgs) ToGetUsersUserOutputWithContext

func (i GetUsersUserArgs) ToGetUsersUserOutputWithContext(ctx context.Context) GetUsersUserOutput

type GetUsersUserArray

type GetUsersUserArray []GetUsersUserInput

func (GetUsersUserArray) ElementType

func (GetUsersUserArray) ElementType() reflect.Type

func (GetUsersUserArray) ToGetUsersUserArrayOutput

func (i GetUsersUserArray) ToGetUsersUserArrayOutput() GetUsersUserArrayOutput

func (GetUsersUserArray) ToGetUsersUserArrayOutputWithContext

func (i GetUsersUserArray) ToGetUsersUserArrayOutputWithContext(ctx context.Context) GetUsersUserArrayOutput

type GetUsersUserArrayInput

type GetUsersUserArrayInput interface {
	pulumi.Input

	ToGetUsersUserArrayOutput() GetUsersUserArrayOutput
	ToGetUsersUserArrayOutputWithContext(context.Context) GetUsersUserArrayOutput
}

GetUsersUserArrayInput is an input type that accepts GetUsersUserArray and GetUsersUserArrayOutput values. You can construct a concrete instance of `GetUsersUserArrayInput` via:

GetUsersUserArray{ GetUsersUserArgs{...} }

type GetUsersUserArrayOutput

type GetUsersUserArrayOutput struct{ *pulumi.OutputState }

func (GetUsersUserArrayOutput) ElementType

func (GetUsersUserArrayOutput) ElementType() reflect.Type

func (GetUsersUserArrayOutput) Index

func (GetUsersUserArrayOutput) ToGetUsersUserArrayOutput

func (o GetUsersUserArrayOutput) ToGetUsersUserArrayOutput() GetUsersUserArrayOutput

func (GetUsersUserArrayOutput) ToGetUsersUserArrayOutputWithContext

func (o GetUsersUserArrayOutput) ToGetUsersUserArrayOutputWithContext(ctx context.Context) GetUsersUserArrayOutput

type GetUsersUserInput

type GetUsersUserInput interface {
	pulumi.Input

	ToGetUsersUserOutput() GetUsersUserOutput
	ToGetUsersUserOutputWithContext(context.Context) GetUsersUserOutput
}

GetUsersUserInput is an input type that accepts GetUsersUserArgs and GetUsersUserOutput values. You can construct a concrete instance of `GetUsersUserInput` via:

GetUsersUserArgs{...}

type GetUsersUserOutput

type GetUsersUserOutput struct{ *pulumi.OutputState }

func (GetUsersUserOutput) AccountEnabled

func (o GetUsersUserOutput) AccountEnabled() pulumi.BoolOutput

Whether or not the account is enabled.

func (GetUsersUserOutput) DisplayName

func (o GetUsersUserOutput) DisplayName() pulumi.StringOutput

The display name of the user.

func (GetUsersUserOutput) ElementType

func (GetUsersUserOutput) ElementType() reflect.Type

func (GetUsersUserOutput) EmployeeId added in v5.39.0

func (o GetUsersUserOutput) EmployeeId() pulumi.StringOutput

The employee identifier assigned to the user by the organisation.

func (GetUsersUserOutput) Mail

The primary email address of the user.

func (GetUsersUserOutput) MailNickname

func (o GetUsersUserOutput) MailNickname() pulumi.StringOutput

The email alias of the user.

func (GetUsersUserOutput) ObjectId

func (o GetUsersUserOutput) ObjectId() pulumi.StringOutput

The object ID of the user.

func (GetUsersUserOutput) OnpremisesImmutableId

func (o GetUsersUserOutput) OnpremisesImmutableId() pulumi.StringOutput

The value used to associate an on-premises Active Directory user account with their Azure AD user object.

func (GetUsersUserOutput) OnpremisesSamAccountName

func (o GetUsersUserOutput) OnpremisesSamAccountName() pulumi.StringOutput

The on-premise SAM account name of the user.

func (GetUsersUserOutput) OnpremisesUserPrincipalName

func (o GetUsersUserOutput) OnpremisesUserPrincipalName() pulumi.StringOutput

The on-premise user principal name of the user.

func (GetUsersUserOutput) ToGetUsersUserOutput

func (o GetUsersUserOutput) ToGetUsersUserOutput() GetUsersUserOutput

func (GetUsersUserOutput) ToGetUsersUserOutputWithContext

func (o GetUsersUserOutput) ToGetUsersUserOutputWithContext(ctx context.Context) GetUsersUserOutput

func (GetUsersUserOutput) UsageLocation

func (o GetUsersUserOutput) UsageLocation() pulumi.StringOutput

The usage location of the user.

func (GetUsersUserOutput) UserPrincipalName

func (o GetUsersUserOutput) UserPrincipalName() pulumi.StringOutput

The user principal name (UPN) of the user.

type Group

type Group struct {
	pulumi.CustomResourceState

	// The object IDs of administrative units in which the group is a member. If specified, new groups will be created in the scope of the first administrative unit and added to the others. If empty, new groups will be created at the tenant level.
	//
	// !> **Warning** Do not use the `administrativeUnitIds` property at the same time as the AdministrativeUnitMember resource, _for the same group_. Doing so will cause a conflict and administrative unit members will be removed.
	AdministrativeUnitIds pulumi.StringArrayOutput `pulumi:"administrativeUnitIds"`
	// Indicates whether this group can be assigned to an Azure Active Directory role. Defaults to `false`. Can only be set to `true` for security-enabled groups. Changing this forces a new resource to be created.
	AssignableToRole pulumi.BoolPtrOutput `pulumi:"assignableToRole"`
	// Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `autoSubscribeNewMembers` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	AutoSubscribeNewMembers pulumi.BoolOutput `pulumi:"autoSubscribeNewMembers"`
	// A set of behaviors for a Microsoft 365 group. Possible values are `AllowOnlyMembersToPost`, `HideGroupInOutlook`, `SubscribeMembersToCalendarEventsDisabled`, `SubscribeNewGroupMembers` and `WelcomeEmailDisabled`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for more details. Changing this forces a new resource to be created.
	Behaviors pulumi.StringArrayOutput `pulumi:"behaviors"`
	// The description for the group.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The display name for the group.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// A `dynamicMembership` block as documented below. Required when `types` contains `DynamicMembership`. Cannot be used with the `members` property.
	DynamicMembership GroupDynamicMembershipPtrOutput `pulumi:"dynamicMembership"`
	// Indicates whether people external to the organization can send messages to the group. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `externalSendersAllowed` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	ExternalSendersAllowed pulumi.BoolOutput `pulumi:"externalSendersAllowed"`
	// Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `hideFromAddressLists` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	HideFromAddressLists pulumi.BoolOutput `pulumi:"hideFromAddressLists"`
	// Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `hideFromOutlookClients` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	HideFromOutlookClients pulumi.BoolOutput `pulumi:"hideFromOutlookClients"`
	// The SMTP address for the group.
	Mail pulumi.StringOutput `pulumi:"mail"`
	// Whether the group is a mail enabled, with a shared group mailbox. At least one of `mailEnabled` or `securityEnabled` must be specified. Only Microsoft 365 groups can be mail enabled (see the `types` property).
	MailEnabled pulumi.BoolPtrOutput `pulumi:"mailEnabled"`
	// The mail alias for the group, unique in the organisation. Required for mail-enabled groups. Changing this forces a new resource to be created.
	MailNickname pulumi.StringOutput `pulumi:"mailNickname"`
	// A set of members who should be present in this group. Supported object types are Users, Groups or Service Principals. Cannot be used with the `dynamicMembership` block.
	//
	// !> **Warning** Do not use the `members` property at the same time as the GroupMember resource for the same group. Doing so will cause a conflict and group members will be removed.
	Members pulumi.StringArrayOutput `pulumi:"members"`
	// The object ID of the group.
	ObjectId pulumi.StringOutput `pulumi:"objectId"`
	// The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesDomainName pulumi.StringOutput `pulumi:"onpremisesDomainName"`
	// The on-premises group type that the AAD group will be written as, when writeback is enabled. Possible values are `UniversalDistributionGroup`, `UniversalMailEnabledSecurityGroup`, or `UniversalSecurityGroup`.
	OnpremisesGroupType pulumi.StringOutput `pulumi:"onpremisesGroupType"`
	// The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesNetbiosName pulumi.StringOutput `pulumi:"onpremisesNetbiosName"`
	// The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesSamAccountName pulumi.StringOutput `pulumi:"onpremisesSamAccountName"`
	// The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesSecurityIdentifier pulumi.StringOutput `pulumi:"onpremisesSecurityIdentifier"`
	// Whether this group is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).
	OnpremisesSyncEnabled pulumi.BoolOutput `pulumi:"onpremisesSyncEnabled"`
	// A set of owners who own this group. Supported object types are Users or Service Principals
	Owners pulumi.StringArrayOutput `pulumi:"owners"`
	// The preferred language for a Microsoft 365 group, in ISO 639-1 notation.
	PreferredLanguage pulumi.StringOutput `pulumi:"preferredLanguage"`
	// If `true`, will return an error if an existing group is found with the same name. Defaults to `false`.
	PreventDuplicateNames pulumi.BoolPtrOutput `pulumi:"preventDuplicateNames"`
	// A set of provisioning options for a Microsoft 365 group. The only supported value is `Team`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for details. Changing this forces a new resource to be created.
	ProvisioningOptions pulumi.StringArrayOutput `pulumi:"provisioningOptions"`
	// List of email addresses for the group that direct to the same group mailbox.
	ProxyAddresses pulumi.StringArrayOutput `pulumi:"proxyAddresses"`
	// Whether the group is a security group for controlling access to in-app resources. At least one of `securityEnabled` or `mailEnabled` must be specified. A Microsoft 365 group can be security enabled _and_ mail enabled (see the `types` property).
	SecurityEnabled pulumi.BoolPtrOutput `pulumi:"securityEnabled"`
	// The colour theme for a Microsoft 365 group. Possible values are `Blue`, `Green`, `Orange`, `Pink`, `Purple`, `Red` or `Teal`. By default, no theme is set.
	Theme pulumi.StringPtrOutput `pulumi:"theme"`
	// A set of group types to configure for the group. Supported values are `DynamicMembership`, which denotes a group with dynamic membership, and `Unified`, which specifies a Microsoft 365 group. Required when `mailEnabled` is true. Changing this forces a new resource to be created.
	//
	// > **Supported Group Types** At present, only security groups and Microsoft 365 groups can be created or managed with this resource. Distribution groups and mail-enabled security groups are not supported. Microsoft 365 groups can be security-enabled.
	Types pulumi.StringArrayOutput `pulumi:"types"`
	// The group join policy and group content visibility. Possible values are `Private`, `Public`, or `Hiddenmembership`. Only Microsoft 365 groups can have `Hiddenmembership` visibility and this value must be set when the group is created. By default, security groups will receive `Private` visibility and Microsoft 365 groups will receive `Public` visibility.
	//
	// > **Group Name Uniqueness** Group names are not unique within Azure Active Directory. Use the `preventDuplicateNames` argument to check for existing groups if you want to avoid name collisions.
	Visibility pulumi.StringOutput `pulumi:"visibility"`
	// Whether the group will be written back to the configured on-premises Active Directory when Azure AD Connect is used.
	WritebackEnabled pulumi.BoolPtrOutput `pulumi:"writebackEnabled"`
}

Manages a group within 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 one of the following application roles: `Group.ReadWrite.All` or `Directory.ReadWrite.All`.

Alternatively, if the authenticated service principal is also an owner of the group being managed, this resource can use the application role: `Group.Create`.

If using the `assignableToRole` property, this resource additionally requires one of the following application roles: `RoleManagement.ReadWrite.Directory` or `Directory.ReadWrite.All`

If specifying owners for a group, which are user principals, this resource additionally requires one of the following application roles: `User.Read.All`, `User.ReadWrite.All`, `Directory.Read.All` or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Groups Administrator`, `User Administrator` or `Global Administrator`

When creating this resource in administrative units exclusively, the role `Groups Administrator` is required to be scoped on any administrative unit used.

The `externalSendersAllowed`, `autoSubscribeNewMembers`, `hideFromAddressLists` and `hideFromOutlookClients` properties can only be configured when authenticating as a user and cannot be configured when authenticating as a service principal. Additionally, the user being used for authentication must be a Member of the tenant where the group is being managed and _not_ a Guest. This is a known API issue; please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) official documentation.

## Example Usage

*Basic example*

<!--Start PulumiCodeChooser --> ```go 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 {
		current, err := azuread.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = azuread.NewGroup(ctx, "example", &azuread.GroupArgs{
			DisplayName: pulumi.String("example"),
			Owners: pulumi.StringArray{
				pulumi.String(current.ObjectId),
			},
			SecurityEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Microsoft 365 group*

<!--Start PulumiCodeChooser --> ```go 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 {
		current, err := azuread.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		groupOwner, err := azuread.NewUser(ctx, "group_owner", &azuread.UserArgs{
			UserPrincipalName: pulumi.String("example-group-owner@example.com"),
			DisplayName:       pulumi.String("Group Owner"),
			MailNickname:      pulumi.String("example-group-owner"),
			Password:          pulumi.String("SecretP@sswd99!"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewGroup(ctx, "example", &azuread.GroupArgs{
			DisplayName:     pulumi.String("example"),
			MailEnabled:     pulumi.Bool(true),
			MailNickname:    pulumi.String("ExampleGroup"),
			SecurityEnabled: pulumi.Bool(true),
			Types: pulumi.StringArray{
				pulumi.String("Unified"),
			},
			Owners: pulumi.StringArray{
				pulumi.String(current.ObjectId),
				groupOwner.ObjectId,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Group with members*

## Import

Groups can be imported using their object ID, e.g.

```sh $ pulumi import azuread:index/group:Group my_group 00000000-0000-0000-0000-000000000000 ```

func GetGroup

func GetGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)

GetGroup gets an existing Group resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGroup

func NewGroup(ctx *pulumi.Context,
	name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)

NewGroup registers a new resource with the given unique name, arguments, and options.

func (*Group) ElementType

func (*Group) ElementType() reflect.Type

func (*Group) ToGroupOutput

func (i *Group) ToGroupOutput() GroupOutput

func (*Group) ToGroupOutputWithContext

func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupArgs

type GroupArgs struct {
	// The object IDs of administrative units in which the group is a member. If specified, new groups will be created in the scope of the first administrative unit and added to the others. If empty, new groups will be created at the tenant level.
	//
	// !> **Warning** Do not use the `administrativeUnitIds` property at the same time as the AdministrativeUnitMember resource, _for the same group_. Doing so will cause a conflict and administrative unit members will be removed.
	AdministrativeUnitIds pulumi.StringArrayInput
	// Indicates whether this group can be assigned to an Azure Active Directory role. Defaults to `false`. Can only be set to `true` for security-enabled groups. Changing this forces a new resource to be created.
	AssignableToRole pulumi.BoolPtrInput
	// Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `autoSubscribeNewMembers` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	AutoSubscribeNewMembers pulumi.BoolPtrInput
	// A set of behaviors for a Microsoft 365 group. Possible values are `AllowOnlyMembersToPost`, `HideGroupInOutlook`, `SubscribeMembersToCalendarEventsDisabled`, `SubscribeNewGroupMembers` and `WelcomeEmailDisabled`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for more details. Changing this forces a new resource to be created.
	Behaviors pulumi.StringArrayInput
	// The description for the group.
	Description pulumi.StringPtrInput
	// The display name for the group.
	DisplayName pulumi.StringInput
	// A `dynamicMembership` block as documented below. Required when `types` contains `DynamicMembership`. Cannot be used with the `members` property.
	DynamicMembership GroupDynamicMembershipPtrInput
	// Indicates whether people external to the organization can send messages to the group. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `externalSendersAllowed` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	ExternalSendersAllowed pulumi.BoolPtrInput
	// Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `hideFromAddressLists` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	HideFromAddressLists pulumi.BoolPtrInput
	// Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `hideFromOutlookClients` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	HideFromOutlookClients pulumi.BoolPtrInput
	// Whether the group is a mail enabled, with a shared group mailbox. At least one of `mailEnabled` or `securityEnabled` must be specified. Only Microsoft 365 groups can be mail enabled (see the `types` property).
	MailEnabled pulumi.BoolPtrInput
	// The mail alias for the group, unique in the organisation. Required for mail-enabled groups. Changing this forces a new resource to be created.
	MailNickname pulumi.StringPtrInput
	// A set of members who should be present in this group. Supported object types are Users, Groups or Service Principals. Cannot be used with the `dynamicMembership` block.
	//
	// !> **Warning** Do not use the `members` property at the same time as the GroupMember resource for the same group. Doing so will cause a conflict and group members will be removed.
	Members pulumi.StringArrayInput
	// The on-premises group type that the AAD group will be written as, when writeback is enabled. Possible values are `UniversalDistributionGroup`, `UniversalMailEnabledSecurityGroup`, or `UniversalSecurityGroup`.
	OnpremisesGroupType pulumi.StringPtrInput
	// A set of owners who own this group. Supported object types are Users or Service Principals
	Owners pulumi.StringArrayInput
	// If `true`, will return an error if an existing group is found with the same name. Defaults to `false`.
	PreventDuplicateNames pulumi.BoolPtrInput
	// A set of provisioning options for a Microsoft 365 group. The only supported value is `Team`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for details. Changing this forces a new resource to be created.
	ProvisioningOptions pulumi.StringArrayInput
	// Whether the group is a security group for controlling access to in-app resources. At least one of `securityEnabled` or `mailEnabled` must be specified. A Microsoft 365 group can be security enabled _and_ mail enabled (see the `types` property).
	SecurityEnabled pulumi.BoolPtrInput
	// The colour theme for a Microsoft 365 group. Possible values are `Blue`, `Green`, `Orange`, `Pink`, `Purple`, `Red` or `Teal`. By default, no theme is set.
	Theme pulumi.StringPtrInput
	// A set of group types to configure for the group. Supported values are `DynamicMembership`, which denotes a group with dynamic membership, and `Unified`, which specifies a Microsoft 365 group. Required when `mailEnabled` is true. Changing this forces a new resource to be created.
	//
	// > **Supported Group Types** At present, only security groups and Microsoft 365 groups can be created or managed with this resource. Distribution groups and mail-enabled security groups are not supported. Microsoft 365 groups can be security-enabled.
	Types pulumi.StringArrayInput
	// The group join policy and group content visibility. Possible values are `Private`, `Public`, or `Hiddenmembership`. Only Microsoft 365 groups can have `Hiddenmembership` visibility and this value must be set when the group is created. By default, security groups will receive `Private` visibility and Microsoft 365 groups will receive `Public` visibility.
	//
	// > **Group Name Uniqueness** Group names are not unique within Azure Active Directory. Use the `preventDuplicateNames` argument to check for existing groups if you want to avoid name collisions.
	Visibility pulumi.StringPtrInput
	// Whether the group will be written back to the configured on-premises Active Directory when Azure AD Connect is used.
	WritebackEnabled pulumi.BoolPtrInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType

func (GroupArgs) ElementType() reflect.Type

type GroupArray

type GroupArray []GroupInput

func (GroupArray) ElementType

func (GroupArray) ElementType() reflect.Type

func (GroupArray) ToGroupArrayOutput

func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput

func (GroupArray) ToGroupArrayOutputWithContext

func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupArrayInput

type GroupArrayInput interface {
	pulumi.Input

	ToGroupArrayOutput() GroupArrayOutput
	ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput
}

GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via:

GroupArray{ GroupArgs{...} }

type GroupArrayOutput

type GroupArrayOutput struct{ *pulumi.OutputState }

func (GroupArrayOutput) ElementType

func (GroupArrayOutput) ElementType() reflect.Type

func (GroupArrayOutput) Index

func (GroupArrayOutput) ToGroupArrayOutput

func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput

func (GroupArrayOutput) ToGroupArrayOutputWithContext

func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupDynamicMembership added in v5.12.0

type GroupDynamicMembership struct {
	// Whether rule processing is "On" (true) or "Paused" (false).
	Enabled bool `pulumi:"enabled"`
	// The rule that determines membership of this group. For more information, see official documentation on [membership rules syntax](https://docs.microsoft.com/en-gb/azure/active-directory/enterprise-users/groups-dynamic-membership).
	//
	// > **Dynamic Group Memberships** Remember to include `DynamicMembership` in the set of `types` for the group when configuring a dynamic membership rule. Dynamic membership is a premium feature which requires an Azure Active Directory P1 or P2 license.
	Rule string `pulumi:"rule"`
}

type GroupDynamicMembershipArgs added in v5.12.0

type GroupDynamicMembershipArgs struct {
	// Whether rule processing is "On" (true) or "Paused" (false).
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The rule that determines membership of this group. For more information, see official documentation on [membership rules syntax](https://docs.microsoft.com/en-gb/azure/active-directory/enterprise-users/groups-dynamic-membership).
	//
	// > **Dynamic Group Memberships** Remember to include `DynamicMembership` in the set of `types` for the group when configuring a dynamic membership rule. Dynamic membership is a premium feature which requires an Azure Active Directory P1 or P2 license.
	Rule pulumi.StringInput `pulumi:"rule"`
}

func (GroupDynamicMembershipArgs) ElementType added in v5.12.0

func (GroupDynamicMembershipArgs) ElementType() reflect.Type

func (GroupDynamicMembershipArgs) ToGroupDynamicMembershipOutput added in v5.12.0

func (i GroupDynamicMembershipArgs) ToGroupDynamicMembershipOutput() GroupDynamicMembershipOutput

func (GroupDynamicMembershipArgs) ToGroupDynamicMembershipOutputWithContext added in v5.12.0

func (i GroupDynamicMembershipArgs) ToGroupDynamicMembershipOutputWithContext(ctx context.Context) GroupDynamicMembershipOutput

func (GroupDynamicMembershipArgs) ToGroupDynamicMembershipPtrOutput added in v5.12.0

func (i GroupDynamicMembershipArgs) ToGroupDynamicMembershipPtrOutput() GroupDynamicMembershipPtrOutput

func (GroupDynamicMembershipArgs) ToGroupDynamicMembershipPtrOutputWithContext added in v5.12.0

func (i GroupDynamicMembershipArgs) ToGroupDynamicMembershipPtrOutputWithContext(ctx context.Context) GroupDynamicMembershipPtrOutput

type GroupDynamicMembershipInput added in v5.12.0

type GroupDynamicMembershipInput interface {
	pulumi.Input

	ToGroupDynamicMembershipOutput() GroupDynamicMembershipOutput
	ToGroupDynamicMembershipOutputWithContext(context.Context) GroupDynamicMembershipOutput
}

GroupDynamicMembershipInput is an input type that accepts GroupDynamicMembershipArgs and GroupDynamicMembershipOutput values. You can construct a concrete instance of `GroupDynamicMembershipInput` via:

GroupDynamicMembershipArgs{...}

type GroupDynamicMembershipOutput added in v5.12.0

type GroupDynamicMembershipOutput struct{ *pulumi.OutputState }

func (GroupDynamicMembershipOutput) ElementType added in v5.12.0

func (GroupDynamicMembershipOutput) Enabled added in v5.12.0

Whether rule processing is "On" (true) or "Paused" (false).

func (GroupDynamicMembershipOutput) Rule added in v5.12.0

The rule that determines membership of this group. For more information, see official documentation on [membership rules syntax](https://docs.microsoft.com/en-gb/azure/active-directory/enterprise-users/groups-dynamic-membership).

> **Dynamic Group Memberships** Remember to include `DynamicMembership` in the set of `types` for the group when configuring a dynamic membership rule. Dynamic membership is a premium feature which requires an Azure Active Directory P1 or P2 license.

func (GroupDynamicMembershipOutput) ToGroupDynamicMembershipOutput added in v5.12.0

func (o GroupDynamicMembershipOutput) ToGroupDynamicMembershipOutput() GroupDynamicMembershipOutput

func (GroupDynamicMembershipOutput) ToGroupDynamicMembershipOutputWithContext added in v5.12.0

func (o GroupDynamicMembershipOutput) ToGroupDynamicMembershipOutputWithContext(ctx context.Context) GroupDynamicMembershipOutput

func (GroupDynamicMembershipOutput) ToGroupDynamicMembershipPtrOutput added in v5.12.0

func (o GroupDynamicMembershipOutput) ToGroupDynamicMembershipPtrOutput() GroupDynamicMembershipPtrOutput

func (GroupDynamicMembershipOutput) ToGroupDynamicMembershipPtrOutputWithContext added in v5.12.0

func (o GroupDynamicMembershipOutput) ToGroupDynamicMembershipPtrOutputWithContext(ctx context.Context) GroupDynamicMembershipPtrOutput

type GroupDynamicMembershipPtrInput added in v5.12.0

type GroupDynamicMembershipPtrInput interface {
	pulumi.Input

	ToGroupDynamicMembershipPtrOutput() GroupDynamicMembershipPtrOutput
	ToGroupDynamicMembershipPtrOutputWithContext(context.Context) GroupDynamicMembershipPtrOutput
}

GroupDynamicMembershipPtrInput is an input type that accepts GroupDynamicMembershipArgs, GroupDynamicMembershipPtr and GroupDynamicMembershipPtrOutput values. You can construct a concrete instance of `GroupDynamicMembershipPtrInput` via:

        GroupDynamicMembershipArgs{...}

or:

        nil

func GroupDynamicMembershipPtr added in v5.12.0

func GroupDynamicMembershipPtr(v *GroupDynamicMembershipArgs) GroupDynamicMembershipPtrInput

type GroupDynamicMembershipPtrOutput added in v5.12.0

type GroupDynamicMembershipPtrOutput struct{ *pulumi.OutputState }

func (GroupDynamicMembershipPtrOutput) Elem added in v5.12.0

func (GroupDynamicMembershipPtrOutput) ElementType added in v5.12.0

func (GroupDynamicMembershipPtrOutput) Enabled added in v5.12.0

Whether rule processing is "On" (true) or "Paused" (false).

func (GroupDynamicMembershipPtrOutput) Rule added in v5.12.0

The rule that determines membership of this group. For more information, see official documentation on [membership rules syntax](https://docs.microsoft.com/en-gb/azure/active-directory/enterprise-users/groups-dynamic-membership).

> **Dynamic Group Memberships** Remember to include `DynamicMembership` in the set of `types` for the group when configuring a dynamic membership rule. Dynamic membership is a premium feature which requires an Azure Active Directory P1 or P2 license.

func (GroupDynamicMembershipPtrOutput) ToGroupDynamicMembershipPtrOutput added in v5.12.0

func (o GroupDynamicMembershipPtrOutput) ToGroupDynamicMembershipPtrOutput() GroupDynamicMembershipPtrOutput

func (GroupDynamicMembershipPtrOutput) ToGroupDynamicMembershipPtrOutputWithContext added in v5.12.0

func (o GroupDynamicMembershipPtrOutput) ToGroupDynamicMembershipPtrOutputWithContext(ctx context.Context) GroupDynamicMembershipPtrOutput

type GroupInput

type GroupInput interface {
	pulumi.Input

	ToGroupOutput() GroupOutput
	ToGroupOutputWithContext(ctx context.Context) GroupOutput
}

type GroupMap

type GroupMap map[string]GroupInput

func (GroupMap) ElementType

func (GroupMap) ElementType() reflect.Type

func (GroupMap) ToGroupMapOutput

func (i GroupMap) ToGroupMapOutput() GroupMapOutput

func (GroupMap) ToGroupMapOutputWithContext

func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupMapInput

type GroupMapInput interface {
	pulumi.Input

	ToGroupMapOutput() GroupMapOutput
	ToGroupMapOutputWithContext(context.Context) GroupMapOutput
}

GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via:

GroupMap{ "key": GroupArgs{...} }

type GroupMapOutput

type GroupMapOutput struct{ *pulumi.OutputState }

func (GroupMapOutput) ElementType

func (GroupMapOutput) ElementType() reflect.Type

func (GroupMapOutput) MapIndex

func (GroupMapOutput) ToGroupMapOutput

func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput

func (GroupMapOutput) ToGroupMapOutputWithContext

func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupMember

type GroupMember struct {
	pulumi.CustomResourceState

	// The object ID of the group you want to add the member to. Changing this forces a new resource to be created.
	GroupObjectId pulumi.StringOutput `pulumi:"groupObjectId"`
	// The object ID of the principal you want to add as a member to the group. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringOutput `pulumi:"memberObjectId"`
}

Manages a single group membership within Azure Active Directory.

> **Warning** Do not use this resource at the same time as the `members` property of the `Group` resource for the same group. Doing so will cause a conflict and group members will be removed.

## API Permissions

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

When authenticated with a service principal, this resource requires one of the following application roles: `Group.ReadWrite.All` or `Directory.ReadWrite.All`.

However, if the authenticated service principal is an owner of the group being managed, an application role is not required.

When authenticated with a user principal, this resource requires one of the following directory roles: `Groups Administrator`, `User Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.LookupUser(ctx, &azuread.LookupUserArgs{
			UserPrincipalName: pulumi.StringRef("jdoe@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		exampleGroup, err := azuread.NewGroup(ctx, "example", &azuread.GroupArgs{
			DisplayName:     pulumi.String("my_group"),
			SecurityEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewGroupMember(ctx, "example", &azuread.GroupMemberArgs{
			GroupObjectId:  exampleGroup.ID(),
			MemberObjectId: pulumi.String(example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Group members can be imported using the object ID of the group and the object ID of the member, e.g.

```sh $ pulumi import azuread:index/groupMember:GroupMember example 00000000-0000-0000-0000-000000000000/member/11111111-1111-1111-1111-111111111111 ```

-> This ID format is unique to Terraform and is composed of the Azure AD Group Object ID and the target Member Object ID in the format `{GroupObjectID}/member/{MemberObjectID}`.

func GetGroupMember

func GetGroupMember(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GroupMemberState, opts ...pulumi.ResourceOption) (*GroupMember, error)

GetGroupMember gets an existing GroupMember resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGroupMember

func NewGroupMember(ctx *pulumi.Context,
	name string, args *GroupMemberArgs, opts ...pulumi.ResourceOption) (*GroupMember, error)

NewGroupMember registers a new resource with the given unique name, arguments, and options.

func (*GroupMember) ElementType

func (*GroupMember) ElementType() reflect.Type

func (*GroupMember) ToGroupMemberOutput

func (i *GroupMember) ToGroupMemberOutput() GroupMemberOutput

func (*GroupMember) ToGroupMemberOutputWithContext

func (i *GroupMember) ToGroupMemberOutputWithContext(ctx context.Context) GroupMemberOutput

type GroupMemberArgs

type GroupMemberArgs struct {
	// The object ID of the group you want to add the member to. Changing this forces a new resource to be created.
	GroupObjectId pulumi.StringInput
	// The object ID of the principal you want to add as a member to the group. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringInput
}

The set of arguments for constructing a GroupMember resource.

func (GroupMemberArgs) ElementType

func (GroupMemberArgs) ElementType() reflect.Type

type GroupMemberArray

type GroupMemberArray []GroupMemberInput

func (GroupMemberArray) ElementType

func (GroupMemberArray) ElementType() reflect.Type

func (GroupMemberArray) ToGroupMemberArrayOutput

func (i GroupMemberArray) ToGroupMemberArrayOutput() GroupMemberArrayOutput

func (GroupMemberArray) ToGroupMemberArrayOutputWithContext

func (i GroupMemberArray) ToGroupMemberArrayOutputWithContext(ctx context.Context) GroupMemberArrayOutput

type GroupMemberArrayInput

type GroupMemberArrayInput interface {
	pulumi.Input

	ToGroupMemberArrayOutput() GroupMemberArrayOutput
	ToGroupMemberArrayOutputWithContext(context.Context) GroupMemberArrayOutput
}

GroupMemberArrayInput is an input type that accepts GroupMemberArray and GroupMemberArrayOutput values. You can construct a concrete instance of `GroupMemberArrayInput` via:

GroupMemberArray{ GroupMemberArgs{...} }

type GroupMemberArrayOutput

type GroupMemberArrayOutput struct{ *pulumi.OutputState }

func (GroupMemberArrayOutput) ElementType

func (GroupMemberArrayOutput) ElementType() reflect.Type

func (GroupMemberArrayOutput) Index

func (GroupMemberArrayOutput) ToGroupMemberArrayOutput

func (o GroupMemberArrayOutput) ToGroupMemberArrayOutput() GroupMemberArrayOutput

func (GroupMemberArrayOutput) ToGroupMemberArrayOutputWithContext

func (o GroupMemberArrayOutput) ToGroupMemberArrayOutputWithContext(ctx context.Context) GroupMemberArrayOutput

type GroupMemberInput

type GroupMemberInput interface {
	pulumi.Input

	ToGroupMemberOutput() GroupMemberOutput
	ToGroupMemberOutputWithContext(ctx context.Context) GroupMemberOutput
}

type GroupMemberMap

type GroupMemberMap map[string]GroupMemberInput

func (GroupMemberMap) ElementType

func (GroupMemberMap) ElementType() reflect.Type

func (GroupMemberMap) ToGroupMemberMapOutput

func (i GroupMemberMap) ToGroupMemberMapOutput() GroupMemberMapOutput

func (GroupMemberMap) ToGroupMemberMapOutputWithContext

func (i GroupMemberMap) ToGroupMemberMapOutputWithContext(ctx context.Context) GroupMemberMapOutput

type GroupMemberMapInput

type GroupMemberMapInput interface {
	pulumi.Input

	ToGroupMemberMapOutput() GroupMemberMapOutput
	ToGroupMemberMapOutputWithContext(context.Context) GroupMemberMapOutput
}

GroupMemberMapInput is an input type that accepts GroupMemberMap and GroupMemberMapOutput values. You can construct a concrete instance of `GroupMemberMapInput` via:

GroupMemberMap{ "key": GroupMemberArgs{...} }

type GroupMemberMapOutput

type GroupMemberMapOutput struct{ *pulumi.OutputState }

func (GroupMemberMapOutput) ElementType

func (GroupMemberMapOutput) ElementType() reflect.Type

func (GroupMemberMapOutput) MapIndex

func (GroupMemberMapOutput) ToGroupMemberMapOutput

func (o GroupMemberMapOutput) ToGroupMemberMapOutput() GroupMemberMapOutput

func (GroupMemberMapOutput) ToGroupMemberMapOutputWithContext

func (o GroupMemberMapOutput) ToGroupMemberMapOutputWithContext(ctx context.Context) GroupMemberMapOutput

type GroupMemberOutput

type GroupMemberOutput struct{ *pulumi.OutputState }

func (GroupMemberOutput) ElementType

func (GroupMemberOutput) ElementType() reflect.Type

func (GroupMemberOutput) GroupObjectId added in v5.22.0

func (o GroupMemberOutput) GroupObjectId() pulumi.StringOutput

The object ID of the group you want to add the member to. Changing this forces a new resource to be created.

func (GroupMemberOutput) MemberObjectId added in v5.22.0

func (o GroupMemberOutput) MemberObjectId() pulumi.StringOutput

The object ID of the principal you want to add as a member to the group. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.

func (GroupMemberOutput) ToGroupMemberOutput

func (o GroupMemberOutput) ToGroupMemberOutput() GroupMemberOutput

func (GroupMemberOutput) ToGroupMemberOutputWithContext

func (o GroupMemberOutput) ToGroupMemberOutputWithContext(ctx context.Context) GroupMemberOutput

type GroupMemberState

type GroupMemberState struct {
	// The object ID of the group you want to add the member to. Changing this forces a new resource to be created.
	GroupObjectId pulumi.StringPtrInput
	// The object ID of the principal you want to add as a member to the group. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
	MemberObjectId pulumi.StringPtrInput
}

func (GroupMemberState) ElementType

func (GroupMemberState) ElementType() reflect.Type

type GroupOutput

type GroupOutput struct{ *pulumi.OutputState }

func (GroupOutput) AdministrativeUnitIds added in v5.35.0

func (o GroupOutput) AdministrativeUnitIds() pulumi.StringArrayOutput

The object IDs of administrative units in which the group is a member. If specified, new groups will be created in the scope of the first administrative unit and added to the others. If empty, new groups will be created at the tenant level.

!> **Warning** Do not use the `administrativeUnitIds` property at the same time as the AdministrativeUnitMember resource, _for the same group_. Doing so will cause a conflict and administrative unit members will be removed.

func (GroupOutput) AssignableToRole added in v5.22.0

func (o GroupOutput) AssignableToRole() pulumi.BoolPtrOutput

Indicates whether this group can be assigned to an Azure Active Directory role. Defaults to `false`. Can only be set to `true` for security-enabled groups. Changing this forces a new resource to be created.

func (GroupOutput) AutoSubscribeNewMembers added in v5.22.0

func (o GroupOutput) AutoSubscribeNewMembers() pulumi.BoolOutput

Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Can only be set for Unified groups.

> **Known Permissions Issue** The `autoSubscribeNewMembers` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.

func (GroupOutput) Behaviors added in v5.22.0

func (o GroupOutput) Behaviors() pulumi.StringArrayOutput

A set of behaviors for a Microsoft 365 group. Possible values are `AllowOnlyMembersToPost`, `HideGroupInOutlook`, `SubscribeMembersToCalendarEventsDisabled`, `SubscribeNewGroupMembers` and `WelcomeEmailDisabled`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for more details. Changing this forces a new resource to be created.

func (GroupOutput) Description added in v5.22.0

func (o GroupOutput) Description() pulumi.StringPtrOutput

The description for the group.

func (GroupOutput) DisplayName added in v5.22.0

func (o GroupOutput) DisplayName() pulumi.StringOutput

The display name for the group.

func (GroupOutput) DynamicMembership added in v5.22.0

func (o GroupOutput) DynamicMembership() GroupDynamicMembershipPtrOutput

A `dynamicMembership` block as documented below. Required when `types` contains `DynamicMembership`. Cannot be used with the `members` property.

func (GroupOutput) ElementType

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) ExternalSendersAllowed added in v5.22.0

func (o GroupOutput) ExternalSendersAllowed() pulumi.BoolOutput

Indicates whether people external to the organization can send messages to the group. Can only be set for Unified groups.

> **Known Permissions Issue** The `externalSendersAllowed` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.

func (GroupOutput) HideFromAddressLists added in v5.22.0

func (o GroupOutput) HideFromAddressLists() pulumi.BoolOutput

Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. Can only be set for Unified groups.

> **Known Permissions Issue** The `hideFromAddressLists` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.

func (GroupOutput) HideFromOutlookClients added in v5.22.0

func (o GroupOutput) HideFromOutlookClients() pulumi.BoolOutput

Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Can only be set for Unified groups.

> **Known Permissions Issue** The `hideFromOutlookClients` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.

func (GroupOutput) Mail added in v5.22.0

func (o GroupOutput) Mail() pulumi.StringOutput

The SMTP address for the group.

func (GroupOutput) MailEnabled added in v5.22.0

func (o GroupOutput) MailEnabled() pulumi.BoolPtrOutput

Whether the group is a mail enabled, with a shared group mailbox. At least one of `mailEnabled` or `securityEnabled` must be specified. Only Microsoft 365 groups can be mail enabled (see the `types` property).

func (GroupOutput) MailNickname added in v5.22.0

func (o GroupOutput) MailNickname() pulumi.StringOutput

The mail alias for the group, unique in the organisation. Required for mail-enabled groups. Changing this forces a new resource to be created.

func (GroupOutput) Members added in v5.22.0

func (o GroupOutput) Members() pulumi.StringArrayOutput

A set of members who should be present in this group. Supported object types are Users, Groups or Service Principals. Cannot be used with the `dynamicMembership` block.

!> **Warning** Do not use the `members` property at the same time as the GroupMember resource for the same group. Doing so will cause a conflict and group members will be removed.

func (GroupOutput) ObjectId added in v5.22.0

func (o GroupOutput) ObjectId() pulumi.StringOutput

The object ID of the group.

func (GroupOutput) OnpremisesDomainName added in v5.22.0

func (o GroupOutput) OnpremisesDomainName() pulumi.StringOutput

The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.

func (GroupOutput) OnpremisesGroupType added in v5.37.0

func (o GroupOutput) OnpremisesGroupType() pulumi.StringOutput

The on-premises group type that the AAD group will be written as, when writeback is enabled. Possible values are `UniversalDistributionGroup`, `UniversalMailEnabledSecurityGroup`, or `UniversalSecurityGroup`.

func (GroupOutput) OnpremisesNetbiosName added in v5.22.0

func (o GroupOutput) OnpremisesNetbiosName() pulumi.StringOutput

The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.

func (GroupOutput) OnpremisesSamAccountName added in v5.22.0

func (o GroupOutput) OnpremisesSamAccountName() pulumi.StringOutput

The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.

func (GroupOutput) OnpremisesSecurityIdentifier added in v5.22.0

func (o GroupOutput) OnpremisesSecurityIdentifier() pulumi.StringOutput

The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.

func (GroupOutput) OnpremisesSyncEnabled added in v5.22.0

func (o GroupOutput) OnpremisesSyncEnabled() pulumi.BoolOutput

Whether this group is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).

func (GroupOutput) Owners added in v5.22.0

A set of owners who own this group. Supported object types are Users or Service Principals

func (GroupOutput) PreferredLanguage added in v5.22.0

func (o GroupOutput) PreferredLanguage() pulumi.StringOutput

The preferred language for a Microsoft 365 group, in ISO 639-1 notation.

func (GroupOutput) PreventDuplicateNames added in v5.22.0

func (o GroupOutput) PreventDuplicateNames() pulumi.BoolPtrOutput

If `true`, will return an error if an existing group is found with the same name. Defaults to `false`.

func (GroupOutput) ProvisioningOptions added in v5.22.0

func (o GroupOutput) ProvisioningOptions() pulumi.StringArrayOutput

A set of provisioning options for a Microsoft 365 group. The only supported value is `Team`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for details. Changing this forces a new resource to be created.

func (GroupOutput) ProxyAddresses added in v5.22.0

func (o GroupOutput) ProxyAddresses() pulumi.StringArrayOutput

List of email addresses for the group that direct to the same group mailbox.

func (GroupOutput) SecurityEnabled added in v5.22.0

func (o GroupOutput) SecurityEnabled() pulumi.BoolPtrOutput

Whether the group is a security group for controlling access to in-app resources. At least one of `securityEnabled` or `mailEnabled` must be specified. A Microsoft 365 group can be security enabled _and_ mail enabled (see the `types` property).

func (GroupOutput) Theme added in v5.22.0

The colour theme for a Microsoft 365 group. Possible values are `Blue`, `Green`, `Orange`, `Pink`, `Purple`, `Red` or `Teal`. By default, no theme is set.

func (GroupOutput) ToGroupOutput

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext

func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput

func (GroupOutput) Types added in v5.22.0

A set of group types to configure for the group. Supported values are `DynamicMembership`, which denotes a group with dynamic membership, and `Unified`, which specifies a Microsoft 365 group. Required when `mailEnabled` is true. Changing this forces a new resource to be created.

> **Supported Group Types** At present, only security groups and Microsoft 365 groups can be created or managed with this resource. Distribution groups and mail-enabled security groups are not supported. Microsoft 365 groups can be security-enabled.

func (GroupOutput) Visibility added in v5.22.0

func (o GroupOutput) Visibility() pulumi.StringOutput

The group join policy and group content visibility. Possible values are `Private`, `Public`, or `Hiddenmembership`. Only Microsoft 365 groups can have `Hiddenmembership` visibility and this value must be set when the group is created. By default, security groups will receive `Private` visibility and Microsoft 365 groups will receive `Public` visibility.

> **Group Name Uniqueness** Group names are not unique within Azure Active Directory. Use the `preventDuplicateNames` argument to check for existing groups if you want to avoid name collisions.

func (GroupOutput) WritebackEnabled added in v5.37.0

func (o GroupOutput) WritebackEnabled() pulumi.BoolPtrOutput

Whether the group will be written back to the configured on-premises Active Directory when Azure AD Connect is used.

type GroupState

type GroupState struct {
	// The object IDs of administrative units in which the group is a member. If specified, new groups will be created in the scope of the first administrative unit and added to the others. If empty, new groups will be created at the tenant level.
	//
	// !> **Warning** Do not use the `administrativeUnitIds` property at the same time as the AdministrativeUnitMember resource, _for the same group_. Doing so will cause a conflict and administrative unit members will be removed.
	AdministrativeUnitIds pulumi.StringArrayInput
	// Indicates whether this group can be assigned to an Azure Active Directory role. Defaults to `false`. Can only be set to `true` for security-enabled groups. Changing this forces a new resource to be created.
	AssignableToRole pulumi.BoolPtrInput
	// Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `autoSubscribeNewMembers` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	AutoSubscribeNewMembers pulumi.BoolPtrInput
	// A set of behaviors for a Microsoft 365 group. Possible values are `AllowOnlyMembersToPost`, `HideGroupInOutlook`, `SubscribeMembersToCalendarEventsDisabled`, `SubscribeNewGroupMembers` and `WelcomeEmailDisabled`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for more details. Changing this forces a new resource to be created.
	Behaviors pulumi.StringArrayInput
	// The description for the group.
	Description pulumi.StringPtrInput
	// The display name for the group.
	DisplayName pulumi.StringPtrInput
	// A `dynamicMembership` block as documented below. Required when `types` contains `DynamicMembership`. Cannot be used with the `members` property.
	DynamicMembership GroupDynamicMembershipPtrInput
	// Indicates whether people external to the organization can send messages to the group. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `externalSendersAllowed` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	ExternalSendersAllowed pulumi.BoolPtrInput
	// Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `hideFromAddressLists` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	HideFromAddressLists pulumi.BoolPtrInput
	// Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Can only be set for Unified groups.
	//
	// > **Known Permissions Issue** The `hideFromOutlookClients` property can only be set when authenticating as a Member user of the tenant and _not_ when authenticating as a Guest user or as a service principal. Please see the [Microsoft Graph Known Issues](https://docs.microsoft.com/en-us/graph/known-issues#groups) documentation.
	HideFromOutlookClients pulumi.BoolPtrInput
	// The SMTP address for the group.
	Mail pulumi.StringPtrInput
	// Whether the group is a mail enabled, with a shared group mailbox. At least one of `mailEnabled` or `securityEnabled` must be specified. Only Microsoft 365 groups can be mail enabled (see the `types` property).
	MailEnabled pulumi.BoolPtrInput
	// The mail alias for the group, unique in the organisation. Required for mail-enabled groups. Changing this forces a new resource to be created.
	MailNickname pulumi.StringPtrInput
	// A set of members who should be present in this group. Supported object types are Users, Groups or Service Principals. Cannot be used with the `dynamicMembership` block.
	//
	// !> **Warning** Do not use the `members` property at the same time as the GroupMember resource for the same group. Doing so will cause a conflict and group members will be removed.
	Members pulumi.StringArrayInput
	// The object ID of the group.
	ObjectId pulumi.StringPtrInput
	// The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesDomainName pulumi.StringPtrInput
	// The on-premises group type that the AAD group will be written as, when writeback is enabled. Possible values are `UniversalDistributionGroup`, `UniversalMailEnabledSecurityGroup`, or `UniversalSecurityGroup`.
	OnpremisesGroupType pulumi.StringPtrInput
	// The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesNetbiosName pulumi.StringPtrInput
	// The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesSamAccountName pulumi.StringPtrInput
	// The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesSecurityIdentifier pulumi.StringPtrInput
	// Whether this group is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).
	OnpremisesSyncEnabled pulumi.BoolPtrInput
	// A set of owners who own this group. Supported object types are Users or Service Principals
	Owners pulumi.StringArrayInput
	// The preferred language for a Microsoft 365 group, in ISO 639-1 notation.
	PreferredLanguage pulumi.StringPtrInput
	// If `true`, will return an error if an existing group is found with the same name. Defaults to `false`.
	PreventDuplicateNames pulumi.BoolPtrInput
	// A set of provisioning options for a Microsoft 365 group. The only supported value is `Team`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for details. Changing this forces a new resource to be created.
	ProvisioningOptions pulumi.StringArrayInput
	// List of email addresses for the group that direct to the same group mailbox.
	ProxyAddresses pulumi.StringArrayInput
	// Whether the group is a security group for controlling access to in-app resources. At least one of `securityEnabled` or `mailEnabled` must be specified. A Microsoft 365 group can be security enabled _and_ mail enabled (see the `types` property).
	SecurityEnabled pulumi.BoolPtrInput
	// The colour theme for a Microsoft 365 group. Possible values are `Blue`, `Green`, `Orange`, `Pink`, `Purple`, `Red` or `Teal`. By default, no theme is set.
	Theme pulumi.StringPtrInput
	// A set of group types to configure for the group. Supported values are `DynamicMembership`, which denotes a group with dynamic membership, and `Unified`, which specifies a Microsoft 365 group. Required when `mailEnabled` is true. Changing this forces a new resource to be created.
	//
	// > **Supported Group Types** At present, only security groups and Microsoft 365 groups can be created or managed with this resource. Distribution groups and mail-enabled security groups are not supported. Microsoft 365 groups can be security-enabled.
	Types pulumi.StringArrayInput
	// The group join policy and group content visibility. Possible values are `Private`, `Public`, or `Hiddenmembership`. Only Microsoft 365 groups can have `Hiddenmembership` visibility and this value must be set when the group is created. By default, security groups will receive `Private` visibility and Microsoft 365 groups will receive `Public` visibility.
	//
	// > **Group Name Uniqueness** Group names are not unique within Azure Active Directory. Use the `preventDuplicateNames` argument to check for existing groups if you want to avoid name collisions.
	Visibility pulumi.StringPtrInput
	// Whether the group will be written back to the configured on-premises Active Directory when Azure AD Connect is used.
	WritebackEnabled pulumi.BoolPtrInput
}

func (GroupState) ElementType

func (GroupState) ElementType() reflect.Type

type Invitation added in v5.1.0

type Invitation struct {
	pulumi.CustomResourceState

	// A `message` block as documented below, which configures the message being sent to the invited user. If this block is omitted, no message will be sent.
	Message InvitationMessagePtrOutput `pulumi:"message"`
	// The URL the user can use to redeem their invitation.
	RedeemUrl pulumi.StringOutput `pulumi:"redeemUrl"`
	// The URL that the user should be redirected to once the invitation is redeemed.
	RedirectUrl pulumi.StringOutput `pulumi:"redirectUrl"`
	// The display name of the user being invited.
	UserDisplayName pulumi.StringPtrOutput `pulumi:"userDisplayName"`
	// The email address of the user being invited.
	UserEmailAddress pulumi.StringOutput `pulumi:"userEmailAddress"`
	// Object ID of the invited user.
	UserId pulumi.StringOutput `pulumi:"userId"`
	// The user type of the user being invited. Must be one of `Guest` or `Member`. Only Global Administrators can invite users as members. Defaults to `Guest`.
	UserType pulumi.StringPtrOutput `pulumi:"userType"`
}

Manages an invitation of a guest user within 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 one of the following application roles: `User.Invite.All`, `User.ReadWrite.All` or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Guest Inviter`, `User Administrator` or `Global Administrator`

## Example Usage

*Basic example*

<!--Start PulumiCodeChooser --> ```go 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.NewInvitation(ctx, "example", &azuread.InvitationArgs{
			UserEmailAddress: pulumi.String("jdoe@example.com"),
			RedirectUrl:      pulumi.String("https://portal.azure.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Invitation with standard message*

<!--Start PulumiCodeChooser --> ```go 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.NewInvitation(ctx, "example", &azuread.InvitationArgs{
			UserEmailAddress: pulumi.String("jdoe@example.com"),
			RedirectUrl:      pulumi.String("https://portal.azure.com"),
			Message: &azuread.InvitationMessageArgs{
				Language: pulumi.String("en-US"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Invitation with custom message body and an additional recipient*

<!--Start PulumiCodeChooser --> ```go 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.NewInvitation(ctx, "example", &azuread.InvitationArgs{
			UserDisplayName:  pulumi.String("Bob Bobson"),
			UserEmailAddress: pulumi.String("bbobson@example.com"),
			RedirectUrl:      pulumi.String("https://portal.azure.com"),
			Message: &azuread.InvitationMessageArgs{
				AdditionalRecipients: pulumi.String("aaliceberg@example.com"),
				Body:                 pulumi.String("Hello there! You are invited to join my Azure tenant!"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

This resource does not support importing.

func GetInvitation added in v5.1.0

func GetInvitation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *InvitationState, opts ...pulumi.ResourceOption) (*Invitation, error)

GetInvitation gets an existing Invitation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewInvitation added in v5.1.0

func NewInvitation(ctx *pulumi.Context,
	name string, args *InvitationArgs, opts ...pulumi.ResourceOption) (*Invitation, error)

NewInvitation registers a new resource with the given unique name, arguments, and options.

func (*Invitation) ElementType added in v5.1.0

func (*Invitation) ElementType() reflect.Type

func (*Invitation) ToInvitationOutput added in v5.1.0

func (i *Invitation) ToInvitationOutput() InvitationOutput

func (*Invitation) ToInvitationOutputWithContext added in v5.1.0

func (i *Invitation) ToInvitationOutputWithContext(ctx context.Context) InvitationOutput

type InvitationArgs added in v5.1.0

type InvitationArgs struct {
	// A `message` block as documented below, which configures the message being sent to the invited user. If this block is omitted, no message will be sent.
	Message InvitationMessagePtrInput
	// The URL that the user should be redirected to once the invitation is redeemed.
	RedirectUrl pulumi.StringInput
	// The display name of the user being invited.
	UserDisplayName pulumi.StringPtrInput
	// The email address of the user being invited.
	UserEmailAddress pulumi.StringInput
	// The user type of the user being invited. Must be one of `Guest` or `Member`. Only Global Administrators can invite users as members. Defaults to `Guest`.
	UserType pulumi.StringPtrInput
}

The set of arguments for constructing a Invitation resource.

func (InvitationArgs) ElementType added in v5.1.0

func (InvitationArgs) ElementType() reflect.Type

type InvitationArray added in v5.1.0

type InvitationArray []InvitationInput

func (InvitationArray) ElementType added in v5.1.0

func (InvitationArray) ElementType() reflect.Type

func (InvitationArray) ToInvitationArrayOutput added in v5.1.0

func (i InvitationArray) ToInvitationArrayOutput() InvitationArrayOutput

func (InvitationArray) ToInvitationArrayOutputWithContext added in v5.1.0

func (i InvitationArray) ToInvitationArrayOutputWithContext(ctx context.Context) InvitationArrayOutput

type InvitationArrayInput added in v5.1.0

type InvitationArrayInput interface {
	pulumi.Input

	ToInvitationArrayOutput() InvitationArrayOutput
	ToInvitationArrayOutputWithContext(context.Context) InvitationArrayOutput
}

InvitationArrayInput is an input type that accepts InvitationArray and InvitationArrayOutput values. You can construct a concrete instance of `InvitationArrayInput` via:

InvitationArray{ InvitationArgs{...} }

type InvitationArrayOutput added in v5.1.0

type InvitationArrayOutput struct{ *pulumi.OutputState }

func (InvitationArrayOutput) ElementType added in v5.1.0

func (InvitationArrayOutput) ElementType() reflect.Type

func (InvitationArrayOutput) Index added in v5.1.0

func (InvitationArrayOutput) ToInvitationArrayOutput added in v5.1.0

func (o InvitationArrayOutput) ToInvitationArrayOutput() InvitationArrayOutput

func (InvitationArrayOutput) ToInvitationArrayOutputWithContext added in v5.1.0

func (o InvitationArrayOutput) ToInvitationArrayOutputWithContext(ctx context.Context) InvitationArrayOutput

type InvitationInput added in v5.1.0

type InvitationInput interface {
	pulumi.Input

	ToInvitationOutput() InvitationOutput
	ToInvitationOutputWithContext(ctx context.Context) InvitationOutput
}

type InvitationMap added in v5.1.0

type InvitationMap map[string]InvitationInput

func (InvitationMap) ElementType added in v5.1.0

func (InvitationMap) ElementType() reflect.Type

func (InvitationMap) ToInvitationMapOutput added in v5.1.0

func (i InvitationMap) ToInvitationMapOutput() InvitationMapOutput

func (InvitationMap) ToInvitationMapOutputWithContext added in v5.1.0

func (i InvitationMap) ToInvitationMapOutputWithContext(ctx context.Context) InvitationMapOutput

type InvitationMapInput added in v5.1.0

type InvitationMapInput interface {
	pulumi.Input

	ToInvitationMapOutput() InvitationMapOutput
	ToInvitationMapOutputWithContext(context.Context) InvitationMapOutput
}

InvitationMapInput is an input type that accepts InvitationMap and InvitationMapOutput values. You can construct a concrete instance of `InvitationMapInput` via:

InvitationMap{ "key": InvitationArgs{...} }

type InvitationMapOutput added in v5.1.0

type InvitationMapOutput struct{ *pulumi.OutputState }

func (InvitationMapOutput) ElementType added in v5.1.0

func (InvitationMapOutput) ElementType() reflect.Type

func (InvitationMapOutput) MapIndex added in v5.1.0

func (InvitationMapOutput) ToInvitationMapOutput added in v5.1.0

func (o InvitationMapOutput) ToInvitationMapOutput() InvitationMapOutput

func (InvitationMapOutput) ToInvitationMapOutputWithContext added in v5.1.0

func (o InvitationMapOutput) ToInvitationMapOutputWithContext(ctx context.Context) InvitationMapOutput

type InvitationMessage added in v5.1.0

type InvitationMessage struct {
	// Email addresses of additional recipients the invitation message should be sent to. Only 1 additional recipient is currently supported by Azure.
	AdditionalRecipients *string `pulumi:"additionalRecipients"`
	// Customized message body you want to send if you don't want to send the default message. Cannot be specified with `language`.
	Body *string `pulumi:"body"`
	// The language you want to send the default message in. The value specified must be in ISO 639 format. Defaults to `en-US`. Cannot be specified with `body`.
	Language *string `pulumi:"language"`
}

type InvitationMessageArgs added in v5.1.0

type InvitationMessageArgs struct {
	// Email addresses of additional recipients the invitation message should be sent to. Only 1 additional recipient is currently supported by Azure.
	AdditionalRecipients pulumi.StringPtrInput `pulumi:"additionalRecipients"`
	// Customized message body you want to send if you don't want to send the default message. Cannot be specified with `language`.
	Body pulumi.StringPtrInput `pulumi:"body"`
	// The language you want to send the default message in. The value specified must be in ISO 639 format. Defaults to `en-US`. Cannot be specified with `body`.
	Language pulumi.StringPtrInput `pulumi:"language"`
}

func (InvitationMessageArgs) ElementType added in v5.1.0

func (InvitationMessageArgs) ElementType() reflect.Type

func (InvitationMessageArgs) ToInvitationMessageOutput added in v5.1.0

func (i InvitationMessageArgs) ToInvitationMessageOutput() InvitationMessageOutput

func (InvitationMessageArgs) ToInvitationMessageOutputWithContext added in v5.1.0

func (i InvitationMessageArgs) ToInvitationMessageOutputWithContext(ctx context.Context) InvitationMessageOutput

func (InvitationMessageArgs) ToInvitationMessagePtrOutput added in v5.1.0

func (i InvitationMessageArgs) ToInvitationMessagePtrOutput() InvitationMessagePtrOutput

func (InvitationMessageArgs) ToInvitationMessagePtrOutputWithContext added in v5.1.0

func (i InvitationMessageArgs) ToInvitationMessagePtrOutputWithContext(ctx context.Context) InvitationMessagePtrOutput

type InvitationMessageInput added in v5.1.0

type InvitationMessageInput interface {
	pulumi.Input

	ToInvitationMessageOutput() InvitationMessageOutput
	ToInvitationMessageOutputWithContext(context.Context) InvitationMessageOutput
}

InvitationMessageInput is an input type that accepts InvitationMessageArgs and InvitationMessageOutput values. You can construct a concrete instance of `InvitationMessageInput` via:

InvitationMessageArgs{...}

type InvitationMessageOutput added in v5.1.0

type InvitationMessageOutput struct{ *pulumi.OutputState }

func (InvitationMessageOutput) AdditionalRecipients added in v5.1.0

func (o InvitationMessageOutput) AdditionalRecipients() pulumi.StringPtrOutput

Email addresses of additional recipients the invitation message should be sent to. Only 1 additional recipient is currently supported by Azure.

func (InvitationMessageOutput) Body added in v5.1.0

Customized message body you want to send if you don't want to send the default message. Cannot be specified with `language`.

func (InvitationMessageOutput) ElementType added in v5.1.0

func (InvitationMessageOutput) ElementType() reflect.Type

func (InvitationMessageOutput) Language added in v5.1.0

The language you want to send the default message in. The value specified must be in ISO 639 format. Defaults to `en-US`. Cannot be specified with `body`.

func (InvitationMessageOutput) ToInvitationMessageOutput added in v5.1.0

func (o InvitationMessageOutput) ToInvitationMessageOutput() InvitationMessageOutput

func (InvitationMessageOutput) ToInvitationMessageOutputWithContext added in v5.1.0

func (o InvitationMessageOutput) ToInvitationMessageOutputWithContext(ctx context.Context) InvitationMessageOutput

func (InvitationMessageOutput) ToInvitationMessagePtrOutput added in v5.1.0

func (o InvitationMessageOutput) ToInvitationMessagePtrOutput() InvitationMessagePtrOutput

func (InvitationMessageOutput) ToInvitationMessagePtrOutputWithContext added in v5.1.0

func (o InvitationMessageOutput) ToInvitationMessagePtrOutputWithContext(ctx context.Context) InvitationMessagePtrOutput

type InvitationMessagePtrInput added in v5.1.0

type InvitationMessagePtrInput interface {
	pulumi.Input

	ToInvitationMessagePtrOutput() InvitationMessagePtrOutput
	ToInvitationMessagePtrOutputWithContext(context.Context) InvitationMessagePtrOutput
}

InvitationMessagePtrInput is an input type that accepts InvitationMessageArgs, InvitationMessagePtr and InvitationMessagePtrOutput values. You can construct a concrete instance of `InvitationMessagePtrInput` via:

        InvitationMessageArgs{...}

or:

        nil

func InvitationMessagePtr added in v5.1.0

func InvitationMessagePtr(v *InvitationMessageArgs) InvitationMessagePtrInput

type InvitationMessagePtrOutput added in v5.1.0

type InvitationMessagePtrOutput struct{ *pulumi.OutputState }

func (InvitationMessagePtrOutput) AdditionalRecipients added in v5.1.0

func (o InvitationMessagePtrOutput) AdditionalRecipients() pulumi.StringPtrOutput

Email addresses of additional recipients the invitation message should be sent to. Only 1 additional recipient is currently supported by Azure.

func (InvitationMessagePtrOutput) Body added in v5.1.0

Customized message body you want to send if you don't want to send the default message. Cannot be specified with `language`.

func (InvitationMessagePtrOutput) Elem added in v5.1.0

func (InvitationMessagePtrOutput) ElementType added in v5.1.0

func (InvitationMessagePtrOutput) ElementType() reflect.Type

func (InvitationMessagePtrOutput) Language added in v5.1.0

The language you want to send the default message in. The value specified must be in ISO 639 format. Defaults to `en-US`. Cannot be specified with `body`.

func (InvitationMessagePtrOutput) ToInvitationMessagePtrOutput added in v5.1.0

func (o InvitationMessagePtrOutput) ToInvitationMessagePtrOutput() InvitationMessagePtrOutput

func (InvitationMessagePtrOutput) ToInvitationMessagePtrOutputWithContext added in v5.1.0

func (o InvitationMessagePtrOutput) ToInvitationMessagePtrOutputWithContext(ctx context.Context) InvitationMessagePtrOutput

type InvitationOutput added in v5.1.0

type InvitationOutput struct{ *pulumi.OutputState }

func (InvitationOutput) ElementType added in v5.1.0

func (InvitationOutput) ElementType() reflect.Type

func (InvitationOutput) Message added in v5.22.0

A `message` block as documented below, which configures the message being sent to the invited user. If this block is omitted, no message will be sent.

func (InvitationOutput) RedeemUrl added in v5.22.0

func (o InvitationOutput) RedeemUrl() pulumi.StringOutput

The URL the user can use to redeem their invitation.

func (InvitationOutput) RedirectUrl added in v5.22.0

func (o InvitationOutput) RedirectUrl() pulumi.StringOutput

The URL that the user should be redirected to once the invitation is redeemed.

func (InvitationOutput) ToInvitationOutput added in v5.1.0

func (o InvitationOutput) ToInvitationOutput() InvitationOutput

func (InvitationOutput) ToInvitationOutputWithContext added in v5.1.0

func (o InvitationOutput) ToInvitationOutputWithContext(ctx context.Context) InvitationOutput

func (InvitationOutput) UserDisplayName added in v5.22.0

func (o InvitationOutput) UserDisplayName() pulumi.StringPtrOutput

The display name of the user being invited.

func (InvitationOutput) UserEmailAddress added in v5.22.0

func (o InvitationOutput) UserEmailAddress() pulumi.StringOutput

The email address of the user being invited.

func (InvitationOutput) UserId added in v5.22.0

Object ID of the invited user.

func (InvitationOutput) UserType added in v5.22.0

The user type of the user being invited. Must be one of `Guest` or `Member`. Only Global Administrators can invite users as members. Defaults to `Guest`.

type InvitationState added in v5.1.0

type InvitationState struct {
	// A `message` block as documented below, which configures the message being sent to the invited user. If this block is omitted, no message will be sent.
	Message InvitationMessagePtrInput
	// The URL the user can use to redeem their invitation.
	RedeemUrl pulumi.StringPtrInput
	// The URL that the user should be redirected to once the invitation is redeemed.
	RedirectUrl pulumi.StringPtrInput
	// The display name of the user being invited.
	UserDisplayName pulumi.StringPtrInput
	// The email address of the user being invited.
	UserEmailAddress pulumi.StringPtrInput
	// Object ID of the invited user.
	UserId pulumi.StringPtrInput
	// The user type of the user being invited. Must be one of `Guest` or `Member`. Only Global Administrators can invite users as members. Defaults to `Guest`.
	UserType pulumi.StringPtrInput
}

func (InvitationState) ElementType added in v5.1.0

func (InvitationState) ElementType() reflect.Type

type LookupAccessPackageArgs added in v5.37.0

type LookupAccessPackageArgs struct {
	// The ID of the Catalog this access package is in.
	CatalogId *string `pulumi:"catalogId"`
	// The display name of the access package.
	DisplayName *string `pulumi:"displayName"`
	// The ID of this access package.
	//
	// > Either `objectId`, or both `catalogId` and `displayName`, must be specified.
	ObjectId *string `pulumi:"objectId"`
}

A collection of arguments for invoking getAccessPackage.

type LookupAccessPackageCatalogArgs added in v5.37.0

type LookupAccessPackageCatalogArgs struct {
	// The display name of the access package catalog.
	DisplayName *string `pulumi:"displayName"`
	// The ID of this access package catalog.
	//
	// > One of `displayName` or `objectId` must be specified.
	ObjectId *string `pulumi:"objectId"`
}

A collection of arguments for invoking getAccessPackageCatalog.

type LookupAccessPackageCatalogOutputArgs added in v5.37.0

type LookupAccessPackageCatalogOutputArgs struct {
	// The display name of the access package catalog.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// The ID of this access package catalog.
	//
	// > One of `displayName` or `objectId` must be specified.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
}

A collection of arguments for invoking getAccessPackageCatalog.

func (LookupAccessPackageCatalogOutputArgs) ElementType added in v5.37.0

type LookupAccessPackageCatalogResult added in v5.37.0

type LookupAccessPackageCatalogResult struct {
	// The description of the access package catalog.
	Description string `pulumi:"description"`
	DisplayName string `pulumi:"displayName"`
	// Whether the access packages in this catalog can be requested by users outside the tenant.
	ExternallyVisible bool `pulumi:"externallyVisible"`
	// The provider-assigned unique ID for this managed resource.
	Id       string `pulumi:"id"`
	ObjectId string `pulumi:"objectId"`
	// Whether the access packages in this catalog are available for management.
	Published bool `pulumi:"published"`
}

A collection of values returned by getAccessPackageCatalog.

func LookupAccessPackageCatalog added in v5.37.0

func LookupAccessPackageCatalog(ctx *pulumi.Context, args *LookupAccessPackageCatalogArgs, opts ...pulumi.InvokeOption) (*LookupAccessPackageCatalogResult, error)

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*

<!--Start PulumiCodeChooser --> ```go 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
	})
}

``` <!--End PulumiCodeChooser -->

*Look up by DisplayName*

<!--Start PulumiCodeChooser --> ```go 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
	})
}

``` <!--End PulumiCodeChooser -->

type LookupAccessPackageCatalogResultOutput added in v5.37.0

type LookupAccessPackageCatalogResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAccessPackageCatalog.

func (LookupAccessPackageCatalogResultOutput) Description added in v5.37.0

The description of the access package catalog.

func (LookupAccessPackageCatalogResultOutput) DisplayName added in v5.37.0

func (LookupAccessPackageCatalogResultOutput) ElementType added in v5.37.0

func (LookupAccessPackageCatalogResultOutput) ExternallyVisible added in v5.37.0

Whether the access packages in this catalog can be requested by users outside the tenant.

func (LookupAccessPackageCatalogResultOutput) Id added in v5.37.0

The provider-assigned unique ID for this managed resource.

func (LookupAccessPackageCatalogResultOutput) ObjectId added in v5.37.0

func (LookupAccessPackageCatalogResultOutput) Published added in v5.37.0

Whether the access packages in this catalog are available for management.

func (LookupAccessPackageCatalogResultOutput) ToLookupAccessPackageCatalogResultOutput added in v5.37.0

func (o LookupAccessPackageCatalogResultOutput) ToLookupAccessPackageCatalogResultOutput() LookupAccessPackageCatalogResultOutput

func (LookupAccessPackageCatalogResultOutput) ToLookupAccessPackageCatalogResultOutputWithContext added in v5.37.0

func (o LookupAccessPackageCatalogResultOutput) ToLookupAccessPackageCatalogResultOutputWithContext(ctx context.Context) LookupAccessPackageCatalogResultOutput

type LookupAccessPackageOutputArgs added in v5.37.0

type LookupAccessPackageOutputArgs struct {
	// The ID of the Catalog this access package is in.
	CatalogId pulumi.StringPtrInput `pulumi:"catalogId"`
	// The display name of the access package.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// The ID of this access package.
	//
	// > Either `objectId`, or both `catalogId` and `displayName`, must be specified.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
}

A collection of arguments for invoking getAccessPackage.

func (LookupAccessPackageOutputArgs) ElementType added in v5.37.0

type LookupAccessPackageResult added in v5.37.0

type LookupAccessPackageResult struct {
	CatalogId *string `pulumi:"catalogId"`
	// The description of the access package.
	Description string `pulumi:"description"`
	DisplayName string `pulumi:"displayName"`
	// Whether the access package is hidden from the requestor.
	Hidden bool `pulumi:"hidden"`
	// The provider-assigned unique ID for this managed resource.
	Id       string `pulumi:"id"`
	ObjectId string `pulumi:"objectId"`
}

A collection of values returned by getAccessPackage.

func LookupAccessPackage added in v5.37.0

func LookupAccessPackage(ctx *pulumi.Context, args *LookupAccessPackageArgs, opts ...pulumi.InvokeOption) (*LookupAccessPackageResult, error)

Use this data source to retrieve information for an existing access package 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`, `Access package manager`, `Global Reader`, or `Global Administrator`.

## Example Usage

*Look up by ID*

<!--Start PulumiCodeChooser --> ```go 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.LookupAccessPackage(ctx, &azuread.LookupAccessPackageArgs{
			ObjectId: pulumi.StringRef("00000000-0000-0000-0000-000000000000"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up by DisplayName*

<!--Start PulumiCodeChooser --> ```go 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.LookupAccessPackage(ctx, &azuread.LookupAccessPackageArgs{
			CatalogId:   pulumi.StringRef("00000000-0000-0000-0000-000000000000"),
			DisplayName: pulumi.StringRef("My access package Catalog"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupAccessPackageResultOutput added in v5.37.0

type LookupAccessPackageResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAccessPackage.

func LookupAccessPackageOutput added in v5.37.0

func (LookupAccessPackageResultOutput) CatalogId added in v5.37.0

func (LookupAccessPackageResultOutput) Description added in v5.37.0

The description of the access package.

func (LookupAccessPackageResultOutput) DisplayName added in v5.37.0

func (LookupAccessPackageResultOutput) ElementType added in v5.37.0

func (LookupAccessPackageResultOutput) Hidden added in v5.37.0

Whether the access package is hidden from the requestor.

func (LookupAccessPackageResultOutput) Id added in v5.37.0

The provider-assigned unique ID for this managed resource.

func (LookupAccessPackageResultOutput) ObjectId added in v5.37.0

func (LookupAccessPackageResultOutput) ToLookupAccessPackageResultOutput added in v5.37.0

func (o LookupAccessPackageResultOutput) ToLookupAccessPackageResultOutput() LookupAccessPackageResultOutput

func (LookupAccessPackageResultOutput) ToLookupAccessPackageResultOutputWithContext added in v5.37.0

func (o LookupAccessPackageResultOutput) ToLookupAccessPackageResultOutputWithContext(ctx context.Context) LookupAccessPackageResultOutput

type LookupAdministrativeUnitArgs added in v5.10.0

type LookupAdministrativeUnitArgs struct {
	// Specifies the display name of the administrative unit.
	DisplayName *string `pulumi:"displayName"`
	// Specifies the object ID of the administrative unit.
	//
	// > One of `displayName` or `objectId` must be specified.
	ObjectId *string `pulumi:"objectId"`
}

A collection of arguments for invoking getAdministrativeUnit.

type LookupAdministrativeUnitOutputArgs added in v5.10.0

type LookupAdministrativeUnitOutputArgs struct {
	// Specifies the display name of the administrative unit.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// Specifies the object ID of the administrative unit.
	//
	// > One of `displayName` or `objectId` must be specified.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
}

A collection of arguments for invoking getAdministrativeUnit.

func (LookupAdministrativeUnitOutputArgs) ElementType added in v5.10.0

type LookupAdministrativeUnitResult added in v5.10.0

type LookupAdministrativeUnitResult struct {
	// The description of the administrative unit.
	Description string `pulumi:"description"`
	// The display name of the administrative unit.
	DisplayName string `pulumi:"displayName"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of object IDs of members who are present in this administrative unit.
	Members []string `pulumi:"members"`
	// The object ID of the administrative unit.
	ObjectId string `pulumi:"objectId"`
	// Whether the administrative unit _and_ its members are hidden or publicly viewable in the directory. One of: `Hiddenmembership` or `Public`.
	Visibility string `pulumi:"visibility"`
}

A collection of values returned by getAdministrativeUnit.

func LookupAdministrativeUnit added in v5.10.0

func LookupAdministrativeUnit(ctx *pulumi.Context, args *LookupAdministrativeUnitArgs, opts ...pulumi.InvokeOption) (*LookupAdministrativeUnitResult, error)

Gets information about an adminisrative unit 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: `AdministrativeUnit.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* <!--Start PulumiCodeChooser --> ```go 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.LookupAdministrativeUnit(ctx, &azuread.LookupAdministrativeUnitArgs{
			DisplayName: pulumi.StringRef("Example-AU"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up by object ID* <!--Start PulumiCodeChooser --> ```go 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.LookupAdministrativeUnit(ctx, &azuread.LookupAdministrativeUnitArgs{
			ObjectId: pulumi.StringRef("00000000-0000-0000-0000-000000000000"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupAdministrativeUnitResultOutput added in v5.10.0

type LookupAdministrativeUnitResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAdministrativeUnit.

func (LookupAdministrativeUnitResultOutput) Description added in v5.10.0

The description of the administrative unit.

func (LookupAdministrativeUnitResultOutput) DisplayName added in v5.10.0

The display name of the administrative unit.

func (LookupAdministrativeUnitResultOutput) ElementType added in v5.10.0

func (LookupAdministrativeUnitResultOutput) Id added in v5.10.0

The provider-assigned unique ID for this managed resource.

func (LookupAdministrativeUnitResultOutput) Members added in v5.10.0

A list of object IDs of members who are present in this administrative unit.

func (LookupAdministrativeUnitResultOutput) ObjectId added in v5.10.0

The object ID of the administrative unit.

func (LookupAdministrativeUnitResultOutput) ToLookupAdministrativeUnitResultOutput added in v5.10.0

func (o LookupAdministrativeUnitResultOutput) ToLookupAdministrativeUnitResultOutput() LookupAdministrativeUnitResultOutput

func (LookupAdministrativeUnitResultOutput) ToLookupAdministrativeUnitResultOutputWithContext added in v5.10.0

func (o LookupAdministrativeUnitResultOutput) ToLookupAdministrativeUnitResultOutputWithContext(ctx context.Context) LookupAdministrativeUnitResultOutput

func (LookupAdministrativeUnitResultOutput) Visibility added in v5.10.0

Whether the administrative unit _and_ its members are hidden or publicly viewable in the directory. One of: `Hiddenmembership` or `Public`.

type LookupApplicationArgs

type LookupApplicationArgs struct {
	// Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationId *string `pulumi:"applicationId"`
	// Specifies the Client ID of the application.
	ClientId *string `pulumi:"clientId"`
	// Specifies the display name of the application.
	DisplayName *string `pulumi:"displayName"`
	// Specifies the Object ID of the application.
	//
	// > One of `clientId`, `displayName`, or `objectId` must be specified.
	ObjectId *string `pulumi:"objectId"`
}

A collection of arguments for invoking getApplication.

type LookupApplicationOutputArgs added in v5.3.0

type LookupApplicationOutputArgs struct {
	// Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationId pulumi.StringPtrInput `pulumi:"applicationId"`
	// Specifies the Client ID of the application.
	ClientId pulumi.StringPtrInput `pulumi:"clientId"`
	// Specifies the display name of the application.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// Specifies the Object ID of the application.
	//
	// > One of `clientId`, `displayName`, or `objectId` must be specified.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
}

A collection of arguments for invoking getApplication.

func (LookupApplicationOutputArgs) ElementType added in v5.3.0

type LookupApplicationResult

type LookupApplicationResult struct {
	// An `api` block as documented below.
	Apis []GetApplicationApi `pulumi:"apis"`
	// A mapping of app role values to app role IDs, intended to be useful when referencing app roles in other resources in your configuration.
	AppRoleIds map[string]string `pulumi:"appRoleIds"`
	// A collection of `appRole` blocks as documented below. For more information see [official documentation on Application Roles](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).
	AppRoles []GetApplicationAppRoleType `pulumi:"appRoles"`
	// Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationId string `pulumi:"applicationId"`
	// The Client ID for the application.
	ClientId string `pulumi:"clientId"`
	// Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences.
	Description string `pulumi:"description"`
	// Specifies whether this application supports device authentication without a user.
	DeviceOnlyAuthEnabled bool `pulumi:"deviceOnlyAuthEnabled"`
	// Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. `DisabledDueToViolationOfServicesAgreement`
	DisabledByMicrosoft string `pulumi:"disabledByMicrosoft"`
	// Display name for the app role that appears during app role assignment and in consent experiences.
	DisplayName string `pulumi:"displayName"`
	// The fallback application type as public client, such as an installed application running on a mobile device.
	FallbackPublicClientEnabled bool `pulumi:"fallbackPublicClientEnabled"`
	// A `features` block as described below.
	FeatureTags []GetApplicationFeatureTag `pulumi:"featureTags"`
	// The `groups` claim issued in a user or OAuth 2.0 access token that the app expects.
	GroupMembershipClaims []string `pulumi:"groupMembershipClaims"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of user-defined URI(s) that uniquely identify a Web application within it's Azure AD tenant, or within a verified custom domain if the application is multi-tenant.
	IdentifierUris []string `pulumi:"identifierUris"`
	// CDN URL to the application's logo.
	LogoUrl string `pulumi:"logoUrl"`
	// URL of the application's marketing page.
	MarketingUrl string `pulumi:"marketingUrl"`
	// User-specified notes relevant for the management of the application.
	Notes string `pulumi:"notes"`
	// A mapping of OAuth2.0 permission scope values to scope IDs, intended to be useful when referencing permission scopes in other resources in your configuration.
	Oauth2PermissionScopeIds map[string]string `pulumi:"oauth2PermissionScopeIds"`
	// Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. When `false`, only GET requests are allowed.
	Oauth2PostResponseRequired bool `pulumi:"oauth2PostResponseRequired"`
	// The application's object ID.
	ObjectId string `pulumi:"objectId"`
	// An `optionalClaims` block as documented below.
	OptionalClaims []GetApplicationOptionalClaim `pulumi:"optionalClaims"`
	// A list of object IDs of principals that are assigned ownership of the application.
	Owners []string `pulumi:"owners"`
	// URL of the application's privacy statement.
	PrivacyStatementUrl string `pulumi:"privacyStatementUrl"`
	// A `publicClient` block as documented below.
	PublicClients []GetApplicationPublicClient `pulumi:"publicClients"`
	// The verified publisher domain for the application.
	PublisherDomain string `pulumi:"publisherDomain"`
	// A collection of `requiredResourceAccess` blocks as documented below.
	RequiredResourceAccesses []GetApplicationRequiredResourceAccess `pulumi:"requiredResourceAccesses"`
	// References application context information from a Service or Asset Management database.
	ServiceManagementReference string `pulumi:"serviceManagementReference"`
	// The Microsoft account types that are supported for the current application. One of `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.
	SignInAudience string `pulumi:"signInAudience"`
	// A `singlePageApplication` block as documented below.
	SinglePageApplications []GetApplicationSinglePageApplication `pulumi:"singlePageApplications"`
	// URL of the application's support page.
	SupportUrl string `pulumi:"supportUrl"`
	// A list of tags applied to the application.
	Tags []string `pulumi:"tags"`
	// URL of the application's terms of service statement.
	TermsOfServiceUrl string `pulumi:"termsOfServiceUrl"`
	// A `web` block as documented below.
	Webs []GetApplicationWeb `pulumi:"webs"`
}

A collection of values returned by getApplication.

func LookupApplication

func LookupApplication(ctx *pulumi.Context, args *LookupApplicationArgs, opts ...pulumi.InvokeOption) (*LookupApplicationResult, error)

Use this data source to access information about an existing Application within 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: `Application.Read.All` or `Directory.Read.All`

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

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.LookupApplication(ctx, &azuread.LookupApplicationArgs{
			DisplayName: pulumi.StringRef("My First AzureAD Application"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("applicationObjectId", example.ObjectId)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupApplicationResultOutput added in v5.3.0

type LookupApplicationResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getApplication.

func LookupApplicationOutput added in v5.3.0

func (LookupApplicationResultOutput) Apis added in v5.3.0

An `api` block as documented below.

func (LookupApplicationResultOutput) AppRoleIds added in v5.3.0

A mapping of app role values to app role IDs, intended to be useful when referencing app roles in other resources in your configuration.

func (LookupApplicationResultOutput) AppRoles added in v5.3.0

A collection of `appRole` blocks as documented below. For more information see [official documentation on Application Roles](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).

func (LookupApplicationResultOutput) ApplicationId deprecated added in v5.3.0

Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider

func (LookupApplicationResultOutput) ClientId added in v5.43.0

The Client ID for the application.

func (LookupApplicationResultOutput) Description added in v5.35.0

Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences.

func (LookupApplicationResultOutput) DeviceOnlyAuthEnabled added in v5.3.0

func (o LookupApplicationResultOutput) DeviceOnlyAuthEnabled() pulumi.BoolOutput

Specifies whether this application supports device authentication without a user.

func (LookupApplicationResultOutput) DisabledByMicrosoft added in v5.3.0

func (o LookupApplicationResultOutput) DisabledByMicrosoft() pulumi.StringOutput

Whether Microsoft has disabled the registered application. If the application is disabled, this will be a string indicating the status/reason, e.g. `DisabledDueToViolationOfServicesAgreement`

func (LookupApplicationResultOutput) DisplayName added in v5.3.0

Display name for the app role that appears during app role assignment and in consent experiences.

func (LookupApplicationResultOutput) ElementType added in v5.3.0

func (LookupApplicationResultOutput) FallbackPublicClientEnabled added in v5.3.0

func (o LookupApplicationResultOutput) FallbackPublicClientEnabled() pulumi.BoolOutput

The fallback application type as public client, such as an installed application running on a mobile device.

func (LookupApplicationResultOutput) FeatureTags added in v5.6.0

A `features` block as described below.

func (LookupApplicationResultOutput) GroupMembershipClaims added in v5.3.0

func (o LookupApplicationResultOutput) GroupMembershipClaims() pulumi.StringArrayOutput

The `groups` claim issued in a user or OAuth 2.0 access token that the app expects.

func (LookupApplicationResultOutput) Id added in v5.3.0

The provider-assigned unique ID for this managed resource.

func (LookupApplicationResultOutput) IdentifierUris added in v5.3.0

A list of user-defined URI(s) that uniquely identify a Web application within it's Azure AD tenant, or within a verified custom domain if the application is multi-tenant.

func (LookupApplicationResultOutput) LogoUrl added in v5.3.0

CDN URL to the application's logo.

func (LookupApplicationResultOutput) MarketingUrl added in v5.3.0

URL of the application's marketing page.

func (LookupApplicationResultOutput) Notes added in v5.35.0

User-specified notes relevant for the management of the application.

func (LookupApplicationResultOutput) Oauth2PermissionScopeIds added in v5.3.0

func (o LookupApplicationResultOutput) Oauth2PermissionScopeIds() pulumi.StringMapOutput

A mapping of OAuth2.0 permission scope values to scope IDs, intended to be useful when referencing permission scopes in other resources in your configuration.

func (LookupApplicationResultOutput) Oauth2PostResponseRequired added in v5.3.0

func (o LookupApplicationResultOutput) Oauth2PostResponseRequired() pulumi.BoolOutput

Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. When `false`, only GET requests are allowed.

func (LookupApplicationResultOutput) ObjectId added in v5.3.0

The application's object ID.

func (LookupApplicationResultOutput) OptionalClaims added in v5.3.0

An `optionalClaims` block as documented below.

func (LookupApplicationResultOutput) Owners added in v5.3.0

A list of object IDs of principals that are assigned ownership of the application.

func (LookupApplicationResultOutput) PrivacyStatementUrl added in v5.3.0

func (o LookupApplicationResultOutput) PrivacyStatementUrl() pulumi.StringOutput

URL of the application's privacy statement.

func (LookupApplicationResultOutput) PublicClients added in v5.3.0

A `publicClient` block as documented below.

func (LookupApplicationResultOutput) PublisherDomain added in v5.3.0

The verified publisher domain for the application.

func (LookupApplicationResultOutput) RequiredResourceAccesses added in v5.3.0

A collection of `requiredResourceAccess` blocks as documented below.

func (LookupApplicationResultOutput) ServiceManagementReference added in v5.37.0

func (o LookupApplicationResultOutput) ServiceManagementReference() pulumi.StringOutput

References application context information from a Service or Asset Management database.

func (LookupApplicationResultOutput) SignInAudience added in v5.3.0

The Microsoft account types that are supported for the current application. One of `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.

func (LookupApplicationResultOutput) SinglePageApplications added in v5.3.0

A `singlePageApplication` block as documented below.

func (LookupApplicationResultOutput) SupportUrl added in v5.3.0

URL of the application's support page.

func (LookupApplicationResultOutput) Tags added in v5.6.0

A list of tags applied to the application.

func (LookupApplicationResultOutput) TermsOfServiceUrl added in v5.3.0

func (o LookupApplicationResultOutput) TermsOfServiceUrl() pulumi.StringOutput

URL of the application's terms of service statement.

func (LookupApplicationResultOutput) ToLookupApplicationResultOutput added in v5.3.0

func (o LookupApplicationResultOutput) ToLookupApplicationResultOutput() LookupApplicationResultOutput

func (LookupApplicationResultOutput) ToLookupApplicationResultOutputWithContext added in v5.3.0

func (o LookupApplicationResultOutput) ToLookupApplicationResultOutputWithContext(ctx context.Context) LookupApplicationResultOutput

func (LookupApplicationResultOutput) Webs added in v5.3.0

A `web` block as documented below.

type LookupGroupArgs

type LookupGroupArgs struct {
	// The display name for the group.
	DisplayName *string `pulumi:"displayName"`
	// Whether the group is mail-enabled.
	MailEnabled *bool `pulumi:"mailEnabled"`
	// The mail alias for the group, unique in the organisation.
	MailNickname *string `pulumi:"mailNickname"`
	// Specifies the object ID of the group.
	ObjectId *string `pulumi:"objectId"`
	// Whether the group is a security group.
	//
	// > One of `displayName`, `objectId` or `mailNickname` must be specified.
	SecurityEnabled *bool `pulumi:"securityEnabled"`
}

A collection of arguments for invoking getGroup.

type LookupGroupOutputArgs added in v5.3.0

type LookupGroupOutputArgs struct {
	// The display name for the group.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// Whether the group is mail-enabled.
	MailEnabled pulumi.BoolPtrInput `pulumi:"mailEnabled"`
	// The mail alias for the group, unique in the organisation.
	MailNickname pulumi.StringPtrInput `pulumi:"mailNickname"`
	// Specifies the object ID of the group.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
	// Whether the group is a security group.
	//
	// > One of `displayName`, `objectId` or `mailNickname` must be specified.
	SecurityEnabled pulumi.BoolPtrInput `pulumi:"securityEnabled"`
}

A collection of arguments for invoking getGroup.

func (LookupGroupOutputArgs) ElementType added in v5.3.0

func (LookupGroupOutputArgs) ElementType() reflect.Type

type LookupGroupResult

type LookupGroupResult struct {
	// Indicates whether this group can be assigned to an Azure Active Directory role.
	AssignableToRole bool `pulumi:"assignableToRole"`
	// Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Only set for Unified groups.
	AutoSubscribeNewMembers bool `pulumi:"autoSubscribeNewMembers"`
	// A list of behaviors for a Microsoft 365 group, such as `AllowOnlyMembersToPost`, `HideGroupInOutlook`, `SubscribeNewGroupMembers` and `WelcomeEmailDisabled`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for more details.
	Behaviors []string `pulumi:"behaviors"`
	// The optional description of the group.
	Description string `pulumi:"description"`
	// The display name for the group.
	DisplayName string `pulumi:"displayName"`
	// A `dynamicMembership` block as documented below.
	DynamicMemberships []GetGroupDynamicMembership `pulumi:"dynamicMemberships"`
	// Indicates whether people external to the organization can send messages to the group. Only set for Unified groups.
	ExternalSendersAllowed bool `pulumi:"externalSendersAllowed"`
	// Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. Only set for Unified groups.
	HideFromAddressLists bool `pulumi:"hideFromAddressLists"`
	// Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Only set for Unified groups.
	HideFromOutlookClients bool `pulumi:"hideFromOutlookClients"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The SMTP address for the group.
	Mail string `pulumi:"mail"`
	// Whether the group is mail-enabled.
	MailEnabled bool `pulumi:"mailEnabled"`
	// The mail alias for the group, unique in the organisation.
	MailNickname string `pulumi:"mailNickname"`
	// List of object IDs of the group members.
	Members []string `pulumi:"members"`
	// The object ID of the group.
	ObjectId string `pulumi:"objectId"`
	// The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesDomainName string `pulumi:"onpremisesDomainName"`
	// The on-premises group type that the AAD group will be written as, when writeback is enabled. Possible values are `UniversalDistributionGroup`, `UniversalMailEnabledSecurityGroup`, or `UniversalSecurityGroup`.
	OnpremisesGroupType string `pulumi:"onpremisesGroupType"`
	// The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesNetbiosName string `pulumi:"onpremisesNetbiosName"`
	// The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesSamAccountName string `pulumi:"onpremisesSamAccountName"`
	// The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesSecurityIdentifier string `pulumi:"onpremisesSecurityIdentifier"`
	// Whether this group is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).
	OnpremisesSyncEnabled bool `pulumi:"onpremisesSyncEnabled"`
	// List of object IDs of the group owners.
	Owners []string `pulumi:"owners"`
	// The preferred language for a Microsoft 365 group, in ISO 639-1 notation.
	PreferredLanguage string `pulumi:"preferredLanguage"`
	// A list of provisioning options for a Microsoft 365 group, such as `Team`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for details.
	ProvisioningOptions []string `pulumi:"provisioningOptions"`
	// List of email addresses for the group that direct to the same group mailbox.
	ProxyAddresses []string `pulumi:"proxyAddresses"`
	// Whether the group is a security group.
	SecurityEnabled bool `pulumi:"securityEnabled"`
	// The colour theme for a Microsoft 365 group. Possible values are `Blue`, `Green`, `Orange`, `Pink`, `Purple`, `Red` or `Teal`. When no theme is set, the value is `null`.
	Theme string `pulumi:"theme"`
	// A list of group types configured for the group. Supported values are `DynamicMembership`, which denotes a group with dynamic membership, and `Unified`, which specifies a Microsoft 365 group.
	Types []string `pulumi:"types"`
	// The group join policy and group content visibility. Possible values are `Private`, `Public`, or `Hiddenmembership`. Only Microsoft 365 groups can have `Hiddenmembership` visibility.
	Visibility string `pulumi:"visibility"`
	// Whether the group will be written back to the configured on-premises Active Directory when Azure AD Connect is used.
	WritebackEnabled bool `pulumi:"writebackEnabled"`
}

A collection of values returned by getGroup.

func LookupGroup

func LookupGroup(ctx *pulumi.Context, args *LookupGroupArgs, opts ...pulumi.InvokeOption) (*LookupGroupResult, error)

Gets information about an Azure Active Directory group.

## 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: `Group.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)

<!--Start PulumiCodeChooser --> ```go 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.LookupGroup(ctx, &azuread.LookupGroupArgs{
			DisplayName:     pulumi.StringRef("MyGroupName"),
			SecurityEnabled: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupGroupResultOutput added in v5.3.0

type LookupGroupResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getGroup.

func LookupGroupOutput added in v5.3.0

func LookupGroupOutput(ctx *pulumi.Context, args LookupGroupOutputArgs, opts ...pulumi.InvokeOption) LookupGroupResultOutput

func (LookupGroupResultOutput) AssignableToRole added in v5.3.0

func (o LookupGroupResultOutput) AssignableToRole() pulumi.BoolOutput

Indicates whether this group can be assigned to an Azure Active Directory role.

func (LookupGroupResultOutput) AutoSubscribeNewMembers added in v5.15.0

func (o LookupGroupResultOutput) AutoSubscribeNewMembers() pulumi.BoolOutput

Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Only set for Unified groups.

func (LookupGroupResultOutput) Behaviors added in v5.3.0

A list of behaviors for a Microsoft 365 group, such as `AllowOnlyMembersToPost`, `HideGroupInOutlook`, `SubscribeNewGroupMembers` and `WelcomeEmailDisabled`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for more details.

func (LookupGroupResultOutput) Description added in v5.3.0

The optional description of the group.

func (LookupGroupResultOutput) DisplayName added in v5.3.0

The display name for the group.

func (LookupGroupResultOutput) DynamicMemberships added in v5.12.0

A `dynamicMembership` block as documented below.

func (LookupGroupResultOutput) ElementType added in v5.3.0

func (LookupGroupResultOutput) ElementType() reflect.Type

func (LookupGroupResultOutput) ExternalSendersAllowed added in v5.15.0

func (o LookupGroupResultOutput) ExternalSendersAllowed() pulumi.BoolOutput

Indicates whether people external to the organization can send messages to the group. Only set for Unified groups.

func (LookupGroupResultOutput) HideFromAddressLists added in v5.15.0

func (o LookupGroupResultOutput) HideFromAddressLists() pulumi.BoolOutput

Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. Only set for Unified groups.

func (LookupGroupResultOutput) HideFromOutlookClients added in v5.15.0

func (o LookupGroupResultOutput) HideFromOutlookClients() pulumi.BoolOutput

Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Only set for Unified groups.

func (LookupGroupResultOutput) Id added in v5.3.0

The provider-assigned unique ID for this managed resource.

func (LookupGroupResultOutput) Mail added in v5.3.0

The SMTP address for the group.

func (LookupGroupResultOutput) MailEnabled added in v5.3.0

func (o LookupGroupResultOutput) MailEnabled() pulumi.BoolOutput

Whether the group is mail-enabled.

func (LookupGroupResultOutput) MailNickname added in v5.3.0

func (o LookupGroupResultOutput) MailNickname() pulumi.StringOutput

The mail alias for the group, unique in the organisation.

func (LookupGroupResultOutput) Members added in v5.3.0

List of object IDs of the group members.

func (LookupGroupResultOutput) ObjectId added in v5.3.0

The object ID of the group.

func (LookupGroupResultOutput) OnpremisesDomainName added in v5.3.0

func (o LookupGroupResultOutput) OnpremisesDomainName() pulumi.StringOutput

The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.

func (LookupGroupResultOutput) OnpremisesGroupType added in v5.37.0

func (o LookupGroupResultOutput) OnpremisesGroupType() pulumi.StringOutput

The on-premises group type that the AAD group will be written as, when writeback is enabled. Possible values are `UniversalDistributionGroup`, `UniversalMailEnabledSecurityGroup`, or `UniversalSecurityGroup`.

func (LookupGroupResultOutput) OnpremisesNetbiosName added in v5.3.0

func (o LookupGroupResultOutput) OnpremisesNetbiosName() pulumi.StringOutput

The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.

func (LookupGroupResultOutput) OnpremisesSamAccountName added in v5.3.0

func (o LookupGroupResultOutput) OnpremisesSamAccountName() pulumi.StringOutput

The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.

func (LookupGroupResultOutput) OnpremisesSecurityIdentifier added in v5.3.0

func (o LookupGroupResultOutput) OnpremisesSecurityIdentifier() pulumi.StringOutput

The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.

func (LookupGroupResultOutput) OnpremisesSyncEnabled added in v5.3.0

func (o LookupGroupResultOutput) OnpremisesSyncEnabled() pulumi.BoolOutput

Whether this group is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).

func (LookupGroupResultOutput) Owners added in v5.3.0

List of object IDs of the group owners.

func (LookupGroupResultOutput) PreferredLanguage added in v5.3.0

func (o LookupGroupResultOutput) PreferredLanguage() pulumi.StringOutput

The preferred language for a Microsoft 365 group, in ISO 639-1 notation.

func (LookupGroupResultOutput) ProvisioningOptions added in v5.3.0

func (o LookupGroupResultOutput) ProvisioningOptions() pulumi.StringArrayOutput

A list of provisioning options for a Microsoft 365 group, such as `Team`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for details.

func (LookupGroupResultOutput) ProxyAddresses added in v5.3.0

List of email addresses for the group that direct to the same group mailbox.

func (LookupGroupResultOutput) SecurityEnabled added in v5.3.0

func (o LookupGroupResultOutput) SecurityEnabled() pulumi.BoolOutput

Whether the group is a security group.

func (LookupGroupResultOutput) Theme added in v5.3.0

The colour theme for a Microsoft 365 group. Possible values are `Blue`, `Green`, `Orange`, `Pink`, `Purple`, `Red` or `Teal`. When no theme is set, the value is `null`.

func (LookupGroupResultOutput) ToLookupGroupResultOutput added in v5.3.0

func (o LookupGroupResultOutput) ToLookupGroupResultOutput() LookupGroupResultOutput

func (LookupGroupResultOutput) ToLookupGroupResultOutputWithContext added in v5.3.0

func (o LookupGroupResultOutput) ToLookupGroupResultOutputWithContext(ctx context.Context) LookupGroupResultOutput

func (LookupGroupResultOutput) Types added in v5.3.0

A list of group types configured for the group. Supported values are `DynamicMembership`, which denotes a group with dynamic membership, and `Unified`, which specifies a Microsoft 365 group.

func (LookupGroupResultOutput) Visibility added in v5.3.0

The group join policy and group content visibility. Possible values are `Private`, `Public`, or `Hiddenmembership`. Only Microsoft 365 groups can have `Hiddenmembership` visibility.

func (LookupGroupResultOutput) WritebackEnabled added in v5.37.0

func (o LookupGroupResultOutput) WritebackEnabled() pulumi.BoolOutput

Whether the group will be written back to the configured on-premises Active Directory when Azure AD Connect is used.

type LookupNamedLocationArgs added in v5.40.0

type LookupNamedLocationArgs struct {
	// Specifies the display named of the named location to look up.
	DisplayName string `pulumi:"displayName"`
}

A collection of arguments for invoking getNamedLocation.

type LookupNamedLocationOutputArgs added in v5.40.0

type LookupNamedLocationOutputArgs struct {
	// Specifies the display named of the named location to look up.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
}

A collection of arguments for invoking getNamedLocation.

func (LookupNamedLocationOutputArgs) ElementType added in v5.40.0

type LookupNamedLocationResult added in v5.40.0

type LookupNamedLocationResult struct {
	Countries   []GetNamedLocationCountry `pulumi:"countries"`
	DisplayName string                    `pulumi:"displayName"`
	// The provider-assigned unique ID for this managed resource.
	Id  string               `pulumi:"id"`
	Ips []GetNamedLocationIp `pulumi:"ips"`
}

A collection of values returned by getNamedLocation.

func LookupNamedLocation added in v5.40.0

func LookupNamedLocation(ctx *pulumi.Context, args *LookupNamedLocationArgs, opts ...pulumi.InvokeOption) (*LookupNamedLocationResult, error)

Gets information about a Named Location within 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 resource requires the following application roles: `Policy.Read.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Conditional Access Administrator` or `Global Reader`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.LookupNamedLocation(ctx, &azuread.LookupNamedLocationArgs{
			DisplayName: "My Named Location",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Attributes Reference

The following attributes are exported:

* `country` - A `country` block as documented below, which describes a country-based named location. * `id` - The ID of the named location. * `ip` - An `ip` block as documented below, which describes an IP-based named location. * ***

`country` block exports the following:

* `countriesAndRegions` - List of countries and/or regions in two-letter format specified by ISO 3166-2. * `includeUnknownCountriesAndRegions` - Whether IP addresses that don't map to a country or region are included in the named location.

***

`ip` block exports the following:

* `ipRanges` - List of IP address ranges in IPv4 CIDR format (e.g. `1.2.3.4/32`) or any allowable IPv6 format from IETF RFC596. * `trusted` - Whether the named location is trusted.

type LookupNamedLocationResultOutput added in v5.40.0

type LookupNamedLocationResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getNamedLocation.

func LookupNamedLocationOutput added in v5.40.0

func (LookupNamedLocationResultOutput) Countries added in v5.40.0

func (LookupNamedLocationResultOutput) DisplayName added in v5.40.0

func (LookupNamedLocationResultOutput) ElementType added in v5.40.0

func (LookupNamedLocationResultOutput) Id added in v5.40.0

The provider-assigned unique ID for this managed resource.

func (LookupNamedLocationResultOutput) Ips added in v5.40.0

func (LookupNamedLocationResultOutput) ToLookupNamedLocationResultOutput added in v5.40.0

func (o LookupNamedLocationResultOutput) ToLookupNamedLocationResultOutput() LookupNamedLocationResultOutput

func (LookupNamedLocationResultOutput) ToLookupNamedLocationResultOutputWithContext added in v5.40.0

func (o LookupNamedLocationResultOutput) ToLookupNamedLocationResultOutputWithContext(ctx context.Context) LookupNamedLocationResultOutput

type LookupServicePrincipalArgs

type LookupServicePrincipalArgs struct {
	// Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationId *string `pulumi:"applicationId"`
	// The client ID of the application associated with this service principal.
	ClientId *string `pulumi:"clientId"`
	// The display name of the application associated with this service principal.
	DisplayName *string `pulumi:"displayName"`
	// The object ID of the service principal.
	//
	// > One of `clientId`, `displayName` or `objectId` must be specified.
	ObjectId *string `pulumi:"objectId"`
}

A collection of arguments for invoking getServicePrincipal.

type LookupServicePrincipalOutputArgs added in v5.3.0

type LookupServicePrincipalOutputArgs struct {
	// Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationId pulumi.StringPtrInput `pulumi:"applicationId"`
	// The client ID of the application associated with this service principal.
	ClientId pulumi.StringPtrInput `pulumi:"clientId"`
	// The display name of the application associated with this service principal.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// The object ID of the service principal.
	//
	// > One of `clientId`, `displayName` or `objectId` must be specified.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
}

A collection of arguments for invoking getServicePrincipal.

func (LookupServicePrincipalOutputArgs) ElementType added in v5.3.0

type LookupServicePrincipalResult

type LookupServicePrincipalResult struct {
	// Whether the service principal account is enabled.
	AccountEnabled bool `pulumi:"accountEnabled"`
	// A list of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.
	AlternativeNames []string `pulumi:"alternativeNames"`
	// Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application.
	AppRoleAssignmentRequired bool `pulumi:"appRoleAssignmentRequired"`
	// A mapping of app role values to app role IDs, as published by the associated application, intended to be useful when referencing app roles in other resources in your configuration.
	AppRoleIds map[string]string `pulumi:"appRoleIds"`
	// A list of app roles published by the associated application, as documented below. For more information [official documentation](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).
	AppRoles []GetServicePrincipalAppRole `pulumi:"appRoles"`
	// Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationId string `pulumi:"applicationId"`
	// The tenant ID where the associated application is registered.
	ApplicationTenantId string `pulumi:"applicationTenantId"`
	// The client ID of the application associated with this service principal.
	ClientId string `pulumi:"clientId"`
	// Permission help text that appears in the admin app assignment and consent experiences.
	Description string `pulumi:"description"`
	// Display name for the permission that appears in the admin consent and app assignment experiences.
	DisplayName string                          `pulumi:"displayName"`
	FeatureTags []GetServicePrincipalFeatureTag `pulumi:"featureTags"`
	// A `features` block as described below.
	//
	// Deprecated: This block has been renamed to `featureTags` and will be removed in version 3.0 of the provider
	Features []GetServicePrincipalFeature `pulumi:"features"`
	// Home page or landing page of the associated application.
	HomepageUrl string `pulumi:"homepageUrl"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps.
	LoginUrl string `pulumi:"loginUrl"`
	// The URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols, taken from the associated application.
	LogoutUrl string `pulumi:"logoutUrl"`
	// A free text field to capture information about the service principal, typically used for operational purposes.
	Notes string `pulumi:"notes"`
	// A list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.
	NotificationEmailAddresses []string `pulumi:"notificationEmailAddresses"`
	// A mapping of OAuth2.0 permission scope values to scope IDs, as exposed by the associated application, intended to be useful when referencing permission scopes in other resources in your configuration.
	Oauth2PermissionScopeIds map[string]string `pulumi:"oauth2PermissionScopeIds"`
	// A collection of OAuth 2.0 delegated permissions exposed by the associated application. Each permission is covered by an `oauth2PermissionScopes` block as documented below.
	Oauth2PermissionScopes []GetServicePrincipalOauth2PermissionScope `pulumi:"oauth2PermissionScopes"`
	// The object ID of the service principal.
	ObjectId string `pulumi:"objectId"`
	// The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps.
	PreferredSingleSignOnMode string `pulumi:"preferredSingleSignOnMode"`
	// A list of URLs where user tokens are sent for sign-in with the associated application, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent for the associated application.
	RedirectUris []string `pulumi:"redirectUris"`
	// The URL where the service exposes SAML metadata for federation.
	SamlMetadataUrl string `pulumi:"samlMetadataUrl"`
	// A `samlSingleSignOn` block as documented below.
	SamlSingleSignOns []GetServicePrincipalSamlSingleSignOn `pulumi:"samlSingleSignOns"`
	// A list of identifier URI(s), copied over from the associated application.
	ServicePrincipalNames []string `pulumi:"servicePrincipalNames"`
	// The Microsoft account types that are supported for the associated application. Possible values include `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.
	SignInAudience string `pulumi:"signInAudience"`
	// A list of tags applied to the service principal.
	Tags []string `pulumi:"tags"`
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.
	Type string `pulumi:"type"`
}

A collection of values returned by getServicePrincipal.

func LookupServicePrincipal

func LookupServicePrincipal(ctx *pulumi.Context, args *LookupServicePrincipalArgs, opts ...pulumi.InvokeOption) (*LookupServicePrincipalResult, error)

Gets information about an existing service principal associated with an application within 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: `Application.Read.All` or `Directory.Read.All`

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

## Example Usage

*Look up by application display name*

<!--Start PulumiCodeChooser --> ```go 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.LookupServicePrincipal(ctx, &azuread.LookupServicePrincipalArgs{
			DisplayName: pulumi.StringRef("my-awesome-application"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up by client ID*

<!--Start PulumiCodeChooser --> ```go 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.LookupServicePrincipal(ctx, &azuread.LookupServicePrincipalArgs{
			ClientId: pulumi.StringRef("00000000-0000-0000-0000-000000000000"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Look up by service principal object ID*

<!--Start PulumiCodeChooser --> ```go 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.LookupServicePrincipal(ctx, &azuread.LookupServicePrincipalArgs{
			ObjectId: pulumi.StringRef("00000000-0000-0000-0000-000000000000"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupServicePrincipalResultOutput added in v5.3.0

type LookupServicePrincipalResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getServicePrincipal.

func LookupServicePrincipalOutput added in v5.3.0

func (LookupServicePrincipalResultOutput) AccountEnabled added in v5.3.0

Whether the service principal account is enabled.

func (LookupServicePrincipalResultOutput) AlternativeNames added in v5.3.0

A list of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.

func (LookupServicePrincipalResultOutput) AppRoleAssignmentRequired added in v5.3.0

func (o LookupServicePrincipalResultOutput) AppRoleAssignmentRequired() pulumi.BoolOutput

Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application.

func (LookupServicePrincipalResultOutput) AppRoleIds added in v5.3.0

A mapping of app role values to app role IDs, as published by the associated application, intended to be useful when referencing app roles in other resources in your configuration.

func (LookupServicePrincipalResultOutput) AppRoles added in v5.3.0

A list of app roles published by the associated application, as documented below. For more information [official documentation](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).

func (LookupServicePrincipalResultOutput) ApplicationId deprecated added in v5.3.0

Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider

func (LookupServicePrincipalResultOutput) ApplicationTenantId added in v5.3.0

func (o LookupServicePrincipalResultOutput) ApplicationTenantId() pulumi.StringOutput

The tenant ID where the associated application is registered.

func (LookupServicePrincipalResultOutput) ClientId added in v5.43.0

The client ID of the application associated with this service principal.

func (LookupServicePrincipalResultOutput) Description added in v5.3.0

Permission help text that appears in the admin app assignment and consent experiences.

func (LookupServicePrincipalResultOutput) DisplayName added in v5.3.0

Display name for the permission that appears in the admin consent and app assignment experiences.

func (LookupServicePrincipalResultOutput) ElementType added in v5.3.0

func (LookupServicePrincipalResultOutput) FeatureTags added in v5.6.0

func (LookupServicePrincipalResultOutput) Features deprecated added in v5.3.0

A `features` block as described below.

Deprecated: This block has been renamed to `featureTags` and will be removed in version 3.0 of the provider

func (LookupServicePrincipalResultOutput) HomepageUrl added in v5.3.0

Home page or landing page of the associated application.

func (LookupServicePrincipalResultOutput) Id added in v5.3.0

The provider-assigned unique ID for this managed resource.

func (LookupServicePrincipalResultOutput) LoginUrl added in v5.3.0

The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps.

func (LookupServicePrincipalResultOutput) LogoutUrl added in v5.3.0

The URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols, taken from the associated application.

func (LookupServicePrincipalResultOutput) Notes added in v5.3.0

A free text field to capture information about the service principal, typically used for operational purposes.

func (LookupServicePrincipalResultOutput) NotificationEmailAddresses added in v5.3.0

func (o LookupServicePrincipalResultOutput) NotificationEmailAddresses() pulumi.StringArrayOutput

A list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.

func (LookupServicePrincipalResultOutput) Oauth2PermissionScopeIds added in v5.3.0

func (o LookupServicePrincipalResultOutput) Oauth2PermissionScopeIds() pulumi.StringMapOutput

A mapping of OAuth2.0 permission scope values to scope IDs, as exposed by the associated application, intended to be useful when referencing permission scopes in other resources in your configuration.

func (LookupServicePrincipalResultOutput) Oauth2PermissionScopes added in v5.3.0

A collection of OAuth 2.0 delegated permissions exposed by the associated application. Each permission is covered by an `oauth2PermissionScopes` block as documented below.

func (LookupServicePrincipalResultOutput) ObjectId added in v5.3.0

The object ID of the service principal.

func (LookupServicePrincipalResultOutput) PreferredSingleSignOnMode added in v5.3.0

func (o LookupServicePrincipalResultOutput) PreferredSingleSignOnMode() pulumi.StringOutput

The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps.

func (LookupServicePrincipalResultOutput) RedirectUris added in v5.3.0

A list of URLs where user tokens are sent for sign-in with the associated application, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent for the associated application.

func (LookupServicePrincipalResultOutput) SamlMetadataUrl added in v5.3.0

The URL where the service exposes SAML metadata for federation.

func (LookupServicePrincipalResultOutput) SamlSingleSignOns added in v5.3.0

A `samlSingleSignOn` block as documented below.

func (LookupServicePrincipalResultOutput) ServicePrincipalNames added in v5.3.0

A list of identifier URI(s), copied over from the associated application.

func (LookupServicePrincipalResultOutput) SignInAudience added in v5.3.0

The Microsoft account types that are supported for the associated application. Possible values include `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.

func (LookupServicePrincipalResultOutput) Tags added in v5.3.0

A list of tags applied to the service principal.

func (LookupServicePrincipalResultOutput) ToLookupServicePrincipalResultOutput added in v5.3.0

func (o LookupServicePrincipalResultOutput) ToLookupServicePrincipalResultOutput() LookupServicePrincipalResultOutput

func (LookupServicePrincipalResultOutput) ToLookupServicePrincipalResultOutputWithContext added in v5.3.0

func (o LookupServicePrincipalResultOutput) ToLookupServicePrincipalResultOutputWithContext(ctx context.Context) LookupServicePrincipalResultOutput

func (LookupServicePrincipalResultOutput) Type added in v5.3.0

Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.

type LookupUserArgs

type LookupUserArgs struct {
	// The employee identifier assigned to the user by the organisation.
	EmployeeId *string `pulumi:"employeeId"`
	// The SMTP address for the user.
	Mail *string `pulumi:"mail"`
	// The email alias of the user.
	MailNickname *string `pulumi:"mailNickname"`
	// The object ID of the user.
	ObjectId *string `pulumi:"objectId"`
	// The user principal name (UPN) of the user.
	//
	// > One of `userPrincipalName`, `objectId`, `mail`, `mailNickname` or `employeeId` must be specified.
	UserPrincipalName *string `pulumi:"userPrincipalName"`
}

A collection of arguments for invoking getUser.

type LookupUserOutputArgs added in v5.3.0

type LookupUserOutputArgs struct {
	// The employee identifier assigned to the user by the organisation.
	EmployeeId pulumi.StringPtrInput `pulumi:"employeeId"`
	// The SMTP address for the user.
	Mail pulumi.StringPtrInput `pulumi:"mail"`
	// The email alias of the user.
	MailNickname pulumi.StringPtrInput `pulumi:"mailNickname"`
	// The object ID of the user.
	ObjectId pulumi.StringPtrInput `pulumi:"objectId"`
	// The user principal name (UPN) of the user.
	//
	// > One of `userPrincipalName`, `objectId`, `mail`, `mailNickname` or `employeeId` must be specified.
	UserPrincipalName pulumi.StringPtrInput `pulumi:"userPrincipalName"`
}

A collection of arguments for invoking getUser.

func (LookupUserOutputArgs) ElementType added in v5.3.0

func (LookupUserOutputArgs) ElementType() reflect.Type

type LookupUserResult

type LookupUserResult struct {
	// Whether or not the account is enabled.
	AccountEnabled bool `pulumi:"accountEnabled"`
	// The age group of the user. Supported values are `Adult`, `NotAdult` and `Minor`.
	AgeGroup string `pulumi:"ageGroup"`
	// A list of telephone numbers for the user.
	BusinessPhones []string `pulumi:"businessPhones"`
	// The city in which the user is located.
	City string `pulumi:"city"`
	// The company name which the user is associated. This property can be useful for describing the company that an external user comes from.
	CompanyName string `pulumi:"companyName"`
	// Whether consent has been obtained for minors. Supported values are `Granted`, `Denied` and `NotRequired`.
	ConsentProvidedForMinor string `pulumi:"consentProvidedForMinor"`
	// The cost center associated with the user.
	CostCenter string `pulumi:"costCenter"`
	// The country/region in which the user is located, e.g. `US` or `UK`.
	Country string `pulumi:"country"`
	// Indicates whether the user account was created as a regular school or work account (`null`), an external account (`Invitation`), a local account for an Azure Active Directory B2C tenant (`LocalAccount`) or self-service sign-up using email verification (`EmailVerified`).
	CreationType string `pulumi:"creationType"`
	// The name for the department in which the user works.
	Department string `pulumi:"department"`
	// The display name of the user.
	DisplayName string `pulumi:"displayName"`
	// The name of the division in which the user works.
	Division string `pulumi:"division"`
	// The employee identifier assigned to the user by the organisation.
	EmployeeId string `pulumi:"employeeId"`
	// Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor.
	EmployeeType string `pulumi:"employeeType"`
	// For an external user invited to the tenant, this property represents the invited user's invitation status. Possible values are `PendingAcceptance` or `Accepted`.
	ExternalUserState string `pulumi:"externalUserState"`
	// The fax number of the user.
	FaxNumber string `pulumi:"faxNumber"`
	// The given name (first name) of the user.
	GivenName string `pulumi:"givenName"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user.
	ImAddresses []string `pulumi:"imAddresses"`
	// The user’s job title.
	JobTitle string `pulumi:"jobTitle"`
	// The SMTP address for the user.
	Mail string `pulumi:"mail"`
	// The email alias of the user.
	MailNickname string `pulumi:"mailNickname"`
	// The object ID of the user's manager.
	ManagerId string `pulumi:"managerId"`
	// The primary cellular telephone number for the user.
	MobilePhone string `pulumi:"mobilePhone"`
	// The object ID of the user.
	ObjectId string `pulumi:"objectId"`
	// The office location in the user's place of business.
	OfficeLocation string `pulumi:"officeLocation"`
	// The on-premises distinguished name (DN) of the user, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesDistinguishedName string `pulumi:"onpremisesDistinguishedName"`
	// The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesDomainName string `pulumi:"onpremisesDomainName"`
	// The value used to associate an on-premise Active Directory user account with their Azure AD user object.
	OnpremisesImmutableId string `pulumi:"onpremisesImmutableId"`
	// The on-premise SAM account name of the user.
	OnpremisesSamAccountName string `pulumi:"onpremisesSamAccountName"`
	// The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesSecurityIdentifier string `pulumi:"onpremisesSecurityIdentifier"`
	// Whether this user is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).
	OnpremisesSyncEnabled bool `pulumi:"onpremisesSyncEnabled"`
	// The on-premise user principal name of the user.
	OnpremisesUserPrincipalName string `pulumi:"onpremisesUserPrincipalName"`
	// A list of additional email addresses for the user.
	OtherMails []string `pulumi:"otherMails"`
	// The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.
	PostalCode string `pulumi:"postalCode"`
	// The user's preferred language, in ISO 639-1 notation.
	PreferredLanguage string `pulumi:"preferredLanguage"`
	// List of email addresses for the user that direct to the same mailbox.
	ProxyAddresses []string `pulumi:"proxyAddresses"`
	// Whether or not the Outlook global address list should include this user.
	ShowInAddressList bool `pulumi:"showInAddressList"`
	// The state or province in the user's address.
	State string `pulumi:"state"`
	// The street address of the user's place of business.
	StreetAddress string `pulumi:"streetAddress"`
	// The user's surname (family name or last name).
	Surname string `pulumi:"surname"`
	// The usage location of the user.
	UsageLocation string `pulumi:"usageLocation"`
	// The user principal name (UPN) of the user.
	UserPrincipalName string `pulumi:"userPrincipalName"`
	// The user type in the directory. Possible values are `Guest` or `Member`.
	UserType string `pulumi:"userType"`
}

A collection of values returned by getUser.

func LookupUser

func LookupUser(ctx *pulumi.Context, args *LookupUserArgs, opts ...pulumi.InvokeOption) (*LookupUserResult, error)

Gets information about an Azure Active Directory user.

## 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: `User.Read.All` or `Directory.Read.All`

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

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.LookupUser(ctx, &azuread.LookupUserArgs{
			UserPrincipalName: pulumi.StringRef("user@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupUserResultOutput added in v5.3.0

type LookupUserResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getUser.

func LookupUserOutput added in v5.3.0

func LookupUserOutput(ctx *pulumi.Context, args LookupUserOutputArgs, opts ...pulumi.InvokeOption) LookupUserResultOutput

func (LookupUserResultOutput) AccountEnabled added in v5.3.0

func (o LookupUserResultOutput) AccountEnabled() pulumi.BoolOutput

Whether or not the account is enabled.

func (LookupUserResultOutput) AgeGroup added in v5.3.0

The age group of the user. Supported values are `Adult`, `NotAdult` and `Minor`.

func (LookupUserResultOutput) BusinessPhones added in v5.3.0

func (o LookupUserResultOutput) BusinessPhones() pulumi.StringArrayOutput

A list of telephone numbers for the user.

func (LookupUserResultOutput) City added in v5.3.0

The city in which the user is located.

func (LookupUserResultOutput) CompanyName added in v5.3.0

func (o LookupUserResultOutput) CompanyName() pulumi.StringOutput

The company name which the user is associated. This property can be useful for describing the company that an external user comes from.

func (LookupUserResultOutput) ConsentProvidedForMinor added in v5.3.0

func (o LookupUserResultOutput) ConsentProvidedForMinor() pulumi.StringOutput

Whether consent has been obtained for minors. Supported values are `Granted`, `Denied` and `NotRequired`.

func (LookupUserResultOutput) CostCenter added in v5.4.0

The cost center associated with the user.

func (LookupUserResultOutput) Country added in v5.3.0

The country/region in which the user is located, e.g. `US` or `UK`.

func (LookupUserResultOutput) CreationType added in v5.3.0

func (o LookupUserResultOutput) CreationType() pulumi.StringOutput

Indicates whether the user account was created as a regular school or work account (`null`), an external account (`Invitation`), a local account for an Azure Active Directory B2C tenant (`LocalAccount`) or self-service sign-up using email verification (`EmailVerified`).

func (LookupUserResultOutput) Department added in v5.3.0

The name for the department in which the user works.

func (LookupUserResultOutput) DisplayName added in v5.3.0

func (o LookupUserResultOutput) DisplayName() pulumi.StringOutput

The display name of the user.

func (LookupUserResultOutput) Division added in v5.4.0

The name of the division in which the user works.

func (LookupUserResultOutput) ElementType added in v5.3.0

func (LookupUserResultOutput) ElementType() reflect.Type

func (LookupUserResultOutput) EmployeeId added in v5.3.0

The employee identifier assigned to the user by the organisation.

func (LookupUserResultOutput) EmployeeType added in v5.4.0

func (o LookupUserResultOutput) EmployeeType() pulumi.StringOutput

Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor.

func (LookupUserResultOutput) ExternalUserState added in v5.3.0

func (o LookupUserResultOutput) ExternalUserState() pulumi.StringOutput

For an external user invited to the tenant, this property represents the invited user's invitation status. Possible values are `PendingAcceptance` or `Accepted`.

func (LookupUserResultOutput) FaxNumber added in v5.3.0

The fax number of the user.

func (LookupUserResultOutput) GivenName added in v5.3.0

The given name (first name) of the user.

func (LookupUserResultOutput) Id added in v5.3.0

The provider-assigned unique ID for this managed resource.

func (LookupUserResultOutput) ImAddresses added in v5.3.0

A list of instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user.

func (LookupUserResultOutput) JobTitle added in v5.3.0

The user’s job title.

func (LookupUserResultOutput) Mail added in v5.3.0

The SMTP address for the user.

func (LookupUserResultOutput) MailNickname added in v5.3.0

func (o LookupUserResultOutput) MailNickname() pulumi.StringOutput

The email alias of the user.

func (LookupUserResultOutput) ManagerId added in v5.6.0

The object ID of the user's manager.

func (LookupUserResultOutput) MobilePhone added in v5.3.0

func (o LookupUserResultOutput) MobilePhone() pulumi.StringOutput

The primary cellular telephone number for the user.

func (LookupUserResultOutput) ObjectId added in v5.3.0

The object ID of the user.

func (LookupUserResultOutput) OfficeLocation added in v5.3.0

func (o LookupUserResultOutput) OfficeLocation() pulumi.StringOutput

The office location in the user's place of business.

func (LookupUserResultOutput) OnpremisesDistinguishedName added in v5.3.0

func (o LookupUserResultOutput) OnpremisesDistinguishedName() pulumi.StringOutput

The on-premises distinguished name (DN) of the user, synchronised from the on-premises directory when Azure AD Connect is used.

func (LookupUserResultOutput) OnpremisesDomainName added in v5.3.0

func (o LookupUserResultOutput) OnpremisesDomainName() pulumi.StringOutput

The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.

func (LookupUserResultOutput) OnpremisesImmutableId added in v5.3.0

func (o LookupUserResultOutput) OnpremisesImmutableId() pulumi.StringOutput

The value used to associate an on-premise Active Directory user account with their Azure AD user object.

func (LookupUserResultOutput) OnpremisesSamAccountName added in v5.3.0

func (o LookupUserResultOutput) OnpremisesSamAccountName() pulumi.StringOutput

The on-premise SAM account name of the user.

func (LookupUserResultOutput) OnpremisesSecurityIdentifier added in v5.3.0

func (o LookupUserResultOutput) OnpremisesSecurityIdentifier() pulumi.StringOutput

The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.

func (LookupUserResultOutput) OnpremisesSyncEnabled added in v5.3.0

func (o LookupUserResultOutput) OnpremisesSyncEnabled() pulumi.BoolOutput

Whether this user is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).

func (LookupUserResultOutput) OnpremisesUserPrincipalName added in v5.3.0

func (o LookupUserResultOutput) OnpremisesUserPrincipalName() pulumi.StringOutput

The on-premise user principal name of the user.

func (LookupUserResultOutput) OtherMails added in v5.3.0

A list of additional email addresses for the user.

func (LookupUserResultOutput) PostalCode added in v5.3.0

The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.

func (LookupUserResultOutput) PreferredLanguage added in v5.3.0

func (o LookupUserResultOutput) PreferredLanguage() pulumi.StringOutput

The user's preferred language, in ISO 639-1 notation.

func (LookupUserResultOutput) ProxyAddresses added in v5.3.0

func (o LookupUserResultOutput) ProxyAddresses() pulumi.StringArrayOutput

List of email addresses for the user that direct to the same mailbox.

func (LookupUserResultOutput) ShowInAddressList added in v5.3.0

func (o LookupUserResultOutput) ShowInAddressList() pulumi.BoolOutput

Whether or not the Outlook global address list should include this user.

func (LookupUserResultOutput) State added in v5.3.0

The state or province in the user's address.

func (LookupUserResultOutput) StreetAddress added in v5.3.0

func (o LookupUserResultOutput) StreetAddress() pulumi.StringOutput

The street address of the user's place of business.

func (LookupUserResultOutput) Surname added in v5.3.0

The user's surname (family name or last name).

func (LookupUserResultOutput) ToLookupUserResultOutput added in v5.3.0

func (o LookupUserResultOutput) ToLookupUserResultOutput() LookupUserResultOutput

func (LookupUserResultOutput) ToLookupUserResultOutputWithContext added in v5.3.0

func (o LookupUserResultOutput) ToLookupUserResultOutputWithContext(ctx context.Context) LookupUserResultOutput

func (LookupUserResultOutput) UsageLocation added in v5.3.0

func (o LookupUserResultOutput) UsageLocation() pulumi.StringOutput

The usage location of the user.

func (LookupUserResultOutput) UserPrincipalName added in v5.3.0

func (o LookupUserResultOutput) UserPrincipalName() pulumi.StringOutput

The user principal name (UPN) of the user.

func (LookupUserResultOutput) UserType added in v5.3.0

The user type in the directory. Possible values are `Guest` or `Member`.

type NamedLocation added in v5.2.0

type NamedLocation struct {
	pulumi.CustomResourceState

	// A `country` block as documented below, which configures a country-based named location.
	Country NamedLocationCountryPtrOutput `pulumi:"country"`
	// The friendly name for this named location.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// An `ip` block as documented below, which configures an IP-based named location.
	//
	// > Exactly one of `ip` or `country` must be specified. Changing between these forces a new resource to be created.
	Ip NamedLocationIpPtrOutput `pulumi:"ip"`
}

Manages a Named Location within 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 roles: `Policy.ReadWrite.ConditionalAccess` and `Policy.Read.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Conditional Access Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.NewNamedLocation(ctx, "example-ip", &azuread.NamedLocationArgs{
			DisplayName: pulumi.String("IP Named Location"),
			Ip: &azuread.NamedLocationIpArgs{
				IpRanges: pulumi.StringArray{
					pulumi.String("1.1.1.1/32"),
					pulumi.String("2.2.2.2/32"),
				},
				Trusted: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewNamedLocation(ctx, "example-country", &azuread.NamedLocationArgs{
			DisplayName: pulumi.String("Country Named Location"),
			Country: &azuread.NamedLocationCountryArgs{
				CountriesAndRegions: pulumi.StringArray{
					pulumi.String("GB"),
					pulumi.String("US"),
				},
				IncludeUnknownCountriesAndRegions: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Named Locations can be imported using the `id`, e.g.

```sh $ pulumi import azuread:index/namedLocation:NamedLocation my_location 00000000-0000-0000-0000-000000000000 ```

func GetNamedLocation added in v5.2.0

func GetNamedLocation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *NamedLocationState, opts ...pulumi.ResourceOption) (*NamedLocation, error)

GetNamedLocation gets an existing NamedLocation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewNamedLocation added in v5.2.0

func NewNamedLocation(ctx *pulumi.Context,
	name string, args *NamedLocationArgs, opts ...pulumi.ResourceOption) (*NamedLocation, error)

NewNamedLocation registers a new resource with the given unique name, arguments, and options.

func (*NamedLocation) ElementType added in v5.2.0

func (*NamedLocation) ElementType() reflect.Type

func (*NamedLocation) ToNamedLocationOutput added in v5.2.0

func (i *NamedLocation) ToNamedLocationOutput() NamedLocationOutput

func (*NamedLocation) ToNamedLocationOutputWithContext added in v5.2.0

func (i *NamedLocation) ToNamedLocationOutputWithContext(ctx context.Context) NamedLocationOutput

type NamedLocationArgs added in v5.2.0

type NamedLocationArgs struct {
	// A `country` block as documented below, which configures a country-based named location.
	Country NamedLocationCountryPtrInput
	// The friendly name for this named location.
	DisplayName pulumi.StringInput
	// An `ip` block as documented below, which configures an IP-based named location.
	//
	// > Exactly one of `ip` or `country` must be specified. Changing between these forces a new resource to be created.
	Ip NamedLocationIpPtrInput
}

The set of arguments for constructing a NamedLocation resource.

func (NamedLocationArgs) ElementType added in v5.2.0

func (NamedLocationArgs) ElementType() reflect.Type

type NamedLocationArray added in v5.2.0

type NamedLocationArray []NamedLocationInput

func (NamedLocationArray) ElementType added in v5.2.0

func (NamedLocationArray) ElementType() reflect.Type

func (NamedLocationArray) ToNamedLocationArrayOutput added in v5.2.0

func (i NamedLocationArray) ToNamedLocationArrayOutput() NamedLocationArrayOutput

func (NamedLocationArray) ToNamedLocationArrayOutputWithContext added in v5.2.0

func (i NamedLocationArray) ToNamedLocationArrayOutputWithContext(ctx context.Context) NamedLocationArrayOutput

type NamedLocationArrayInput added in v5.2.0

type NamedLocationArrayInput interface {
	pulumi.Input

	ToNamedLocationArrayOutput() NamedLocationArrayOutput
	ToNamedLocationArrayOutputWithContext(context.Context) NamedLocationArrayOutput
}

NamedLocationArrayInput is an input type that accepts NamedLocationArray and NamedLocationArrayOutput values. You can construct a concrete instance of `NamedLocationArrayInput` via:

NamedLocationArray{ NamedLocationArgs{...} }

type NamedLocationArrayOutput added in v5.2.0

type NamedLocationArrayOutput struct{ *pulumi.OutputState }

func (NamedLocationArrayOutput) ElementType added in v5.2.0

func (NamedLocationArrayOutput) ElementType() reflect.Type

func (NamedLocationArrayOutput) Index added in v5.2.0

func (NamedLocationArrayOutput) ToNamedLocationArrayOutput added in v5.2.0

func (o NamedLocationArrayOutput) ToNamedLocationArrayOutput() NamedLocationArrayOutput

func (NamedLocationArrayOutput) ToNamedLocationArrayOutputWithContext added in v5.2.0

func (o NamedLocationArrayOutput) ToNamedLocationArrayOutputWithContext(ctx context.Context) NamedLocationArrayOutput

type NamedLocationCountry added in v5.2.0

type NamedLocationCountry struct {
	// List of countries and/or regions in two-letter format specified by ISO 3166-2.
	CountriesAndRegions []string `pulumi:"countriesAndRegions"`
	// Whether IP addresses that don't map to a country or region should be included in the named location. Defaults to `false`.
	IncludeUnknownCountriesAndRegions *bool `pulumi:"includeUnknownCountriesAndRegions"`
}

type NamedLocationCountryArgs added in v5.2.0

type NamedLocationCountryArgs struct {
	// List of countries and/or regions in two-letter format specified by ISO 3166-2.
	CountriesAndRegions pulumi.StringArrayInput `pulumi:"countriesAndRegions"`
	// Whether IP addresses that don't map to a country or region should be included in the named location. Defaults to `false`.
	IncludeUnknownCountriesAndRegions pulumi.BoolPtrInput `pulumi:"includeUnknownCountriesAndRegions"`
}

func (NamedLocationCountryArgs) ElementType added in v5.2.0

func (NamedLocationCountryArgs) ElementType() reflect.Type

func (NamedLocationCountryArgs) ToNamedLocationCountryOutput added in v5.2.0

func (i NamedLocationCountryArgs) ToNamedLocationCountryOutput() NamedLocationCountryOutput

func (NamedLocationCountryArgs) ToNamedLocationCountryOutputWithContext added in v5.2.0

func (i NamedLocationCountryArgs) ToNamedLocationCountryOutputWithContext(ctx context.Context) NamedLocationCountryOutput

func (NamedLocationCountryArgs) ToNamedLocationCountryPtrOutput added in v5.2.0

func (i NamedLocationCountryArgs) ToNamedLocationCountryPtrOutput() NamedLocationCountryPtrOutput

func (NamedLocationCountryArgs) ToNamedLocationCountryPtrOutputWithContext added in v5.2.0

func (i NamedLocationCountryArgs) ToNamedLocationCountryPtrOutputWithContext(ctx context.Context) NamedLocationCountryPtrOutput

type NamedLocationCountryInput added in v5.2.0

type NamedLocationCountryInput interface {
	pulumi.Input

	ToNamedLocationCountryOutput() NamedLocationCountryOutput
	ToNamedLocationCountryOutputWithContext(context.Context) NamedLocationCountryOutput
}

NamedLocationCountryInput is an input type that accepts NamedLocationCountryArgs and NamedLocationCountryOutput values. You can construct a concrete instance of `NamedLocationCountryInput` via:

NamedLocationCountryArgs{...}

type NamedLocationCountryOutput added in v5.2.0

type NamedLocationCountryOutput struct{ *pulumi.OutputState }

func (NamedLocationCountryOutput) CountriesAndRegions added in v5.2.0

func (o NamedLocationCountryOutput) CountriesAndRegions() pulumi.StringArrayOutput

List of countries and/or regions in two-letter format specified by ISO 3166-2.

func (NamedLocationCountryOutput) ElementType added in v5.2.0

func (NamedLocationCountryOutput) ElementType() reflect.Type

func (NamedLocationCountryOutput) IncludeUnknownCountriesAndRegions added in v5.2.0

func (o NamedLocationCountryOutput) IncludeUnknownCountriesAndRegions() pulumi.BoolPtrOutput

Whether IP addresses that don't map to a country or region should be included in the named location. Defaults to `false`.

func (NamedLocationCountryOutput) ToNamedLocationCountryOutput added in v5.2.0

func (o NamedLocationCountryOutput) ToNamedLocationCountryOutput() NamedLocationCountryOutput

func (NamedLocationCountryOutput) ToNamedLocationCountryOutputWithContext added in v5.2.0

func (o NamedLocationCountryOutput) ToNamedLocationCountryOutputWithContext(ctx context.Context) NamedLocationCountryOutput

func (NamedLocationCountryOutput) ToNamedLocationCountryPtrOutput added in v5.2.0

func (o NamedLocationCountryOutput) ToNamedLocationCountryPtrOutput() NamedLocationCountryPtrOutput

func (NamedLocationCountryOutput) ToNamedLocationCountryPtrOutputWithContext added in v5.2.0

func (o NamedLocationCountryOutput) ToNamedLocationCountryPtrOutputWithContext(ctx context.Context) NamedLocationCountryPtrOutput

type NamedLocationCountryPtrInput added in v5.2.0

type NamedLocationCountryPtrInput interface {
	pulumi.Input

	ToNamedLocationCountryPtrOutput() NamedLocationCountryPtrOutput
	ToNamedLocationCountryPtrOutputWithContext(context.Context) NamedLocationCountryPtrOutput
}

NamedLocationCountryPtrInput is an input type that accepts NamedLocationCountryArgs, NamedLocationCountryPtr and NamedLocationCountryPtrOutput values. You can construct a concrete instance of `NamedLocationCountryPtrInput` via:

        NamedLocationCountryArgs{...}

or:

        nil

func NamedLocationCountryPtr added in v5.2.0

func NamedLocationCountryPtr(v *NamedLocationCountryArgs) NamedLocationCountryPtrInput

type NamedLocationCountryPtrOutput added in v5.2.0

type NamedLocationCountryPtrOutput struct{ *pulumi.OutputState }

func (NamedLocationCountryPtrOutput) CountriesAndRegions added in v5.2.0

func (o NamedLocationCountryPtrOutput) CountriesAndRegions() pulumi.StringArrayOutput

List of countries and/or regions in two-letter format specified by ISO 3166-2.

func (NamedLocationCountryPtrOutput) Elem added in v5.2.0

func (NamedLocationCountryPtrOutput) ElementType added in v5.2.0

func (NamedLocationCountryPtrOutput) IncludeUnknownCountriesAndRegions added in v5.2.0

func (o NamedLocationCountryPtrOutput) IncludeUnknownCountriesAndRegions() pulumi.BoolPtrOutput

Whether IP addresses that don't map to a country or region should be included in the named location. Defaults to `false`.

func (NamedLocationCountryPtrOutput) ToNamedLocationCountryPtrOutput added in v5.2.0

func (o NamedLocationCountryPtrOutput) ToNamedLocationCountryPtrOutput() NamedLocationCountryPtrOutput

func (NamedLocationCountryPtrOutput) ToNamedLocationCountryPtrOutputWithContext added in v5.2.0

func (o NamedLocationCountryPtrOutput) ToNamedLocationCountryPtrOutputWithContext(ctx context.Context) NamedLocationCountryPtrOutput

type NamedLocationInput added in v5.2.0

type NamedLocationInput interface {
	pulumi.Input

	ToNamedLocationOutput() NamedLocationOutput
	ToNamedLocationOutputWithContext(ctx context.Context) NamedLocationOutput
}

type NamedLocationIp added in v5.2.0

type NamedLocationIp struct {
	// List of IP address ranges in IPv4 CIDR format (e.g. `1.2.3.4/32`) or any allowable IPv6 format from IETF RFC596. Each CIDR prefix must be `/8` or larger.
	IpRanges []string `pulumi:"ipRanges"`
	// Whether the named location is trusted. Defaults to `false`.
	Trusted *bool `pulumi:"trusted"`
}

type NamedLocationIpArgs added in v5.2.0

type NamedLocationIpArgs struct {
	// List of IP address ranges in IPv4 CIDR format (e.g. `1.2.3.4/32`) or any allowable IPv6 format from IETF RFC596. Each CIDR prefix must be `/8` or larger.
	IpRanges pulumi.StringArrayInput `pulumi:"ipRanges"`
	// Whether the named location is trusted. Defaults to `false`.
	Trusted pulumi.BoolPtrInput `pulumi:"trusted"`
}

func (NamedLocationIpArgs) ElementType added in v5.2.0

func (NamedLocationIpArgs) ElementType() reflect.Type

func (NamedLocationIpArgs) ToNamedLocationIpOutput added in v5.2.0

func (i NamedLocationIpArgs) ToNamedLocationIpOutput() NamedLocationIpOutput

func (NamedLocationIpArgs) ToNamedLocationIpOutputWithContext added in v5.2.0

func (i NamedLocationIpArgs) ToNamedLocationIpOutputWithContext(ctx context.Context) NamedLocationIpOutput

func (NamedLocationIpArgs) ToNamedLocationIpPtrOutput added in v5.2.0

func (i NamedLocationIpArgs) ToNamedLocationIpPtrOutput() NamedLocationIpPtrOutput

func (NamedLocationIpArgs) ToNamedLocationIpPtrOutputWithContext added in v5.2.0

func (i NamedLocationIpArgs) ToNamedLocationIpPtrOutputWithContext(ctx context.Context) NamedLocationIpPtrOutput

type NamedLocationIpInput added in v5.2.0

type NamedLocationIpInput interface {
	pulumi.Input

	ToNamedLocationIpOutput() NamedLocationIpOutput
	ToNamedLocationIpOutputWithContext(context.Context) NamedLocationIpOutput
}

NamedLocationIpInput is an input type that accepts NamedLocationIpArgs and NamedLocationIpOutput values. You can construct a concrete instance of `NamedLocationIpInput` via:

NamedLocationIpArgs{...}

type NamedLocationIpOutput added in v5.2.0

type NamedLocationIpOutput struct{ *pulumi.OutputState }

func (NamedLocationIpOutput) ElementType added in v5.2.0

func (NamedLocationIpOutput) ElementType() reflect.Type

func (NamedLocationIpOutput) IpRanges added in v5.2.0

List of IP address ranges in IPv4 CIDR format (e.g. `1.2.3.4/32`) or any allowable IPv6 format from IETF RFC596. Each CIDR prefix must be `/8` or larger.

func (NamedLocationIpOutput) ToNamedLocationIpOutput added in v5.2.0

func (o NamedLocationIpOutput) ToNamedLocationIpOutput() NamedLocationIpOutput

func (NamedLocationIpOutput) ToNamedLocationIpOutputWithContext added in v5.2.0

func (o NamedLocationIpOutput) ToNamedLocationIpOutputWithContext(ctx context.Context) NamedLocationIpOutput

func (NamedLocationIpOutput) ToNamedLocationIpPtrOutput added in v5.2.0

func (o NamedLocationIpOutput) ToNamedLocationIpPtrOutput() NamedLocationIpPtrOutput

func (NamedLocationIpOutput) ToNamedLocationIpPtrOutputWithContext added in v5.2.0

func (o NamedLocationIpOutput) ToNamedLocationIpPtrOutputWithContext(ctx context.Context) NamedLocationIpPtrOutput

func (NamedLocationIpOutput) Trusted added in v5.2.0

Whether the named location is trusted. Defaults to `false`.

type NamedLocationIpPtrInput added in v5.2.0

type NamedLocationIpPtrInput interface {
	pulumi.Input

	ToNamedLocationIpPtrOutput() NamedLocationIpPtrOutput
	ToNamedLocationIpPtrOutputWithContext(context.Context) NamedLocationIpPtrOutput
}

NamedLocationIpPtrInput is an input type that accepts NamedLocationIpArgs, NamedLocationIpPtr and NamedLocationIpPtrOutput values. You can construct a concrete instance of `NamedLocationIpPtrInput` via:

        NamedLocationIpArgs{...}

or:

        nil

func NamedLocationIpPtr added in v5.2.0

func NamedLocationIpPtr(v *NamedLocationIpArgs) NamedLocationIpPtrInput

type NamedLocationIpPtrOutput added in v5.2.0

type NamedLocationIpPtrOutput struct{ *pulumi.OutputState }

func (NamedLocationIpPtrOutput) Elem added in v5.2.0

func (NamedLocationIpPtrOutput) ElementType added in v5.2.0

func (NamedLocationIpPtrOutput) ElementType() reflect.Type

func (NamedLocationIpPtrOutput) IpRanges added in v5.2.0

List of IP address ranges in IPv4 CIDR format (e.g. `1.2.3.4/32`) or any allowable IPv6 format from IETF RFC596. Each CIDR prefix must be `/8` or larger.

func (NamedLocationIpPtrOutput) ToNamedLocationIpPtrOutput added in v5.2.0

func (o NamedLocationIpPtrOutput) ToNamedLocationIpPtrOutput() NamedLocationIpPtrOutput

func (NamedLocationIpPtrOutput) ToNamedLocationIpPtrOutputWithContext added in v5.2.0

func (o NamedLocationIpPtrOutput) ToNamedLocationIpPtrOutputWithContext(ctx context.Context) NamedLocationIpPtrOutput

func (NamedLocationIpPtrOutput) Trusted added in v5.2.0

Whether the named location is trusted. Defaults to `false`.

type NamedLocationMap added in v5.2.0

type NamedLocationMap map[string]NamedLocationInput

func (NamedLocationMap) ElementType added in v5.2.0

func (NamedLocationMap) ElementType() reflect.Type

func (NamedLocationMap) ToNamedLocationMapOutput added in v5.2.0

func (i NamedLocationMap) ToNamedLocationMapOutput() NamedLocationMapOutput

func (NamedLocationMap) ToNamedLocationMapOutputWithContext added in v5.2.0

func (i NamedLocationMap) ToNamedLocationMapOutputWithContext(ctx context.Context) NamedLocationMapOutput

type NamedLocationMapInput added in v5.2.0

type NamedLocationMapInput interface {
	pulumi.Input

	ToNamedLocationMapOutput() NamedLocationMapOutput
	ToNamedLocationMapOutputWithContext(context.Context) NamedLocationMapOutput
}

NamedLocationMapInput is an input type that accepts NamedLocationMap and NamedLocationMapOutput values. You can construct a concrete instance of `NamedLocationMapInput` via:

NamedLocationMap{ "key": NamedLocationArgs{...} }

type NamedLocationMapOutput added in v5.2.0

type NamedLocationMapOutput struct{ *pulumi.OutputState }

func (NamedLocationMapOutput) ElementType added in v5.2.0

func (NamedLocationMapOutput) ElementType() reflect.Type

func (NamedLocationMapOutput) MapIndex added in v5.2.0

func (NamedLocationMapOutput) ToNamedLocationMapOutput added in v5.2.0

func (o NamedLocationMapOutput) ToNamedLocationMapOutput() NamedLocationMapOutput

func (NamedLocationMapOutput) ToNamedLocationMapOutputWithContext added in v5.2.0

func (o NamedLocationMapOutput) ToNamedLocationMapOutputWithContext(ctx context.Context) NamedLocationMapOutput

type NamedLocationOutput added in v5.2.0

type NamedLocationOutput struct{ *pulumi.OutputState }

func (NamedLocationOutput) Country added in v5.22.0

A `country` block as documented below, which configures a country-based named location.

func (NamedLocationOutput) DisplayName added in v5.22.0

func (o NamedLocationOutput) DisplayName() pulumi.StringOutput

The friendly name for this named location.

func (NamedLocationOutput) ElementType added in v5.2.0

func (NamedLocationOutput) ElementType() reflect.Type

func (NamedLocationOutput) Ip added in v5.22.0

An `ip` block as documented below, which configures an IP-based named location.

> Exactly one of `ip` or `country` must be specified. Changing between these forces a new resource to be created.

func (NamedLocationOutput) ToNamedLocationOutput added in v5.2.0

func (o NamedLocationOutput) ToNamedLocationOutput() NamedLocationOutput

func (NamedLocationOutput) ToNamedLocationOutputWithContext added in v5.2.0

func (o NamedLocationOutput) ToNamedLocationOutputWithContext(ctx context.Context) NamedLocationOutput

type NamedLocationState added in v5.2.0

type NamedLocationState struct {
	// A `country` block as documented below, which configures a country-based named location.
	Country NamedLocationCountryPtrInput
	// The friendly name for this named location.
	DisplayName pulumi.StringPtrInput
	// An `ip` block as documented below, which configures an IP-based named location.
	//
	// > Exactly one of `ip` or `country` must be specified. Changing between these forces a new resource to be created.
	Ip NamedLocationIpPtrInput
}

func (NamedLocationState) ElementType added in v5.2.0

func (NamedLocationState) ElementType() reflect.Type

type Provider

type Provider struct {
	pulumi.ProviderResourceState

	// Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate
	ClientCertificate pulumi.StringPtrOutput `pulumi:"clientCertificate"`
	// The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client
	// Certificate
	ClientCertificatePassword pulumi.StringPtrOutput `pulumi:"clientCertificatePassword"`
	// The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service
	// Principal using a Client Certificate
	ClientCertificatePath pulumi.StringPtrOutput `pulumi:"clientCertificatePath"`
	// The Client ID which should be used for service principal authentication
	ClientId pulumi.StringPtrOutput `pulumi:"clientId"`
	// The path to a file containing the Client ID which should be used for service principal authentication
	ClientIdFilePath pulumi.StringPtrOutput `pulumi:"clientIdFilePath"`
	// The application password to use when authenticating as a Service Principal using a Client Secret
	ClientSecret pulumi.StringPtrOutput `pulumi:"clientSecret"`
	// The path to a file containing the application password to use when authenticating as a Service Principal using a Client
	// Secret
	ClientSecretFilePath pulumi.StringPtrOutput `pulumi:"clientSecretFilePath"`
	// The cloud environment which should be used. Possible values are: `global` (also `public`), `usgovernmentl4` (also
	// `usgovernment`), `usgovernmentl5` (also `dod`), and `china`. Defaults to `global`. Not used and should not be specified
	// when `metadata_host` is specified.
	Environment pulumi.StringPtrOutput `pulumi:"environment"`
	// The Hostname which should be used for the Azure Metadata Service.
	MetadataHost pulumi.StringOutput `pulumi:"metadataHost"`
	// The path to a custom endpoint for Managed Identity - in most circumstances this should be detected automatically
	MsiEndpoint pulumi.StringPtrOutput `pulumi:"msiEndpoint"`
	// The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID
	// Connect.
	OidcRequestToken pulumi.StringPtrOutput `pulumi:"oidcRequestToken"`
	// The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal
	// using OpenID Connect.
	OidcRequestUrl pulumi.StringPtrOutput `pulumi:"oidcRequestUrl"`
	// The ID token for use when authenticating as a Service Principal using OpenID Connect.
	OidcToken pulumi.StringPtrOutput `pulumi:"oidcToken"`
	// The path to a file containing an ID token for use when authenticating as a Service Principal using OpenID Connect.
	OidcTokenFilePath pulumi.StringPtrOutput `pulumi:"oidcTokenFilePath"`
	// A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution
	PartnerId pulumi.StringPtrOutput `pulumi:"partnerId"`
	// The Tenant ID which should be used. Works with all authentication methods except Managed Identity
	TenantId pulumi.StringPtrOutput `pulumi:"tenantId"`
}

The provider type for the azuread package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs

type ProviderArgs struct {
	// Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate
	ClientCertificate pulumi.StringPtrInput
	// The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client
	// Certificate
	ClientCertificatePassword pulumi.StringPtrInput
	// The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service
	// Principal using a Client Certificate
	ClientCertificatePath pulumi.StringPtrInput
	// The Client ID which should be used for service principal authentication
	ClientId pulumi.StringPtrInput
	// The path to a file containing the Client ID which should be used for service principal authentication
	ClientIdFilePath pulumi.StringPtrInput
	// The application password to use when authenticating as a Service Principal using a Client Secret
	ClientSecret pulumi.StringPtrInput
	// The path to a file containing the application password to use when authenticating as a Service Principal using a Client
	// Secret
	ClientSecretFilePath pulumi.StringPtrInput
	// Disable the Terraform Partner ID, which is used if a custom `partner_id` isn't specified
	DisableTerraformPartnerId pulumi.BoolPtrInput
	// The cloud environment which should be used. Possible values are: `global` (also `public`), `usgovernmentl4` (also
	// `usgovernment`), `usgovernmentl5` (also `dod`), and `china`. Defaults to `global`. Not used and should not be specified
	// when `metadata_host` is specified.
	Environment pulumi.StringPtrInput
	// The Hostname which should be used for the Azure Metadata Service.
	MetadataHost pulumi.StringInput
	// The path to a custom endpoint for Managed Identity - in most circumstances this should be detected automatically
	MsiEndpoint pulumi.StringPtrInput
	// The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID
	// Connect.
	OidcRequestToken pulumi.StringPtrInput
	// The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal
	// using OpenID Connect.
	OidcRequestUrl pulumi.StringPtrInput
	// The ID token for use when authenticating as a Service Principal using OpenID Connect.
	OidcToken pulumi.StringPtrInput
	// The path to a file containing an ID token for use when authenticating as a Service Principal using OpenID Connect.
	OidcTokenFilePath pulumi.StringPtrInput
	// A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution
	PartnerId pulumi.StringPtrInput
	// The Tenant ID which should be used. Works with all authentication methods except Managed Identity
	TenantId pulumi.StringPtrInput
	// Allow Azure AKS Workload Identity to be used for Authentication.
	UseAksWorkloadIdentity pulumi.BoolPtrInput
	// Allow Azure CLI to be used for Authentication
	UseCli pulumi.BoolPtrInput
	// Allow Managed Identity to be used for Authentication
	UseMsi pulumi.BoolPtrInput
	// Allow OpenID Connect to be used for authentication
	UseOidc pulumi.BoolPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ClientCertificate added in v5.22.0

func (o ProviderOutput) ClientCertificate() pulumi.StringPtrOutput

Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate

func (ProviderOutput) ClientCertificatePassword added in v5.22.0

func (o ProviderOutput) ClientCertificatePassword() pulumi.StringPtrOutput

The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate

func (ProviderOutput) ClientCertificatePath added in v5.22.0

func (o ProviderOutput) ClientCertificatePath() pulumi.StringPtrOutput

The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate

func (ProviderOutput) ClientId added in v5.22.0

func (o ProviderOutput) ClientId() pulumi.StringPtrOutput

The Client ID which should be used for service principal authentication

func (ProviderOutput) ClientIdFilePath added in v5.41.0

func (o ProviderOutput) ClientIdFilePath() pulumi.StringPtrOutput

The path to a file containing the Client ID which should be used for service principal authentication

func (ProviderOutput) ClientSecret added in v5.22.0

func (o ProviderOutput) ClientSecret() pulumi.StringPtrOutput

The application password to use when authenticating as a Service Principal using a Client Secret

func (ProviderOutput) ClientSecretFilePath added in v5.41.0

func (o ProviderOutput) ClientSecretFilePath() pulumi.StringPtrOutput

The path to a file containing the application password to use when authenticating as a Service Principal using a Client Secret

func (ProviderOutput) ElementType

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) Environment added in v5.22.0

func (o ProviderOutput) Environment() pulumi.StringPtrOutput

The cloud environment which should be used. Possible values are: `global` (also `public`), `usgovernmentl4` (also `usgovernment`), `usgovernmentl5` (also `dod`), and `china`. Defaults to `global`. Not used and should not be specified when `metadata_host` is specified.

func (ProviderOutput) MetadataHost added in v5.35.0

func (o ProviderOutput) MetadataHost() pulumi.StringOutput

The Hostname which should be used for the Azure Metadata Service.

func (ProviderOutput) MsiEndpoint added in v5.22.0

func (o ProviderOutput) MsiEndpoint() pulumi.StringPtrOutput

The path to a custom endpoint for Managed Identity - in most circumstances this should be detected automatically

func (ProviderOutput) OidcRequestToken added in v5.23.0

func (o ProviderOutput) OidcRequestToken() pulumi.StringPtrOutput

The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.

func (ProviderOutput) OidcRequestUrl added in v5.23.0

func (o ProviderOutput) OidcRequestUrl() pulumi.StringPtrOutput

The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.

func (ProviderOutput) OidcToken added in v5.28.0

func (o ProviderOutput) OidcToken() pulumi.StringPtrOutput

The ID token for use when authenticating as a Service Principal using OpenID Connect.

func (ProviderOutput) OidcTokenFilePath added in v5.29.1

func (o ProviderOutput) OidcTokenFilePath() pulumi.StringPtrOutput

The path to a file containing an ID token for use when authenticating as a Service Principal using OpenID Connect.

func (ProviderOutput) PartnerId added in v5.22.0

func (o ProviderOutput) PartnerId() pulumi.StringPtrOutput

A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution

func (ProviderOutput) TenantId added in v5.22.0

func (o ProviderOutput) TenantId() pulumi.StringPtrOutput

The Tenant ID which should be used. Works with all authentication methods except Managed Identity

func (ProviderOutput) ToProviderOutput

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ServicePrincipal

type ServicePrincipal struct {
	pulumi.CustomResourceState

	// Whether or not the service principal account is enabled. Defaults to `true`.
	AccountEnabled pulumi.BoolPtrOutput `pulumi:"accountEnabled"`
	// A set of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.
	AlternativeNames pulumi.StringArrayOutput `pulumi:"alternativeNames"`
	// Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application. Defaults to `false`.
	AppRoleAssignmentRequired pulumi.BoolPtrOutput `pulumi:"appRoleAssignmentRequired"`
	// A mapping of app role values to app role IDs, as published by the associated application, intended to be useful when referencing app roles in other resources in your configuration.
	AppRoleIds pulumi.StringMapOutput `pulumi:"appRoleIds"`
	// A list of app roles published by the associated application, as documented below. For more information [official documentation](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).
	AppRoles ServicePrincipalAppRoleArrayOutput `pulumi:"appRoles"`
	// The application ID (client ID) of the application for which to create a service principal
	//
	// Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The tenant ID where the associated application is registered.
	ApplicationTenantId pulumi.StringOutput `pulumi:"applicationTenantId"`
	// The client ID of the application for which to create a service principal.
	ClientId pulumi.StringOutput `pulumi:"clientId"`
	// A description of the service principal provided for internal end-users.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Display name for the app role that appears during app role assignment and in consent experiences.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// A `featureTags` block as described below. Cannot be used together with the `tags` property.
	//
	// > **Features and Tags** Features are configured for a service principal using tags, and are provided as a shortcut to set the corresponding magic tag value for each feature. You cannot configure `featureTags` and `tags` for a service principal at the same time, so if you need to assign additional custom tags it's recommended to use the `tags` property instead. Any tags configured for the linked application will propagate to this service principal.
	FeatureTags ServicePrincipalFeatureTagArrayOutput `pulumi:"featureTags"`
	// Block of features to configure for this service principal using tags
	//
	// Deprecated: This block has been renamed to `featureTags` and will be removed in version 3.0 of the provider
	Features ServicePrincipalFeatureArrayOutput `pulumi:"features"`
	// Home page or landing page of the associated application.
	HomepageUrl pulumi.StringOutput `pulumi:"homepageUrl"`
	// The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
	LoginUrl pulumi.StringPtrOutput `pulumi:"loginUrl"`
	// The URL that will be used by Microsoft's authorization service to log out an user using OpenId Connect front-channel, back-channel or SAML logout protocols, taken from the associated application.
	LogoutUrl pulumi.StringOutput `pulumi:"logoutUrl"`
	// A free text field to capture information about the service principal, typically used for operational purposes.
	Notes pulumi.StringPtrOutput `pulumi:"notes"`
	// A set of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.
	NotificationEmailAddresses pulumi.StringArrayOutput `pulumi:"notificationEmailAddresses"`
	// A mapping of OAuth2.0 permission scope values to scope IDs, as exposed by the associated application, intended to be useful when referencing permission scopes in other resources in your configuration.
	Oauth2PermissionScopeIds pulumi.StringMapOutput `pulumi:"oauth2PermissionScopeIds"`
	// A list of OAuth 2.0 delegated permission scopes exposed by the associated application, as documented below.
	Oauth2PermissionScopes ServicePrincipalOauth2PermissionScopeArrayOutput `pulumi:"oauth2PermissionScopes"`
	// The object ID of the service principal.
	ObjectId pulumi.StringOutput `pulumi:"objectId"`
	// A list of object IDs of principals that will be granted ownership of the service principal
	Owners pulumi.StringArrayOutput `pulumi:"owners"`
	// The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. Supported values are `oidc`, `password`, `saml` or `notSupported`. Omit this property or specify a blank string to unset.
	PreferredSingleSignOnMode pulumi.StringPtrOutput `pulumi:"preferredSingleSignOnMode"`
	// A list of URLs where user tokens are sent for sign-in with the associated application, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent for the associated application.
	RedirectUris pulumi.StringArrayOutput `pulumi:"redirectUris"`
	// The URL where the service exposes SAML metadata for federation.
	SamlMetadataUrl pulumi.StringOutput `pulumi:"samlMetadataUrl"`
	// A `samlSingleSignOn` block as documented below.
	SamlSingleSignOn ServicePrincipalSamlSingleSignOnPtrOutput `pulumi:"samlSingleSignOn"`
	// A list of identifier URI(s), copied over from the associated application.
	ServicePrincipalNames pulumi.StringArrayOutput `pulumi:"servicePrincipalNames"`
	// The Microsoft account types that are supported for the associated application. Possible values include `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.
	SignInAudience pulumi.StringOutput `pulumi:"signInAudience"`
	// A set of tags to apply to the service principal for configuring specific behaviours of the service principal. Note that these are not provided for use by practitioners. Cannot be used together with the `featureTags` block.
	//
	// > **Tags and Features** Azure Active Directory uses special tag values to configure the behavior of service principals. These can be specified using either the `tags` property or with the `featureTags` block. If you need to set any custom tag values not supported by the `featureTags` block, it's recommended to use the `tags` property. Tag values set for the linked application will also propagate to this service principal.
	Tags pulumi.StringArrayOutput `pulumi:"tags"`
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.
	Type pulumi.StringOutput `pulumi:"type"`
	// When true, the resource will return an existing service principal instead of failing with an error
	UseExisting pulumi.BoolPtrOutput `pulumi:"useExisting"`
}

## Example Usage

*Create a service principal for an application*

<!--Start PulumiCodeChooser --> ```go 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 {
		current, err := azuread.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			Owners: pulumi.StringArray{
				pulumi.String(current.ObjectId),
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ClientId:                  example.ClientId,
			AppRoleAssignmentRequired: pulumi.Bool(false),
			Owners: pulumi.StringArray{
				pulumi.String(current.ObjectId),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Create a service principal for an enterprise application*

<!--Start PulumiCodeChooser --> ```go 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 {
		current, err := azuread.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			Owners: pulumi.StringArray{
				pulumi.String(current.ObjectId),
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ClientId:                  example.ClientId,
			AppRoleAssignmentRequired: pulumi.Bool(false),
			Owners: pulumi.StringArray{
				pulumi.String(current.ObjectId),
			},
			FeatureTags: azuread.ServicePrincipalFeatureTagArray{
				&azuread.ServicePrincipalFeatureTagArgs{
					Enterprise: pulumi.Bool(true),
					Gallery:    pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Manage a service principal for a first-party Microsoft application*

<!--Start PulumiCodeChooser --> ```go 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 {
		wellKnown, err := azuread.GetApplicationPublishedAppIds(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipal(ctx, "msgraph", &azuread.ServicePrincipalArgs{
			ClientId:    pulumi.String(wellKnown.Result.MicrosoftGraph),
			UseExisting: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Create a service principal for an application created from a gallery template*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.GetApplicationTemplate(ctx, &azuread.GetApplicationTemplateArgs{
			DisplayName: pulumi.StringRef("Marketo"),
		}, nil)
		if err != nil {
			return err
		}
		exampleApplication, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			TemplateId:  pulumi.String(example.TemplateId),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ClientId:    exampleApplication.ClientId,
			UseExisting: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Service principals can be imported using their object ID, e.g.

```sh $ pulumi import azuread:index/servicePrincipal:ServicePrincipal example 00000000-0000-0000-0000-000000000000 ```

func GetServicePrincipal

func GetServicePrincipal(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServicePrincipalState, opts ...pulumi.ResourceOption) (*ServicePrincipal, error)

GetServicePrincipal gets an existing ServicePrincipal resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServicePrincipal

func NewServicePrincipal(ctx *pulumi.Context,
	name string, args *ServicePrincipalArgs, opts ...pulumi.ResourceOption) (*ServicePrincipal, error)

NewServicePrincipal registers a new resource with the given unique name, arguments, and options.

func (*ServicePrincipal) ElementType

func (*ServicePrincipal) ElementType() reflect.Type

func (*ServicePrincipal) ToServicePrincipalOutput

func (i *ServicePrincipal) ToServicePrincipalOutput() ServicePrincipalOutput

func (*ServicePrincipal) ToServicePrincipalOutputWithContext

func (i *ServicePrincipal) ToServicePrincipalOutputWithContext(ctx context.Context) ServicePrincipalOutput

type ServicePrincipalAppRole

type ServicePrincipalAppRole struct {
	// Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in a standalone scenario). Possible values are: `User` and `Application`, or both.
	AllowedMemberTypes []string `pulumi:"allowedMemberTypes"`
	// A description of the service principal provided for internal end-users.
	Description *string `pulumi:"description"`
	// Display name for the app role that appears during app role assignment and in consent experiences.
	DisplayName *string `pulumi:"displayName"`
	// Specifies whether the permission scope is enabled.
	Enabled *bool `pulumi:"enabled"`
	// The unique identifier of the delegated permission.
	Id *string `pulumi:"id"`
	// The value that is used for the `scp` claim in OAuth 2.0 access tokens.
	Value *string `pulumi:"value"`
}

type ServicePrincipalAppRoleArgs

type ServicePrincipalAppRoleArgs struct {
	// Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in a standalone scenario). Possible values are: `User` and `Application`, or both.
	AllowedMemberTypes pulumi.StringArrayInput `pulumi:"allowedMemberTypes"`
	// A description of the service principal provided for internal end-users.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Display name for the app role that appears during app role assignment and in consent experiences.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// Specifies whether the permission scope is enabled.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
	// The unique identifier of the delegated permission.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// The value that is used for the `scp` claim in OAuth 2.0 access tokens.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (ServicePrincipalAppRoleArgs) ElementType

func (ServicePrincipalAppRoleArgs) ToServicePrincipalAppRoleOutput

func (i ServicePrincipalAppRoleArgs) ToServicePrincipalAppRoleOutput() ServicePrincipalAppRoleOutput

func (ServicePrincipalAppRoleArgs) ToServicePrincipalAppRoleOutputWithContext

func (i ServicePrincipalAppRoleArgs) ToServicePrincipalAppRoleOutputWithContext(ctx context.Context) ServicePrincipalAppRoleOutput

type ServicePrincipalAppRoleArray

type ServicePrincipalAppRoleArray []ServicePrincipalAppRoleInput

func (ServicePrincipalAppRoleArray) ElementType

func (ServicePrincipalAppRoleArray) ToServicePrincipalAppRoleArrayOutput

func (i ServicePrincipalAppRoleArray) ToServicePrincipalAppRoleArrayOutput() ServicePrincipalAppRoleArrayOutput

func (ServicePrincipalAppRoleArray) ToServicePrincipalAppRoleArrayOutputWithContext

func (i ServicePrincipalAppRoleArray) ToServicePrincipalAppRoleArrayOutputWithContext(ctx context.Context) ServicePrincipalAppRoleArrayOutput

type ServicePrincipalAppRoleArrayInput

type ServicePrincipalAppRoleArrayInput interface {
	pulumi.Input

	ToServicePrincipalAppRoleArrayOutput() ServicePrincipalAppRoleArrayOutput
	ToServicePrincipalAppRoleArrayOutputWithContext(context.Context) ServicePrincipalAppRoleArrayOutput
}

ServicePrincipalAppRoleArrayInput is an input type that accepts ServicePrincipalAppRoleArray and ServicePrincipalAppRoleArrayOutput values. You can construct a concrete instance of `ServicePrincipalAppRoleArrayInput` via:

ServicePrincipalAppRoleArray{ ServicePrincipalAppRoleArgs{...} }

type ServicePrincipalAppRoleArrayOutput

type ServicePrincipalAppRoleArrayOutput struct{ *pulumi.OutputState }

func (ServicePrincipalAppRoleArrayOutput) ElementType

func (ServicePrincipalAppRoleArrayOutput) Index

func (ServicePrincipalAppRoleArrayOutput) ToServicePrincipalAppRoleArrayOutput

func (o ServicePrincipalAppRoleArrayOutput) ToServicePrincipalAppRoleArrayOutput() ServicePrincipalAppRoleArrayOutput

func (ServicePrincipalAppRoleArrayOutput) ToServicePrincipalAppRoleArrayOutputWithContext

func (o ServicePrincipalAppRoleArrayOutput) ToServicePrincipalAppRoleArrayOutputWithContext(ctx context.Context) ServicePrincipalAppRoleArrayOutput

type ServicePrincipalAppRoleInput

type ServicePrincipalAppRoleInput interface {
	pulumi.Input

	ToServicePrincipalAppRoleOutput() ServicePrincipalAppRoleOutput
	ToServicePrincipalAppRoleOutputWithContext(context.Context) ServicePrincipalAppRoleOutput
}

ServicePrincipalAppRoleInput is an input type that accepts ServicePrincipalAppRoleArgs and ServicePrincipalAppRoleOutput values. You can construct a concrete instance of `ServicePrincipalAppRoleInput` via:

ServicePrincipalAppRoleArgs{...}

type ServicePrincipalAppRoleOutput

type ServicePrincipalAppRoleOutput struct{ *pulumi.OutputState }

func (ServicePrincipalAppRoleOutput) AllowedMemberTypes

Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in a standalone scenario). Possible values are: `User` and `Application`, or both.

func (ServicePrincipalAppRoleOutput) Description

A description of the service principal provided for internal end-users.

func (ServicePrincipalAppRoleOutput) DisplayName

Display name for the app role that appears during app role assignment and in consent experiences.

func (ServicePrincipalAppRoleOutput) ElementType

func (ServicePrincipalAppRoleOutput) Enabled

Specifies whether the permission scope is enabled.

func (ServicePrincipalAppRoleOutput) Id

The unique identifier of the delegated permission.

func (ServicePrincipalAppRoleOutput) ToServicePrincipalAppRoleOutput

func (o ServicePrincipalAppRoleOutput) ToServicePrincipalAppRoleOutput() ServicePrincipalAppRoleOutput

func (ServicePrincipalAppRoleOutput) ToServicePrincipalAppRoleOutputWithContext

func (o ServicePrincipalAppRoleOutput) ToServicePrincipalAppRoleOutputWithContext(ctx context.Context) ServicePrincipalAppRoleOutput

func (ServicePrincipalAppRoleOutput) Value

The value that is used for the `scp` claim in OAuth 2.0 access tokens.

type ServicePrincipalArgs

type ServicePrincipalArgs struct {
	// Whether or not the service principal account is enabled. Defaults to `true`.
	AccountEnabled pulumi.BoolPtrInput
	// A set of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.
	AlternativeNames pulumi.StringArrayInput
	// Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application. Defaults to `false`.
	AppRoleAssignmentRequired pulumi.BoolPtrInput
	// The application ID (client ID) of the application for which to create a service principal
	//
	// Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationId pulumi.StringPtrInput
	// The client ID of the application for which to create a service principal.
	ClientId pulumi.StringPtrInput
	// A description of the service principal provided for internal end-users.
	Description pulumi.StringPtrInput
	// A `featureTags` block as described below. Cannot be used together with the `tags` property.
	//
	// > **Features and Tags** Features are configured for a service principal using tags, and are provided as a shortcut to set the corresponding magic tag value for each feature. You cannot configure `featureTags` and `tags` for a service principal at the same time, so if you need to assign additional custom tags it's recommended to use the `tags` property instead. Any tags configured for the linked application will propagate to this service principal.
	FeatureTags ServicePrincipalFeatureTagArrayInput
	// Block of features to configure for this service principal using tags
	//
	// Deprecated: This block has been renamed to `featureTags` and will be removed in version 3.0 of the provider
	Features ServicePrincipalFeatureArrayInput
	// The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
	LoginUrl pulumi.StringPtrInput
	// A free text field to capture information about the service principal, typically used for operational purposes.
	Notes pulumi.StringPtrInput
	// A set of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.
	NotificationEmailAddresses pulumi.StringArrayInput
	// A list of object IDs of principals that will be granted ownership of the service principal
	Owners pulumi.StringArrayInput
	// The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. Supported values are `oidc`, `password`, `saml` or `notSupported`. Omit this property or specify a blank string to unset.
	PreferredSingleSignOnMode pulumi.StringPtrInput
	// A `samlSingleSignOn` block as documented below.
	SamlSingleSignOn ServicePrincipalSamlSingleSignOnPtrInput
	// A set of tags to apply to the service principal for configuring specific behaviours of the service principal. Note that these are not provided for use by practitioners. Cannot be used together with the `featureTags` block.
	//
	// > **Tags and Features** Azure Active Directory uses special tag values to configure the behavior of service principals. These can be specified using either the `tags` property or with the `featureTags` block. If you need to set any custom tag values not supported by the `featureTags` block, it's recommended to use the `tags` property. Tag values set for the linked application will also propagate to this service principal.
	Tags pulumi.StringArrayInput
	// When true, the resource will return an existing service principal instead of failing with an error
	UseExisting pulumi.BoolPtrInput
}

The set of arguments for constructing a ServicePrincipal resource.

func (ServicePrincipalArgs) ElementType

func (ServicePrincipalArgs) ElementType() reflect.Type

type ServicePrincipalArray

type ServicePrincipalArray []ServicePrincipalInput

func (ServicePrincipalArray) ElementType

func (ServicePrincipalArray) ElementType() reflect.Type

func (ServicePrincipalArray) ToServicePrincipalArrayOutput

func (i ServicePrincipalArray) ToServicePrincipalArrayOutput() ServicePrincipalArrayOutput

func (ServicePrincipalArray) ToServicePrincipalArrayOutputWithContext

func (i ServicePrincipalArray) ToServicePrincipalArrayOutputWithContext(ctx context.Context) ServicePrincipalArrayOutput

type ServicePrincipalArrayInput

type ServicePrincipalArrayInput interface {
	pulumi.Input

	ToServicePrincipalArrayOutput() ServicePrincipalArrayOutput
	ToServicePrincipalArrayOutputWithContext(context.Context) ServicePrincipalArrayOutput
}

ServicePrincipalArrayInput is an input type that accepts ServicePrincipalArray and ServicePrincipalArrayOutput values. You can construct a concrete instance of `ServicePrincipalArrayInput` via:

ServicePrincipalArray{ ServicePrincipalArgs{...} }

type ServicePrincipalArrayOutput

type ServicePrincipalArrayOutput struct{ *pulumi.OutputState }

func (ServicePrincipalArrayOutput) ElementType

func (ServicePrincipalArrayOutput) Index

func (ServicePrincipalArrayOutput) ToServicePrincipalArrayOutput

func (o ServicePrincipalArrayOutput) ToServicePrincipalArrayOutput() ServicePrincipalArrayOutput

func (ServicePrincipalArrayOutput) ToServicePrincipalArrayOutputWithContext

func (o ServicePrincipalArrayOutput) ToServicePrincipalArrayOutputWithContext(ctx context.Context) ServicePrincipalArrayOutput

type ServicePrincipalCertificate

type ServicePrincipalCertificate struct {
	pulumi.CustomResourceState

	// Specifies the encoding used for the supplied certificate data. Must be one of `pem`, `base64` or `hex`. Defaults to `pem`.
	//
	// > **Tip for Azure Key Vault** The `hex` encoding option is useful for consuming certificate data from the azurermKeyVaultCertificate resource.
	Encoding pulumi.StringPtrOutput `pulumi:"encoding"`
	// The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringOutput `pulumi:"endDate"`
	// A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Changing this field forces a new resource to be created.
	//
	// > One of `endDate` or `endDateRelative` must be set. The maximum duration is determined by Azure AD.
	EndDateRelative pulumi.StringPtrOutput `pulumi:"endDateRelative"`
	// A UUID used to uniquely identify this certificate. If not specified a UUID will be automatically generated. Changing this field forces a new resource to be created.
	KeyId pulumi.StringOutput `pulumi:"keyId"`
	// The object ID of the service principal for which this certificate should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringOutput `pulumi:"servicePrincipalId"`
	// The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the value is determined by Azure Active Directory and is usually the start date of the certificate for asymmetric keys, or the current timestamp for symmetric keys. Changing this field forces a new resource to be created.
	StartDate pulumi.StringOutput `pulumi:"startDate"`
	// The type of key/certificate. Must be one of `AsymmetricX509Cert` or `Symmetric`. Changing this fields forces a new resource to be created.
	Type pulumi.StringPtrOutput `pulumi:"type"`
	// The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argument.
	Value pulumi.StringOutput `pulumi:"value"`
}

## Example Usage

*Using a PEM certificate*

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ApplicationId: example.ApplicationId,
		})
		if err != nil {
			return err
		}
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "cert.pem",
		}, nil)
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipalCertificate(ctx, "example", &azuread.ServicePrincipalCertificateArgs{
			ServicePrincipalId: exampleServicePrincipal.ID(),
			Type:               pulumi.String("AsymmetricX509Cert"),
			Value:              invokeFile.Result,
			EndDate:            pulumi.String("2021-05-01T01:02:03Z"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Using a DER certificate*

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) func main() { pulumi.Run(func(ctx *pulumi.Context) error { example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{ DisplayName: pulumi.String("example"), }) if err != nil { return err } exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{ ApplicationId: example.ApplicationId, }) if err != nil { return err } invokeBase64encode, err := std.Base64encode(ctx, invokeFile1, err := std.File(ctx, &std.FileArgs{ Input: "cert.der", }, nil) if err != nil { return err } &std.Base64encodeArgs{ Input: invokeFile1.Result, }, nil) if err != nil { return err } _, err = azuread.NewServicePrincipalCertificate(ctx, "example", &azuread.ServicePrincipalCertificateArgs{ ServicePrincipalId: exampleServicePrincipal.ID(), Type: pulumi.String("AsymmetricX509Cert"), Encoding: pulumi.String("base64"), Value: invokeBase64encode.Result, EndDate: pulumi.String("2021-05-01T01:02:03Z"), }) if err != nil { return err } return nil }) } ``` <!--End PulumiCodeChooser -->

## Import

Certificates can be imported using the object ID of the associated service principal and the key ID of the certificate credential, e.g.

```sh $ pulumi import azuread:index/servicePrincipalCertificate:ServicePrincipalCertificate example 00000000-0000-0000-0000-000000000000/certificate/11111111-1111-1111-1111-111111111111 ```

-> This ID format is unique to Terraform and is composed of the service principal's object ID, the string "certificate" and the certificate's key ID in the format `{ServicePrincipalObjectId}/certificate/{CertificateKeyId}`.

func GetServicePrincipalCertificate

func GetServicePrincipalCertificate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServicePrincipalCertificateState, opts ...pulumi.ResourceOption) (*ServicePrincipalCertificate, error)

GetServicePrincipalCertificate gets an existing ServicePrincipalCertificate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServicePrincipalCertificate

func NewServicePrincipalCertificate(ctx *pulumi.Context,
	name string, args *ServicePrincipalCertificateArgs, opts ...pulumi.ResourceOption) (*ServicePrincipalCertificate, error)

NewServicePrincipalCertificate registers a new resource with the given unique name, arguments, and options.

func (*ServicePrincipalCertificate) ElementType

func (*ServicePrincipalCertificate) ElementType() reflect.Type

func (*ServicePrincipalCertificate) ToServicePrincipalCertificateOutput

func (i *ServicePrincipalCertificate) ToServicePrincipalCertificateOutput() ServicePrincipalCertificateOutput

func (*ServicePrincipalCertificate) ToServicePrincipalCertificateOutputWithContext

func (i *ServicePrincipalCertificate) ToServicePrincipalCertificateOutputWithContext(ctx context.Context) ServicePrincipalCertificateOutput

type ServicePrincipalCertificateArgs

type ServicePrincipalCertificateArgs struct {
	// Specifies the encoding used for the supplied certificate data. Must be one of `pem`, `base64` or `hex`. Defaults to `pem`.
	//
	// > **Tip for Azure Key Vault** The `hex` encoding option is useful for consuming certificate data from the azurermKeyVaultCertificate resource.
	Encoding pulumi.StringPtrInput
	// The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringPtrInput
	// A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Changing this field forces a new resource to be created.
	//
	// > One of `endDate` or `endDateRelative` must be set. The maximum duration is determined by Azure AD.
	EndDateRelative pulumi.StringPtrInput
	// A UUID used to uniquely identify this certificate. If not specified a UUID will be automatically generated. Changing this field forces a new resource to be created.
	KeyId pulumi.StringPtrInput
	// The object ID of the service principal for which this certificate should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringInput
	// The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the value is determined by Azure Active Directory and is usually the start date of the certificate for asymmetric keys, or the current timestamp for symmetric keys. Changing this field forces a new resource to be created.
	StartDate pulumi.StringPtrInput
	// The type of key/certificate. Must be one of `AsymmetricX509Cert` or `Symmetric`. Changing this fields forces a new resource to be created.
	Type pulumi.StringPtrInput
	// The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argument.
	Value pulumi.StringInput
}

The set of arguments for constructing a ServicePrincipalCertificate resource.

func (ServicePrincipalCertificateArgs) ElementType

type ServicePrincipalCertificateArray

type ServicePrincipalCertificateArray []ServicePrincipalCertificateInput

func (ServicePrincipalCertificateArray) ElementType

func (ServicePrincipalCertificateArray) ToServicePrincipalCertificateArrayOutput

func (i ServicePrincipalCertificateArray) ToServicePrincipalCertificateArrayOutput() ServicePrincipalCertificateArrayOutput

func (ServicePrincipalCertificateArray) ToServicePrincipalCertificateArrayOutputWithContext

func (i ServicePrincipalCertificateArray) ToServicePrincipalCertificateArrayOutputWithContext(ctx context.Context) ServicePrincipalCertificateArrayOutput

type ServicePrincipalCertificateArrayInput

type ServicePrincipalCertificateArrayInput interface {
	pulumi.Input

	ToServicePrincipalCertificateArrayOutput() ServicePrincipalCertificateArrayOutput
	ToServicePrincipalCertificateArrayOutputWithContext(context.Context) ServicePrincipalCertificateArrayOutput
}

ServicePrincipalCertificateArrayInput is an input type that accepts ServicePrincipalCertificateArray and ServicePrincipalCertificateArrayOutput values. You can construct a concrete instance of `ServicePrincipalCertificateArrayInput` via:

ServicePrincipalCertificateArray{ ServicePrincipalCertificateArgs{...} }

type ServicePrincipalCertificateArrayOutput

type ServicePrincipalCertificateArrayOutput struct{ *pulumi.OutputState }

func (ServicePrincipalCertificateArrayOutput) ElementType

func (ServicePrincipalCertificateArrayOutput) Index

func (ServicePrincipalCertificateArrayOutput) ToServicePrincipalCertificateArrayOutput

func (o ServicePrincipalCertificateArrayOutput) ToServicePrincipalCertificateArrayOutput() ServicePrincipalCertificateArrayOutput

func (ServicePrincipalCertificateArrayOutput) ToServicePrincipalCertificateArrayOutputWithContext

func (o ServicePrincipalCertificateArrayOutput) ToServicePrincipalCertificateArrayOutputWithContext(ctx context.Context) ServicePrincipalCertificateArrayOutput

type ServicePrincipalCertificateInput

type ServicePrincipalCertificateInput interface {
	pulumi.Input

	ToServicePrincipalCertificateOutput() ServicePrincipalCertificateOutput
	ToServicePrincipalCertificateOutputWithContext(ctx context.Context) ServicePrincipalCertificateOutput
}

type ServicePrincipalCertificateMap

type ServicePrincipalCertificateMap map[string]ServicePrincipalCertificateInput

func (ServicePrincipalCertificateMap) ElementType

func (ServicePrincipalCertificateMap) ToServicePrincipalCertificateMapOutput

func (i ServicePrincipalCertificateMap) ToServicePrincipalCertificateMapOutput() ServicePrincipalCertificateMapOutput

func (ServicePrincipalCertificateMap) ToServicePrincipalCertificateMapOutputWithContext

func (i ServicePrincipalCertificateMap) ToServicePrincipalCertificateMapOutputWithContext(ctx context.Context) ServicePrincipalCertificateMapOutput

type ServicePrincipalCertificateMapInput

type ServicePrincipalCertificateMapInput interface {
	pulumi.Input

	ToServicePrincipalCertificateMapOutput() ServicePrincipalCertificateMapOutput
	ToServicePrincipalCertificateMapOutputWithContext(context.Context) ServicePrincipalCertificateMapOutput
}

ServicePrincipalCertificateMapInput is an input type that accepts ServicePrincipalCertificateMap and ServicePrincipalCertificateMapOutput values. You can construct a concrete instance of `ServicePrincipalCertificateMapInput` via:

ServicePrincipalCertificateMap{ "key": ServicePrincipalCertificateArgs{...} }

type ServicePrincipalCertificateMapOutput

type ServicePrincipalCertificateMapOutput struct{ *pulumi.OutputState }

func (ServicePrincipalCertificateMapOutput) ElementType

func (ServicePrincipalCertificateMapOutput) MapIndex

func (ServicePrincipalCertificateMapOutput) ToServicePrincipalCertificateMapOutput

func (o ServicePrincipalCertificateMapOutput) ToServicePrincipalCertificateMapOutput() ServicePrincipalCertificateMapOutput

func (ServicePrincipalCertificateMapOutput) ToServicePrincipalCertificateMapOutputWithContext

func (o ServicePrincipalCertificateMapOutput) ToServicePrincipalCertificateMapOutputWithContext(ctx context.Context) ServicePrincipalCertificateMapOutput

type ServicePrincipalCertificateOutput

type ServicePrincipalCertificateOutput struct{ *pulumi.OutputState }

func (ServicePrincipalCertificateOutput) ElementType

func (ServicePrincipalCertificateOutput) Encoding added in v5.22.0

Specifies the encoding used for the supplied certificate data. Must be one of `pem`, `base64` or `hex`. Defaults to `pem`.

> **Tip for Azure Key Vault** The `hex` encoding option is useful for consuming certificate data from the azurermKeyVaultCertificate resource.

func (ServicePrincipalCertificateOutput) EndDate added in v5.22.0

The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.

func (ServicePrincipalCertificateOutput) EndDateRelative added in v5.22.0

A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Changing this field forces a new resource to be created.

> One of `endDate` or `endDateRelative` must be set. The maximum duration is determined by Azure AD.

func (ServicePrincipalCertificateOutput) KeyId added in v5.22.0

A UUID used to uniquely identify this certificate. If not specified a UUID will be automatically generated. Changing this field forces a new resource to be created.

func (ServicePrincipalCertificateOutput) ServicePrincipalId added in v5.22.0

func (o ServicePrincipalCertificateOutput) ServicePrincipalId() pulumi.StringOutput

The object ID of the service principal for which this certificate should be created. Changing this field forces a new resource to be created.

func (ServicePrincipalCertificateOutput) StartDate added in v5.22.0

The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the value is determined by Azure Active Directory and is usually the start date of the certificate for asymmetric keys, or the current timestamp for symmetric keys. Changing this field forces a new resource to be created.

func (ServicePrincipalCertificateOutput) ToServicePrincipalCertificateOutput

func (o ServicePrincipalCertificateOutput) ToServicePrincipalCertificateOutput() ServicePrincipalCertificateOutput

func (ServicePrincipalCertificateOutput) ToServicePrincipalCertificateOutputWithContext

func (o ServicePrincipalCertificateOutput) ToServicePrincipalCertificateOutputWithContext(ctx context.Context) ServicePrincipalCertificateOutput

func (ServicePrincipalCertificateOutput) Type added in v5.22.0

The type of key/certificate. Must be one of `AsymmetricX509Cert` or `Symmetric`. Changing this fields forces a new resource to be created.

func (ServicePrincipalCertificateOutput) Value added in v5.22.0

The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argument.

type ServicePrincipalCertificateState

type ServicePrincipalCertificateState struct {
	// Specifies the encoding used for the supplied certificate data. Must be one of `pem`, `base64` or `hex`. Defaults to `pem`.
	//
	// > **Tip for Azure Key Vault** The `hex` encoding option is useful for consuming certificate data from the azurermKeyVaultCertificate resource.
	Encoding pulumi.StringPtrInput
	// The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringPtrInput
	// A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Changing this field forces a new resource to be created.
	//
	// > One of `endDate` or `endDateRelative` must be set. The maximum duration is determined by Azure AD.
	EndDateRelative pulumi.StringPtrInput
	// A UUID used to uniquely identify this certificate. If not specified a UUID will be automatically generated. Changing this field forces a new resource to be created.
	KeyId pulumi.StringPtrInput
	// The object ID of the service principal for which this certificate should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringPtrInput
	// The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the value is determined by Azure Active Directory and is usually the start date of the certificate for asymmetric keys, or the current timestamp for symmetric keys. Changing this field forces a new resource to be created.
	StartDate pulumi.StringPtrInput
	// The type of key/certificate. Must be one of `AsymmetricX509Cert` or `Symmetric`. Changing this fields forces a new resource to be created.
	Type pulumi.StringPtrInput
	// The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argument.
	Value pulumi.StringPtrInput
}

func (ServicePrincipalCertificateState) ElementType

type ServicePrincipalClaimsMappingPolicyAssignment added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignment struct {
	pulumi.CustomResourceState

	// The ID of the claims mapping policy to assign.
	ClaimsMappingPolicyId pulumi.StringOutput `pulumi:"claimsMappingPolicyId"`
	// The object ID of the service principal for the policy assignment.
	ServicePrincipalId pulumi.StringOutput `pulumi:"servicePrincipalId"`
}

Manages a Claims Mapping Policy Assignment within 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 roles: `Policy.ReadWrite.ApplicationConfiguration` and `Policy.Read.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `Application Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.NewServicePrincipalClaimsMappingPolicyAssignment(ctx, "app", &azuread.ServicePrincipalClaimsMappingPolicyAssignmentArgs{
			ClaimsMappingPolicyId: pulumi.Any(myPolicy.Id),
			ServicePrincipalId:    pulumi.Any(myPrincipal.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Claims Mapping Policy can be imported using the `id`, in the form `service-principal-uuid/claimsMappingPolicy/claims-mapping-policy-uuid`, e.g:

```sh $ pulumi import azuread:index/servicePrincipalClaimsMappingPolicyAssignment:ServicePrincipalClaimsMappingPolicyAssignment app 00000000-0000-0000-0000-000000000000/claimsMappingPolicy/11111111-0000-0000-0000-000000000000 ```

func GetServicePrincipalClaimsMappingPolicyAssignment added in v5.19.0

func GetServicePrincipalClaimsMappingPolicyAssignment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServicePrincipalClaimsMappingPolicyAssignmentState, opts ...pulumi.ResourceOption) (*ServicePrincipalClaimsMappingPolicyAssignment, error)

GetServicePrincipalClaimsMappingPolicyAssignment gets an existing ServicePrincipalClaimsMappingPolicyAssignment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServicePrincipalClaimsMappingPolicyAssignment added in v5.19.0

func NewServicePrincipalClaimsMappingPolicyAssignment(ctx *pulumi.Context,
	name string, args *ServicePrincipalClaimsMappingPolicyAssignmentArgs, opts ...pulumi.ResourceOption) (*ServicePrincipalClaimsMappingPolicyAssignment, error)

NewServicePrincipalClaimsMappingPolicyAssignment registers a new resource with the given unique name, arguments, and options.

func (*ServicePrincipalClaimsMappingPolicyAssignment) ElementType added in v5.19.0

func (*ServicePrincipalClaimsMappingPolicyAssignment) ToServicePrincipalClaimsMappingPolicyAssignmentOutput added in v5.19.0

func (i *ServicePrincipalClaimsMappingPolicyAssignment) ToServicePrincipalClaimsMappingPolicyAssignmentOutput() ServicePrincipalClaimsMappingPolicyAssignmentOutput

func (*ServicePrincipalClaimsMappingPolicyAssignment) ToServicePrincipalClaimsMappingPolicyAssignmentOutputWithContext added in v5.19.0

func (i *ServicePrincipalClaimsMappingPolicyAssignment) ToServicePrincipalClaimsMappingPolicyAssignmentOutputWithContext(ctx context.Context) ServicePrincipalClaimsMappingPolicyAssignmentOutput

type ServicePrincipalClaimsMappingPolicyAssignmentArgs added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentArgs struct {
	// The ID of the claims mapping policy to assign.
	ClaimsMappingPolicyId pulumi.StringInput
	// The object ID of the service principal for the policy assignment.
	ServicePrincipalId pulumi.StringInput
}

The set of arguments for constructing a ServicePrincipalClaimsMappingPolicyAssignment resource.

func (ServicePrincipalClaimsMappingPolicyAssignmentArgs) ElementType added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentArray added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentArray []ServicePrincipalClaimsMappingPolicyAssignmentInput

func (ServicePrincipalClaimsMappingPolicyAssignmentArray) ElementType added in v5.19.0

func (ServicePrincipalClaimsMappingPolicyAssignmentArray) ToServicePrincipalClaimsMappingPolicyAssignmentArrayOutput added in v5.19.0

func (i ServicePrincipalClaimsMappingPolicyAssignmentArray) ToServicePrincipalClaimsMappingPolicyAssignmentArrayOutput() ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput

func (ServicePrincipalClaimsMappingPolicyAssignmentArray) ToServicePrincipalClaimsMappingPolicyAssignmentArrayOutputWithContext added in v5.19.0

func (i ServicePrincipalClaimsMappingPolicyAssignmentArray) ToServicePrincipalClaimsMappingPolicyAssignmentArrayOutputWithContext(ctx context.Context) ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput

type ServicePrincipalClaimsMappingPolicyAssignmentArrayInput added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentArrayInput interface {
	pulumi.Input

	ToServicePrincipalClaimsMappingPolicyAssignmentArrayOutput() ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput
	ToServicePrincipalClaimsMappingPolicyAssignmentArrayOutputWithContext(context.Context) ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput
}

ServicePrincipalClaimsMappingPolicyAssignmentArrayInput is an input type that accepts ServicePrincipalClaimsMappingPolicyAssignmentArray and ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput values. You can construct a concrete instance of `ServicePrincipalClaimsMappingPolicyAssignmentArrayInput` via:

ServicePrincipalClaimsMappingPolicyAssignmentArray{ ServicePrincipalClaimsMappingPolicyAssignmentArgs{...} }

type ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput struct{ *pulumi.OutputState }

func (ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput) ElementType added in v5.19.0

func (ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput) Index added in v5.19.0

func (ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput) ToServicePrincipalClaimsMappingPolicyAssignmentArrayOutput added in v5.19.0

func (ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput) ToServicePrincipalClaimsMappingPolicyAssignmentArrayOutputWithContext added in v5.19.0

func (o ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput) ToServicePrincipalClaimsMappingPolicyAssignmentArrayOutputWithContext(ctx context.Context) ServicePrincipalClaimsMappingPolicyAssignmentArrayOutput

type ServicePrincipalClaimsMappingPolicyAssignmentInput added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentInput interface {
	pulumi.Input

	ToServicePrincipalClaimsMappingPolicyAssignmentOutput() ServicePrincipalClaimsMappingPolicyAssignmentOutput
	ToServicePrincipalClaimsMappingPolicyAssignmentOutputWithContext(ctx context.Context) ServicePrincipalClaimsMappingPolicyAssignmentOutput
}

type ServicePrincipalClaimsMappingPolicyAssignmentMap added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentMap map[string]ServicePrincipalClaimsMappingPolicyAssignmentInput

func (ServicePrincipalClaimsMappingPolicyAssignmentMap) ElementType added in v5.19.0

func (ServicePrincipalClaimsMappingPolicyAssignmentMap) ToServicePrincipalClaimsMappingPolicyAssignmentMapOutput added in v5.19.0

func (i ServicePrincipalClaimsMappingPolicyAssignmentMap) ToServicePrincipalClaimsMappingPolicyAssignmentMapOutput() ServicePrincipalClaimsMappingPolicyAssignmentMapOutput

func (ServicePrincipalClaimsMappingPolicyAssignmentMap) ToServicePrincipalClaimsMappingPolicyAssignmentMapOutputWithContext added in v5.19.0

func (i ServicePrincipalClaimsMappingPolicyAssignmentMap) ToServicePrincipalClaimsMappingPolicyAssignmentMapOutputWithContext(ctx context.Context) ServicePrincipalClaimsMappingPolicyAssignmentMapOutput

type ServicePrincipalClaimsMappingPolicyAssignmentMapInput added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentMapInput interface {
	pulumi.Input

	ToServicePrincipalClaimsMappingPolicyAssignmentMapOutput() ServicePrincipalClaimsMappingPolicyAssignmentMapOutput
	ToServicePrincipalClaimsMappingPolicyAssignmentMapOutputWithContext(context.Context) ServicePrincipalClaimsMappingPolicyAssignmentMapOutput
}

ServicePrincipalClaimsMappingPolicyAssignmentMapInput is an input type that accepts ServicePrincipalClaimsMappingPolicyAssignmentMap and ServicePrincipalClaimsMappingPolicyAssignmentMapOutput values. You can construct a concrete instance of `ServicePrincipalClaimsMappingPolicyAssignmentMapInput` via:

ServicePrincipalClaimsMappingPolicyAssignmentMap{ "key": ServicePrincipalClaimsMappingPolicyAssignmentArgs{...} }

type ServicePrincipalClaimsMappingPolicyAssignmentMapOutput added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentMapOutput struct{ *pulumi.OutputState }

func (ServicePrincipalClaimsMappingPolicyAssignmentMapOutput) ElementType added in v5.19.0

func (ServicePrincipalClaimsMappingPolicyAssignmentMapOutput) MapIndex added in v5.19.0

func (ServicePrincipalClaimsMappingPolicyAssignmentMapOutput) ToServicePrincipalClaimsMappingPolicyAssignmentMapOutput added in v5.19.0

func (ServicePrincipalClaimsMappingPolicyAssignmentMapOutput) ToServicePrincipalClaimsMappingPolicyAssignmentMapOutputWithContext added in v5.19.0

func (o ServicePrincipalClaimsMappingPolicyAssignmentMapOutput) ToServicePrincipalClaimsMappingPolicyAssignmentMapOutputWithContext(ctx context.Context) ServicePrincipalClaimsMappingPolicyAssignmentMapOutput

type ServicePrincipalClaimsMappingPolicyAssignmentOutput added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentOutput struct{ *pulumi.OutputState }

func (ServicePrincipalClaimsMappingPolicyAssignmentOutput) ClaimsMappingPolicyId added in v5.22.0

The ID of the claims mapping policy to assign.

func (ServicePrincipalClaimsMappingPolicyAssignmentOutput) ElementType added in v5.19.0

func (ServicePrincipalClaimsMappingPolicyAssignmentOutput) ServicePrincipalId added in v5.22.0

The object ID of the service principal for the policy assignment.

func (ServicePrincipalClaimsMappingPolicyAssignmentOutput) ToServicePrincipalClaimsMappingPolicyAssignmentOutput added in v5.19.0

func (o ServicePrincipalClaimsMappingPolicyAssignmentOutput) ToServicePrincipalClaimsMappingPolicyAssignmentOutput() ServicePrincipalClaimsMappingPolicyAssignmentOutput

func (ServicePrincipalClaimsMappingPolicyAssignmentOutput) ToServicePrincipalClaimsMappingPolicyAssignmentOutputWithContext added in v5.19.0

func (o ServicePrincipalClaimsMappingPolicyAssignmentOutput) ToServicePrincipalClaimsMappingPolicyAssignmentOutputWithContext(ctx context.Context) ServicePrincipalClaimsMappingPolicyAssignmentOutput

type ServicePrincipalClaimsMappingPolicyAssignmentState added in v5.19.0

type ServicePrincipalClaimsMappingPolicyAssignmentState struct {
	// The ID of the claims mapping policy to assign.
	ClaimsMappingPolicyId pulumi.StringPtrInput
	// The object ID of the service principal for the policy assignment.
	ServicePrincipalId pulumi.StringPtrInput
}

func (ServicePrincipalClaimsMappingPolicyAssignmentState) ElementType added in v5.19.0

type ServicePrincipalDelegatedPermissionGrant added in v5.10.0

type ServicePrincipalDelegatedPermissionGrant struct {
	pulumi.CustomResourceState

	// A set of claim values for delegated permission scopes which should be included in access tokens for the resource.
	ClaimValues pulumi.StringArrayOutput `pulumi:"claimValues"`
	// The object ID of the service principal representing the resource to be accessed. Changing this forces a new resource to be created.
	ResourceServicePrincipalObjectId pulumi.StringOutput `pulumi:"resourceServicePrincipalObjectId"`
	// The object ID of the service principal for which this delegated permission grant should be created. Changing this forces a new resource to be created.
	ServicePrincipalObjectId pulumi.StringOutput `pulumi:"servicePrincipalObjectId"`
	// The object ID of the user on behalf of whom the service principal is authorized to access the resource. When omitted, the delegated permission grant will be consented for all users. Changing this forces a new resource to be created.
	//
	// > **Granting Admin Consent** To grant admin consent for the service principal to impersonate all users, just omit the `userObjectId` property.
	UserObjectId pulumi.StringPtrOutput `pulumi:"userObjectId"`
}

Manages a delegated permission grant for a service principal, on behalf of a single user, or all users.

## 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: `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one the following directory role: `Global Administrator`

## Example Usage

*Delegated permission grant for all users*

<!--Start PulumiCodeChooser --> ```go 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 {
		wellKnown, err := azuread.GetApplicationPublishedAppIds(ctx, nil, nil)
		if err != nil {
			return err
		}
		msgraph, err := azuread.NewServicePrincipal(ctx, "msgraph", &azuread.ServicePrincipalArgs{
			ApplicationId: pulumi.String(wellKnown.Result.MicrosoftGraph),
			UseExisting:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			RequiredResourceAccesses: azuread.ApplicationRequiredResourceAccessArray{
				&azuread.ApplicationRequiredResourceAccessArgs{
					ResourceAppId: pulumi.String(wellKnown.Result.MicrosoftGraph),
					ResourceAccesses: azuread.ApplicationRequiredResourceAccessResourceAccessArray{
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id: msgraph.Oauth2PermissionScopeIds.ApplyT(func(oauth2PermissionScopeIds map[string]string) (string, error) {
								return oauth2PermissionScopeIds.Openid, nil
							}).(pulumi.StringOutput),
							Type: pulumi.String("Scope"),
						},
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id: msgraph.Oauth2PermissionScopeIds.ApplyT(func(oauth2PermissionScopeIds map[string]string) (string, error) {
								return oauth2PermissionScopeIds.User.Read, nil
							}).(pulumi.StringOutput),
							Type: pulumi.String("Scope"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ApplicationId: example.ApplicationId,
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipalDelegatedPermissionGrant(ctx, "example", &azuread.ServicePrincipalDelegatedPermissionGrantArgs{
			ServicePrincipalObjectId:         exampleServicePrincipal.ObjectId,
			ResourceServicePrincipalObjectId: msgraph.ObjectId,
			ClaimValues: pulumi.StringArray{
				pulumi.String("openid"),
				pulumi.String("User.Read.All"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Delegated permission grant for a single user*

<!--Start PulumiCodeChooser --> ```go 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 {
		wellKnown, err := azuread.GetApplicationPublishedAppIds(ctx, nil, nil)
		if err != nil {
			return err
		}
		msgraph, err := azuread.NewServicePrincipal(ctx, "msgraph", &azuread.ServicePrincipalArgs{
			ApplicationId: pulumi.String(wellKnown.Result.MicrosoftGraph),
			UseExisting:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			RequiredResourceAccesses: azuread.ApplicationRequiredResourceAccessArray{
				&azuread.ApplicationRequiredResourceAccessArgs{
					ResourceAppId: pulumi.String(wellKnown.Result.MicrosoftGraph),
					ResourceAccesses: azuread.ApplicationRequiredResourceAccessResourceAccessArray{
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id: msgraph.Oauth2PermissionScopeIds.ApplyT(func(oauth2PermissionScopeIds map[string]string) (string, error) {
								return oauth2PermissionScopeIds.Openid, nil
							}).(pulumi.StringOutput),
							Type: pulumi.String("Scope"),
						},
						&azuread.ApplicationRequiredResourceAccessResourceAccessArgs{
							Id: msgraph.Oauth2PermissionScopeIds.ApplyT(func(oauth2PermissionScopeIds map[string]string) (string, error) {
								return oauth2PermissionScopeIds.User.Read, nil
							}).(pulumi.StringOutput),
							Type: pulumi.String("Scope"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ApplicationId: example.ApplicationId,
		})
		if err != nil {
			return err
		}
		exampleUser, err := azuread.NewUser(ctx, "example", &azuread.UserArgs{
			DisplayName:       pulumi.String("J. Doe"),
			UserPrincipalName: pulumi.String("jdoe@example.com"),
			MailNickname:      pulumi.String("jdoe"),
			Password:          pulumi.String("SecretP@sswd99!"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipalDelegatedPermissionGrant(ctx, "example", &azuread.ServicePrincipalDelegatedPermissionGrantArgs{
			ServicePrincipalObjectId:         exampleServicePrincipal.ObjectId,
			ResourceServicePrincipalObjectId: msgraph.ObjectId,
			ClaimValues: pulumi.StringArray{
				pulumi.String("openid"),
				pulumi.String("User.Read.All"),
			},
			UserObjectId: exampleUser.ObjectId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Delegated permission grants can be imported using their ID, e.g.

```sh $ pulumi import azuread:index/servicePrincipalDelegatedPermissionGrant:ServicePrincipalDelegatedPermissionGrant example aaBBcDDeFG6h5JKLMN2PQrrssTTUUvWWxxxxxyyyzzz ```

func GetServicePrincipalDelegatedPermissionGrant added in v5.10.0

func GetServicePrincipalDelegatedPermissionGrant(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServicePrincipalDelegatedPermissionGrantState, opts ...pulumi.ResourceOption) (*ServicePrincipalDelegatedPermissionGrant, error)

GetServicePrincipalDelegatedPermissionGrant gets an existing ServicePrincipalDelegatedPermissionGrant resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServicePrincipalDelegatedPermissionGrant added in v5.10.0

func NewServicePrincipalDelegatedPermissionGrant(ctx *pulumi.Context,
	name string, args *ServicePrincipalDelegatedPermissionGrantArgs, opts ...pulumi.ResourceOption) (*ServicePrincipalDelegatedPermissionGrant, error)

NewServicePrincipalDelegatedPermissionGrant registers a new resource with the given unique name, arguments, and options.

func (*ServicePrincipalDelegatedPermissionGrant) ElementType added in v5.10.0

func (*ServicePrincipalDelegatedPermissionGrant) ToServicePrincipalDelegatedPermissionGrantOutput added in v5.10.0

func (i *ServicePrincipalDelegatedPermissionGrant) ToServicePrincipalDelegatedPermissionGrantOutput() ServicePrincipalDelegatedPermissionGrantOutput

func (*ServicePrincipalDelegatedPermissionGrant) ToServicePrincipalDelegatedPermissionGrantOutputWithContext added in v5.10.0

func (i *ServicePrincipalDelegatedPermissionGrant) ToServicePrincipalDelegatedPermissionGrantOutputWithContext(ctx context.Context) ServicePrincipalDelegatedPermissionGrantOutput

type ServicePrincipalDelegatedPermissionGrantArgs added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantArgs struct {
	// A set of claim values for delegated permission scopes which should be included in access tokens for the resource.
	ClaimValues pulumi.StringArrayInput
	// The object ID of the service principal representing the resource to be accessed. Changing this forces a new resource to be created.
	ResourceServicePrincipalObjectId pulumi.StringInput
	// The object ID of the service principal for which this delegated permission grant should be created. Changing this forces a new resource to be created.
	ServicePrincipalObjectId pulumi.StringInput
	// The object ID of the user on behalf of whom the service principal is authorized to access the resource. When omitted, the delegated permission grant will be consented for all users. Changing this forces a new resource to be created.
	//
	// > **Granting Admin Consent** To grant admin consent for the service principal to impersonate all users, just omit the `userObjectId` property.
	UserObjectId pulumi.StringPtrInput
}

The set of arguments for constructing a ServicePrincipalDelegatedPermissionGrant resource.

func (ServicePrincipalDelegatedPermissionGrantArgs) ElementType added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantArray added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantArray []ServicePrincipalDelegatedPermissionGrantInput

func (ServicePrincipalDelegatedPermissionGrantArray) ElementType added in v5.10.0

func (ServicePrincipalDelegatedPermissionGrantArray) ToServicePrincipalDelegatedPermissionGrantArrayOutput added in v5.10.0

func (i ServicePrincipalDelegatedPermissionGrantArray) ToServicePrincipalDelegatedPermissionGrantArrayOutput() ServicePrincipalDelegatedPermissionGrantArrayOutput

func (ServicePrincipalDelegatedPermissionGrantArray) ToServicePrincipalDelegatedPermissionGrantArrayOutputWithContext added in v5.10.0

func (i ServicePrincipalDelegatedPermissionGrantArray) ToServicePrincipalDelegatedPermissionGrantArrayOutputWithContext(ctx context.Context) ServicePrincipalDelegatedPermissionGrantArrayOutput

type ServicePrincipalDelegatedPermissionGrantArrayInput added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantArrayInput interface {
	pulumi.Input

	ToServicePrincipalDelegatedPermissionGrantArrayOutput() ServicePrincipalDelegatedPermissionGrantArrayOutput
	ToServicePrincipalDelegatedPermissionGrantArrayOutputWithContext(context.Context) ServicePrincipalDelegatedPermissionGrantArrayOutput
}

ServicePrincipalDelegatedPermissionGrantArrayInput is an input type that accepts ServicePrincipalDelegatedPermissionGrantArray and ServicePrincipalDelegatedPermissionGrantArrayOutput values. You can construct a concrete instance of `ServicePrincipalDelegatedPermissionGrantArrayInput` via:

ServicePrincipalDelegatedPermissionGrantArray{ ServicePrincipalDelegatedPermissionGrantArgs{...} }

type ServicePrincipalDelegatedPermissionGrantArrayOutput added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantArrayOutput struct{ *pulumi.OutputState }

func (ServicePrincipalDelegatedPermissionGrantArrayOutput) ElementType added in v5.10.0

func (ServicePrincipalDelegatedPermissionGrantArrayOutput) Index added in v5.10.0

func (ServicePrincipalDelegatedPermissionGrantArrayOutput) ToServicePrincipalDelegatedPermissionGrantArrayOutput added in v5.10.0

func (o ServicePrincipalDelegatedPermissionGrantArrayOutput) ToServicePrincipalDelegatedPermissionGrantArrayOutput() ServicePrincipalDelegatedPermissionGrantArrayOutput

func (ServicePrincipalDelegatedPermissionGrantArrayOutput) ToServicePrincipalDelegatedPermissionGrantArrayOutputWithContext added in v5.10.0

func (o ServicePrincipalDelegatedPermissionGrantArrayOutput) ToServicePrincipalDelegatedPermissionGrantArrayOutputWithContext(ctx context.Context) ServicePrincipalDelegatedPermissionGrantArrayOutput

type ServicePrincipalDelegatedPermissionGrantInput added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantInput interface {
	pulumi.Input

	ToServicePrincipalDelegatedPermissionGrantOutput() ServicePrincipalDelegatedPermissionGrantOutput
	ToServicePrincipalDelegatedPermissionGrantOutputWithContext(ctx context.Context) ServicePrincipalDelegatedPermissionGrantOutput
}

type ServicePrincipalDelegatedPermissionGrantMap added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantMap map[string]ServicePrincipalDelegatedPermissionGrantInput

func (ServicePrincipalDelegatedPermissionGrantMap) ElementType added in v5.10.0

func (ServicePrincipalDelegatedPermissionGrantMap) ToServicePrincipalDelegatedPermissionGrantMapOutput added in v5.10.0

func (i ServicePrincipalDelegatedPermissionGrantMap) ToServicePrincipalDelegatedPermissionGrantMapOutput() ServicePrincipalDelegatedPermissionGrantMapOutput

func (ServicePrincipalDelegatedPermissionGrantMap) ToServicePrincipalDelegatedPermissionGrantMapOutputWithContext added in v5.10.0

func (i ServicePrincipalDelegatedPermissionGrantMap) ToServicePrincipalDelegatedPermissionGrantMapOutputWithContext(ctx context.Context) ServicePrincipalDelegatedPermissionGrantMapOutput

type ServicePrincipalDelegatedPermissionGrantMapInput added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantMapInput interface {
	pulumi.Input

	ToServicePrincipalDelegatedPermissionGrantMapOutput() ServicePrincipalDelegatedPermissionGrantMapOutput
	ToServicePrincipalDelegatedPermissionGrantMapOutputWithContext(context.Context) ServicePrincipalDelegatedPermissionGrantMapOutput
}

ServicePrincipalDelegatedPermissionGrantMapInput is an input type that accepts ServicePrincipalDelegatedPermissionGrantMap and ServicePrincipalDelegatedPermissionGrantMapOutput values. You can construct a concrete instance of `ServicePrincipalDelegatedPermissionGrantMapInput` via:

ServicePrincipalDelegatedPermissionGrantMap{ "key": ServicePrincipalDelegatedPermissionGrantArgs{...} }

type ServicePrincipalDelegatedPermissionGrantMapOutput added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantMapOutput struct{ *pulumi.OutputState }

func (ServicePrincipalDelegatedPermissionGrantMapOutput) ElementType added in v5.10.0

func (ServicePrincipalDelegatedPermissionGrantMapOutput) MapIndex added in v5.10.0

func (ServicePrincipalDelegatedPermissionGrantMapOutput) ToServicePrincipalDelegatedPermissionGrantMapOutput added in v5.10.0

func (o ServicePrincipalDelegatedPermissionGrantMapOutput) ToServicePrincipalDelegatedPermissionGrantMapOutput() ServicePrincipalDelegatedPermissionGrantMapOutput

func (ServicePrincipalDelegatedPermissionGrantMapOutput) ToServicePrincipalDelegatedPermissionGrantMapOutputWithContext added in v5.10.0

func (o ServicePrincipalDelegatedPermissionGrantMapOutput) ToServicePrincipalDelegatedPermissionGrantMapOutputWithContext(ctx context.Context) ServicePrincipalDelegatedPermissionGrantMapOutput

type ServicePrincipalDelegatedPermissionGrantOutput added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantOutput struct{ *pulumi.OutputState }

func (ServicePrincipalDelegatedPermissionGrantOutput) ClaimValues added in v5.22.0

A set of claim values for delegated permission scopes which should be included in access tokens for the resource.

func (ServicePrincipalDelegatedPermissionGrantOutput) ElementType added in v5.10.0

func (ServicePrincipalDelegatedPermissionGrantOutput) ResourceServicePrincipalObjectId added in v5.22.0

func (o ServicePrincipalDelegatedPermissionGrantOutput) ResourceServicePrincipalObjectId() pulumi.StringOutput

The object ID of the service principal representing the resource to be accessed. Changing this forces a new resource to be created.

func (ServicePrincipalDelegatedPermissionGrantOutput) ServicePrincipalObjectId added in v5.22.0

The object ID of the service principal for which this delegated permission grant should be created. Changing this forces a new resource to be created.

func (ServicePrincipalDelegatedPermissionGrantOutput) ToServicePrincipalDelegatedPermissionGrantOutput added in v5.10.0

func (o ServicePrincipalDelegatedPermissionGrantOutput) ToServicePrincipalDelegatedPermissionGrantOutput() ServicePrincipalDelegatedPermissionGrantOutput

func (ServicePrincipalDelegatedPermissionGrantOutput) ToServicePrincipalDelegatedPermissionGrantOutputWithContext added in v5.10.0

func (o ServicePrincipalDelegatedPermissionGrantOutput) ToServicePrincipalDelegatedPermissionGrantOutputWithContext(ctx context.Context) ServicePrincipalDelegatedPermissionGrantOutput

func (ServicePrincipalDelegatedPermissionGrantOutput) UserObjectId added in v5.22.0

The object ID of the user on behalf of whom the service principal is authorized to access the resource. When omitted, the delegated permission grant will be consented for all users. Changing this forces a new resource to be created.

> **Granting Admin Consent** To grant admin consent for the service principal to impersonate all users, just omit the `userObjectId` property.

type ServicePrincipalDelegatedPermissionGrantState added in v5.10.0

type ServicePrincipalDelegatedPermissionGrantState struct {
	// A set of claim values for delegated permission scopes which should be included in access tokens for the resource.
	ClaimValues pulumi.StringArrayInput
	// The object ID of the service principal representing the resource to be accessed. Changing this forces a new resource to be created.
	ResourceServicePrincipalObjectId pulumi.StringPtrInput
	// The object ID of the service principal for which this delegated permission grant should be created. Changing this forces a new resource to be created.
	ServicePrincipalObjectId pulumi.StringPtrInput
	// The object ID of the user on behalf of whom the service principal is authorized to access the resource. When omitted, the delegated permission grant will be consented for all users. Changing this forces a new resource to be created.
	//
	// > **Granting Admin Consent** To grant admin consent for the service principal to impersonate all users, just omit the `userObjectId` property.
	UserObjectId pulumi.StringPtrInput
}

func (ServicePrincipalDelegatedPermissionGrantState) ElementType added in v5.10.0

type ServicePrincipalFeature added in v5.3.0

type ServicePrincipalFeature struct {
	// Whether this service principal represents a custom SAML application
	CustomSingleSignOnApp *bool `pulumi:"customSingleSignOnApp"`
	// Whether this service principal represents an Enterprise Application
	EnterpriseApplication *bool `pulumi:"enterpriseApplication"`
	// Whether this service principal represents a gallery application
	GalleryApplication *bool `pulumi:"galleryApplication"`
	// Whether this app is visible to users in My Apps and Office 365 Launcher
	VisibleToUsers *bool `pulumi:"visibleToUsers"`
}

type ServicePrincipalFeatureArgs added in v5.3.0

type ServicePrincipalFeatureArgs struct {
	// Whether this service principal represents a custom SAML application
	CustomSingleSignOnApp pulumi.BoolPtrInput `pulumi:"customSingleSignOnApp"`
	// Whether this service principal represents an Enterprise Application
	EnterpriseApplication pulumi.BoolPtrInput `pulumi:"enterpriseApplication"`
	// Whether this service principal represents a gallery application
	GalleryApplication pulumi.BoolPtrInput `pulumi:"galleryApplication"`
	// Whether this app is visible to users in My Apps and Office 365 Launcher
	VisibleToUsers pulumi.BoolPtrInput `pulumi:"visibleToUsers"`
}

func (ServicePrincipalFeatureArgs) ElementType added in v5.3.0

func (ServicePrincipalFeatureArgs) ToServicePrincipalFeatureOutput added in v5.3.0

func (i ServicePrincipalFeatureArgs) ToServicePrincipalFeatureOutput() ServicePrincipalFeatureOutput

func (ServicePrincipalFeatureArgs) ToServicePrincipalFeatureOutputWithContext added in v5.3.0

func (i ServicePrincipalFeatureArgs) ToServicePrincipalFeatureOutputWithContext(ctx context.Context) ServicePrincipalFeatureOutput

type ServicePrincipalFeatureArray added in v5.3.0

type ServicePrincipalFeatureArray []ServicePrincipalFeatureInput

func (ServicePrincipalFeatureArray) ElementType added in v5.3.0

func (ServicePrincipalFeatureArray) ToServicePrincipalFeatureArrayOutput added in v5.3.0

func (i ServicePrincipalFeatureArray) ToServicePrincipalFeatureArrayOutput() ServicePrincipalFeatureArrayOutput

func (ServicePrincipalFeatureArray) ToServicePrincipalFeatureArrayOutputWithContext added in v5.3.0

func (i ServicePrincipalFeatureArray) ToServicePrincipalFeatureArrayOutputWithContext(ctx context.Context) ServicePrincipalFeatureArrayOutput

type ServicePrincipalFeatureArrayInput added in v5.3.0

type ServicePrincipalFeatureArrayInput interface {
	pulumi.Input

	ToServicePrincipalFeatureArrayOutput() ServicePrincipalFeatureArrayOutput
	ToServicePrincipalFeatureArrayOutputWithContext(context.Context) ServicePrincipalFeatureArrayOutput
}

ServicePrincipalFeatureArrayInput is an input type that accepts ServicePrincipalFeatureArray and ServicePrincipalFeatureArrayOutput values. You can construct a concrete instance of `ServicePrincipalFeatureArrayInput` via:

ServicePrincipalFeatureArray{ ServicePrincipalFeatureArgs{...} }

type ServicePrincipalFeatureArrayOutput added in v5.3.0

type ServicePrincipalFeatureArrayOutput struct{ *pulumi.OutputState }

func (ServicePrincipalFeatureArrayOutput) ElementType added in v5.3.0

func (ServicePrincipalFeatureArrayOutput) Index added in v5.3.0

func (ServicePrincipalFeatureArrayOutput) ToServicePrincipalFeatureArrayOutput added in v5.3.0

func (o ServicePrincipalFeatureArrayOutput) ToServicePrincipalFeatureArrayOutput() ServicePrincipalFeatureArrayOutput

func (ServicePrincipalFeatureArrayOutput) ToServicePrincipalFeatureArrayOutputWithContext added in v5.3.0

func (o ServicePrincipalFeatureArrayOutput) ToServicePrincipalFeatureArrayOutputWithContext(ctx context.Context) ServicePrincipalFeatureArrayOutput

type ServicePrincipalFeatureInput added in v5.3.0

type ServicePrincipalFeatureInput interface {
	pulumi.Input

	ToServicePrincipalFeatureOutput() ServicePrincipalFeatureOutput
	ToServicePrincipalFeatureOutputWithContext(context.Context) ServicePrincipalFeatureOutput
}

ServicePrincipalFeatureInput is an input type that accepts ServicePrincipalFeatureArgs and ServicePrincipalFeatureOutput values. You can construct a concrete instance of `ServicePrincipalFeatureInput` via:

ServicePrincipalFeatureArgs{...}

type ServicePrincipalFeatureOutput added in v5.3.0

type ServicePrincipalFeatureOutput struct{ *pulumi.OutputState }

func (ServicePrincipalFeatureOutput) CustomSingleSignOnApp added in v5.3.0

func (o ServicePrincipalFeatureOutput) CustomSingleSignOnApp() pulumi.BoolPtrOutput

Whether this service principal represents a custom SAML application

func (ServicePrincipalFeatureOutput) ElementType added in v5.3.0

func (ServicePrincipalFeatureOutput) EnterpriseApplication added in v5.3.0

func (o ServicePrincipalFeatureOutput) EnterpriseApplication() pulumi.BoolPtrOutput

Whether this service principal represents an Enterprise Application

func (ServicePrincipalFeatureOutput) GalleryApplication added in v5.3.0

func (o ServicePrincipalFeatureOutput) GalleryApplication() pulumi.BoolPtrOutput

Whether this service principal represents a gallery application

func (ServicePrincipalFeatureOutput) ToServicePrincipalFeatureOutput added in v5.3.0

func (o ServicePrincipalFeatureOutput) ToServicePrincipalFeatureOutput() ServicePrincipalFeatureOutput

func (ServicePrincipalFeatureOutput) ToServicePrincipalFeatureOutputWithContext added in v5.3.0

func (o ServicePrincipalFeatureOutput) ToServicePrincipalFeatureOutputWithContext(ctx context.Context) ServicePrincipalFeatureOutput

func (ServicePrincipalFeatureOutput) VisibleToUsers added in v5.3.0

Whether this app is visible to users in My Apps and Office 365 Launcher

type ServicePrincipalFeatureTag added in v5.6.0

type ServicePrincipalFeatureTag struct {
	// Whether this service principal represents a custom SAML application. Enabling this will assign the `WindowsAzureActiveDirectoryCustomSingleSignOnApplication` tag. Defaults to `false`.
	CustomSingleSignOn *bool `pulumi:"customSingleSignOn"`
	// Whether this service principal represents an Enterprise Application. Enabling this will assign the `WindowsAzureActiveDirectoryIntegratedApp` tag. Defaults to `false`.
	Enterprise *bool `pulumi:"enterprise"`
	// Whether this service principal represents a gallery application. Enabling this will assign the `WindowsAzureActiveDirectoryGalleryApplicationNonPrimaryV1` tag. Defaults to `false`.
	Gallery *bool `pulumi:"gallery"`
	// Whether this app is invisible to users in My Apps and Office 365 Launcher. Enabling this will assign the `HideApp` tag. Defaults to `false`.
	Hide *bool `pulumi:"hide"`
}

type ServicePrincipalFeatureTagArgs added in v5.6.0

type ServicePrincipalFeatureTagArgs struct {
	// Whether this service principal represents a custom SAML application. Enabling this will assign the `WindowsAzureActiveDirectoryCustomSingleSignOnApplication` tag. Defaults to `false`.
	CustomSingleSignOn pulumi.BoolPtrInput `pulumi:"customSingleSignOn"`
	// Whether this service principal represents an Enterprise Application. Enabling this will assign the `WindowsAzureActiveDirectoryIntegratedApp` tag. Defaults to `false`.
	Enterprise pulumi.BoolPtrInput `pulumi:"enterprise"`
	// Whether this service principal represents a gallery application. Enabling this will assign the `WindowsAzureActiveDirectoryGalleryApplicationNonPrimaryV1` tag. Defaults to `false`.
	Gallery pulumi.BoolPtrInput `pulumi:"gallery"`
	// Whether this app is invisible to users in My Apps and Office 365 Launcher. Enabling this will assign the `HideApp` tag. Defaults to `false`.
	Hide pulumi.BoolPtrInput `pulumi:"hide"`
}

func (ServicePrincipalFeatureTagArgs) ElementType added in v5.6.0

func (ServicePrincipalFeatureTagArgs) ToServicePrincipalFeatureTagOutput added in v5.6.0

func (i ServicePrincipalFeatureTagArgs) ToServicePrincipalFeatureTagOutput() ServicePrincipalFeatureTagOutput

func (ServicePrincipalFeatureTagArgs) ToServicePrincipalFeatureTagOutputWithContext added in v5.6.0

func (i ServicePrincipalFeatureTagArgs) ToServicePrincipalFeatureTagOutputWithContext(ctx context.Context) ServicePrincipalFeatureTagOutput

type ServicePrincipalFeatureTagArray added in v5.6.0

type ServicePrincipalFeatureTagArray []ServicePrincipalFeatureTagInput

func (ServicePrincipalFeatureTagArray) ElementType added in v5.6.0

func (ServicePrincipalFeatureTagArray) ToServicePrincipalFeatureTagArrayOutput added in v5.6.0

func (i ServicePrincipalFeatureTagArray) ToServicePrincipalFeatureTagArrayOutput() ServicePrincipalFeatureTagArrayOutput

func (ServicePrincipalFeatureTagArray) ToServicePrincipalFeatureTagArrayOutputWithContext added in v5.6.0

func (i ServicePrincipalFeatureTagArray) ToServicePrincipalFeatureTagArrayOutputWithContext(ctx context.Context) ServicePrincipalFeatureTagArrayOutput

type ServicePrincipalFeatureTagArrayInput added in v5.6.0

type ServicePrincipalFeatureTagArrayInput interface {
	pulumi.Input

	ToServicePrincipalFeatureTagArrayOutput() ServicePrincipalFeatureTagArrayOutput
	ToServicePrincipalFeatureTagArrayOutputWithContext(context.Context) ServicePrincipalFeatureTagArrayOutput
}

ServicePrincipalFeatureTagArrayInput is an input type that accepts ServicePrincipalFeatureTagArray and ServicePrincipalFeatureTagArrayOutput values. You can construct a concrete instance of `ServicePrincipalFeatureTagArrayInput` via:

ServicePrincipalFeatureTagArray{ ServicePrincipalFeatureTagArgs{...} }

type ServicePrincipalFeatureTagArrayOutput added in v5.6.0

type ServicePrincipalFeatureTagArrayOutput struct{ *pulumi.OutputState }

func (ServicePrincipalFeatureTagArrayOutput) ElementType added in v5.6.0

func (ServicePrincipalFeatureTagArrayOutput) Index added in v5.6.0

func (ServicePrincipalFeatureTagArrayOutput) ToServicePrincipalFeatureTagArrayOutput added in v5.6.0

func (o ServicePrincipalFeatureTagArrayOutput) ToServicePrincipalFeatureTagArrayOutput() ServicePrincipalFeatureTagArrayOutput

func (ServicePrincipalFeatureTagArrayOutput) ToServicePrincipalFeatureTagArrayOutputWithContext added in v5.6.0

func (o ServicePrincipalFeatureTagArrayOutput) ToServicePrincipalFeatureTagArrayOutputWithContext(ctx context.Context) ServicePrincipalFeatureTagArrayOutput

type ServicePrincipalFeatureTagInput added in v5.6.0

type ServicePrincipalFeatureTagInput interface {
	pulumi.Input

	ToServicePrincipalFeatureTagOutput() ServicePrincipalFeatureTagOutput
	ToServicePrincipalFeatureTagOutputWithContext(context.Context) ServicePrincipalFeatureTagOutput
}

ServicePrincipalFeatureTagInput is an input type that accepts ServicePrincipalFeatureTagArgs and ServicePrincipalFeatureTagOutput values. You can construct a concrete instance of `ServicePrincipalFeatureTagInput` via:

ServicePrincipalFeatureTagArgs{...}

type ServicePrincipalFeatureTagOutput added in v5.6.0

type ServicePrincipalFeatureTagOutput struct{ *pulumi.OutputState }

func (ServicePrincipalFeatureTagOutput) CustomSingleSignOn added in v5.6.0

func (o ServicePrincipalFeatureTagOutput) CustomSingleSignOn() pulumi.BoolPtrOutput

Whether this service principal represents a custom SAML application. Enabling this will assign the `WindowsAzureActiveDirectoryCustomSingleSignOnApplication` tag. Defaults to `false`.

func (ServicePrincipalFeatureTagOutput) ElementType added in v5.6.0

func (ServicePrincipalFeatureTagOutput) Enterprise added in v5.6.0

Whether this service principal represents an Enterprise Application. Enabling this will assign the `WindowsAzureActiveDirectoryIntegratedApp` tag. Defaults to `false`.

func (ServicePrincipalFeatureTagOutput) Gallery added in v5.6.0

Whether this service principal represents a gallery application. Enabling this will assign the `WindowsAzureActiveDirectoryGalleryApplicationNonPrimaryV1` tag. Defaults to `false`.

func (ServicePrincipalFeatureTagOutput) Hide added in v5.6.0

Whether this app is invisible to users in My Apps and Office 365 Launcher. Enabling this will assign the `HideApp` tag. Defaults to `false`.

func (ServicePrincipalFeatureTagOutput) ToServicePrincipalFeatureTagOutput added in v5.6.0

func (o ServicePrincipalFeatureTagOutput) ToServicePrincipalFeatureTagOutput() ServicePrincipalFeatureTagOutput

func (ServicePrincipalFeatureTagOutput) ToServicePrincipalFeatureTagOutputWithContext added in v5.6.0

func (o ServicePrincipalFeatureTagOutput) ToServicePrincipalFeatureTagOutputWithContext(ctx context.Context) ServicePrincipalFeatureTagOutput

type ServicePrincipalInput

type ServicePrincipalInput interface {
	pulumi.Input

	ToServicePrincipalOutput() ServicePrincipalOutput
	ToServicePrincipalOutputWithContext(ctx context.Context) ServicePrincipalOutput
}

type ServicePrincipalMap

type ServicePrincipalMap map[string]ServicePrincipalInput

func (ServicePrincipalMap) ElementType

func (ServicePrincipalMap) ElementType() reflect.Type

func (ServicePrincipalMap) ToServicePrincipalMapOutput

func (i ServicePrincipalMap) ToServicePrincipalMapOutput() ServicePrincipalMapOutput

func (ServicePrincipalMap) ToServicePrincipalMapOutputWithContext

func (i ServicePrincipalMap) ToServicePrincipalMapOutputWithContext(ctx context.Context) ServicePrincipalMapOutput

type ServicePrincipalMapInput

type ServicePrincipalMapInput interface {
	pulumi.Input

	ToServicePrincipalMapOutput() ServicePrincipalMapOutput
	ToServicePrincipalMapOutputWithContext(context.Context) ServicePrincipalMapOutput
}

ServicePrincipalMapInput is an input type that accepts ServicePrincipalMap and ServicePrincipalMapOutput values. You can construct a concrete instance of `ServicePrincipalMapInput` via:

ServicePrincipalMap{ "key": ServicePrincipalArgs{...} }

type ServicePrincipalMapOutput

type ServicePrincipalMapOutput struct{ *pulumi.OutputState }

func (ServicePrincipalMapOutput) ElementType

func (ServicePrincipalMapOutput) ElementType() reflect.Type

func (ServicePrincipalMapOutput) MapIndex

func (ServicePrincipalMapOutput) ToServicePrincipalMapOutput

func (o ServicePrincipalMapOutput) ToServicePrincipalMapOutput() ServicePrincipalMapOutput

func (ServicePrincipalMapOutput) ToServicePrincipalMapOutputWithContext

func (o ServicePrincipalMapOutput) ToServicePrincipalMapOutputWithContext(ctx context.Context) ServicePrincipalMapOutput

type ServicePrincipalOauth2PermissionScope

type ServicePrincipalOauth2PermissionScope struct {
	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription *string `pulumi:"adminConsentDescription"`
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName *string `pulumi:"adminConsentDisplayName"`
	// Specifies whether the permission scope is enabled.
	Enabled *bool `pulumi:"enabled"`
	// The unique identifier of the delegated permission.
	Id *string `pulumi:"id"`
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.
	Type *string `pulumi:"type"`
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription *string `pulumi:"userConsentDescription"`
	// Display name for the delegated permission that appears in the end user consent experience.
	UserConsentDisplayName *string `pulumi:"userConsentDisplayName"`
	// The value that is used for the `scp` claim in OAuth 2.0 access tokens.
	Value *string `pulumi:"value"`
}

type ServicePrincipalOauth2PermissionScopeArgs

type ServicePrincipalOauth2PermissionScopeArgs struct {
	// Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDescription pulumi.StringPtrInput `pulumi:"adminConsentDescription"`
	// Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.
	AdminConsentDisplayName pulumi.StringPtrInput `pulumi:"adminConsentDisplayName"`
	// Specifies whether the permission scope is enabled.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
	// The unique identifier of the delegated permission.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.
	Type pulumi.StringPtrInput `pulumi:"type"`
	// Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.
	UserConsentDescription pulumi.StringPtrInput `pulumi:"userConsentDescription"`
	// Display name for the delegated permission that appears in the end user consent experience.
	UserConsentDisplayName pulumi.StringPtrInput `pulumi:"userConsentDisplayName"`
	// The value that is used for the `scp` claim in OAuth 2.0 access tokens.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (ServicePrincipalOauth2PermissionScopeArgs) ElementType

func (ServicePrincipalOauth2PermissionScopeArgs) ToServicePrincipalOauth2PermissionScopeOutput

func (i ServicePrincipalOauth2PermissionScopeArgs) ToServicePrincipalOauth2PermissionScopeOutput() ServicePrincipalOauth2PermissionScopeOutput

func (ServicePrincipalOauth2PermissionScopeArgs) ToServicePrincipalOauth2PermissionScopeOutputWithContext

func (i ServicePrincipalOauth2PermissionScopeArgs) ToServicePrincipalOauth2PermissionScopeOutputWithContext(ctx context.Context) ServicePrincipalOauth2PermissionScopeOutput

type ServicePrincipalOauth2PermissionScopeArray

type ServicePrincipalOauth2PermissionScopeArray []ServicePrincipalOauth2PermissionScopeInput

func (ServicePrincipalOauth2PermissionScopeArray) ElementType

func (ServicePrincipalOauth2PermissionScopeArray) ToServicePrincipalOauth2PermissionScopeArrayOutput

func (i ServicePrincipalOauth2PermissionScopeArray) ToServicePrincipalOauth2PermissionScopeArrayOutput() ServicePrincipalOauth2PermissionScopeArrayOutput

func (ServicePrincipalOauth2PermissionScopeArray) ToServicePrincipalOauth2PermissionScopeArrayOutputWithContext

func (i ServicePrincipalOauth2PermissionScopeArray) ToServicePrincipalOauth2PermissionScopeArrayOutputWithContext(ctx context.Context) ServicePrincipalOauth2PermissionScopeArrayOutput

type ServicePrincipalOauth2PermissionScopeArrayInput

type ServicePrincipalOauth2PermissionScopeArrayInput interface {
	pulumi.Input

	ToServicePrincipalOauth2PermissionScopeArrayOutput() ServicePrincipalOauth2PermissionScopeArrayOutput
	ToServicePrincipalOauth2PermissionScopeArrayOutputWithContext(context.Context) ServicePrincipalOauth2PermissionScopeArrayOutput
}

ServicePrincipalOauth2PermissionScopeArrayInput is an input type that accepts ServicePrincipalOauth2PermissionScopeArray and ServicePrincipalOauth2PermissionScopeArrayOutput values. You can construct a concrete instance of `ServicePrincipalOauth2PermissionScopeArrayInput` via:

ServicePrincipalOauth2PermissionScopeArray{ ServicePrincipalOauth2PermissionScopeArgs{...} }

type ServicePrincipalOauth2PermissionScopeArrayOutput

type ServicePrincipalOauth2PermissionScopeArrayOutput struct{ *pulumi.OutputState }

func (ServicePrincipalOauth2PermissionScopeArrayOutput) ElementType

func (ServicePrincipalOauth2PermissionScopeArrayOutput) Index

func (ServicePrincipalOauth2PermissionScopeArrayOutput) ToServicePrincipalOauth2PermissionScopeArrayOutput

func (o ServicePrincipalOauth2PermissionScopeArrayOutput) ToServicePrincipalOauth2PermissionScopeArrayOutput() ServicePrincipalOauth2PermissionScopeArrayOutput

func (ServicePrincipalOauth2PermissionScopeArrayOutput) ToServicePrincipalOauth2PermissionScopeArrayOutputWithContext

func (o ServicePrincipalOauth2PermissionScopeArrayOutput) ToServicePrincipalOauth2PermissionScopeArrayOutputWithContext(ctx context.Context) ServicePrincipalOauth2PermissionScopeArrayOutput

type ServicePrincipalOauth2PermissionScopeInput

type ServicePrincipalOauth2PermissionScopeInput interface {
	pulumi.Input

	ToServicePrincipalOauth2PermissionScopeOutput() ServicePrincipalOauth2PermissionScopeOutput
	ToServicePrincipalOauth2PermissionScopeOutputWithContext(context.Context) ServicePrincipalOauth2PermissionScopeOutput
}

ServicePrincipalOauth2PermissionScopeInput is an input type that accepts ServicePrincipalOauth2PermissionScopeArgs and ServicePrincipalOauth2PermissionScopeOutput values. You can construct a concrete instance of `ServicePrincipalOauth2PermissionScopeInput` via:

ServicePrincipalOauth2PermissionScopeArgs{...}

type ServicePrincipalOauth2PermissionScopeOutput

type ServicePrincipalOauth2PermissionScopeOutput struct{ *pulumi.OutputState }

func (ServicePrincipalOauth2PermissionScopeOutput) AdminConsentDescription

Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users.

func (ServicePrincipalOauth2PermissionScopeOutput) AdminConsentDisplayName

Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users.

func (ServicePrincipalOauth2PermissionScopeOutput) ElementType

func (ServicePrincipalOauth2PermissionScopeOutput) Enabled

Specifies whether the permission scope is enabled.

func (ServicePrincipalOauth2PermissionScopeOutput) Id

The unique identifier of the delegated permission.

func (ServicePrincipalOauth2PermissionScopeOutput) ToServicePrincipalOauth2PermissionScopeOutput

func (o ServicePrincipalOauth2PermissionScopeOutput) ToServicePrincipalOauth2PermissionScopeOutput() ServicePrincipalOauth2PermissionScopeOutput

func (ServicePrincipalOauth2PermissionScopeOutput) ToServicePrincipalOauth2PermissionScopeOutputWithContext

func (o ServicePrincipalOauth2PermissionScopeOutput) ToServicePrincipalOauth2PermissionScopeOutputWithContext(ctx context.Context) ServicePrincipalOauth2PermissionScopeOutput

func (ServicePrincipalOauth2PermissionScopeOutput) Type

Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.

func (ServicePrincipalOauth2PermissionScopeOutput) UserConsentDescription

Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf.

func (ServicePrincipalOauth2PermissionScopeOutput) UserConsentDisplayName

Display name for the delegated permission that appears in the end user consent experience.

func (ServicePrincipalOauth2PermissionScopeOutput) Value

The value that is used for the `scp` claim in OAuth 2.0 access tokens.

type ServicePrincipalOutput

type ServicePrincipalOutput struct{ *pulumi.OutputState }

func (ServicePrincipalOutput) AccountEnabled added in v5.22.0

func (o ServicePrincipalOutput) AccountEnabled() pulumi.BoolPtrOutput

Whether or not the service principal account is enabled. Defaults to `true`.

func (ServicePrincipalOutput) AlternativeNames added in v5.22.0

func (o ServicePrincipalOutput) AlternativeNames() pulumi.StringArrayOutput

A set of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.

func (ServicePrincipalOutput) AppRoleAssignmentRequired added in v5.22.0

func (o ServicePrincipalOutput) AppRoleAssignmentRequired() pulumi.BoolPtrOutput

Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application. Defaults to `false`.

func (ServicePrincipalOutput) AppRoleIds added in v5.22.0

A mapping of app role values to app role IDs, as published by the associated application, intended to be useful when referencing app roles in other resources in your configuration.

func (ServicePrincipalOutput) AppRoles added in v5.22.0

A list of app roles published by the associated application, as documented below. For more information [official documentation](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).

func (ServicePrincipalOutput) ApplicationId deprecated added in v5.22.0

func (o ServicePrincipalOutput) ApplicationId() pulumi.StringOutput

The application ID (client ID) of the application for which to create a service principal

Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider

func (ServicePrincipalOutput) ApplicationTenantId added in v5.22.0

func (o ServicePrincipalOutput) ApplicationTenantId() pulumi.StringOutput

The tenant ID where the associated application is registered.

func (ServicePrincipalOutput) ClientId added in v5.43.0

The client ID of the application for which to create a service principal.

func (ServicePrincipalOutput) Description added in v5.22.0

A description of the service principal provided for internal end-users.

func (ServicePrincipalOutput) DisplayName added in v5.22.0

func (o ServicePrincipalOutput) DisplayName() pulumi.StringOutput

Display name for the app role that appears during app role assignment and in consent experiences.

func (ServicePrincipalOutput) ElementType

func (ServicePrincipalOutput) ElementType() reflect.Type

func (ServicePrincipalOutput) FeatureTags added in v5.22.0

A `featureTags` block as described below. Cannot be used together with the `tags` property.

> **Features and Tags** Features are configured for a service principal using tags, and are provided as a shortcut to set the corresponding magic tag value for each feature. You cannot configure `featureTags` and `tags` for a service principal at the same time, so if you need to assign additional custom tags it's recommended to use the `tags` property instead. Any tags configured for the linked application will propagate to this service principal.

func (ServicePrincipalOutput) Features deprecated added in v5.22.0

Block of features to configure for this service principal using tags

Deprecated: This block has been renamed to `featureTags` and will be removed in version 3.0 of the provider

func (ServicePrincipalOutput) HomepageUrl added in v5.22.0

func (o ServicePrincipalOutput) HomepageUrl() pulumi.StringOutput

Home page or landing page of the associated application.

func (ServicePrincipalOutput) LoginUrl added in v5.22.0

The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.

func (ServicePrincipalOutput) LogoutUrl added in v5.22.0

The URL that will be used by Microsoft's authorization service to log out an user using OpenId Connect front-channel, back-channel or SAML logout protocols, taken from the associated application.

func (ServicePrincipalOutput) Notes added in v5.22.0

A free text field to capture information about the service principal, typically used for operational purposes.

func (ServicePrincipalOutput) NotificationEmailAddresses added in v5.22.0

func (o ServicePrincipalOutput) NotificationEmailAddresses() pulumi.StringArrayOutput

A set of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.

func (ServicePrincipalOutput) Oauth2PermissionScopeIds added in v5.22.0

func (o ServicePrincipalOutput) Oauth2PermissionScopeIds() pulumi.StringMapOutput

A mapping of OAuth2.0 permission scope values to scope IDs, as exposed by the associated application, intended to be useful when referencing permission scopes in other resources in your configuration.

func (ServicePrincipalOutput) Oauth2PermissionScopes added in v5.22.0

A list of OAuth 2.0 delegated permission scopes exposed by the associated application, as documented below.

func (ServicePrincipalOutput) ObjectId added in v5.22.0

The object ID of the service principal.

func (ServicePrincipalOutput) Owners added in v5.22.0

A list of object IDs of principals that will be granted ownership of the service principal

func (ServicePrincipalOutput) PreferredSingleSignOnMode added in v5.22.0

func (o ServicePrincipalOutput) PreferredSingleSignOnMode() pulumi.StringPtrOutput

The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. Supported values are `oidc`, `password`, `saml` or `notSupported`. Omit this property or specify a blank string to unset.

func (ServicePrincipalOutput) RedirectUris added in v5.22.0

A list of URLs where user tokens are sent for sign-in with the associated application, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent for the associated application.

func (ServicePrincipalOutput) SamlMetadataUrl added in v5.22.0

func (o ServicePrincipalOutput) SamlMetadataUrl() pulumi.StringOutput

The URL where the service exposes SAML metadata for federation.

func (ServicePrincipalOutput) SamlSingleSignOn added in v5.22.0

A `samlSingleSignOn` block as documented below.

func (ServicePrincipalOutput) ServicePrincipalNames added in v5.22.0

func (o ServicePrincipalOutput) ServicePrincipalNames() pulumi.StringArrayOutput

A list of identifier URI(s), copied over from the associated application.

func (ServicePrincipalOutput) SignInAudience added in v5.22.0

func (o ServicePrincipalOutput) SignInAudience() pulumi.StringOutput

The Microsoft account types that are supported for the associated application. Possible values include `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.

func (ServicePrincipalOutput) Tags added in v5.22.0

A set of tags to apply to the service principal for configuring specific behaviours of the service principal. Note that these are not provided for use by practitioners. Cannot be used together with the `featureTags` block.

> **Tags and Features** Azure Active Directory uses special tag values to configure the behavior of service principals. These can be specified using either the `tags` property or with the `featureTags` block. If you need to set any custom tag values not supported by the `featureTags` block, it's recommended to use the `tags` property. Tag values set for the linked application will also propagate to this service principal.

func (ServicePrincipalOutput) ToServicePrincipalOutput

func (o ServicePrincipalOutput) ToServicePrincipalOutput() ServicePrincipalOutput

func (ServicePrincipalOutput) ToServicePrincipalOutputWithContext

func (o ServicePrincipalOutput) ToServicePrincipalOutputWithContext(ctx context.Context) ServicePrincipalOutput

func (ServicePrincipalOutput) Type added in v5.22.0

Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.

func (ServicePrincipalOutput) UseExisting added in v5.22.0

When true, the resource will return an existing service principal instead of failing with an error

type ServicePrincipalPassword

type ServicePrincipalPassword struct {
	pulumi.CustomResourceState

	// A display name for the password.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The end date until which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringOutput `pulumi:"endDate"`
	// A relative duration for which the password is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.
	EndDateRelative pulumi.StringPtrOutput `pulumi:"endDateRelative"`
	// A UUID used to uniquely identify this password credential.
	KeyId pulumi.StringOutput `pulumi:"keyId"`
	// A map of arbitrary key/value pairs that will force recreation of the password when they change, enabling password rotation based on external conditions such as a rotating timestamp. Changing this forces a new resource to be created.
	RotateWhenChanged pulumi.StringMapOutput `pulumi:"rotateWhenChanged"`
	// The object ID of the service principal for which this password should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringOutput `pulumi:"servicePrincipalId"`
	// The start date from which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date is used.  Changing this field forces a new resource to be created.
	StartDate pulumi.StringOutput `pulumi:"startDate"`
	// The password for this service principal, which is generated by Azure Active Directory.
	Value pulumi.StringOutput `pulumi:"value"`
}

## Example Usage

*Basic example*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ClientId: example.ClientId,
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipalPassword(ctx, "example", &azuread.ServicePrincipalPasswordArgs{
			ServicePrincipalId: exampleServicePrincipal.ObjectId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Time-based rotation*

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi-time/sdk/go/time"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ClientId: example.ClientId,
		})
		if err != nil {
			return err
		}
		exampleRotating, err := time.NewRotating(ctx, "example", &time.RotatingArgs{
			RotationDays: pulumi.Int(7),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipalPassword(ctx, "example", &azuread.ServicePrincipalPasswordArgs{
			ServicePrincipalId: exampleServicePrincipal.ObjectId,
			RotateWhenChanged: pulumi.StringMap{
				"rotation": exampleRotating.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

This resource does not support importing.

func GetServicePrincipalPassword

func GetServicePrincipalPassword(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServicePrincipalPasswordState, opts ...pulumi.ResourceOption) (*ServicePrincipalPassword, error)

GetServicePrincipalPassword gets an existing ServicePrincipalPassword resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServicePrincipalPassword

func NewServicePrincipalPassword(ctx *pulumi.Context,
	name string, args *ServicePrincipalPasswordArgs, opts ...pulumi.ResourceOption) (*ServicePrincipalPassword, error)

NewServicePrincipalPassword registers a new resource with the given unique name, arguments, and options.

func (*ServicePrincipalPassword) ElementType

func (*ServicePrincipalPassword) ElementType() reflect.Type

func (*ServicePrincipalPassword) ToServicePrincipalPasswordOutput

func (i *ServicePrincipalPassword) ToServicePrincipalPasswordOutput() ServicePrincipalPasswordOutput

func (*ServicePrincipalPassword) ToServicePrincipalPasswordOutputWithContext

func (i *ServicePrincipalPassword) ToServicePrincipalPasswordOutputWithContext(ctx context.Context) ServicePrincipalPasswordOutput

type ServicePrincipalPasswordArgs

type ServicePrincipalPasswordArgs struct {
	// A display name for the password.
	DisplayName pulumi.StringPtrInput
	// The end date until which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringPtrInput
	// A relative duration for which the password is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.
	EndDateRelative pulumi.StringPtrInput
	// A map of arbitrary key/value pairs that will force recreation of the password when they change, enabling password rotation based on external conditions such as a rotating timestamp. Changing this forces a new resource to be created.
	RotateWhenChanged pulumi.StringMapInput
	// The object ID of the service principal for which this password should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringInput
	// The start date from which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date is used.  Changing this field forces a new resource to be created.
	StartDate pulumi.StringPtrInput
}

The set of arguments for constructing a ServicePrincipalPassword resource.

func (ServicePrincipalPasswordArgs) ElementType

type ServicePrincipalPasswordArray

type ServicePrincipalPasswordArray []ServicePrincipalPasswordInput

func (ServicePrincipalPasswordArray) ElementType

func (ServicePrincipalPasswordArray) ToServicePrincipalPasswordArrayOutput

func (i ServicePrincipalPasswordArray) ToServicePrincipalPasswordArrayOutput() ServicePrincipalPasswordArrayOutput

func (ServicePrincipalPasswordArray) ToServicePrincipalPasswordArrayOutputWithContext

func (i ServicePrincipalPasswordArray) ToServicePrincipalPasswordArrayOutputWithContext(ctx context.Context) ServicePrincipalPasswordArrayOutput

type ServicePrincipalPasswordArrayInput

type ServicePrincipalPasswordArrayInput interface {
	pulumi.Input

	ToServicePrincipalPasswordArrayOutput() ServicePrincipalPasswordArrayOutput
	ToServicePrincipalPasswordArrayOutputWithContext(context.Context) ServicePrincipalPasswordArrayOutput
}

ServicePrincipalPasswordArrayInput is an input type that accepts ServicePrincipalPasswordArray and ServicePrincipalPasswordArrayOutput values. You can construct a concrete instance of `ServicePrincipalPasswordArrayInput` via:

ServicePrincipalPasswordArray{ ServicePrincipalPasswordArgs{...} }

type ServicePrincipalPasswordArrayOutput

type ServicePrincipalPasswordArrayOutput struct{ *pulumi.OutputState }

func (ServicePrincipalPasswordArrayOutput) ElementType

func (ServicePrincipalPasswordArrayOutput) Index

func (ServicePrincipalPasswordArrayOutput) ToServicePrincipalPasswordArrayOutput

func (o ServicePrincipalPasswordArrayOutput) ToServicePrincipalPasswordArrayOutput() ServicePrincipalPasswordArrayOutput

func (ServicePrincipalPasswordArrayOutput) ToServicePrincipalPasswordArrayOutputWithContext

func (o ServicePrincipalPasswordArrayOutput) ToServicePrincipalPasswordArrayOutputWithContext(ctx context.Context) ServicePrincipalPasswordArrayOutput

type ServicePrincipalPasswordInput

type ServicePrincipalPasswordInput interface {
	pulumi.Input

	ToServicePrincipalPasswordOutput() ServicePrincipalPasswordOutput
	ToServicePrincipalPasswordOutputWithContext(ctx context.Context) ServicePrincipalPasswordOutput
}

type ServicePrincipalPasswordMap

type ServicePrincipalPasswordMap map[string]ServicePrincipalPasswordInput

func (ServicePrincipalPasswordMap) ElementType

func (ServicePrincipalPasswordMap) ToServicePrincipalPasswordMapOutput

func (i ServicePrincipalPasswordMap) ToServicePrincipalPasswordMapOutput() ServicePrincipalPasswordMapOutput

func (ServicePrincipalPasswordMap) ToServicePrincipalPasswordMapOutputWithContext

func (i ServicePrincipalPasswordMap) ToServicePrincipalPasswordMapOutputWithContext(ctx context.Context) ServicePrincipalPasswordMapOutput

type ServicePrincipalPasswordMapInput

type ServicePrincipalPasswordMapInput interface {
	pulumi.Input

	ToServicePrincipalPasswordMapOutput() ServicePrincipalPasswordMapOutput
	ToServicePrincipalPasswordMapOutputWithContext(context.Context) ServicePrincipalPasswordMapOutput
}

ServicePrincipalPasswordMapInput is an input type that accepts ServicePrincipalPasswordMap and ServicePrincipalPasswordMapOutput values. You can construct a concrete instance of `ServicePrincipalPasswordMapInput` via:

ServicePrincipalPasswordMap{ "key": ServicePrincipalPasswordArgs{...} }

type ServicePrincipalPasswordMapOutput

type ServicePrincipalPasswordMapOutput struct{ *pulumi.OutputState }

func (ServicePrincipalPasswordMapOutput) ElementType

func (ServicePrincipalPasswordMapOutput) MapIndex

func (ServicePrincipalPasswordMapOutput) ToServicePrincipalPasswordMapOutput

func (o ServicePrincipalPasswordMapOutput) ToServicePrincipalPasswordMapOutput() ServicePrincipalPasswordMapOutput

func (ServicePrincipalPasswordMapOutput) ToServicePrincipalPasswordMapOutputWithContext

func (o ServicePrincipalPasswordMapOutput) ToServicePrincipalPasswordMapOutputWithContext(ctx context.Context) ServicePrincipalPasswordMapOutput

type ServicePrincipalPasswordOutput

type ServicePrincipalPasswordOutput struct{ *pulumi.OutputState }

func (ServicePrincipalPasswordOutput) DisplayName added in v5.22.0

A display name for the password.

func (ServicePrincipalPasswordOutput) ElementType

func (ServicePrincipalPasswordOutput) EndDate added in v5.22.0

The end date until which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.

func (ServicePrincipalPasswordOutput) EndDateRelative added in v5.22.0

A relative duration for which the password is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.

func (ServicePrincipalPasswordOutput) KeyId added in v5.22.0

A UUID used to uniquely identify this password credential.

func (ServicePrincipalPasswordOutput) RotateWhenChanged added in v5.22.0

A map of arbitrary key/value pairs that will force recreation of the password when they change, enabling password rotation based on external conditions such as a rotating timestamp. Changing this forces a new resource to be created.

func (ServicePrincipalPasswordOutput) ServicePrincipalId added in v5.22.0

func (o ServicePrincipalPasswordOutput) ServicePrincipalId() pulumi.StringOutput

The object ID of the service principal for which this password should be created. Changing this field forces a new resource to be created.

func (ServicePrincipalPasswordOutput) StartDate added in v5.22.0

The start date from which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date is used. Changing this field forces a new resource to be created.

func (ServicePrincipalPasswordOutput) ToServicePrincipalPasswordOutput

func (o ServicePrincipalPasswordOutput) ToServicePrincipalPasswordOutput() ServicePrincipalPasswordOutput

func (ServicePrincipalPasswordOutput) ToServicePrincipalPasswordOutputWithContext

func (o ServicePrincipalPasswordOutput) ToServicePrincipalPasswordOutputWithContext(ctx context.Context) ServicePrincipalPasswordOutput

func (ServicePrincipalPasswordOutput) Value added in v5.22.0

The password for this service principal, which is generated by Azure Active Directory.

type ServicePrincipalPasswordState

type ServicePrincipalPasswordState struct {
	// A display name for the password.
	DisplayName pulumi.StringPtrInput
	// The end date until which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringPtrInput
	// A relative duration for which the password is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created.
	EndDateRelative pulumi.StringPtrInput
	// A UUID used to uniquely identify this password credential.
	KeyId pulumi.StringPtrInput
	// A map of arbitrary key/value pairs that will force recreation of the password when they change, enabling password rotation based on external conditions such as a rotating timestamp. Changing this forces a new resource to be created.
	RotateWhenChanged pulumi.StringMapInput
	// The object ID of the service principal for which this password should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringPtrInput
	// The start date from which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date is used.  Changing this field forces a new resource to be created.
	StartDate pulumi.StringPtrInput
	// The password for this service principal, which is generated by Azure Active Directory.
	Value pulumi.StringPtrInput
}

func (ServicePrincipalPasswordState) ElementType

type ServicePrincipalSamlSingleSignOn added in v5.2.0

type ServicePrincipalSamlSingleSignOn struct {
	// The relative URI the service provider would redirect to after completion of the single sign-on flow.
	RelayState *string `pulumi:"relayState"`
}

type ServicePrincipalSamlSingleSignOnArgs added in v5.2.0

type ServicePrincipalSamlSingleSignOnArgs struct {
	// The relative URI the service provider would redirect to after completion of the single sign-on flow.
	RelayState pulumi.StringPtrInput `pulumi:"relayState"`
}

func (ServicePrincipalSamlSingleSignOnArgs) ElementType added in v5.2.0

func (ServicePrincipalSamlSingleSignOnArgs) ToServicePrincipalSamlSingleSignOnOutput added in v5.2.0

func (i ServicePrincipalSamlSingleSignOnArgs) ToServicePrincipalSamlSingleSignOnOutput() ServicePrincipalSamlSingleSignOnOutput

func (ServicePrincipalSamlSingleSignOnArgs) ToServicePrincipalSamlSingleSignOnOutputWithContext added in v5.2.0

func (i ServicePrincipalSamlSingleSignOnArgs) ToServicePrincipalSamlSingleSignOnOutputWithContext(ctx context.Context) ServicePrincipalSamlSingleSignOnOutput

func (ServicePrincipalSamlSingleSignOnArgs) ToServicePrincipalSamlSingleSignOnPtrOutput added in v5.2.0

func (i ServicePrincipalSamlSingleSignOnArgs) ToServicePrincipalSamlSingleSignOnPtrOutput() ServicePrincipalSamlSingleSignOnPtrOutput

func (ServicePrincipalSamlSingleSignOnArgs) ToServicePrincipalSamlSingleSignOnPtrOutputWithContext added in v5.2.0

func (i ServicePrincipalSamlSingleSignOnArgs) ToServicePrincipalSamlSingleSignOnPtrOutputWithContext(ctx context.Context) ServicePrincipalSamlSingleSignOnPtrOutput

type ServicePrincipalSamlSingleSignOnInput added in v5.2.0

type ServicePrincipalSamlSingleSignOnInput interface {
	pulumi.Input

	ToServicePrincipalSamlSingleSignOnOutput() ServicePrincipalSamlSingleSignOnOutput
	ToServicePrincipalSamlSingleSignOnOutputWithContext(context.Context) ServicePrincipalSamlSingleSignOnOutput
}

ServicePrincipalSamlSingleSignOnInput is an input type that accepts ServicePrincipalSamlSingleSignOnArgs and ServicePrincipalSamlSingleSignOnOutput values. You can construct a concrete instance of `ServicePrincipalSamlSingleSignOnInput` via:

ServicePrincipalSamlSingleSignOnArgs{...}

type ServicePrincipalSamlSingleSignOnOutput added in v5.2.0

type ServicePrincipalSamlSingleSignOnOutput struct{ *pulumi.OutputState }

func (ServicePrincipalSamlSingleSignOnOutput) ElementType added in v5.2.0

func (ServicePrincipalSamlSingleSignOnOutput) RelayState added in v5.2.0

The relative URI the service provider would redirect to after completion of the single sign-on flow.

func (ServicePrincipalSamlSingleSignOnOutput) ToServicePrincipalSamlSingleSignOnOutput added in v5.2.0

func (o ServicePrincipalSamlSingleSignOnOutput) ToServicePrincipalSamlSingleSignOnOutput() ServicePrincipalSamlSingleSignOnOutput

func (ServicePrincipalSamlSingleSignOnOutput) ToServicePrincipalSamlSingleSignOnOutputWithContext added in v5.2.0

func (o ServicePrincipalSamlSingleSignOnOutput) ToServicePrincipalSamlSingleSignOnOutputWithContext(ctx context.Context) ServicePrincipalSamlSingleSignOnOutput

func (ServicePrincipalSamlSingleSignOnOutput) ToServicePrincipalSamlSingleSignOnPtrOutput added in v5.2.0

func (o ServicePrincipalSamlSingleSignOnOutput) ToServicePrincipalSamlSingleSignOnPtrOutput() ServicePrincipalSamlSingleSignOnPtrOutput

func (ServicePrincipalSamlSingleSignOnOutput) ToServicePrincipalSamlSingleSignOnPtrOutputWithContext added in v5.2.0

func (o ServicePrincipalSamlSingleSignOnOutput) ToServicePrincipalSamlSingleSignOnPtrOutputWithContext(ctx context.Context) ServicePrincipalSamlSingleSignOnPtrOutput

type ServicePrincipalSamlSingleSignOnPtrInput added in v5.2.0

type ServicePrincipalSamlSingleSignOnPtrInput interface {
	pulumi.Input

	ToServicePrincipalSamlSingleSignOnPtrOutput() ServicePrincipalSamlSingleSignOnPtrOutput
	ToServicePrincipalSamlSingleSignOnPtrOutputWithContext(context.Context) ServicePrincipalSamlSingleSignOnPtrOutput
}

ServicePrincipalSamlSingleSignOnPtrInput is an input type that accepts ServicePrincipalSamlSingleSignOnArgs, ServicePrincipalSamlSingleSignOnPtr and ServicePrincipalSamlSingleSignOnPtrOutput values. You can construct a concrete instance of `ServicePrincipalSamlSingleSignOnPtrInput` via:

        ServicePrincipalSamlSingleSignOnArgs{...}

or:

        nil

type ServicePrincipalSamlSingleSignOnPtrOutput added in v5.2.0

type ServicePrincipalSamlSingleSignOnPtrOutput struct{ *pulumi.OutputState }

func (ServicePrincipalSamlSingleSignOnPtrOutput) Elem added in v5.2.0

func (ServicePrincipalSamlSingleSignOnPtrOutput) ElementType added in v5.2.0

func (ServicePrincipalSamlSingleSignOnPtrOutput) RelayState added in v5.2.0

The relative URI the service provider would redirect to after completion of the single sign-on flow.

func (ServicePrincipalSamlSingleSignOnPtrOutput) ToServicePrincipalSamlSingleSignOnPtrOutput added in v5.2.0

func (o ServicePrincipalSamlSingleSignOnPtrOutput) ToServicePrincipalSamlSingleSignOnPtrOutput() ServicePrincipalSamlSingleSignOnPtrOutput

func (ServicePrincipalSamlSingleSignOnPtrOutput) ToServicePrincipalSamlSingleSignOnPtrOutputWithContext added in v5.2.0

func (o ServicePrincipalSamlSingleSignOnPtrOutput) ToServicePrincipalSamlSingleSignOnPtrOutputWithContext(ctx context.Context) ServicePrincipalSamlSingleSignOnPtrOutput

type ServicePrincipalState

type ServicePrincipalState struct {
	// Whether or not the service principal account is enabled. Defaults to `true`.
	AccountEnabled pulumi.BoolPtrInput
	// A set of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.
	AlternativeNames pulumi.StringArrayInput
	// Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application. Defaults to `false`.
	AppRoleAssignmentRequired pulumi.BoolPtrInput
	// A mapping of app role values to app role IDs, as published by the associated application, intended to be useful when referencing app roles in other resources in your configuration.
	AppRoleIds pulumi.StringMapInput
	// A list of app roles published by the associated application, as documented below. For more information [official documentation](https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/app-roles).
	AppRoles ServicePrincipalAppRoleArrayInput
	// The application ID (client ID) of the application for which to create a service principal
	//
	// Deprecated: The `applicationId` property has been replaced with the `clientId` property and will be removed in version 3.0 of the AzureAD provider
	ApplicationId pulumi.StringPtrInput
	// The tenant ID where the associated application is registered.
	ApplicationTenantId pulumi.StringPtrInput
	// The client ID of the application for which to create a service principal.
	ClientId pulumi.StringPtrInput
	// A description of the service principal provided for internal end-users.
	Description pulumi.StringPtrInput
	// Display name for the app role that appears during app role assignment and in consent experiences.
	DisplayName pulumi.StringPtrInput
	// A `featureTags` block as described below. Cannot be used together with the `tags` property.
	//
	// > **Features and Tags** Features are configured for a service principal using tags, and are provided as a shortcut to set the corresponding magic tag value for each feature. You cannot configure `featureTags` and `tags` for a service principal at the same time, so if you need to assign additional custom tags it's recommended to use the `tags` property instead. Any tags configured for the linked application will propagate to this service principal.
	FeatureTags ServicePrincipalFeatureTagArrayInput
	// Block of features to configure for this service principal using tags
	//
	// Deprecated: This block has been renamed to `featureTags` and will be removed in version 3.0 of the provider
	Features ServicePrincipalFeatureArrayInput
	// Home page or landing page of the associated application.
	HomepageUrl pulumi.StringPtrInput
	// The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
	LoginUrl pulumi.StringPtrInput
	// The URL that will be used by Microsoft's authorization service to log out an user using OpenId Connect front-channel, back-channel or SAML logout protocols, taken from the associated application.
	LogoutUrl pulumi.StringPtrInput
	// A free text field to capture information about the service principal, typically used for operational purposes.
	Notes pulumi.StringPtrInput
	// A set of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.
	NotificationEmailAddresses pulumi.StringArrayInput
	// A mapping of OAuth2.0 permission scope values to scope IDs, as exposed by the associated application, intended to be useful when referencing permission scopes in other resources in your configuration.
	Oauth2PermissionScopeIds pulumi.StringMapInput
	// A list of OAuth 2.0 delegated permission scopes exposed by the associated application, as documented below.
	Oauth2PermissionScopes ServicePrincipalOauth2PermissionScopeArrayInput
	// The object ID of the service principal.
	ObjectId pulumi.StringPtrInput
	// A list of object IDs of principals that will be granted ownership of the service principal
	Owners pulumi.StringArrayInput
	// The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. Supported values are `oidc`, `password`, `saml` or `notSupported`. Omit this property or specify a blank string to unset.
	PreferredSingleSignOnMode pulumi.StringPtrInput
	// A list of URLs where user tokens are sent for sign-in with the associated application, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent for the associated application.
	RedirectUris pulumi.StringArrayInput
	// The URL where the service exposes SAML metadata for federation.
	SamlMetadataUrl pulumi.StringPtrInput
	// A `samlSingleSignOn` block as documented below.
	SamlSingleSignOn ServicePrincipalSamlSingleSignOnPtrInput
	// A list of identifier URI(s), copied over from the associated application.
	ServicePrincipalNames pulumi.StringArrayInput
	// The Microsoft account types that are supported for the associated application. Possible values include `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.
	SignInAudience pulumi.StringPtrInput
	// A set of tags to apply to the service principal for configuring specific behaviours of the service principal. Note that these are not provided for use by practitioners. Cannot be used together with the `featureTags` block.
	//
	// > **Tags and Features** Azure Active Directory uses special tag values to configure the behavior of service principals. These can be specified using either the `tags` property or with the `featureTags` block. If you need to set any custom tag values not supported by the `featureTags` block, it's recommended to use the `tags` property. Tag values set for the linked application will also propagate to this service principal.
	Tags pulumi.StringArrayInput
	// Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.
	Type pulumi.StringPtrInput
	// When true, the resource will return an existing service principal instead of failing with an error
	UseExisting pulumi.BoolPtrInput
}

func (ServicePrincipalState) ElementType

func (ServicePrincipalState) ElementType() reflect.Type

type ServicePrincipalTokenSigningCertificate added in v5.34.0

type ServicePrincipalTokenSigningCertificate struct {
	pulumi.CustomResourceState

	// Specifies a friendly name for the certificate.
	// Must start with `CN=`. Changing this field forces a new resource to be created.
	//
	// > If not specified, it will default to `CN=Microsoft Azure Federated SSO Certificate`.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The end date until which the token signing certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringOutput `pulumi:"endDate"`
	// A UUID used to uniquely identify the verify certificate.
	KeyId pulumi.StringOutput `pulumi:"keyId"`
	// The object ID of the service principal for which this certificate should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringOutput `pulumi:"servicePrincipalId"`
	// The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`).
	StartDate pulumi.StringOutput `pulumi:"startDate"`
	// A SHA-1 generated thumbprint of the token signing certificate, which can be used to set the preferred signing certificate for a service principal.
	Thumbprint pulumi.StringOutput `pulumi:"thumbprint"`
	// The certificate data, which is PEM encoded but does not include the
	// header `-----BEGIN CERTIFICATE-----\n` or the footer `\n-----END CERTIFICATE-----`.
	Value pulumi.StringOutput `pulumi:"value"`
}

## Example Usage

*Using default settings*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ApplicationId: example.ApplicationId,
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipalTokenSigningCertificate(ctx, "example", &azuread.ServicePrincipalTokenSigningCertificateArgs{
			ServicePrincipalId: exampleServicePrincipal.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

*Using custom settings*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ApplicationId: example.ApplicationId,
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewServicePrincipalTokenSigningCertificate(ctx, "example", &azuread.ServicePrincipalTokenSigningCertificateArgs{
			ServicePrincipalId: exampleServicePrincipal.ID(),
			DisplayName:        pulumi.String("CN=example.com"),
			EndDate:            pulumi.String("2023-05-01T01:02:03Z"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Token signing certificates can be imported using the object ID of the associated service principal and the key ID of the verify certificate credential, e.g.

```sh $ pulumi import azuread:index/servicePrincipalTokenSigningCertificate:ServicePrincipalTokenSigningCertificate example 00000000-0000-0000-0000-000000000000/tokenSigningCertificate/11111111-1111-1111-1111-111111111111 ```

-> This ID format is unique to Terraform and is composed of the service principal's object ID, the string "tokenSigningCertificate" and the verify certificate's key ID in the format `{ServicePrincipalObjectId}/tokenSigningCertificate/{CertificateKeyId}`.

func GetServicePrincipalTokenSigningCertificate added in v5.34.0

func GetServicePrincipalTokenSigningCertificate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServicePrincipalTokenSigningCertificateState, opts ...pulumi.ResourceOption) (*ServicePrincipalTokenSigningCertificate, error)

GetServicePrincipalTokenSigningCertificate gets an existing ServicePrincipalTokenSigningCertificate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServicePrincipalTokenSigningCertificate added in v5.34.0

func NewServicePrincipalTokenSigningCertificate(ctx *pulumi.Context,
	name string, args *ServicePrincipalTokenSigningCertificateArgs, opts ...pulumi.ResourceOption) (*ServicePrincipalTokenSigningCertificate, error)

NewServicePrincipalTokenSigningCertificate registers a new resource with the given unique name, arguments, and options.

func (*ServicePrincipalTokenSigningCertificate) ElementType added in v5.34.0

func (*ServicePrincipalTokenSigningCertificate) ToServicePrincipalTokenSigningCertificateOutput added in v5.34.0

func (i *ServicePrincipalTokenSigningCertificate) ToServicePrincipalTokenSigningCertificateOutput() ServicePrincipalTokenSigningCertificateOutput

func (*ServicePrincipalTokenSigningCertificate) ToServicePrincipalTokenSigningCertificateOutputWithContext added in v5.34.0

func (i *ServicePrincipalTokenSigningCertificate) ToServicePrincipalTokenSigningCertificateOutputWithContext(ctx context.Context) ServicePrincipalTokenSigningCertificateOutput

type ServicePrincipalTokenSigningCertificateArgs added in v5.34.0

type ServicePrincipalTokenSigningCertificateArgs struct {
	// Specifies a friendly name for the certificate.
	// Must start with `CN=`. Changing this field forces a new resource to be created.
	//
	// > If not specified, it will default to `CN=Microsoft Azure Federated SSO Certificate`.
	DisplayName pulumi.StringPtrInput
	// The end date until which the token signing certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringPtrInput
	// The object ID of the service principal for which this certificate should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringInput
}

The set of arguments for constructing a ServicePrincipalTokenSigningCertificate resource.

func (ServicePrincipalTokenSigningCertificateArgs) ElementType added in v5.34.0

type ServicePrincipalTokenSigningCertificateArray added in v5.34.0

type ServicePrincipalTokenSigningCertificateArray []ServicePrincipalTokenSigningCertificateInput

func (ServicePrincipalTokenSigningCertificateArray) ElementType added in v5.34.0

func (ServicePrincipalTokenSigningCertificateArray) ToServicePrincipalTokenSigningCertificateArrayOutput added in v5.34.0

func (i ServicePrincipalTokenSigningCertificateArray) ToServicePrincipalTokenSigningCertificateArrayOutput() ServicePrincipalTokenSigningCertificateArrayOutput

func (ServicePrincipalTokenSigningCertificateArray) ToServicePrincipalTokenSigningCertificateArrayOutputWithContext added in v5.34.0

func (i ServicePrincipalTokenSigningCertificateArray) ToServicePrincipalTokenSigningCertificateArrayOutputWithContext(ctx context.Context) ServicePrincipalTokenSigningCertificateArrayOutput

type ServicePrincipalTokenSigningCertificateArrayInput added in v5.34.0

type ServicePrincipalTokenSigningCertificateArrayInput interface {
	pulumi.Input

	ToServicePrincipalTokenSigningCertificateArrayOutput() ServicePrincipalTokenSigningCertificateArrayOutput
	ToServicePrincipalTokenSigningCertificateArrayOutputWithContext(context.Context) ServicePrincipalTokenSigningCertificateArrayOutput
}

ServicePrincipalTokenSigningCertificateArrayInput is an input type that accepts ServicePrincipalTokenSigningCertificateArray and ServicePrincipalTokenSigningCertificateArrayOutput values. You can construct a concrete instance of `ServicePrincipalTokenSigningCertificateArrayInput` via:

ServicePrincipalTokenSigningCertificateArray{ ServicePrincipalTokenSigningCertificateArgs{...} }

type ServicePrincipalTokenSigningCertificateArrayOutput added in v5.34.0

type ServicePrincipalTokenSigningCertificateArrayOutput struct{ *pulumi.OutputState }

func (ServicePrincipalTokenSigningCertificateArrayOutput) ElementType added in v5.34.0

func (ServicePrincipalTokenSigningCertificateArrayOutput) Index added in v5.34.0

func (ServicePrincipalTokenSigningCertificateArrayOutput) ToServicePrincipalTokenSigningCertificateArrayOutput added in v5.34.0

func (o ServicePrincipalTokenSigningCertificateArrayOutput) ToServicePrincipalTokenSigningCertificateArrayOutput() ServicePrincipalTokenSigningCertificateArrayOutput

func (ServicePrincipalTokenSigningCertificateArrayOutput) ToServicePrincipalTokenSigningCertificateArrayOutputWithContext added in v5.34.0

func (o ServicePrincipalTokenSigningCertificateArrayOutput) ToServicePrincipalTokenSigningCertificateArrayOutputWithContext(ctx context.Context) ServicePrincipalTokenSigningCertificateArrayOutput

type ServicePrincipalTokenSigningCertificateInput added in v5.34.0

type ServicePrincipalTokenSigningCertificateInput interface {
	pulumi.Input

	ToServicePrincipalTokenSigningCertificateOutput() ServicePrincipalTokenSigningCertificateOutput
	ToServicePrincipalTokenSigningCertificateOutputWithContext(ctx context.Context) ServicePrincipalTokenSigningCertificateOutput
}

type ServicePrincipalTokenSigningCertificateMap added in v5.34.0

type ServicePrincipalTokenSigningCertificateMap map[string]ServicePrincipalTokenSigningCertificateInput

func (ServicePrincipalTokenSigningCertificateMap) ElementType added in v5.34.0

func (ServicePrincipalTokenSigningCertificateMap) ToServicePrincipalTokenSigningCertificateMapOutput added in v5.34.0

func (i ServicePrincipalTokenSigningCertificateMap) ToServicePrincipalTokenSigningCertificateMapOutput() ServicePrincipalTokenSigningCertificateMapOutput

func (ServicePrincipalTokenSigningCertificateMap) ToServicePrincipalTokenSigningCertificateMapOutputWithContext added in v5.34.0

func (i ServicePrincipalTokenSigningCertificateMap) ToServicePrincipalTokenSigningCertificateMapOutputWithContext(ctx context.Context) ServicePrincipalTokenSigningCertificateMapOutput

type ServicePrincipalTokenSigningCertificateMapInput added in v5.34.0

type ServicePrincipalTokenSigningCertificateMapInput interface {
	pulumi.Input

	ToServicePrincipalTokenSigningCertificateMapOutput() ServicePrincipalTokenSigningCertificateMapOutput
	ToServicePrincipalTokenSigningCertificateMapOutputWithContext(context.Context) ServicePrincipalTokenSigningCertificateMapOutput
}

ServicePrincipalTokenSigningCertificateMapInput is an input type that accepts ServicePrincipalTokenSigningCertificateMap and ServicePrincipalTokenSigningCertificateMapOutput values. You can construct a concrete instance of `ServicePrincipalTokenSigningCertificateMapInput` via:

ServicePrincipalTokenSigningCertificateMap{ "key": ServicePrincipalTokenSigningCertificateArgs{...} }

type ServicePrincipalTokenSigningCertificateMapOutput added in v5.34.0

type ServicePrincipalTokenSigningCertificateMapOutput struct{ *pulumi.OutputState }

func (ServicePrincipalTokenSigningCertificateMapOutput) ElementType added in v5.34.0

func (ServicePrincipalTokenSigningCertificateMapOutput) MapIndex added in v5.34.0

func (ServicePrincipalTokenSigningCertificateMapOutput) ToServicePrincipalTokenSigningCertificateMapOutput added in v5.34.0

func (o ServicePrincipalTokenSigningCertificateMapOutput) ToServicePrincipalTokenSigningCertificateMapOutput() ServicePrincipalTokenSigningCertificateMapOutput

func (ServicePrincipalTokenSigningCertificateMapOutput) ToServicePrincipalTokenSigningCertificateMapOutputWithContext added in v5.34.0

func (o ServicePrincipalTokenSigningCertificateMapOutput) ToServicePrincipalTokenSigningCertificateMapOutputWithContext(ctx context.Context) ServicePrincipalTokenSigningCertificateMapOutput

type ServicePrincipalTokenSigningCertificateOutput added in v5.34.0

type ServicePrincipalTokenSigningCertificateOutput struct{ *pulumi.OutputState }

func (ServicePrincipalTokenSigningCertificateOutput) DisplayName added in v5.34.0

Specifies a friendly name for the certificate. Must start with `CN=`. Changing this field forces a new resource to be created.

> If not specified, it will default to `CN=Microsoft Azure Federated SSO Certificate`.

func (ServicePrincipalTokenSigningCertificateOutput) ElementType added in v5.34.0

func (ServicePrincipalTokenSigningCertificateOutput) EndDate added in v5.34.0

The end date until which the token signing certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.

func (ServicePrincipalTokenSigningCertificateOutput) KeyId added in v5.34.0

A UUID used to uniquely identify the verify certificate.

func (ServicePrincipalTokenSigningCertificateOutput) ServicePrincipalId added in v5.34.0

The object ID of the service principal for which this certificate should be created. Changing this field forces a new resource to be created.

func (ServicePrincipalTokenSigningCertificateOutput) StartDate added in v5.34.0

The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`).

func (ServicePrincipalTokenSigningCertificateOutput) Thumbprint added in v5.34.0

A SHA-1 generated thumbprint of the token signing certificate, which can be used to set the preferred signing certificate for a service principal.

func (ServicePrincipalTokenSigningCertificateOutput) ToServicePrincipalTokenSigningCertificateOutput added in v5.34.0

func (o ServicePrincipalTokenSigningCertificateOutput) ToServicePrincipalTokenSigningCertificateOutput() ServicePrincipalTokenSigningCertificateOutput

func (ServicePrincipalTokenSigningCertificateOutput) ToServicePrincipalTokenSigningCertificateOutputWithContext added in v5.34.0

func (o ServicePrincipalTokenSigningCertificateOutput) ToServicePrincipalTokenSigningCertificateOutputWithContext(ctx context.Context) ServicePrincipalTokenSigningCertificateOutput

func (ServicePrincipalTokenSigningCertificateOutput) Value added in v5.34.0

The certificate data, which is PEM encoded but does not include the header `-----BEGIN CERTIFICATE-----\n` or the footer `\n-----END CERTIFICATE-----`.

type ServicePrincipalTokenSigningCertificateState added in v5.34.0

type ServicePrincipalTokenSigningCertificateState struct {
	// Specifies a friendly name for the certificate.
	// Must start with `CN=`. Changing this field forces a new resource to be created.
	//
	// > If not specified, it will default to `CN=Microsoft Azure Federated SSO Certificate`.
	DisplayName pulumi.StringPtrInput
	// The end date until which the token signing certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). Changing this field forces a new resource to be created.
	EndDate pulumi.StringPtrInput
	// A UUID used to uniquely identify the verify certificate.
	KeyId pulumi.StringPtrInput
	// The object ID of the service principal for which this certificate should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringPtrInput
	// The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`).
	StartDate pulumi.StringPtrInput
	// A SHA-1 generated thumbprint of the token signing certificate, which can be used to set the preferred signing certificate for a service principal.
	Thumbprint pulumi.StringPtrInput
	// The certificate data, which is PEM encoded but does not include the
	// header `-----BEGIN CERTIFICATE-----\n` or the footer `\n-----END CERTIFICATE-----`.
	Value pulumi.StringPtrInput
}

func (ServicePrincipalTokenSigningCertificateState) ElementType added in v5.34.0

type SynchronizationJob added in v5.31.0

type SynchronizationJob struct {
	pulumi.CustomResourceState

	// Whether or not the provisioning job is enabled. Default state is `true`.
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	// A `schedule` list as documented below.
	Schedules SynchronizationJobScheduleArrayOutput `pulumi:"schedules"`
	// The object ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringOutput `pulumi:"servicePrincipalId"`
	// Identifier of the synchronization template this job is based on.
	TemplateId pulumi.StringOutput `pulumi:"templateId"`
}

Manages a synchronization job associated with a service principal (enterprise application) within 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 one of the following application roles: `Application.ReadWrite.All` or `Directory.ReadWrite.All`

## Example Usage

*Basic example*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.GetApplicationTemplate(ctx, &azuread.GetApplicationTemplateArgs{
			DisplayName: pulumi.StringRef("Azure Databricks SCIM Provisioning Connector"),
		}, nil)
		if err != nil {
			return err
		}
		exampleApplication, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			TemplateId:  pulumi.String(example.TemplateId),
			FeatureTags: azuread.ApplicationFeatureTagArray{
				&azuread.ApplicationFeatureTagArgs{
					Enterprise: pulumi.Bool(true),
					Gallery:    pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ApplicationId: exampleApplication.ApplicationId,
			UseExisting:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewSynchronizationSecret(ctx, "example", &azuread.SynchronizationSecretArgs{
			ServicePrincipalId: exampleServicePrincipal.ID(),
			Credentials: azuread.SynchronizationSecretCredentialArray{
				&azuread.SynchronizationSecretCredentialArgs{
					Key:   pulumi.String("BaseAddress"),
					Value: pulumi.String("https://adb-example.azuredatabricks.net/api/2.0/preview/scim"),
				},
				&azuread.SynchronizationSecretCredentialArgs{
					Key:   pulumi.String("SecretToken"),
					Value: pulumi.String("some-token"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewSynchronizationJob(ctx, "example", &azuread.SynchronizationJobArgs{
			ServicePrincipalId: exampleServicePrincipal.ID(),
			TemplateId:         pulumi.String("dataBricks"),
			Enabled:            pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Synchronization jobs can be imported using the `id`, e.g.

```sh $ pulumi import azuread:index/synchronizationJob:SynchronizationJob example 00000000-0000-0000-0000-000000000000/job/dataBricks.f5532fc709734b1a90e8a1fa9fd03a82.8442fd39-2183-419c-8732-74b6ce866bd5 ```

-> This ID format is unique to Terraform and is composed of the Service Principal Object ID and the ID of the Synchronization Job Id in the format `{servicePrincipalId}/job/{jobId}`.

func GetSynchronizationJob added in v5.31.0

func GetSynchronizationJob(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SynchronizationJobState, opts ...pulumi.ResourceOption) (*SynchronizationJob, error)

GetSynchronizationJob gets an existing SynchronizationJob resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSynchronizationJob added in v5.31.0

func NewSynchronizationJob(ctx *pulumi.Context,
	name string, args *SynchronizationJobArgs, opts ...pulumi.ResourceOption) (*SynchronizationJob, error)

NewSynchronizationJob registers a new resource with the given unique name, arguments, and options.

func (*SynchronizationJob) ElementType added in v5.31.0

func (*SynchronizationJob) ElementType() reflect.Type

func (*SynchronizationJob) ToSynchronizationJobOutput added in v5.31.0

func (i *SynchronizationJob) ToSynchronizationJobOutput() SynchronizationJobOutput

func (*SynchronizationJob) ToSynchronizationJobOutputWithContext added in v5.31.0

func (i *SynchronizationJob) ToSynchronizationJobOutputWithContext(ctx context.Context) SynchronizationJobOutput

type SynchronizationJobArgs added in v5.31.0

type SynchronizationJobArgs struct {
	// Whether or not the provisioning job is enabled. Default state is `true`.
	Enabled pulumi.BoolPtrInput
	// The object ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringInput
	// Identifier of the synchronization template this job is based on.
	TemplateId pulumi.StringInput
}

The set of arguments for constructing a SynchronizationJob resource.

func (SynchronizationJobArgs) ElementType added in v5.31.0

func (SynchronizationJobArgs) ElementType() reflect.Type

type SynchronizationJobArray added in v5.31.0

type SynchronizationJobArray []SynchronizationJobInput

func (SynchronizationJobArray) ElementType added in v5.31.0

func (SynchronizationJobArray) ElementType() reflect.Type

func (SynchronizationJobArray) ToSynchronizationJobArrayOutput added in v5.31.0

func (i SynchronizationJobArray) ToSynchronizationJobArrayOutput() SynchronizationJobArrayOutput

func (SynchronizationJobArray) ToSynchronizationJobArrayOutputWithContext added in v5.31.0

func (i SynchronizationJobArray) ToSynchronizationJobArrayOutputWithContext(ctx context.Context) SynchronizationJobArrayOutput

type SynchronizationJobArrayInput added in v5.31.0

type SynchronizationJobArrayInput interface {
	pulumi.Input

	ToSynchronizationJobArrayOutput() SynchronizationJobArrayOutput
	ToSynchronizationJobArrayOutputWithContext(context.Context) SynchronizationJobArrayOutput
}

SynchronizationJobArrayInput is an input type that accepts SynchronizationJobArray and SynchronizationJobArrayOutput values. You can construct a concrete instance of `SynchronizationJobArrayInput` via:

SynchronizationJobArray{ SynchronizationJobArgs{...} }

type SynchronizationJobArrayOutput added in v5.31.0

type SynchronizationJobArrayOutput struct{ *pulumi.OutputState }

func (SynchronizationJobArrayOutput) ElementType added in v5.31.0

func (SynchronizationJobArrayOutput) Index added in v5.31.0

func (SynchronizationJobArrayOutput) ToSynchronizationJobArrayOutput added in v5.31.0

func (o SynchronizationJobArrayOutput) ToSynchronizationJobArrayOutput() SynchronizationJobArrayOutput

func (SynchronizationJobArrayOutput) ToSynchronizationJobArrayOutputWithContext added in v5.31.0

func (o SynchronizationJobArrayOutput) ToSynchronizationJobArrayOutputWithContext(ctx context.Context) SynchronizationJobArrayOutput

type SynchronizationJobInput added in v5.31.0

type SynchronizationJobInput interface {
	pulumi.Input

	ToSynchronizationJobOutput() SynchronizationJobOutput
	ToSynchronizationJobOutputWithContext(ctx context.Context) SynchronizationJobOutput
}

type SynchronizationJobMap added in v5.31.0

type SynchronizationJobMap map[string]SynchronizationJobInput

func (SynchronizationJobMap) ElementType added in v5.31.0

func (SynchronizationJobMap) ElementType() reflect.Type

func (SynchronizationJobMap) ToSynchronizationJobMapOutput added in v5.31.0

func (i SynchronizationJobMap) ToSynchronizationJobMapOutput() SynchronizationJobMapOutput

func (SynchronizationJobMap) ToSynchronizationJobMapOutputWithContext added in v5.31.0

func (i SynchronizationJobMap) ToSynchronizationJobMapOutputWithContext(ctx context.Context) SynchronizationJobMapOutput

type SynchronizationJobMapInput added in v5.31.0

type SynchronizationJobMapInput interface {
	pulumi.Input

	ToSynchronizationJobMapOutput() SynchronizationJobMapOutput
	ToSynchronizationJobMapOutputWithContext(context.Context) SynchronizationJobMapOutput
}

SynchronizationJobMapInput is an input type that accepts SynchronizationJobMap and SynchronizationJobMapOutput values. You can construct a concrete instance of `SynchronizationJobMapInput` via:

SynchronizationJobMap{ "key": SynchronizationJobArgs{...} }

type SynchronizationJobMapOutput added in v5.31.0

type SynchronizationJobMapOutput struct{ *pulumi.OutputState }

func (SynchronizationJobMapOutput) ElementType added in v5.31.0

func (SynchronizationJobMapOutput) MapIndex added in v5.31.0

func (SynchronizationJobMapOutput) ToSynchronizationJobMapOutput added in v5.31.0

func (o SynchronizationJobMapOutput) ToSynchronizationJobMapOutput() SynchronizationJobMapOutput

func (SynchronizationJobMapOutput) ToSynchronizationJobMapOutputWithContext added in v5.31.0

func (o SynchronizationJobMapOutput) ToSynchronizationJobMapOutputWithContext(ctx context.Context) SynchronizationJobMapOutput

type SynchronizationJobOutput added in v5.31.0

type SynchronizationJobOutput struct{ *pulumi.OutputState }

func (SynchronizationJobOutput) ElementType added in v5.31.0

func (SynchronizationJobOutput) ElementType() reflect.Type

func (SynchronizationJobOutput) Enabled added in v5.31.0

Whether or not the provisioning job is enabled. Default state is `true`.

func (SynchronizationJobOutput) Schedules added in v5.31.0

A `schedule` list as documented below.

func (SynchronizationJobOutput) ServicePrincipalId added in v5.31.0

func (o SynchronizationJobOutput) ServicePrincipalId() pulumi.StringOutput

The object ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.

func (SynchronizationJobOutput) TemplateId added in v5.31.0

Identifier of the synchronization template this job is based on.

func (SynchronizationJobOutput) ToSynchronizationJobOutput added in v5.31.0

func (o SynchronizationJobOutput) ToSynchronizationJobOutput() SynchronizationJobOutput

func (SynchronizationJobOutput) ToSynchronizationJobOutputWithContext added in v5.31.0

func (o SynchronizationJobOutput) ToSynchronizationJobOutputWithContext(ctx context.Context) SynchronizationJobOutput

type SynchronizationJobSchedule added in v5.31.0

type SynchronizationJobSchedule struct {
	// Date and time when this job will expire, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`).
	Expiration *string `pulumi:"expiration"`
	// The interval between synchronization iterations ISO8601. E.g. PT40M run every 40 minutes.
	Interval *string `pulumi:"interval"`
	// State of the job.
	State *string `pulumi:"state"`
}

type SynchronizationJobScheduleArgs added in v5.31.0

type SynchronizationJobScheduleArgs struct {
	// Date and time when this job will expire, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`).
	Expiration pulumi.StringPtrInput `pulumi:"expiration"`
	// The interval between synchronization iterations ISO8601. E.g. PT40M run every 40 minutes.
	Interval pulumi.StringPtrInput `pulumi:"interval"`
	// State of the job.
	State pulumi.StringPtrInput `pulumi:"state"`
}

func (SynchronizationJobScheduleArgs) ElementType added in v5.31.0

func (SynchronizationJobScheduleArgs) ToSynchronizationJobScheduleOutput added in v5.31.0

func (i SynchronizationJobScheduleArgs) ToSynchronizationJobScheduleOutput() SynchronizationJobScheduleOutput

func (SynchronizationJobScheduleArgs) ToSynchronizationJobScheduleOutputWithContext added in v5.31.0

func (i SynchronizationJobScheduleArgs) ToSynchronizationJobScheduleOutputWithContext(ctx context.Context) SynchronizationJobScheduleOutput

type SynchronizationJobScheduleArray added in v5.31.0

type SynchronizationJobScheduleArray []SynchronizationJobScheduleInput

func (SynchronizationJobScheduleArray) ElementType added in v5.31.0

func (SynchronizationJobScheduleArray) ToSynchronizationJobScheduleArrayOutput added in v5.31.0

func (i SynchronizationJobScheduleArray) ToSynchronizationJobScheduleArrayOutput() SynchronizationJobScheduleArrayOutput

func (SynchronizationJobScheduleArray) ToSynchronizationJobScheduleArrayOutputWithContext added in v5.31.0

func (i SynchronizationJobScheduleArray) ToSynchronizationJobScheduleArrayOutputWithContext(ctx context.Context) SynchronizationJobScheduleArrayOutput

type SynchronizationJobScheduleArrayInput added in v5.31.0

type SynchronizationJobScheduleArrayInput interface {
	pulumi.Input

	ToSynchronizationJobScheduleArrayOutput() SynchronizationJobScheduleArrayOutput
	ToSynchronizationJobScheduleArrayOutputWithContext(context.Context) SynchronizationJobScheduleArrayOutput
}

SynchronizationJobScheduleArrayInput is an input type that accepts SynchronizationJobScheduleArray and SynchronizationJobScheduleArrayOutput values. You can construct a concrete instance of `SynchronizationJobScheduleArrayInput` via:

SynchronizationJobScheduleArray{ SynchronizationJobScheduleArgs{...} }

type SynchronizationJobScheduleArrayOutput added in v5.31.0

type SynchronizationJobScheduleArrayOutput struct{ *pulumi.OutputState }

func (SynchronizationJobScheduleArrayOutput) ElementType added in v5.31.0

func (SynchronizationJobScheduleArrayOutput) Index added in v5.31.0

func (SynchronizationJobScheduleArrayOutput) ToSynchronizationJobScheduleArrayOutput added in v5.31.0

func (o SynchronizationJobScheduleArrayOutput) ToSynchronizationJobScheduleArrayOutput() SynchronizationJobScheduleArrayOutput

func (SynchronizationJobScheduleArrayOutput) ToSynchronizationJobScheduleArrayOutputWithContext added in v5.31.0

func (o SynchronizationJobScheduleArrayOutput) ToSynchronizationJobScheduleArrayOutputWithContext(ctx context.Context) SynchronizationJobScheduleArrayOutput

type SynchronizationJobScheduleInput added in v5.31.0

type SynchronizationJobScheduleInput interface {
	pulumi.Input

	ToSynchronizationJobScheduleOutput() SynchronizationJobScheduleOutput
	ToSynchronizationJobScheduleOutputWithContext(context.Context) SynchronizationJobScheduleOutput
}

SynchronizationJobScheduleInput is an input type that accepts SynchronizationJobScheduleArgs and SynchronizationJobScheduleOutput values. You can construct a concrete instance of `SynchronizationJobScheduleInput` via:

SynchronizationJobScheduleArgs{...}

type SynchronizationJobScheduleOutput added in v5.31.0

type SynchronizationJobScheduleOutput struct{ *pulumi.OutputState }

func (SynchronizationJobScheduleOutput) ElementType added in v5.31.0

func (SynchronizationJobScheduleOutput) Expiration added in v5.31.0

Date and time when this job will expire, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`).

func (SynchronizationJobScheduleOutput) Interval added in v5.31.0

The interval between synchronization iterations ISO8601. E.g. PT40M run every 40 minutes.

func (SynchronizationJobScheduleOutput) State added in v5.31.0

State of the job.

func (SynchronizationJobScheduleOutput) ToSynchronizationJobScheduleOutput added in v5.31.0

func (o SynchronizationJobScheduleOutput) ToSynchronizationJobScheduleOutput() SynchronizationJobScheduleOutput

func (SynchronizationJobScheduleOutput) ToSynchronizationJobScheduleOutputWithContext added in v5.31.0

func (o SynchronizationJobScheduleOutput) ToSynchronizationJobScheduleOutputWithContext(ctx context.Context) SynchronizationJobScheduleOutput

type SynchronizationJobState added in v5.31.0

type SynchronizationJobState struct {
	// Whether or not the provisioning job is enabled. Default state is `true`.
	Enabled pulumi.BoolPtrInput
	// A `schedule` list as documented below.
	Schedules SynchronizationJobScheduleArrayInput
	// The object ID of the service principal for which this synchronization job should be created. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringPtrInput
	// Identifier of the synchronization template this job is based on.
	TemplateId pulumi.StringPtrInput
}

func (SynchronizationJobState) ElementType added in v5.31.0

func (SynchronizationJobState) ElementType() reflect.Type

type SynchronizationSecret added in v5.31.0

type SynchronizationSecret struct {
	pulumi.CustomResourceState

	// One or more `credential` blocks as documented below.
	Credentials SynchronizationSecretCredentialArrayOutput `pulumi:"credentials"`
	// The object ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringOutput `pulumi:"servicePrincipalId"`
}

Manages synchronization secrets associated with a service principal (enterprise application) within 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 one of the following application roles: `Application.ReadWrite.All` or `Directory.ReadWrite.All`

## Example Usage

*Basic example*

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuread.GetApplicationTemplate(ctx, &azuread.GetApplicationTemplateArgs{
			DisplayName: pulumi.StringRef("Azure Databricks SCIM Provisioning Connector"),
		}, nil)
		if err != nil {
			return err
		}
		exampleApplication, err := azuread.NewApplication(ctx, "example", &azuread.ApplicationArgs{
			DisplayName: pulumi.String("example"),
			TemplateId:  pulumi.String(example.TemplateId),
			FeatureTags: azuread.ApplicationFeatureTagArray{
				&azuread.ApplicationFeatureTagArgs{
					Enterprise: pulumi.Bool(true),
					Gallery:    pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		exampleServicePrincipal, err := azuread.NewServicePrincipal(ctx, "example", &azuread.ServicePrincipalArgs{
			ApplicationId: exampleApplication.ApplicationId,
			UseExisting:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewSynchronizationSecret(ctx, "example", &azuread.SynchronizationSecretArgs{
			ServicePrincipalId: exampleServicePrincipal.ID(),
			Credentials: azuread.SynchronizationSecretCredentialArray{
				&azuread.SynchronizationSecretCredentialArgs{
					Key:   pulumi.String("BaseAddress"),
					Value: pulumi.String("abc"),
				},
				&azuread.SynchronizationSecretCredentialArgs{
					Key:   pulumi.String("SecretToken"),
					Value: pulumi.String("some-token"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

This resource does not support importing.

func GetSynchronizationSecret added in v5.31.0

func GetSynchronizationSecret(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SynchronizationSecretState, opts ...pulumi.ResourceOption) (*SynchronizationSecret, error)

GetSynchronizationSecret gets an existing SynchronizationSecret resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSynchronizationSecret added in v5.31.0

func NewSynchronizationSecret(ctx *pulumi.Context,
	name string, args *SynchronizationSecretArgs, opts ...pulumi.ResourceOption) (*SynchronizationSecret, error)

NewSynchronizationSecret registers a new resource with the given unique name, arguments, and options.

func (*SynchronizationSecret) ElementType added in v5.31.0

func (*SynchronizationSecret) ElementType() reflect.Type

func (*SynchronizationSecret) ToSynchronizationSecretOutput added in v5.31.0

func (i *SynchronizationSecret) ToSynchronizationSecretOutput() SynchronizationSecretOutput

func (*SynchronizationSecret) ToSynchronizationSecretOutputWithContext added in v5.31.0

func (i *SynchronizationSecret) ToSynchronizationSecretOutputWithContext(ctx context.Context) SynchronizationSecretOutput

type SynchronizationSecretArgs added in v5.31.0

type SynchronizationSecretArgs struct {
	// One or more `credential` blocks as documented below.
	Credentials SynchronizationSecretCredentialArrayInput
	// The object ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringInput
}

The set of arguments for constructing a SynchronizationSecret resource.

func (SynchronizationSecretArgs) ElementType added in v5.31.0

func (SynchronizationSecretArgs) ElementType() reflect.Type

type SynchronizationSecretArray added in v5.31.0

type SynchronizationSecretArray []SynchronizationSecretInput

func (SynchronizationSecretArray) ElementType added in v5.31.0

func (SynchronizationSecretArray) ElementType() reflect.Type

func (SynchronizationSecretArray) ToSynchronizationSecretArrayOutput added in v5.31.0

func (i SynchronizationSecretArray) ToSynchronizationSecretArrayOutput() SynchronizationSecretArrayOutput

func (SynchronizationSecretArray) ToSynchronizationSecretArrayOutputWithContext added in v5.31.0

func (i SynchronizationSecretArray) ToSynchronizationSecretArrayOutputWithContext(ctx context.Context) SynchronizationSecretArrayOutput

type SynchronizationSecretArrayInput added in v5.31.0

type SynchronizationSecretArrayInput interface {
	pulumi.Input

	ToSynchronizationSecretArrayOutput() SynchronizationSecretArrayOutput
	ToSynchronizationSecretArrayOutputWithContext(context.Context) SynchronizationSecretArrayOutput
}

SynchronizationSecretArrayInput is an input type that accepts SynchronizationSecretArray and SynchronizationSecretArrayOutput values. You can construct a concrete instance of `SynchronizationSecretArrayInput` via:

SynchronizationSecretArray{ SynchronizationSecretArgs{...} }

type SynchronizationSecretArrayOutput added in v5.31.0

type SynchronizationSecretArrayOutput struct{ *pulumi.OutputState }

func (SynchronizationSecretArrayOutput) ElementType added in v5.31.0

func (SynchronizationSecretArrayOutput) Index added in v5.31.0

func (SynchronizationSecretArrayOutput) ToSynchronizationSecretArrayOutput added in v5.31.0

func (o SynchronizationSecretArrayOutput) ToSynchronizationSecretArrayOutput() SynchronizationSecretArrayOutput

func (SynchronizationSecretArrayOutput) ToSynchronizationSecretArrayOutputWithContext added in v5.31.0

func (o SynchronizationSecretArrayOutput) ToSynchronizationSecretArrayOutputWithContext(ctx context.Context) SynchronizationSecretArrayOutput

type SynchronizationSecretCredential added in v5.31.0

type SynchronizationSecretCredential struct {
	// The key of the secret.
	Key string `pulumi:"key"`
	// The value of the secret.
	Value string `pulumi:"value"`
}

type SynchronizationSecretCredentialArgs added in v5.31.0

type SynchronizationSecretCredentialArgs struct {
	// The key of the secret.
	Key pulumi.StringInput `pulumi:"key"`
	// The value of the secret.
	Value pulumi.StringInput `pulumi:"value"`
}

func (SynchronizationSecretCredentialArgs) ElementType added in v5.31.0

func (SynchronizationSecretCredentialArgs) ToSynchronizationSecretCredentialOutput added in v5.31.0

func (i SynchronizationSecretCredentialArgs) ToSynchronizationSecretCredentialOutput() SynchronizationSecretCredentialOutput

func (SynchronizationSecretCredentialArgs) ToSynchronizationSecretCredentialOutputWithContext added in v5.31.0

func (i SynchronizationSecretCredentialArgs) ToSynchronizationSecretCredentialOutputWithContext(ctx context.Context) SynchronizationSecretCredentialOutput

type SynchronizationSecretCredentialArray added in v5.31.0

type SynchronizationSecretCredentialArray []SynchronizationSecretCredentialInput

func (SynchronizationSecretCredentialArray) ElementType added in v5.31.0

func (SynchronizationSecretCredentialArray) ToSynchronizationSecretCredentialArrayOutput added in v5.31.0

func (i SynchronizationSecretCredentialArray) ToSynchronizationSecretCredentialArrayOutput() SynchronizationSecretCredentialArrayOutput

func (SynchronizationSecretCredentialArray) ToSynchronizationSecretCredentialArrayOutputWithContext added in v5.31.0

func (i SynchronizationSecretCredentialArray) ToSynchronizationSecretCredentialArrayOutputWithContext(ctx context.Context) SynchronizationSecretCredentialArrayOutput

type SynchronizationSecretCredentialArrayInput added in v5.31.0

type SynchronizationSecretCredentialArrayInput interface {
	pulumi.Input

	ToSynchronizationSecretCredentialArrayOutput() SynchronizationSecretCredentialArrayOutput
	ToSynchronizationSecretCredentialArrayOutputWithContext(context.Context) SynchronizationSecretCredentialArrayOutput
}

SynchronizationSecretCredentialArrayInput is an input type that accepts SynchronizationSecretCredentialArray and SynchronizationSecretCredentialArrayOutput values. You can construct a concrete instance of `SynchronizationSecretCredentialArrayInput` via:

SynchronizationSecretCredentialArray{ SynchronizationSecretCredentialArgs{...} }

type SynchronizationSecretCredentialArrayOutput added in v5.31.0

type SynchronizationSecretCredentialArrayOutput struct{ *pulumi.OutputState }

func (SynchronizationSecretCredentialArrayOutput) ElementType added in v5.31.0

func (SynchronizationSecretCredentialArrayOutput) Index added in v5.31.0

func (SynchronizationSecretCredentialArrayOutput) ToSynchronizationSecretCredentialArrayOutput added in v5.31.0

func (o SynchronizationSecretCredentialArrayOutput) ToSynchronizationSecretCredentialArrayOutput() SynchronizationSecretCredentialArrayOutput

func (SynchronizationSecretCredentialArrayOutput) ToSynchronizationSecretCredentialArrayOutputWithContext added in v5.31.0

func (o SynchronizationSecretCredentialArrayOutput) ToSynchronizationSecretCredentialArrayOutputWithContext(ctx context.Context) SynchronizationSecretCredentialArrayOutput

type SynchronizationSecretCredentialInput added in v5.31.0

type SynchronizationSecretCredentialInput interface {
	pulumi.Input

	ToSynchronizationSecretCredentialOutput() SynchronizationSecretCredentialOutput
	ToSynchronizationSecretCredentialOutputWithContext(context.Context) SynchronizationSecretCredentialOutput
}

SynchronizationSecretCredentialInput is an input type that accepts SynchronizationSecretCredentialArgs and SynchronizationSecretCredentialOutput values. You can construct a concrete instance of `SynchronizationSecretCredentialInput` via:

SynchronizationSecretCredentialArgs{...}

type SynchronizationSecretCredentialOutput added in v5.31.0

type SynchronizationSecretCredentialOutput struct{ *pulumi.OutputState }

func (SynchronizationSecretCredentialOutput) ElementType added in v5.31.0

func (SynchronizationSecretCredentialOutput) Key added in v5.31.0

The key of the secret.

func (SynchronizationSecretCredentialOutput) ToSynchronizationSecretCredentialOutput added in v5.31.0

func (o SynchronizationSecretCredentialOutput) ToSynchronizationSecretCredentialOutput() SynchronizationSecretCredentialOutput

func (SynchronizationSecretCredentialOutput) ToSynchronizationSecretCredentialOutputWithContext added in v5.31.0

func (o SynchronizationSecretCredentialOutput) ToSynchronizationSecretCredentialOutputWithContext(ctx context.Context) SynchronizationSecretCredentialOutput

func (SynchronizationSecretCredentialOutput) Value added in v5.31.0

The value of the secret.

type SynchronizationSecretInput added in v5.31.0

type SynchronizationSecretInput interface {
	pulumi.Input

	ToSynchronizationSecretOutput() SynchronizationSecretOutput
	ToSynchronizationSecretOutputWithContext(ctx context.Context) SynchronizationSecretOutput
}

type SynchronizationSecretMap added in v5.31.0

type SynchronizationSecretMap map[string]SynchronizationSecretInput

func (SynchronizationSecretMap) ElementType added in v5.31.0

func (SynchronizationSecretMap) ElementType() reflect.Type

func (SynchronizationSecretMap) ToSynchronizationSecretMapOutput added in v5.31.0

func (i SynchronizationSecretMap) ToSynchronizationSecretMapOutput() SynchronizationSecretMapOutput

func (SynchronizationSecretMap) ToSynchronizationSecretMapOutputWithContext added in v5.31.0

func (i SynchronizationSecretMap) ToSynchronizationSecretMapOutputWithContext(ctx context.Context) SynchronizationSecretMapOutput

type SynchronizationSecretMapInput added in v5.31.0

type SynchronizationSecretMapInput interface {
	pulumi.Input

	ToSynchronizationSecretMapOutput() SynchronizationSecretMapOutput
	ToSynchronizationSecretMapOutputWithContext(context.Context) SynchronizationSecretMapOutput
}

SynchronizationSecretMapInput is an input type that accepts SynchronizationSecretMap and SynchronizationSecretMapOutput values. You can construct a concrete instance of `SynchronizationSecretMapInput` via:

SynchronizationSecretMap{ "key": SynchronizationSecretArgs{...} }

type SynchronizationSecretMapOutput added in v5.31.0

type SynchronizationSecretMapOutput struct{ *pulumi.OutputState }

func (SynchronizationSecretMapOutput) ElementType added in v5.31.0

func (SynchronizationSecretMapOutput) MapIndex added in v5.31.0

func (SynchronizationSecretMapOutput) ToSynchronizationSecretMapOutput added in v5.31.0

func (o SynchronizationSecretMapOutput) ToSynchronizationSecretMapOutput() SynchronizationSecretMapOutput

func (SynchronizationSecretMapOutput) ToSynchronizationSecretMapOutputWithContext added in v5.31.0

func (o SynchronizationSecretMapOutput) ToSynchronizationSecretMapOutputWithContext(ctx context.Context) SynchronizationSecretMapOutput

type SynchronizationSecretOutput added in v5.31.0

type SynchronizationSecretOutput struct{ *pulumi.OutputState }

func (SynchronizationSecretOutput) Credentials added in v5.31.0

One or more `credential` blocks as documented below.

func (SynchronizationSecretOutput) ElementType added in v5.31.0

func (SynchronizationSecretOutput) ServicePrincipalId added in v5.31.0

func (o SynchronizationSecretOutput) ServicePrincipalId() pulumi.StringOutput

The object ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.

func (SynchronizationSecretOutput) ToSynchronizationSecretOutput added in v5.31.0

func (o SynchronizationSecretOutput) ToSynchronizationSecretOutput() SynchronizationSecretOutput

func (SynchronizationSecretOutput) ToSynchronizationSecretOutputWithContext added in v5.31.0

func (o SynchronizationSecretOutput) ToSynchronizationSecretOutputWithContext(ctx context.Context) SynchronizationSecretOutput

type SynchronizationSecretState added in v5.31.0

type SynchronizationSecretState struct {
	// One or more `credential` blocks as documented below.
	Credentials SynchronizationSecretCredentialArrayInput
	// The object ID of the service principal for which this synchronization secrets should be stored. Changing this field forces a new resource to be created.
	ServicePrincipalId pulumi.StringPtrInput
}

func (SynchronizationSecretState) ElementType added in v5.31.0

func (SynchronizationSecretState) ElementType() reflect.Type

type User

type User struct {
	pulumi.CustomResourceState

	// A freeform field for the user to describe themselves
	AboutMe pulumi.StringOutput `pulumi:"aboutMe"`
	// Whether or not the account should be enabled.
	AccountEnabled pulumi.BoolPtrOutput `pulumi:"accountEnabled"`
	// The age group of the user. Supported values are `Adult`, `NotAdult` and `Minor`. Omit this property or specify a blank string to unset.
	AgeGroup pulumi.StringPtrOutput `pulumi:"ageGroup"`
	// A list of telephone numbers for the user. Only one number can be set for this property. Read-only for users synced with Azure AD Connect.
	BusinessPhones pulumi.StringArrayOutput `pulumi:"businessPhones"`
	// The city in which the user is located.
	City pulumi.StringPtrOutput `pulumi:"city"`
	// The company name which the user is associated. This property can be useful for describing the company that an external user comes from.
	CompanyName pulumi.StringPtrOutput `pulumi:"companyName"`
	// Whether consent has been obtained for minors. Supported values are `Granted`, `Denied` and `NotRequired`. Omit this property or specify a blank string to unset.
	ConsentProvidedForMinor pulumi.StringPtrOutput `pulumi:"consentProvidedForMinor"`
	// The cost center associated with the user.
	CostCenter pulumi.StringPtrOutput `pulumi:"costCenter"`
	// The country/region in which the user is located. Examples include: `NO`, `JP`, and `GB`.
	Country pulumi.StringPtrOutput `pulumi:"country"`
	// Indicates whether the user account was created as a regular school or work account (`null`), an external account (`Invitation`), a local account for an Azure Active Directory B2C tenant (`LocalAccount`) or self-service sign-up using email verification (`EmailVerified`).
	CreationType pulumi.StringOutput `pulumi:"creationType"`
	// The name for the department in which the user works.
	Department pulumi.StringPtrOutput `pulumi:"department"`
	// Whether the user's password is exempt from expiring. Defaults to `false`.
	DisablePasswordExpiration pulumi.BoolPtrOutput `pulumi:"disablePasswordExpiration"`
	// Whether the user is allowed weaker passwords than the default policy to be specified. Defaults to `false`.
	DisableStrongPassword pulumi.BoolPtrOutput `pulumi:"disableStrongPassword"`
	// The name to display in the address book for the user.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The name of the division in which the user works.
	Division pulumi.StringPtrOutput `pulumi:"division"`
	// The employee identifier assigned to the user by the organisation.
	EmployeeId pulumi.StringPtrOutput `pulumi:"employeeId"`
	// Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor.
	EmployeeType pulumi.StringPtrOutput `pulumi:"employeeType"`
	// For an external user invited to the tenant, this property represents the invited user's invitation status. Possible values are `PendingAcceptance` or `Accepted`.
	ExternalUserState pulumi.StringOutput `pulumi:"externalUserState"`
	// The fax number of the user.
	FaxNumber pulumi.StringPtrOutput `pulumi:"faxNumber"`
	// Whether the user is forced to change the password during the next sign-in. Only takes effect when also changing the password. Defaults to `false`.
	ForcePasswordChange pulumi.BoolPtrOutput `pulumi:"forcePasswordChange"`
	// The given name (first name) of the user.
	GivenName pulumi.StringPtrOutput `pulumi:"givenName"`
	// A list of instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user.
	ImAddresses pulumi.StringArrayOutput `pulumi:"imAddresses"`
	// The user’s job title.
	JobTitle pulumi.StringPtrOutput `pulumi:"jobTitle"`
	// The SMTP address for the user. This property cannot be unset once specified.
	Mail pulumi.StringOutput `pulumi:"mail"`
	// The mail alias for the user. Defaults to the user name part of the user principal name (UPN).
	MailNickname pulumi.StringOutput `pulumi:"mailNickname"`
	// The object ID of the user's manager.
	ManagerId pulumi.StringPtrOutput `pulumi:"managerId"`
	// The primary cellular telephone number for the user.
	MobilePhone pulumi.StringPtrOutput `pulumi:"mobilePhone"`
	// The object ID of the user.
	ObjectId pulumi.StringOutput `pulumi:"objectId"`
	// The office location in the user's place of business.
	OfficeLocation pulumi.StringPtrOutput `pulumi:"officeLocation"`
	// The on-premises distinguished name (DN) of the user, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesDistinguishedName pulumi.StringOutput `pulumi:"onpremisesDistinguishedName"`
	// The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesDomainName pulumi.StringOutput `pulumi:"onpremisesDomainName"`
	// The value used to associate an on-premise Active Directory user account with their Azure AD user object. This must be specified if you are using a federated domain for the user's `userPrincipalName` property when creating a new user account.
	OnpremisesImmutableId pulumi.StringOutput `pulumi:"onpremisesImmutableId"`
	// The on-premise SAM account name of the user.
	OnpremisesSamAccountName pulumi.StringOutput `pulumi:"onpremisesSamAccountName"`
	// The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesSecurityIdentifier pulumi.StringOutput `pulumi:"onpremisesSecurityIdentifier"`
	// Whether this user is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).
	OnpremisesSyncEnabled pulumi.BoolOutput `pulumi:"onpremisesSyncEnabled"`
	// The on-premise user principal name of the user.
	OnpremisesUserPrincipalName pulumi.StringOutput `pulumi:"onpremisesUserPrincipalName"`
	// A list of additional email addresses for the user.
	OtherMails pulumi.StringArrayOutput `pulumi:"otherMails"`
	// The password for the user. The password must satisfy minimum requirements as specified by the password policy. The
	// maximum length is 256 characters. This property is required when creating a new user
	Password pulumi.StringOutput `pulumi:"password"`
	// The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.
	PostalCode pulumi.StringPtrOutput `pulumi:"postalCode"`
	// The user's preferred language, in ISO 639-1 notation.
	PreferredLanguage pulumi.StringPtrOutput `pulumi:"preferredLanguage"`
	// List of email addresses for the user that direct to the same mailbox.
	ProxyAddresses pulumi.StringArrayOutput `pulumi:"proxyAddresses"`
	// Whether or not the Outlook global address list should include this user. Defaults to `true`.
	ShowInAddressList pulumi.BoolPtrOutput `pulumi:"showInAddressList"`
	// The state or province in the user's address.
	State pulumi.StringPtrOutput `pulumi:"state"`
	// The street address of the user's place of business.
	StreetAddress pulumi.StringPtrOutput `pulumi:"streetAddress"`
	// The user's surname (family name or last name).
	Surname pulumi.StringPtrOutput `pulumi:"surname"`
	// The usage location of the user. Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set.
	UsageLocation pulumi.StringPtrOutput `pulumi:"usageLocation"`
	// The user principal name (UPN) of the user.
	UserPrincipalName pulumi.StringOutput `pulumi:"userPrincipalName"`
	// The user type in the directory. Possible values are `Guest` or `Member`.
	UserType pulumi.StringOutput `pulumi:"userType"`
}

Manages a user within 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 one of the following application roles: `User.ReadWrite.All` or `Directory.ReadWrite.All`

When authenticated with a user principal, this resource requires one of the following directory roles: `User Administrator` or `Global Administrator`

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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.NewUser(ctx, "example", &azuread.UserArgs{
			UserPrincipalName: pulumi.String("jdoe@example.com"),
			DisplayName:       pulumi.String("J. Doe"),
			MailNickname:      pulumi.String("jdoe"),
			Password:          pulumi.String("SecretP@sswd99!"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Users can be imported using their object ID, e.g.

```sh $ pulumi import azuread:index/user:User my_user 00000000-0000-0000-0000-000000000000 ```

func GetUser

func GetUser(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserState, opts ...pulumi.ResourceOption) (*User, error)

GetUser gets an existing User resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUser

func NewUser(ctx *pulumi.Context,
	name string, args *UserArgs, opts ...pulumi.ResourceOption) (*User, error)

NewUser registers a new resource with the given unique name, arguments, and options.

func (*User) ElementType

func (*User) ElementType() reflect.Type

func (*User) ToUserOutput

func (i *User) ToUserOutput() UserOutput

func (*User) ToUserOutputWithContext

func (i *User) ToUserOutputWithContext(ctx context.Context) UserOutput

type UserArgs

type UserArgs struct {
	// Whether or not the account should be enabled.
	AccountEnabled pulumi.BoolPtrInput
	// The age group of the user. Supported values are `Adult`, `NotAdult` and `Minor`. Omit this property or specify a blank string to unset.
	AgeGroup pulumi.StringPtrInput
	// A list of telephone numbers for the user. Only one number can be set for this property. Read-only for users synced with Azure AD Connect.
	BusinessPhones pulumi.StringArrayInput
	// The city in which the user is located.
	City pulumi.StringPtrInput
	// The company name which the user is associated. This property can be useful for describing the company that an external user comes from.
	CompanyName pulumi.StringPtrInput
	// Whether consent has been obtained for minors. Supported values are `Granted`, `Denied` and `NotRequired`. Omit this property or specify a blank string to unset.
	ConsentProvidedForMinor pulumi.StringPtrInput
	// The cost center associated with the user.
	CostCenter pulumi.StringPtrInput
	// The country/region in which the user is located. Examples include: `NO`, `JP`, and `GB`.
	Country pulumi.StringPtrInput
	// The name for the department in which the user works.
	Department pulumi.StringPtrInput
	// Whether the user's password is exempt from expiring. Defaults to `false`.
	DisablePasswordExpiration pulumi.BoolPtrInput
	// Whether the user is allowed weaker passwords than the default policy to be specified. Defaults to `false`.
	DisableStrongPassword pulumi.BoolPtrInput
	// The name to display in the address book for the user.
	DisplayName pulumi.StringInput
	// The name of the division in which the user works.
	Division pulumi.StringPtrInput
	// The employee identifier assigned to the user by the organisation.
	EmployeeId pulumi.StringPtrInput
	// Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor.
	EmployeeType pulumi.StringPtrInput
	// The fax number of the user.
	FaxNumber pulumi.StringPtrInput
	// Whether the user is forced to change the password during the next sign-in. Only takes effect when also changing the password. Defaults to `false`.
	ForcePasswordChange pulumi.BoolPtrInput
	// The given name (first name) of the user.
	GivenName pulumi.StringPtrInput
	// The user’s job title.
	JobTitle pulumi.StringPtrInput
	// The SMTP address for the user. This property cannot be unset once specified.
	Mail pulumi.StringPtrInput
	// The mail alias for the user. Defaults to the user name part of the user principal name (UPN).
	MailNickname pulumi.StringPtrInput
	// The object ID of the user's manager.
	ManagerId pulumi.StringPtrInput
	// The primary cellular telephone number for the user.
	MobilePhone pulumi.StringPtrInput
	// The office location in the user's place of business.
	OfficeLocation pulumi.StringPtrInput
	// The value used to associate an on-premise Active Directory user account with their Azure AD user object. This must be specified if you are using a federated domain for the user's `userPrincipalName` property when creating a new user account.
	OnpremisesImmutableId pulumi.StringPtrInput
	// A list of additional email addresses for the user.
	OtherMails pulumi.StringArrayInput
	// The password for the user. The password must satisfy minimum requirements as specified by the password policy. The
	// maximum length is 256 characters. This property is required when creating a new user
	Password pulumi.StringPtrInput
	// The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.
	PostalCode pulumi.StringPtrInput
	// The user's preferred language, in ISO 639-1 notation.
	PreferredLanguage pulumi.StringPtrInput
	// Whether or not the Outlook global address list should include this user. Defaults to `true`.
	ShowInAddressList pulumi.BoolPtrInput
	// The state or province in the user's address.
	State pulumi.StringPtrInput
	// The street address of the user's place of business.
	StreetAddress pulumi.StringPtrInput
	// The user's surname (family name or last name).
	Surname pulumi.StringPtrInput
	// The usage location of the user. Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set.
	UsageLocation pulumi.StringPtrInput
	// The user principal name (UPN) of the user.
	UserPrincipalName pulumi.StringInput
}

The set of arguments for constructing a User resource.

func (UserArgs) ElementType

func (UserArgs) ElementType() reflect.Type

type UserArray

type UserArray []UserInput

func (UserArray) ElementType

func (UserArray) ElementType() reflect.Type

func (UserArray) ToUserArrayOutput

func (i UserArray) ToUserArrayOutput() UserArrayOutput

func (UserArray) ToUserArrayOutputWithContext

func (i UserArray) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput

type UserArrayInput

type UserArrayInput interface {
	pulumi.Input

	ToUserArrayOutput() UserArrayOutput
	ToUserArrayOutputWithContext(context.Context) UserArrayOutput
}

UserArrayInput is an input type that accepts UserArray and UserArrayOutput values. You can construct a concrete instance of `UserArrayInput` via:

UserArray{ UserArgs{...} }

type UserArrayOutput

type UserArrayOutput struct{ *pulumi.OutputState }

func (UserArrayOutput) ElementType

func (UserArrayOutput) ElementType() reflect.Type

func (UserArrayOutput) Index

func (UserArrayOutput) ToUserArrayOutput

func (o UserArrayOutput) ToUserArrayOutput() UserArrayOutput

func (UserArrayOutput) ToUserArrayOutputWithContext

func (o UserArrayOutput) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput

type UserFlowAttribute added in v5.37.0

type UserFlowAttribute struct {
	pulumi.CustomResourceState

	// The type of the user flow attribute. Values include `builtIn`, `custom` or `required`.
	AttributeType pulumi.StringOutput `pulumi:"attributeType"`
	// The data type of the user flow attribute. Possible values are `boolean`, `dateTime`, `int64`, `string` or `stringCollection`. Changing this forces a new resource to be created.
	DataType pulumi.StringOutput `pulumi:"dataType"`
	// The description of the user flow attribute that is shown to the user at the time of sign-up.
	Description pulumi.StringOutput `pulumi:"description"`
	// The display name of the user flow attribute. Changing this forces a new resource to be created.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
}

Manages user flow attributes in an Azure Active Directory (Azure AD) tenant.

## 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: `IdentityUserFlow.ReadWrite.All`

## Example Usage

*Basic example*

<!--Start PulumiCodeChooser --> ```go 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.NewUserFlowAttribute(ctx, "example", &azuread.UserFlowAttributeArgs{
			DisplayName: pulumi.String("Hobby"),
			Description: pulumi.String("Your hobby"),
			DataType:    pulumi.String("string"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

User flow attributes can be imported using the `id`, e.g.

```sh $ pulumi import azuread:index/userFlowAttribute:UserFlowAttribute example extension_ecc9f88db2924942b8a96f44873616fe_Hobbyjkorv ```

-> This ID can be queried using the [User Flow Attributes API](https://learn.microsoft.com/en-us/graph/api/identityuserflowattribute-list?view=graph-rest-1.0&tabs=http).

func GetUserFlowAttribute added in v5.37.0

func GetUserFlowAttribute(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserFlowAttributeState, opts ...pulumi.ResourceOption) (*UserFlowAttribute, error)

GetUserFlowAttribute gets an existing UserFlowAttribute resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUserFlowAttribute added in v5.37.0

func NewUserFlowAttribute(ctx *pulumi.Context,
	name string, args *UserFlowAttributeArgs, opts ...pulumi.ResourceOption) (*UserFlowAttribute, error)

NewUserFlowAttribute registers a new resource with the given unique name, arguments, and options.

func (*UserFlowAttribute) ElementType added in v5.37.0

func (*UserFlowAttribute) ElementType() reflect.Type

func (*UserFlowAttribute) ToUserFlowAttributeOutput added in v5.37.0

func (i *UserFlowAttribute) ToUserFlowAttributeOutput() UserFlowAttributeOutput

func (*UserFlowAttribute) ToUserFlowAttributeOutputWithContext added in v5.37.0

func (i *UserFlowAttribute) ToUserFlowAttributeOutputWithContext(ctx context.Context) UserFlowAttributeOutput

type UserFlowAttributeArgs added in v5.37.0

type UserFlowAttributeArgs struct {
	// The data type of the user flow attribute. Possible values are `boolean`, `dateTime`, `int64`, `string` or `stringCollection`. Changing this forces a new resource to be created.
	DataType pulumi.StringInput
	// The description of the user flow attribute that is shown to the user at the time of sign-up.
	Description pulumi.StringInput
	// The display name of the user flow attribute. Changing this forces a new resource to be created.
	DisplayName pulumi.StringInput
}

The set of arguments for constructing a UserFlowAttribute resource.

func (UserFlowAttributeArgs) ElementType added in v5.37.0

func (UserFlowAttributeArgs) ElementType() reflect.Type

type UserFlowAttributeArray added in v5.37.0

type UserFlowAttributeArray []UserFlowAttributeInput

func (UserFlowAttributeArray) ElementType added in v5.37.0

func (UserFlowAttributeArray) ElementType() reflect.Type

func (UserFlowAttributeArray) ToUserFlowAttributeArrayOutput added in v5.37.0

func (i UserFlowAttributeArray) ToUserFlowAttributeArrayOutput() UserFlowAttributeArrayOutput

func (UserFlowAttributeArray) ToUserFlowAttributeArrayOutputWithContext added in v5.37.0

func (i UserFlowAttributeArray) ToUserFlowAttributeArrayOutputWithContext(ctx context.Context) UserFlowAttributeArrayOutput

type UserFlowAttributeArrayInput added in v5.37.0

type UserFlowAttributeArrayInput interface {
	pulumi.Input

	ToUserFlowAttributeArrayOutput() UserFlowAttributeArrayOutput
	ToUserFlowAttributeArrayOutputWithContext(context.Context) UserFlowAttributeArrayOutput
}

UserFlowAttributeArrayInput is an input type that accepts UserFlowAttributeArray and UserFlowAttributeArrayOutput values. You can construct a concrete instance of `UserFlowAttributeArrayInput` via:

UserFlowAttributeArray{ UserFlowAttributeArgs{...} }

type UserFlowAttributeArrayOutput added in v5.37.0

type UserFlowAttributeArrayOutput struct{ *pulumi.OutputState }

func (UserFlowAttributeArrayOutput) ElementType added in v5.37.0

func (UserFlowAttributeArrayOutput) Index added in v5.37.0

func (UserFlowAttributeArrayOutput) ToUserFlowAttributeArrayOutput added in v5.37.0

func (o UserFlowAttributeArrayOutput) ToUserFlowAttributeArrayOutput() UserFlowAttributeArrayOutput

func (UserFlowAttributeArrayOutput) ToUserFlowAttributeArrayOutputWithContext added in v5.37.0

func (o UserFlowAttributeArrayOutput) ToUserFlowAttributeArrayOutputWithContext(ctx context.Context) UserFlowAttributeArrayOutput

type UserFlowAttributeInput added in v5.37.0

type UserFlowAttributeInput interface {
	pulumi.Input

	ToUserFlowAttributeOutput() UserFlowAttributeOutput
	ToUserFlowAttributeOutputWithContext(ctx context.Context) UserFlowAttributeOutput
}

type UserFlowAttributeMap added in v5.37.0

type UserFlowAttributeMap map[string]UserFlowAttributeInput

func (UserFlowAttributeMap) ElementType added in v5.37.0

func (UserFlowAttributeMap) ElementType() reflect.Type

func (UserFlowAttributeMap) ToUserFlowAttributeMapOutput added in v5.37.0

func (i UserFlowAttributeMap) ToUserFlowAttributeMapOutput() UserFlowAttributeMapOutput

func (UserFlowAttributeMap) ToUserFlowAttributeMapOutputWithContext added in v5.37.0

func (i UserFlowAttributeMap) ToUserFlowAttributeMapOutputWithContext(ctx context.Context) UserFlowAttributeMapOutput

type UserFlowAttributeMapInput added in v5.37.0

type UserFlowAttributeMapInput interface {
	pulumi.Input

	ToUserFlowAttributeMapOutput() UserFlowAttributeMapOutput
	ToUserFlowAttributeMapOutputWithContext(context.Context) UserFlowAttributeMapOutput
}

UserFlowAttributeMapInput is an input type that accepts UserFlowAttributeMap and UserFlowAttributeMapOutput values. You can construct a concrete instance of `UserFlowAttributeMapInput` via:

UserFlowAttributeMap{ "key": UserFlowAttributeArgs{...} }

type UserFlowAttributeMapOutput added in v5.37.0

type UserFlowAttributeMapOutput struct{ *pulumi.OutputState }

func (UserFlowAttributeMapOutput) ElementType added in v5.37.0

func (UserFlowAttributeMapOutput) ElementType() reflect.Type

func (UserFlowAttributeMapOutput) MapIndex added in v5.37.0

func (UserFlowAttributeMapOutput) ToUserFlowAttributeMapOutput added in v5.37.0

func (o UserFlowAttributeMapOutput) ToUserFlowAttributeMapOutput() UserFlowAttributeMapOutput

func (UserFlowAttributeMapOutput) ToUserFlowAttributeMapOutputWithContext added in v5.37.0

func (o UserFlowAttributeMapOutput) ToUserFlowAttributeMapOutputWithContext(ctx context.Context) UserFlowAttributeMapOutput

type UserFlowAttributeOutput added in v5.37.0

type UserFlowAttributeOutput struct{ *pulumi.OutputState }

func (UserFlowAttributeOutput) AttributeType added in v5.37.0

func (o UserFlowAttributeOutput) AttributeType() pulumi.StringOutput

The type of the user flow attribute. Values include `builtIn`, `custom` or `required`.

func (UserFlowAttributeOutput) DataType added in v5.37.0

The data type of the user flow attribute. Possible values are `boolean`, `dateTime`, `int64`, `string` or `stringCollection`. Changing this forces a new resource to be created.

func (UserFlowAttributeOutput) Description added in v5.37.0

The description of the user flow attribute that is shown to the user at the time of sign-up.

func (UserFlowAttributeOutput) DisplayName added in v5.37.0

The display name of the user flow attribute. Changing this forces a new resource to be created.

func (UserFlowAttributeOutput) ElementType added in v5.37.0

func (UserFlowAttributeOutput) ElementType() reflect.Type

func (UserFlowAttributeOutput) ToUserFlowAttributeOutput added in v5.37.0

func (o UserFlowAttributeOutput) ToUserFlowAttributeOutput() UserFlowAttributeOutput

func (UserFlowAttributeOutput) ToUserFlowAttributeOutputWithContext added in v5.37.0

func (o UserFlowAttributeOutput) ToUserFlowAttributeOutputWithContext(ctx context.Context) UserFlowAttributeOutput

type UserFlowAttributeState added in v5.37.0

type UserFlowAttributeState struct {
	// The type of the user flow attribute. Values include `builtIn`, `custom` or `required`.
	AttributeType pulumi.StringPtrInput
	// The data type of the user flow attribute. Possible values are `boolean`, `dateTime`, `int64`, `string` or `stringCollection`. Changing this forces a new resource to be created.
	DataType pulumi.StringPtrInput
	// The description of the user flow attribute that is shown to the user at the time of sign-up.
	Description pulumi.StringPtrInput
	// The display name of the user flow attribute. Changing this forces a new resource to be created.
	DisplayName pulumi.StringPtrInput
}

func (UserFlowAttributeState) ElementType added in v5.37.0

func (UserFlowAttributeState) ElementType() reflect.Type

type UserInput

type UserInput interface {
	pulumi.Input

	ToUserOutput() UserOutput
	ToUserOutputWithContext(ctx context.Context) UserOutput
}

type UserMap

type UserMap map[string]UserInput

func (UserMap) ElementType

func (UserMap) ElementType() reflect.Type

func (UserMap) ToUserMapOutput

func (i UserMap) ToUserMapOutput() UserMapOutput

func (UserMap) ToUserMapOutputWithContext

func (i UserMap) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput

type UserMapInput

type UserMapInput interface {
	pulumi.Input

	ToUserMapOutput() UserMapOutput
	ToUserMapOutputWithContext(context.Context) UserMapOutput
}

UserMapInput is an input type that accepts UserMap and UserMapOutput values. You can construct a concrete instance of `UserMapInput` via:

UserMap{ "key": UserArgs{...} }

type UserMapOutput

type UserMapOutput struct{ *pulumi.OutputState }

func (UserMapOutput) ElementType

func (UserMapOutput) ElementType() reflect.Type

func (UserMapOutput) MapIndex

func (UserMapOutput) ToUserMapOutput

func (o UserMapOutput) ToUserMapOutput() UserMapOutput

func (UserMapOutput) ToUserMapOutputWithContext

func (o UserMapOutput) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput

type UserOutput

type UserOutput struct{ *pulumi.OutputState }

func (UserOutput) AboutMe added in v5.22.0

func (o UserOutput) AboutMe() pulumi.StringOutput

A freeform field for the user to describe themselves

func (UserOutput) AccountEnabled added in v5.22.0

func (o UserOutput) AccountEnabled() pulumi.BoolPtrOutput

Whether or not the account should be enabled.

func (UserOutput) AgeGroup added in v5.22.0

func (o UserOutput) AgeGroup() pulumi.StringPtrOutput

The age group of the user. Supported values are `Adult`, `NotAdult` and `Minor`. Omit this property or specify a blank string to unset.

func (UserOutput) BusinessPhones added in v5.22.0

func (o UserOutput) BusinessPhones() pulumi.StringArrayOutput

A list of telephone numbers for the user. Only one number can be set for this property. Read-only for users synced with Azure AD Connect.

func (UserOutput) City added in v5.22.0

The city in which the user is located.

func (UserOutput) CompanyName added in v5.22.0

func (o UserOutput) CompanyName() pulumi.StringPtrOutput

The company name which the user is associated. This property can be useful for describing the company that an external user comes from.

func (UserOutput) ConsentProvidedForMinor added in v5.22.0

func (o UserOutput) ConsentProvidedForMinor() pulumi.StringPtrOutput

Whether consent has been obtained for minors. Supported values are `Granted`, `Denied` and `NotRequired`. Omit this property or specify a blank string to unset.

func (UserOutput) CostCenter added in v5.22.0

func (o UserOutput) CostCenter() pulumi.StringPtrOutput

The cost center associated with the user.

func (UserOutput) Country added in v5.22.0

func (o UserOutput) Country() pulumi.StringPtrOutput

The country/region in which the user is located. Examples include: `NO`, `JP`, and `GB`.

func (UserOutput) CreationType added in v5.22.0

func (o UserOutput) CreationType() pulumi.StringOutput

Indicates whether the user account was created as a regular school or work account (`null`), an external account (`Invitation`), a local account for an Azure Active Directory B2C tenant (`LocalAccount`) or self-service sign-up using email verification (`EmailVerified`).

func (UserOutput) Department added in v5.22.0

func (o UserOutput) Department() pulumi.StringPtrOutput

The name for the department in which the user works.

func (UserOutput) DisablePasswordExpiration added in v5.22.0

func (o UserOutput) DisablePasswordExpiration() pulumi.BoolPtrOutput

Whether the user's password is exempt from expiring. Defaults to `false`.

func (UserOutput) DisableStrongPassword added in v5.22.0

func (o UserOutput) DisableStrongPassword() pulumi.BoolPtrOutput

Whether the user is allowed weaker passwords than the default policy to be specified. Defaults to `false`.

func (UserOutput) DisplayName added in v5.22.0

func (o UserOutput) DisplayName() pulumi.StringOutput

The name to display in the address book for the user.

func (UserOutput) Division added in v5.22.0

func (o UserOutput) Division() pulumi.StringPtrOutput

The name of the division in which the user works.

func (UserOutput) ElementType

func (UserOutput) ElementType() reflect.Type

func (UserOutput) EmployeeId added in v5.22.0

func (o UserOutput) EmployeeId() pulumi.StringPtrOutput

The employee identifier assigned to the user by the organisation.

func (UserOutput) EmployeeType added in v5.22.0

func (o UserOutput) EmployeeType() pulumi.StringPtrOutput

Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor.

func (UserOutput) ExternalUserState added in v5.22.0

func (o UserOutput) ExternalUserState() pulumi.StringOutput

For an external user invited to the tenant, this property represents the invited user's invitation status. Possible values are `PendingAcceptance` or `Accepted`.

func (UserOutput) FaxNumber added in v5.22.0

func (o UserOutput) FaxNumber() pulumi.StringPtrOutput

The fax number of the user.

func (UserOutput) ForcePasswordChange added in v5.22.0

func (o UserOutput) ForcePasswordChange() pulumi.BoolPtrOutput

Whether the user is forced to change the password during the next sign-in. Only takes effect when also changing the password. Defaults to `false`.

func (UserOutput) GivenName added in v5.22.0

func (o UserOutput) GivenName() pulumi.StringPtrOutput

The given name (first name) of the user.

func (UserOutput) ImAddresses added in v5.22.0

func (o UserOutput) ImAddresses() pulumi.StringArrayOutput

A list of instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user.

func (UserOutput) JobTitle added in v5.22.0

func (o UserOutput) JobTitle() pulumi.StringPtrOutput

The user’s job title.

func (UserOutput) Mail added in v5.22.0

func (o UserOutput) Mail() pulumi.StringOutput

The SMTP address for the user. This property cannot be unset once specified.

func (UserOutput) MailNickname added in v5.22.0

func (o UserOutput) MailNickname() pulumi.StringOutput

The mail alias for the user. Defaults to the user name part of the user principal name (UPN).

func (UserOutput) ManagerId added in v5.22.0

func (o UserOutput) ManagerId() pulumi.StringPtrOutput

The object ID of the user's manager.

func (UserOutput) MobilePhone added in v5.22.0

func (o UserOutput) MobilePhone() pulumi.StringPtrOutput

The primary cellular telephone number for the user.

func (UserOutput) ObjectId added in v5.22.0

func (o UserOutput) ObjectId() pulumi.StringOutput

The object ID of the user.

func (UserOutput) OfficeLocation added in v5.22.0

func (o UserOutput) OfficeLocation() pulumi.StringPtrOutput

The office location in the user's place of business.

func (UserOutput) OnpremisesDistinguishedName added in v5.22.0

func (o UserOutput) OnpremisesDistinguishedName() pulumi.StringOutput

The on-premises distinguished name (DN) of the user, synchronised from the on-premises directory when Azure AD Connect is used.

func (UserOutput) OnpremisesDomainName added in v5.22.0

func (o UserOutput) OnpremisesDomainName() pulumi.StringOutput

The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.

func (UserOutput) OnpremisesImmutableId added in v5.22.0

func (o UserOutput) OnpremisesImmutableId() pulumi.StringOutput

The value used to associate an on-premise Active Directory user account with their Azure AD user object. This must be specified if you are using a federated domain for the user's `userPrincipalName` property when creating a new user account.

func (UserOutput) OnpremisesSamAccountName added in v5.22.0

func (o UserOutput) OnpremisesSamAccountName() pulumi.StringOutput

The on-premise SAM account name of the user.

func (UserOutput) OnpremisesSecurityIdentifier added in v5.22.0

func (o UserOutput) OnpremisesSecurityIdentifier() pulumi.StringOutput

The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.

func (UserOutput) OnpremisesSyncEnabled added in v5.22.0

func (o UserOutput) OnpremisesSyncEnabled() pulumi.BoolOutput

Whether this user is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).

func (UserOutput) OnpremisesUserPrincipalName added in v5.22.0

func (o UserOutput) OnpremisesUserPrincipalName() pulumi.StringOutput

The on-premise user principal name of the user.

func (UserOutput) OtherMails added in v5.22.0

func (o UserOutput) OtherMails() pulumi.StringArrayOutput

A list of additional email addresses for the user.

func (UserOutput) Password added in v5.22.0

func (o UserOutput) Password() pulumi.StringOutput

The password for the user. The password must satisfy minimum requirements as specified by the password policy. The maximum length is 256 characters. This property is required when creating a new user

func (UserOutput) PostalCode added in v5.22.0

func (o UserOutput) PostalCode() pulumi.StringPtrOutput

The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.

func (UserOutput) PreferredLanguage added in v5.22.0

func (o UserOutput) PreferredLanguage() pulumi.StringPtrOutput

The user's preferred language, in ISO 639-1 notation.

func (UserOutput) ProxyAddresses added in v5.22.0

func (o UserOutput) ProxyAddresses() pulumi.StringArrayOutput

List of email addresses for the user that direct to the same mailbox.

func (UserOutput) ShowInAddressList added in v5.22.0

func (o UserOutput) ShowInAddressList() pulumi.BoolPtrOutput

Whether or not the Outlook global address list should include this user. Defaults to `true`.

func (UserOutput) State added in v5.22.0

func (o UserOutput) State() pulumi.StringPtrOutput

The state or province in the user's address.

func (UserOutput) StreetAddress added in v5.22.0

func (o UserOutput) StreetAddress() pulumi.StringPtrOutput

The street address of the user's place of business.

func (UserOutput) Surname added in v5.22.0

func (o UserOutput) Surname() pulumi.StringPtrOutput

The user's surname (family name or last name).

func (UserOutput) ToUserOutput

func (o UserOutput) ToUserOutput() UserOutput

func (UserOutput) ToUserOutputWithContext

func (o UserOutput) ToUserOutputWithContext(ctx context.Context) UserOutput

func (UserOutput) UsageLocation added in v5.22.0

func (o UserOutput) UsageLocation() pulumi.StringPtrOutput

The usage location of the user. Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set.

func (UserOutput) UserPrincipalName added in v5.22.0

func (o UserOutput) UserPrincipalName() pulumi.StringOutput

The user principal name (UPN) of the user.

func (UserOutput) UserType added in v5.22.0

func (o UserOutput) UserType() pulumi.StringOutput

The user type in the directory. Possible values are `Guest` or `Member`.

type UserState

type UserState struct {
	// A freeform field for the user to describe themselves
	AboutMe pulumi.StringPtrInput
	// Whether or not the account should be enabled.
	AccountEnabled pulumi.BoolPtrInput
	// The age group of the user. Supported values are `Adult`, `NotAdult` and `Minor`. Omit this property or specify a blank string to unset.
	AgeGroup pulumi.StringPtrInput
	// A list of telephone numbers for the user. Only one number can be set for this property. Read-only for users synced with Azure AD Connect.
	BusinessPhones pulumi.StringArrayInput
	// The city in which the user is located.
	City pulumi.StringPtrInput
	// The company name which the user is associated. This property can be useful for describing the company that an external user comes from.
	CompanyName pulumi.StringPtrInput
	// Whether consent has been obtained for minors. Supported values are `Granted`, `Denied` and `NotRequired`. Omit this property or specify a blank string to unset.
	ConsentProvidedForMinor pulumi.StringPtrInput
	// The cost center associated with the user.
	CostCenter pulumi.StringPtrInput
	// The country/region in which the user is located. Examples include: `NO`, `JP`, and `GB`.
	Country pulumi.StringPtrInput
	// Indicates whether the user account was created as a regular school or work account (`null`), an external account (`Invitation`), a local account for an Azure Active Directory B2C tenant (`LocalAccount`) or self-service sign-up using email verification (`EmailVerified`).
	CreationType pulumi.StringPtrInput
	// The name for the department in which the user works.
	Department pulumi.StringPtrInput
	// Whether the user's password is exempt from expiring. Defaults to `false`.
	DisablePasswordExpiration pulumi.BoolPtrInput
	// Whether the user is allowed weaker passwords than the default policy to be specified. Defaults to `false`.
	DisableStrongPassword pulumi.BoolPtrInput
	// The name to display in the address book for the user.
	DisplayName pulumi.StringPtrInput
	// The name of the division in which the user works.
	Division pulumi.StringPtrInput
	// The employee identifier assigned to the user by the organisation.
	EmployeeId pulumi.StringPtrInput
	// Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor.
	EmployeeType pulumi.StringPtrInput
	// For an external user invited to the tenant, this property represents the invited user's invitation status. Possible values are `PendingAcceptance` or `Accepted`.
	ExternalUserState pulumi.StringPtrInput
	// The fax number of the user.
	FaxNumber pulumi.StringPtrInput
	// Whether the user is forced to change the password during the next sign-in. Only takes effect when also changing the password. Defaults to `false`.
	ForcePasswordChange pulumi.BoolPtrInput
	// The given name (first name) of the user.
	GivenName pulumi.StringPtrInput
	// A list of instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user.
	ImAddresses pulumi.StringArrayInput
	// The user’s job title.
	JobTitle pulumi.StringPtrInput
	// The SMTP address for the user. This property cannot be unset once specified.
	Mail pulumi.StringPtrInput
	// The mail alias for the user. Defaults to the user name part of the user principal name (UPN).
	MailNickname pulumi.StringPtrInput
	// The object ID of the user's manager.
	ManagerId pulumi.StringPtrInput
	// The primary cellular telephone number for the user.
	MobilePhone pulumi.StringPtrInput
	// The object ID of the user.
	ObjectId pulumi.StringPtrInput
	// The office location in the user's place of business.
	OfficeLocation pulumi.StringPtrInput
	// The on-premises distinguished name (DN) of the user, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesDistinguishedName pulumi.StringPtrInput
	// The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesDomainName pulumi.StringPtrInput
	// The value used to associate an on-premise Active Directory user account with their Azure AD user object. This must be specified if you are using a federated domain for the user's `userPrincipalName` property when creating a new user account.
	OnpremisesImmutableId pulumi.StringPtrInput
	// The on-premise SAM account name of the user.
	OnpremisesSamAccountName pulumi.StringPtrInput
	// The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
	OnpremisesSecurityIdentifier pulumi.StringPtrInput
	// Whether this user is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).
	OnpremisesSyncEnabled pulumi.BoolPtrInput
	// The on-premise user principal name of the user.
	OnpremisesUserPrincipalName pulumi.StringPtrInput
	// A list of additional email addresses for the user.
	OtherMails pulumi.StringArrayInput
	// The password for the user. The password must satisfy minimum requirements as specified by the password policy. The
	// maximum length is 256 characters. This property is required when creating a new user
	Password pulumi.StringPtrInput
	// The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.
	PostalCode pulumi.StringPtrInput
	// The user's preferred language, in ISO 639-1 notation.
	PreferredLanguage pulumi.StringPtrInput
	// List of email addresses for the user that direct to the same mailbox.
	ProxyAddresses pulumi.StringArrayInput
	// Whether or not the Outlook global address list should include this user. Defaults to `true`.
	ShowInAddressList pulumi.BoolPtrInput
	// The state or province in the user's address.
	State pulumi.StringPtrInput
	// The street address of the user's place of business.
	StreetAddress pulumi.StringPtrInput
	// The user's surname (family name or last name).
	Surname pulumi.StringPtrInput
	// The usage location of the user. Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set.
	UsageLocation pulumi.StringPtrInput
	// The user principal name (UPN) of the user.
	UserPrincipalName pulumi.StringPtrInput
	// The user type in the directory. Possible values are `Guest` or `Member`.
	UserType pulumi.StringPtrInput
}

func (UserState) ElementType

func (UserState) ElementType() reflect.Type

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL