B2CTenantsOperations Class

B2CTenantsOperations 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

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

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.

begin_create(resource_group_name: str, resource_name: str, create_tenant_request_body: Optional[_models.CreateTenantRequestBody] = None, **kwargs: Any) -> LROPoller[_models.B2CTenantResource]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The initial domain name of the B2C tenant.

create_tenant_request_body

<xref:$>(<xref:python-base-namespace>)CreateTenantRequestBody

default value: None

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 PollingMethod

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

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

Return type

LROPoller[<xref:$>(<xref:python-base-namespace>)B2CTenantResource]

Exceptions

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.

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The initial domain name of the B2C tenant.

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 PollingMethod

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

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

Return type

LROPoller[None]

Exceptions

HttpResponseError

check_name_availability

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

check_name_availability(check_name_availability_request_body: Optional[_models.CheckNameAvailabilityRequestBody] = None, **kwargs: Any) -> _models.NameAvailabilityResponse

Parameters

check_name_availability_request_body

<xref:$>(<xref:python-base-namespace>)CheckNameAvailabilityRequestBody

default value: None

cls

callable

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

Returns

NameAvailabilityResponse, or the result of cls(response)

Return type

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

Exceptions

HttpResponseError

get

Get the Azure AD B2C tenant resource.

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> _models.B2CTenantResource

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The initial domain name of the B2C tenant.

cls

callable

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

Returns

B2CTenantResource, or the result of cls(response)

Return type

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

Exceptions

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: Any) -> Iterable[_models.B2CTenantResourceList]

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

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

Returns

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

Return type

ItemPaged[<xref:$>(<xref:python-base-namespace>)B2CTenantResourceList]

Exceptions

HttpResponseError

list_by_subscription

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

list_by_subscription(**kwargs: Any) -> Iterable[_models.B2CTenantResourceList]

Parameters

cls

callable

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

Returns

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

Return type

ItemPaged[<xref:$>(<xref:python-base-namespace>)B2CTenantResourceList]

Exceptions

HttpResponseError

update

Update the Azure AD B2C tenant resource.

update(resource_group_name: str, resource_name: str, update_tenant_request_body: Optional[_models.B2CTenantUpdateRequest] = None, **kwargs: Any) -> _models.B2CTenantResource

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The initial domain name of the B2C tenant.

update_tenant_request_body

<xref:$>(<xref:python-base-namespace>)B2CTenantUpdateRequest

default value: None

cls

callable

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

Returns

B2CTenantResource, or the result of cls(response)

Return type

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

Exceptions

HttpResponseError

Attributes

models

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