Skip to main content

b2c_tenants

Overview

Nameb2c_tenants
TypeResource
Idazure.aad_b2c.b2c_tenants

Fields

NameDatatypeDescription
idstringAn identifier that represents the Azure AD B2C tenant resource.
namestringThe name of the Azure AD B2C tenant resource.
locationstringThe location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia'. Refer to this documentation for more information.
propertiesobjectProperties of the Azure AD B2C tenant Azure resource.
skuobjectSKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
systemDataobjectMetadata pertaining to creation and last modification of the resource.
tagsobjectResource Tags
typestringThe type of the B2C tenant resource.

Methods

NameAccessible byRequired ParamsDescription
getSELECTresourceGroupName, resourceName, subscriptionIdGet the Azure AD B2C tenant resource.
list_by_resource_groupSELECTresourceGroupName, subscriptionIdGet all the Azure AD B2C tenant resources in a resource group.
list_by_subscriptionSELECTsubscriptionIdGet all the Azure AD B2C tenant resources in a subscription.
createINSERTresourceGroupName, resourceName, subscriptionId, data__location, data__properties, data__skuInitiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription. Note: Please check name availability before creating a new tenant.
deleteDELETEresourceGroupName, resourceName, subscriptionIdInitiates 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.
_list_by_resource_groupEXECresourceGroupName, subscriptionIdGet all the Azure AD B2C tenant resources in a resource group.
_list_by_subscriptionEXECsubscriptionIdGet all the Azure AD B2C tenant resources in a subscription.
b2c_tenantsEXECsubscriptionId, data__countryCode, data__nameChecks the availability and validity of a domain name for the tenant.
updateEXECresourceGroupName, resourceName, subscriptionIdUpdate the Azure AD B2C tenant resource.