CIAM Tenants - List By Resource Group

Reference

Service:: Azure AD B2C

API Version:: 2023-05-17-preview

Get all the Azure AD for customers tenants resources in a resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories?api-version=2023-05-17-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	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	CIAMTenantResourceList	List of Azure AD for customers tenants in resource group successfully retrieved.
Other Status Codes	ErrorResponse	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

CIAMTenants_ListByResourceGroup

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories?api-version=2023-05-17-preview

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories/contoso",
      "name": "contoso",
      "type": "Microsoft.AzureActiveDirectory/ciamDirectories",
      "location": "United States",
      "sku": {
        "name": "Standard",
        "tier": "A0"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "createTenantProperties": {
          "displayName": "Contoso",
          "countryCode": "US"
        },
        "billingConfig": {
          "billingType": "MAU",
          "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
        },
        "domainName": "contoso.onmicrosoft.com",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "tags": null,
      "systemData": {
        "createdBy": "contosoAdmin@onmicrosoft.com",
        "createdByType": "User",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "contosoAdmin@onmicrosoft.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-02-04T01:01:01.1075056Z"
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
ciamBillingType	The type of billing. Will be MAU for all new customers. Cannot be changed if value is 'MAU'. Learn more about Azure AD for customers billing at aka.ms/b2cBilling.
CIAMResourceSKU	SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
CIAMResourceSKUName	The name of the SKU for the tenant.
CIAMTenantResource	The Azure AD for customers resource.
CIAMTenantResourceList	The collection of Azure AD for customers tenant resources
ciamTypeValue	The type of the Azure AD for customers tenant resource.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProvisioningState	Provisioning State
systemData	Metadata pertaining to creation and last modification of the resource.

ciamBillingType

The type of billing. Will be MAU for all new customers. Cannot be changed if value is 'MAU'. Learn more about Azure AD for customers billing at aka.ms/b2cBilling.

Name	Type	Description
MAU	string	Azure AD for customers usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.

CIAMResourceSKU

SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.

Name	Type	Description
name	CIAMResourceSKUName	The name of the SKU for the tenant.

CIAMResourceSKUName

The name of the SKU for the tenant.

Name	Type	Description
PremiumP1	string
PremiumP2	string
Standard	string

CIAMTenantResource

The Azure AD for customers resource.

Name	Type	Description
id	string	An identifier that represents the Azure AD for customers 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 for customers tenant resource.
properties.billingConfig.billingType	ciamBillingType	The type of billing. Will be MAU for all new customers. Cannot be changed if value is 'MAU'. Learn more about Azure AD for customers billing at aka.ms/b2cBilling.
properties.billingConfig.effectiveStartDateUtc	string	The data from which the billing type took effect
properties.createTenantProperties.countryCode	string	Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list.
properties.createTenantProperties.displayName	string	The display name of the Azure AD for customers tenant.
properties.domainName	string	The domain name of the tenant
properties.provisioningState	ProvisioningState	Provisioning State
properties.tenantId	string	An identifier of the Azure AD for customers tenant.
sku	CIAMResourceSKU	SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource Tags
type	ciamTypeValue	The type of the Azure AD for customers tenant resource.

CIAMTenantResourceList

The collection of Azure AD for customers tenant resources

Name	Type	Description
nextLink	string	The URL to get the next set of Azure AD for customers tenant resources.
value	CIAMTenantResource[]	List of Azure AD for customers tenant resources

ciamTypeValue

The type of the Azure AD for customers tenant resource.

Name	Type	Description
Microsoft.AzureActiveDirectory/ciamDirectories	string	The resource type for Azure AD for customers tenant resource.

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.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ProvisioningState

Provisioning State

Name	Type	Description
Canceled	string
Deleted	string
Deleting	string
Failed	string
Provisioning	string
Succeeded	string

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	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	createdByType	The type of identity that last modified the resource.