B2C Tenants - List By Subscription
Get all the Azure AD B2C tenant resources in a subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/b2cDirectories?api-version=2021-04-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Azure AD B2C tenant resources in subscription successfully retrieved. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
B2CTenants_ListBySubscription
Sample request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.AzureActiveDirectory/b2cDirectories?api-version=2021-04-01
Sample response
{
"value": [
{
"type": "Microsoft.AzureActiveDirectory/b2cDirectories",
"sku": {
"name": "Standard",
"tier": "A0"
},
"properties": {
"billingConfig": {
"billingType": "MAU",
"effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
},
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/b2cDirectories/contoso.onmicrosoft.com",
"name": "contoso.onmicrosoft.com",
"location": "United States",
"tags": null
}
]
}
Definitions
Name | Description |
---|---|
B2CResourceSKU |
SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling. |
B2CResource |
The name of the SKU for the tenant. |
B2CResource |
The tier of the tenant. |
B2CTenant |
|
B2CTenant |
The collection of Azure AD B2C tenant resources |
Billing |
The billing configuration for the tenant. |
Billing |
The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling. |
Cloud |
An error response for a resource management request. |
created |
The type of identity that created the resource. |
Error |
The resource management error additional info. |
Error |
Error Response |
system |
Metadata pertaining to creation and last modification of the resource. |
Type |
The type of the B2C tenant resource. |
B2CResourceSKU
SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
Name | Type | Description |
---|---|---|
name |
The name of the SKU for the tenant. |
|
tier |
The tier of the tenant. |
B2CResourceSKUName
The name of the SKU for the tenant.
Name | Type | Description |
---|---|---|
PremiumP1 |
string |
Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. |
PremiumP2 |
string |
Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. |
Standard |
string |
Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. |
B2CResourceSKUTier
The tier of the tenant.
Name | Type | Description |
---|---|---|
A0 |
string |
The SKU tier used for all Azure AD B2C tenants. |
B2CTenantResource
Name | Type | Description |
---|---|---|
id |
string |
An identifier that represents the Azure AD B2C tenant resource. |
location |
string |
The 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. |
name |
string |
The name of the Azure AD B2C tenant resource. |
properties.billingConfig |
The billing configuration for the tenant. |
|
properties.tenantId |
string |
An identifier of the Azure AD B2C tenant. |
sku |
SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling. |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
tags |
object |
Resource Tags |
type |
The type of the B2C tenant resource. |
B2CTenantResourceList
The collection of Azure AD B2C tenant resources
Name | Type | Description |
---|---|---|
value |
List of Azure AD B2C tenant resources |
BillingConfig
The billing configuration for the tenant.
Name | Type | Description |
---|---|---|
billingType |
The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling. |
|
effectiveStartDateUtc |
string |
The data from which the billing type took effect |
BillingType
The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
Name | Type | Description |
---|---|---|
Auths |
string |
Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. |
MAU |
string |
Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. |
CloudError
An error response for a resource management request.
Name | Type | Description |
---|---|---|
error |
Error Response |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorResponse
Error Response
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
TypeValue
The type of the B2C tenant resource.
Name | Type | Description |
---|---|---|
Microsoft.AzureActiveDirectory/b2cDirectories |
string |
The resource type for Azure AD B2C tenant resource. |