@azure/arm-azureadexternalidentities package

  • Reference

Classes

ExternalIdentitiesConfigurationClient

Interfaces

AvailableOperations

Available operations of the service
B2CResourceSKU

SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
B2CTenantResource
B2CTenantResourceList

The collection of Azure AD B2C tenant resources
B2CTenantResourcePropertiesBillingConfig

The billing configuration for the tenant.
B2CTenantUpdateRequest

The request body to update the Azure AD B2C tenant resource.
B2CTenants

Interface representing a B2CTenants.
B2CTenantsCheckNameAvailabilityOptionalParams

Optional parameters.
B2CTenantsCreateHeaders

Defines headers for B2CTenants_create operation.
B2CTenantsCreateOptionalParams

Optional parameters.
B2CTenantsDeleteHeaders

Defines headers for B2CTenants_delete operation.
B2CTenantsDeleteOptionalParams

Optional parameters.
B2CTenantsGetOptionalParams

Optional parameters.
B2CTenantsListByResourceGroupOptionalParams

Optional parameters.
B2CTenantsListBySubscriptionOptionalParams

Optional parameters.
B2CTenantsUpdateOptionalParams

Optional parameters.
CheckNameAvailabilityRequestBody

The information required to check the availability of the name for the tenant.
CloudError

An error response for a resource management request.
CreateTenantRequestBody

The information needed to create the Azure AD B2C tenant and corresponding Azure resource, which is used for billing purposes.
ErrorAdditionalInfo

The resource management error additional info.
ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)
ExternalIdentitiesConfigurationClientOptionalParams

Optional parameters.
GuestUsages

Interface representing a GuestUsages.
GuestUsagesCreateOptionalParams

Optional parameters.
GuestUsagesDeleteOptionalParams

Optional parameters.
GuestUsagesGetOptionalParams

Optional parameters.
GuestUsagesListByResourceGroupOptionalParams

Optional parameters.
GuestUsagesListBySubscriptionOptionalParams

Optional parameters.
GuestUsagesResource

Guest Usages Resource
GuestUsagesResourceList

The collection of guest usages resources
GuestUsagesResourcePatch

Guest Usages Resource for Patch
GuestUsagesUpdateOptionalParams

Optional parameters.
NameAvailabilityResponse

Response of the CheckNameAvailability operation.
OperationDetail

Operation detail payload
OperationDisplay

Operation display payload
Operations

Interface representing a Operations.
OperationsListOptionalParams

Optional parameters.
SystemData

Metadata pertaining to creation and last modification of the resource.

Type Aliases

B2CResourceSKUName

Defines values for B2CResourceSKUName.
KnownB2CResourceSKUName can be used interchangeably with B2CResourceSKUName, this enum contains the known values that the service supports.

Known values supported by the service

Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
B2CResourceSKUTier

Defines values for B2CResourceSKUTier.
KnownB2CResourceSKUTier can be used interchangeably with B2CResourceSKUTier, this enum contains the known values that the service supports.

Known values supported by the service

A0: The SKU tier used for all Azure AD B2C tenants.
B2CTenantsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.
B2CTenantsCreateResponse

Contains response data for the create operation.
B2CTenantsGetResponse

Contains response data for the get operation.
B2CTenantsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.
B2CTenantsListBySubscriptionResponse

Contains response data for the listBySubscription operation.
B2CTenantsUpdateResponse

Contains response data for the update operation.
BillingType

Defines values for BillingType.
KnownBillingType can be used interchangeably with BillingType, this enum contains the known values that the service supports.

Known values supported by the service

MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key
GuestUsagesCreateResponse

Contains response data for the create operation.
GuestUsagesGetResponse

Contains response data for the get operation.
GuestUsagesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.
GuestUsagesListBySubscriptionResponse

Contains response data for the listBySubscription operation.
GuestUsagesUpdateResponse

Contains response data for the update operation.
NameAvailabilityReasonType

Defines values for NameAvailabilityReasonType.
KnownNameAvailabilityReasonType can be used interchangeably with NameAvailabilityReasonType, this enum contains the known values that the service supports.

Known values supported by the service

AlreadyExists: The name is already in use and is therefore unavailable.
Invalid: The name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.).
OperationsListResponse

Contains response data for the list operation.
TypeValue

Defines values for TypeValue.
KnownTypeValue can be used interchangeably with TypeValue, this enum contains the known values that the service supports.

Known values supported by the service

Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource.

Enums

KnownB2CResourceSKUName

Known values of B2CResourceSKUName that the service accepts.
KnownB2CResourceSKUTier

Known values of B2CResourceSKUTier that the service accepts.
KnownBillingType

Known values of BillingType that the service accepts.
KnownCreatedByType

Known values of CreatedByType that the service accepts.
KnownNameAvailabilityReasonType

Known values of NameAvailabilityReasonType that the service accepts.
KnownTypeValue

Known values of TypeValue that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

The continuation token that can be passed into byPage().