B2CTenants interface

  • Reference
Package:
@azure/arm-azureadexternalidentities

Interface representing a B2CTenants.

Methods

beginCreate(string, string, B2CTenantsCreateOptionalParams)

Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
beginCreateAndWait(string, string, B2CTenantsCreateOptionalParams)

Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
beginDelete(string, string, B2CTenantsDeleteOptionalParams)

Initiates an async operation to delete the Azure AD B2C tenant and Azure resource. The resource deletion can only happen as the last step in the tenant deletion process.
beginDeleteAndWait(string, string, B2CTenantsDeleteOptionalParams)

Initiates an async operation to delete the Azure AD B2C tenant and Azure resource. The resource deletion can only happen as the last step in the tenant deletion process.
checkNameAvailability(B2CTenantsCheckNameAvailabilityOptionalParams)

Checks the availability and validity of a domain name for the tenant.
get(string, string, B2CTenantsGetOptionalParams)

Get the Azure AD B2C tenant resource.
listByResourceGroup(string, B2CTenantsListByResourceGroupOptionalParams)

Get all the Azure AD B2C tenant resources in a resource group.
listBySubscription(B2CTenantsListBySubscriptionOptionalParams)

Get all the Azure AD B2C tenant resources in a subscription.
update(string, string, B2CTenantsUpdateOptionalParams)

Update the Azure AD B2C tenant resource.

Method Details

beginCreate(string, string, B2CTenantsCreateOptionalParams)

Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.

function beginCreate(resourceGroupName: string, resourceName: string, options?: B2CTenantsCreateOptionalParams): Promise<PollerLike<PollOperationState<B2CTenantResource>, B2CTenantResource>>

Parameters

resourceGroupName

string

The name of the resource group.

resourceName

string

The initial domain name of the Azure AD B2C tenant.

options
B2CTenantsCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<B2CTenantResource>, B2CTenantResource>>

beginCreateAndWait(string, string, B2CTenantsCreateOptionalParams)

Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.

function beginCreateAndWait(resourceGroupName: string, resourceName: string, options?: B2CTenantsCreateOptionalParams): Promise<B2CTenantResource>

Parameters

resourceGroupName

string

The name of the resource group.

resourceName

string

The initial domain name of the Azure AD B2C tenant.

options
B2CTenantsCreateOptionalParams

The options parameters.

Returns

Promise<B2CTenantResource>

beginDelete(string, string, B2CTenantsDeleteOptionalParams)

Initiates an async operation to delete the Azure AD B2C tenant and Azure resource. The resource deletion can only happen as the last step in the tenant deletion process.

function beginDelete(resourceGroupName: string, resourceName: string, options?: B2CTenantsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

resourceName

string

The initial domain name of the Azure AD B2C tenant.

options
B2CTenantsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, B2CTenantsDeleteOptionalParams)

Initiates an async operation to delete the Azure AD B2C tenant and Azure resource. The resource deletion can only happen as the last step in the tenant deletion process.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: B2CTenantsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

resourceName

string

The initial domain name of the Azure AD B2C tenant.

options
B2CTenantsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

checkNameAvailability(B2CTenantsCheckNameAvailabilityOptionalParams)

Checks the availability and validity of a domain name for the tenant.

function checkNameAvailability(options?: B2CTenantsCheckNameAvailabilityOptionalParams): Promise<NameAvailabilityResponse>

Parameters

options
B2CTenantsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<NameAvailabilityResponse>

get(string, string, B2CTenantsGetOptionalParams)

Get the Azure AD B2C tenant resource.

function get(resourceGroupName: string, resourceName: string, options?: B2CTenantsGetOptionalParams): Promise<B2CTenantResource>

Parameters

resourceGroupName

string

The name of the resource group.

resourceName

string

The initial domain name of the Azure AD B2C tenant.

options
B2CTenantsGetOptionalParams

The options parameters.

Returns

Promise<B2CTenantResource>

listByResourceGroup(string, B2CTenantsListByResourceGroupOptionalParams)

Get all the Azure AD B2C tenant resources in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: B2CTenantsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<B2CTenantResource, B2CTenantResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options
B2CTenantsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<B2CTenantResource, B2CTenantResource[], PageSettings>

listBySubscription(B2CTenantsListBySubscriptionOptionalParams)

Get all the Azure AD B2C tenant resources in a subscription.

function listBySubscription(options?: B2CTenantsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<B2CTenantResource, B2CTenantResource[], PageSettings>

Parameters

options
B2CTenantsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<B2CTenantResource, B2CTenantResource[], PageSettings>

update(string, string, B2CTenantsUpdateOptionalParams)

Update the Azure AD B2C tenant resource.

function update(resourceGroupName: string, resourceName: string, options?: B2CTenantsUpdateOptionalParams): Promise<B2CTenantResource>

Parameters

resourceGroupName

string

The name of the resource group.

resourceName

string

The initial domain name of the Azure AD B2C tenant.

options
B2CTenantsUpdateOptionalParams

The options parameters.

Returns

Promise<B2CTenantResource>