azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations
name: B2CTenantsOperations
fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations
module: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations
inheritances:
- builtins.object
summary: '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.'
constructor:
  syntax: B2CTenantsOperations(client, config, serializer, deserializer)
  parameters:
  - name: client
    description: Client for service requests.
    isRequired: true
  - name: config
    description: Configuration of service client.
    isRequired: true
  - name: serializer
    description: An object model serializer.
    isRequired: true
  - name: deserializer
    description: An object model deserializer.
    isRequired: true
variables:
- description: Alias to model classes used in this operation group.
  name: models
methods:
- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.begin_create
  name: begin_create
  summary: 'Initiates an async request to create both the Azure AD B2C tenant and
    the corresponding Azure

    resource linked to a subscription.'
  signature: 'async begin_create(resource_group_name: str, resource_name: str, create_tenant_request_body:
    CreateTenantRequestBody | None = None, **kwargs) -> AsyncLROPoller[B2CTenantResource]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The initial domain name of the B2C tenant.
    isRequired: true
    types:
    - <xref:str>
  - name: create_tenant_request_body
    defaultValue: None
    types:
    - <xref:$>(<xref:python-base-namespace>)<xref:azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'True for ARMPolling, False for no polling, or a

      polling object for personal polling strategy'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.AsyncPollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of AsyncLROPoller that returns either B2CTenantResource
      or the result of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[~$(<xref:python>-<xref:base>-<xref:namespace>)<xref:azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.begin_delete
  name: begin_delete
  summary: '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](https://aka.ms/deleteB2Ctenant).'
  signature: 'async begin_delete(resource_group_name: str, resource_name: str, **kwargs)
    -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The initial domain name of the B2C tenant.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'True for ARMPolling, False for no polling, or a

      polling object for personal polling strategy'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.AsyncPollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.check_name_availability
  name: check_name_availability
  summary: Checks the availability and validity of a domain name for the tenant.
  signature: 'async check_name_availability(check_name_availability_request_body:
    CheckNameAvailabilityRequestBody | None = None, **kwargs) -> NameAvailabilityResponse'
  parameters:
  - name: check_name_availability_request_body
    defaultValue: None
    types:
    - <xref:$>(<xref:python-base-namespace>)<xref:azure.mgmt.azureadb2c.v2019_01_01_preview.models.CheckNameAvailabilityRequestBody>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: NameAvailabilityResponse, or the result of cls(response)
    types:
    - $(<xref:python>-<xref:base>-<xref:namespace>)<xref:azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.get
  name: get
  summary: Get the Azure AD B2C tenant resource.
  signature: 'async get(resource_group_name: str, resource_name: str, **kwargs) ->
    B2CTenantResource'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The initial domain name of the B2C tenant.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: B2CTenantResource, or the result of cls(response)
    types:
    - $(<xref:python>-<xref:base>-<xref:namespace>)<xref:azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.list_by_resource_group
  name: list_by_resource_group
  summary: Get all the Azure AD B2C tenant resources in a resource group.
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs) -> AsyncIterable[B2CTenantResourceList]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either B2CTenantResourceList or the
      result of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[~$(<xref:python>-<xref:base>-<xref:namespace>)<xref:azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourceList>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.list_by_subscription
  name: list_by_subscription
  summary: Get all the Azure AD B2C tenant resources in a subscription.
  signature: list_by_subscription(**kwargs) -> AsyncIterable[B2CTenantResourceList]
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either B2CTenantResourceList or the
      result of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[~$(<xref:python>-<xref:base>-<xref:namespace>)<xref:azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourceList>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.update
  name: update
  summary: Update the Azure AD B2C tenant resource.
  signature: 'async update(resource_group_name: str, resource_name: str, update_tenant_request_body:
    B2CTenantUpdateRequest | None = None, **kwargs) -> B2CTenantResource'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The initial domain name of the B2C tenant.
    isRequired: true
    types:
    - <xref:str>
  - name: update_tenant_request_body
    defaultValue: None
    types:
    - <xref:$>(<xref:python-base-namespace>)<xref:azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: B2CTenantResource, or the result of cls(response)
    types:
    - $(<xref:python>-<xref:base>-<xref:namespace>)<xref:azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.models
  name: models
  signature: 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'>