aadb2c

package
v5.78.0 Latest Latest
Warning

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

 Go to latest Published: May 22, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Directory 

type Directory struct {
	pulumi.CustomResourceState

	// The type of billing for the AAD B2C tenant. Possible values include: `MAU` or `Auths`.
	BillingType pulumi.StringOutput `pulumi:"billingType"`
	// Country code of the B2C tenant. The `countryCode` should be valid for the specified `dataResidencyLocation`. See [official docs](https://aka.ms/B2CDataResidency) for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.
	CountryCode pulumi.StringOutput `pulumi:"countryCode"`
	// Location in which the B2C tenant is hosted and data resides. The `dataResidencyLocation` should be valid for the specified `countryCode`. See [official docs](https://aka.ms/B2CDataResidenc) for more information. Changing this forces a new AAD B2C Directory to be created. Possible values are `Asia Pacific`, `Australia`, `Europe`, `Global` and `United States`.
	DataResidencyLocation pulumi.StringOutput `pulumi:"dataResidencyLocation"`
	// The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Domain name of the B2C tenant, including the `.onmicrosoft.com` suffix. Changing this forces a new AAD B2C Directory to be created.
	DomainName pulumi.StringOutput `pulumi:"domainName"`
	// The date from which the billing type took effect. May not be populated until after the first billing cycle.
	EffectiveStartDate pulumi.StringOutput `pulumi:"effectiveStartDate"`
	// The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// Billing SKU for the B2C tenant. Must be one of: `PremiumP1` or `PremiumP2` (`Standard` is not supported). See [official docs](https://aka.ms/b2cBilling) for more information.
	SkuName pulumi.StringOutput `pulumi:"skuName"`
	// A mapping of tags which should be assigned to the AAD B2C Directory.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// The Tenant ID for the AAD B2C tenant.
	TenantId pulumi.StringOutput `pulumi:"tenantId"`
}

Manages an AAD B2C Directory.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/aadb2c"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aadb2c.NewDirectory(ctx, "example", &aadb2c.DirectoryArgs{
			CountryCode:           pulumi.String("US"),
			DataResidencyLocation: pulumi.String("United States"),
			DisplayName:           pulumi.String("example-b2c-tenant"),
			DomainName:            pulumi.String("exampleb2ctenant.onmicrosoft.com"),
			ResourceGroupName:     pulumi.String("example-rg"),
			SkuName:               pulumi.String("PremiumP1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

AAD B2C Directories can be imported using the `resource id`, e.g.

```sh $ pulumi import azure:aadb2c/directory:Directory example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/example-resource-group/providers/Microsoft.AzureActiveDirectory/b2cDirectories/directory-name ```

func GetDirectory 

func GetDirectory(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DirectoryState, opts ...pulumi.ResourceOption) (*Directory, error)

GetDirectory gets an existing Directory 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 NewDirectory 

func NewDirectory(ctx *pulumi.Context,
	name string, args *DirectoryArgs, opts ...pulumi.ResourceOption) (*Directory, error)

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

func (*Directory) ElementType 

func (*Directory) ElementType() reflect.Type

func (*Directory) ToDirectoryOutput 

func (i *Directory) ToDirectoryOutput() DirectoryOutput

func (*Directory) ToDirectoryOutputWithContext 

func (i *Directory) ToDirectoryOutputWithContext(ctx context.Context) DirectoryOutput

type DirectoryArgs 

type DirectoryArgs struct {
	// Country code of the B2C tenant. The `countryCode` should be valid for the specified `dataResidencyLocation`. See [official docs](https://aka.ms/B2CDataResidency) for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.
	CountryCode pulumi.StringPtrInput
	// Location in which the B2C tenant is hosted and data resides. The `dataResidencyLocation` should be valid for the specified `countryCode`. See [official docs](https://aka.ms/B2CDataResidenc) for more information. Changing this forces a new AAD B2C Directory to be created. Possible values are `Asia Pacific`, `Australia`, `Europe`, `Global` and `United States`.
	DataResidencyLocation pulumi.StringInput
	// The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.
	DisplayName pulumi.StringPtrInput
	// Domain name of the B2C tenant, including the `.onmicrosoft.com` suffix. Changing this forces a new AAD B2C Directory to be created.
	DomainName pulumi.StringInput
	// The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.
	ResourceGroupName pulumi.StringInput
	// Billing SKU for the B2C tenant. Must be one of: `PremiumP1` or `PremiumP2` (`Standard` is not supported). See [official docs](https://aka.ms/b2cBilling) for more information.
	SkuName pulumi.StringInput
	// A mapping of tags which should be assigned to the AAD B2C Directory.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Directory resource.

func (DirectoryArgs) ElementType 

func (DirectoryArgs) ElementType() reflect.Type

type DirectoryArray 

type DirectoryArray []DirectoryInput

func (DirectoryArray) ElementType 

func (DirectoryArray) ElementType() reflect.Type

func (DirectoryArray) ToDirectoryArrayOutput 

func (i DirectoryArray) ToDirectoryArrayOutput() DirectoryArrayOutput

func (DirectoryArray) ToDirectoryArrayOutputWithContext 

func (i DirectoryArray) ToDirectoryArrayOutputWithContext(ctx context.Context) DirectoryArrayOutput

type DirectoryArrayInput 

type DirectoryArrayInput interface {
	pulumi.Input

	ToDirectoryArrayOutput() DirectoryArrayOutput
	ToDirectoryArrayOutputWithContext(context.Context) DirectoryArrayOutput
}

DirectoryArrayInput is an input type that accepts DirectoryArray and DirectoryArrayOutput values. You can construct a concrete instance of `DirectoryArrayInput` via: 

DirectoryArray{ DirectoryArgs{...} }

type DirectoryArrayOutput 

type DirectoryArrayOutput struct{ *pulumi.OutputState }

func (DirectoryArrayOutput) ElementType 

func (DirectoryArrayOutput) ElementType() reflect.Type

func (DirectoryArrayOutput) Index 

func (o DirectoryArrayOutput) Index(i pulumi.IntInput) DirectoryOutput

func (DirectoryArrayOutput) ToDirectoryArrayOutput 

func (o DirectoryArrayOutput) ToDirectoryArrayOutput() DirectoryArrayOutput

func (DirectoryArrayOutput) ToDirectoryArrayOutputWithContext 

func (o DirectoryArrayOutput) ToDirectoryArrayOutputWithContext(ctx context.Context) DirectoryArrayOutput

type DirectoryInput 

type DirectoryInput interface {
	pulumi.Input

	ToDirectoryOutput() DirectoryOutput
	ToDirectoryOutputWithContext(ctx context.Context) DirectoryOutput
}

type DirectoryMap 

type DirectoryMap map[string]DirectoryInput

func (DirectoryMap) ElementType 

func (DirectoryMap) ElementType() reflect.Type

func (DirectoryMap) ToDirectoryMapOutput 

func (i DirectoryMap) ToDirectoryMapOutput() DirectoryMapOutput

func (DirectoryMap) ToDirectoryMapOutputWithContext 

func (i DirectoryMap) ToDirectoryMapOutputWithContext(ctx context.Context) DirectoryMapOutput

type DirectoryMapInput 

type DirectoryMapInput interface {
	pulumi.Input

	ToDirectoryMapOutput() DirectoryMapOutput
	ToDirectoryMapOutputWithContext(context.Context) DirectoryMapOutput
}

DirectoryMapInput is an input type that accepts DirectoryMap and DirectoryMapOutput values. You can construct a concrete instance of `DirectoryMapInput` via: 

DirectoryMap{ "key": DirectoryArgs{...} }

type DirectoryMapOutput 

type DirectoryMapOutput struct{ *pulumi.OutputState }

func (DirectoryMapOutput) ElementType 

func (DirectoryMapOutput) ElementType() reflect.Type

func (DirectoryMapOutput) MapIndex 

func (o DirectoryMapOutput) MapIndex(k pulumi.StringInput) DirectoryOutput

func (DirectoryMapOutput) ToDirectoryMapOutput 

func (o DirectoryMapOutput) ToDirectoryMapOutput() DirectoryMapOutput

func (DirectoryMapOutput) ToDirectoryMapOutputWithContext 

func (o DirectoryMapOutput) ToDirectoryMapOutputWithContext(ctx context.Context) DirectoryMapOutput

type DirectoryOutput 

type DirectoryOutput struct{ *pulumi.OutputState }

func (DirectoryOutput) BillingType added in v5.5.0 

func (o DirectoryOutput) BillingType() pulumi.StringOutput

The type of billing for the AAD B2C tenant. Possible values include: `MAU` or `Auths`.

func (DirectoryOutput) CountryCode added in v5.5.0 

func (o DirectoryOutput) CountryCode() pulumi.StringOutput

Country code of the B2C tenant. The `countryCode` should be valid for the specified `dataResidencyLocation`. See [official docs](https://aka.ms/B2CDataResidency) for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

func (DirectoryOutput) DataResidencyLocation added in v5.5.0 

func (o DirectoryOutput) DataResidencyLocation() pulumi.StringOutput

Location in which the B2C tenant is hosted and data resides. The `dataResidencyLocation` should be valid for the specified `countryCode`. See [official docs](https://aka.ms/B2CDataResidenc) for more information. Changing this forces a new AAD B2C Directory to be created. Possible values are `Asia Pacific`, `Australia`, `Europe`, `Global` and `United States`.

func (DirectoryOutput) DisplayName added in v5.5.0 

func (o DirectoryOutput) DisplayName() pulumi.StringOutput

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

func (DirectoryOutput) DomainName added in v5.5.0 

func (o DirectoryOutput) DomainName() pulumi.StringOutput

Domain name of the B2C tenant, including the `.onmicrosoft.com` suffix. Changing this forces a new AAD B2C Directory to be created.

func (DirectoryOutput) EffectiveStartDate added in v5.5.0 

func (o DirectoryOutput) EffectiveStartDate() pulumi.StringOutput

The date from which the billing type took effect. May not be populated until after the first billing cycle.

func (DirectoryOutput) ElementType 

func (DirectoryOutput) ElementType() reflect.Type

func (DirectoryOutput) ResourceGroupName added in v5.5.0 

func (o DirectoryOutput) ResourceGroupName() pulumi.StringOutput

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

func (DirectoryOutput) SkuName added in v5.5.0 

func (o DirectoryOutput) SkuName() pulumi.StringOutput

Billing SKU for the B2C tenant. Must be one of: `PremiumP1` or `PremiumP2` (`Standard` is not supported). See [official docs](https://aka.ms/b2cBilling) for more information.

func (DirectoryOutput) Tags added in v5.5.0 

func (o DirectoryOutput) Tags() pulumi.StringMapOutput

A mapping of tags which should be assigned to the AAD B2C Directory.

func (DirectoryOutput) TenantId added in v5.5.0 

func (o DirectoryOutput) TenantId() pulumi.StringOutput

The Tenant ID for the AAD B2C tenant.

func (DirectoryOutput) ToDirectoryOutput 

func (o DirectoryOutput) ToDirectoryOutput() DirectoryOutput

func (DirectoryOutput) ToDirectoryOutputWithContext 

func (o DirectoryOutput) ToDirectoryOutputWithContext(ctx context.Context) DirectoryOutput

type DirectoryState 

type DirectoryState struct {
	// The type of billing for the AAD B2C tenant. Possible values include: `MAU` or `Auths`.
	BillingType pulumi.StringPtrInput
	// Country code of the B2C tenant. The `countryCode` should be valid for the specified `dataResidencyLocation`. See [official docs](https://aka.ms/B2CDataResidency) for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.
	CountryCode pulumi.StringPtrInput
	// Location in which the B2C tenant is hosted and data resides. The `dataResidencyLocation` should be valid for the specified `countryCode`. See [official docs](https://aka.ms/B2CDataResidenc) for more information. Changing this forces a new AAD B2C Directory to be created. Possible values are `Asia Pacific`, `Australia`, `Europe`, `Global` and `United States`.
	DataResidencyLocation pulumi.StringPtrInput
	// The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.
	DisplayName pulumi.StringPtrInput
	// Domain name of the B2C tenant, including the `.onmicrosoft.com` suffix. Changing this forces a new AAD B2C Directory to be created.
	DomainName pulumi.StringPtrInput
	// The date from which the billing type took effect. May not be populated until after the first billing cycle.
	EffectiveStartDate pulumi.StringPtrInput
	// The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.
	ResourceGroupName pulumi.StringPtrInput
	// Billing SKU for the B2C tenant. Must be one of: `PremiumP1` or `PremiumP2` (`Standard` is not supported). See [official docs](https://aka.ms/b2cBilling) for more information.
	SkuName pulumi.StringPtrInput
	// A mapping of tags which should be assigned to the AAD B2C Directory.
	Tags pulumi.StringMapInput
	// The Tenant ID for the AAD B2C tenant.
	TenantId pulumi.StringPtrInput
}

func (DirectoryState) ElementType 

func (DirectoryState) ElementType() reflect.Type

type LookupDirectoryArgs 

type LookupDirectoryArgs struct {
	// Domain name of the B2C tenant, including the `.onmicrosoft.com` suffix.
	DomainName string `pulumi:"domainName"`
	// The name of the Resource Group where the AAD B2C Directory exists.
	ResourceGroupName string `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getDirectory.

type LookupDirectoryOutputArgs 

type LookupDirectoryOutputArgs struct {
	// Domain name of the B2C tenant, including the `.onmicrosoft.com` suffix.
	DomainName pulumi.StringInput `pulumi:"domainName"`
	// The name of the Resource Group where the AAD B2C Directory exists.
	ResourceGroupName pulumi.StringInput `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getDirectory.

func (LookupDirectoryOutputArgs) ElementType 

func (LookupDirectoryOutputArgs) ElementType() reflect.Type

type LookupDirectoryResult 

type LookupDirectoryResult struct {
	// The type of billing for the AAD B2C tenant. Possible values include: `MAU` or `Auths`.
	BillingType string `pulumi:"billingType"`
	// Location in which the B2C tenant is hosted and data resides. See [official docs](https://aka.ms/B2CDataResidenc) for more information.
	DataResidencyLocation string `pulumi:"dataResidencyLocation"`
	DomainName            string `pulumi:"domainName"`
	// The date from which the billing type took effect. May not be populated until after the first billing cycle.
	EffectiveStartDate string `pulumi:"effectiveStartDate"`
	// The provider-assigned unique ID for this managed resource.
	Id                string `pulumi:"id"`
	ResourceGroupName string `pulumi:"resourceGroupName"`
	// Billing SKU for the B2C tenant. See [official docs](https://aka.ms/b2cBilling) for more information.
	SkuName string `pulumi:"skuName"`
	// A mapping of tags assigned to the AAD B2C Directory.
	Tags map[string]string `pulumi:"tags"`
	// The Tenant ID for the AAD B2C tenant.
	TenantId string `pulumi:"tenantId"`
}

A collection of values returned by getDirectory.

func LookupDirectory 

func LookupDirectory(ctx *pulumi.Context, args *LookupDirectoryArgs, opts ...pulumi.InvokeOption) (*LookupDirectoryResult, error)

Use this data source to access information about an existing AAD B2C Directory.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/aadb2c"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := aadb2c.LookupDirectory(ctx, &aadb2c.LookupDirectoryArgs{
			ResourceGroupName: "example-rg",
			DomainName:        "exampleb2ctenant.onmicrosoft.com",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("tenantId", example.TenantId)
		return nil
	})
}

```

type LookupDirectoryResultOutput 

type LookupDirectoryResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDirectory.

func LookupDirectoryOutput 

func LookupDirectoryOutput(ctx *pulumi.Context, args LookupDirectoryOutputArgs, opts ...pulumi.InvokeOption) LookupDirectoryResultOutput

func (LookupDirectoryResultOutput) BillingType 

func (o LookupDirectoryResultOutput) BillingType() pulumi.StringOutput

The type of billing for the AAD B2C tenant. Possible values include: `MAU` or `Auths`.

func (LookupDirectoryResultOutput) DataResidencyLocation 

func (o LookupDirectoryResultOutput) DataResidencyLocation() pulumi.StringOutput

Location in which the B2C tenant is hosted and data resides. See [official docs](https://aka.ms/B2CDataResidenc) for more information.

func (LookupDirectoryResultOutput) DomainName 

func (o LookupDirectoryResultOutput) DomainName() pulumi.StringOutput

func (LookupDirectoryResultOutput) EffectiveStartDate 

func (o LookupDirectoryResultOutput) EffectiveStartDate() pulumi.StringOutput

The date from which the billing type took effect. May not be populated until after the first billing cycle.

func (LookupDirectoryResultOutput) ElementType 

func (LookupDirectoryResultOutput) ElementType() reflect.Type

func (LookupDirectoryResultOutput) Id 

func (o LookupDirectoryResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupDirectoryResultOutput) ResourceGroupName 

func (o LookupDirectoryResultOutput) ResourceGroupName() pulumi.StringOutput

func (LookupDirectoryResultOutput) SkuName 

func (o LookupDirectoryResultOutput) SkuName() pulumi.StringOutput

Billing SKU for the B2C tenant. See [official docs](https://aka.ms/b2cBilling) for more information.

func (LookupDirectoryResultOutput) Tags 

func (o LookupDirectoryResultOutput) Tags() pulumi.StringMapOutput

A mapping of tags assigned to the AAD B2C Directory.

func (LookupDirectoryResultOutput) TenantId 

func (o LookupDirectoryResultOutput) TenantId() pulumi.StringOutput

The Tenant ID for the AAD B2C tenant.

func (LookupDirectoryResultOutput) ToLookupDirectoryResultOutput 

func (o LookupDirectoryResultOutput) ToLookupDirectoryResultOutput() LookupDirectoryResultOutput

func (LookupDirectoryResultOutput) ToLookupDirectoryResultOutputWithContext 

func (o LookupDirectoryResultOutput) ToLookupDirectoryResultOutputWithContext(ctx context.Context) LookupDirectoryResultOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.