Share via

B2CTenantsOperations Class

  • Reference

B2CTenantsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
B2CTenantsOperations

Constructor

B2CTenantsOperations(client, config, serializer, deserializer)

Parameters

Name Description
client
Required

Client for service requests.
config
Required

Configuration of service client.
serializer
Required

An object model serializer.
deserializer
Required

An object model deserializer.

Variables

Name Description
models

Alias to model classes used in this operation group.

Methods

begin_create

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

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.
check_name_availability

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

Get the Azure AD B2C tenant resource.
list_by_resource_group

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

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

Update the Azure AD B2C tenant resource.

begin_create

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

async begin_create(resource_group_name: str, resource_name: str, create_tenant_request_body: CreateTenantRequestBody | None = None, **kwargs) -> AsyncLROPoller[B2CTenantResource]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
resource_name
Required
str

The initial domain name of the B2C tenant.
create_tenant_request_body
<xref:$>(<xref:python-base-namespace>)CreateTenantRequestBody
Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
AsyncLROPoller[~$(<xref:python>-<xref:base>-<xref:namespace>)B2CTenantResource]

An instance of AsyncLROPoller that returns either B2CTenantResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

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.

async begin_delete(resource_group_name: str, resource_name: str, **kwargs) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
resource_name
Required
str

The initial domain name of the B2C tenant.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

check_name_availability

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

async check_name_availability(check_name_availability_request_body: CheckNameAvailabilityRequestBody | None = None, **kwargs) -> NameAvailabilityResponse

Parameters

Name Description
check_name_availability_request_body
<xref:$>(<xref:python-base-namespace>)CheckNameAvailabilityRequestBody
Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
$(<xref:python>-<xref:base>-<xref:namespace>)NameAvailabilityResponse

NameAvailabilityResponse, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get the Azure AD B2C tenant resource.

async get(resource_group_name: str, resource_name: str, **kwargs) -> B2CTenantResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
resource_name
Required
str

The initial domain name of the B2C tenant.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
$(<xref:python>-<xref:base>-<xref:namespace>)B2CTenantResource

B2CTenantResource, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

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

list_by_resource_group(resource_group_name: str, **kwargs) -> AsyncIterable[B2CTenantResourceList]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
AsyncItemPaged[~$(<xref:python>-<xref:base>-<xref:namespace>)B2CTenantResourceList]

An iterator like instance of either B2CTenantResourceList or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_subscription

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

list_by_subscription(**kwargs) -> AsyncIterable[B2CTenantResourceList]

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
AsyncItemPaged[~$(<xref:python>-<xref:base>-<xref:namespace>)B2CTenantResourceList]

An iterator like instance of either B2CTenantResourceList or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update

Update the Azure AD B2C tenant resource.

async update(resource_group_name: str, resource_name: str, update_tenant_request_body: B2CTenantUpdateRequest | None = None, **kwargs) -> B2CTenantResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
resource_name
Required
str

The initial domain name of the B2C tenant.
update_tenant_request_body
<xref:$>(<xref:python-base-namespace>)B2CTenantUpdateRequest
Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
$(<xref:python>-<xref:base>-<xref:namespace>)B2CTenantResource

B2CTenantResource, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.azureadb2c.v2019_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\azureadb2c\\v2019_01_01_preview\\models\\__init__.py'>