Microsoft.AzureActiveDirectory (stable:2021-04-01)

2025/09/26 • 14 new, 14 deleted methods

B2CTenants_CheckNameAvailability (new)
Description :  Checks the availability and validity of a domain name for the tenant.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/checkNameAvailability
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
checkNameAvailabilityRequestBody:
{
Required: False ,
}
{
name:
{
Description: The domain name to check for availability. ,
Required: True ,
}
string ,
countryCode:
{
Description: Country code of Azure tenant (e.g. 'US'). Refer to [aka.ms/B2CDataResidency](https://aka.ms/B2CDataResidency) 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. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Description of the reason if name is not available. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: True if the name is available and can be used to create a new tenant. Otherwise false. ,
Required: False ,
}
boolean ,
reason:
{
Description: Describes the reason for the 'nameAvailable' value. ,
Enum:
{
AlreadyExists: The name is already in use and is therefore unavailable. ,
Invalid: The name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.). ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_ListByResourceGroup (new)
Description :  Get all the Azure AD B2C tenant resources in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure AD B2C tenant resources ,
Required: False ,
}
[
{
type:
{
Description: The type of the B2C tenant resource. ,
Enum:
{
Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
id:
{
Description: An identifier that represents the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_ListBySubscription (new)
Description :  Get all the Azure AD B2C tenant resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/b2cDirectories
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure AD B2C tenant resources ,
Required: False ,
}
[
{
type:
{
Description: The type of the B2C tenant resource. ,
Enum:
{
Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
id:
{
Description: An identifier that represents the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_Get (new)
Description :  Get the Azure AD B2C tenant resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: The type of the B2C tenant resource. ,
Enum:
{
Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
id:
{
Description: An identifier that represents the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_Create (new)
Description :  Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
createTenantRequestBody:
{
Required: False ,
}
{
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
properties:
{
Required: True ,
}
{
createTenantProperties:
{
Description: These properties are used to create the Azure AD B2C tenant. These properties are not part of the Azure resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
countryCode:
{
Description: Country code of Azure tenant (e.g. 'US'). Refer to [aka.ms/B2CDataResidency](https://aka.ms/B2CDataResidency) 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. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
type:
{
Description: The type of the B2C tenant resource. ,
Enum:
{
Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
id:
{
Description: An identifier that represents the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Contains the number of seconds to wait before polling the location. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_Update (new)
Description :  Update the Azure AD B2C tenant resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
updateTenantRequestBody:
{
Required: False ,
}
{
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: False ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties. ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
type:
{
Description: The type of the B2C tenant resource. ,
Enum:
{
Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
id:
{
Description: An identifier that represents the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_Delete (new)
Description :  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).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Contains the URL/location which can return the deletion status. ,
}
string ,
retry-after:
{
Description: Contains the number of seconds to wait before checking the deletion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists the operations available from this provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureActiveDirectory/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of available operation details ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Display of the operation ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation ,
Required: False ,
}
string ,
resource:
{
Description: Resource of the operation ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_Create (new)
Description :  Creates a Guest Usages resource, which is used to linking a subscription to an instance of Azure AD External Identities. [Learn more](https://aka.ms/extidbilling).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages/{resourceName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
Resource:
{
Description: Guest Usages resource to be created ,
Required: False ,
}
{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_Update (new)
Description :  Updates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages/{resourceName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
ResourcePatch:
{
Description: Guest Usages Resource to be updated ,
Required: False ,
}
{
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_Delete (new)
Description :  Deletes a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages/{resourceName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_Get (new)
Description :  Gets a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages/{resourceName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_ListBySubscription (new)
Description :  Gets Guest Usages resources under a subscription for the Microsoft.AzureActiveDirectory resource provider
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/guestUsages
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of guest usages resources ,
Required: False ,
}
[
{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_ListByResourceGroup (new)
Description :  Gets Guest Usages resources under a resource group for the Microsoft.AzureActiveDirectory resource provider
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of guest usages resources ,
Required: False ,
}
[
{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_CheckNameAvailability (removed)
Description :  Checks the availability and validity of a domain name for the tenant.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/checkNameAvailability
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
checkNameAvailabilityRequestBody:
{
Required: False ,
}
{
name:
{
Description: The domain name to check for availability. ,
Required: True ,
}
string ,
countryCode:
{
Description: Country code of Azure tenant (e.g. 'US'). Refer to [aka.ms/B2CDataResidency](https://aka.ms/B2CDataResidency) 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. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Description of the reason if name is not available. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: True if the name is available and can be used to create a new tenant. Otherwise false. ,
Required: False ,
}
boolean ,
reason:
{
Description: Describes the reason for the 'nameAvailable' value. ,
Enum:
{
AlreadyExists: The name is already in use and is therefore unavailable. ,
Invalid: The name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.). ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_ListByResourceGroup (removed)
Description :  Get all the Azure AD B2C tenant resources in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure AD B2C tenant resources ,
Required: False ,
}
[
{
type:
{
Description: The type of the B2C tenant resource. ,
Enum:
{
Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
id:
{
Description: An identifier that represents the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_ListBySubscription (removed)
Description :  Get all the Azure AD B2C tenant resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/b2cDirectories
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure AD B2C tenant resources ,
Required: False ,
}
[
{
type:
{
Description: The type of the B2C tenant resource. ,
Enum:
{
Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
id:
{
Description: An identifier that represents the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_Get (removed)
Description :  Get the Azure AD B2C tenant resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: The type of the B2C tenant resource. ,
Enum:
{
Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
id:
{
Description: An identifier that represents the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_Create (removed)
Description :  Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
createTenantRequestBody:
{
Required: False ,
}
{
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
properties:
{
Required: True ,
}
{
createTenantProperties:
{
Description: These properties are used to create the Azure AD B2C tenant. These properties are not part of the Azure resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
countryCode:
{
Description: Country code of Azure tenant (e.g. 'US'). Refer to [aka.ms/B2CDataResidency](https://aka.ms/B2CDataResidency) 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. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
type:
{
Description: The type of the B2C tenant resource. ,
Enum:
{
Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
id:
{
Description: An identifier that represents the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Contains the number of seconds to wait before polling the location. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_Update (removed)
Description :  Update the Azure AD B2C tenant resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
updateTenantRequestBody:
{
Required: False ,
}
{
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: False ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties. ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
type:
{
Description: The type of the B2C tenant resource. ,
Enum:
{
Microsoft.AzureActiveDirectory/b2cDirectories: The resource type for Azure AD B2C tenant resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). ,
Required: True ,
}
{
name:
{
Description: The name of the SKU for the tenant. ,
Enum:
{
Standard: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
PremiumP1: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
PremiumP2: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The tier of the tenant. ,
Enum:
{
A0: The SKU tier used for all Azure AD B2C tenants. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Azure AD B2C tenant resource properties ,
Required: False ,
}
{
billingConfig:
{
Description: The billing configuration for the tenant. ,
Required: False ,
}
{
billingType:
{
Description: 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](https://aka.ms/b2cbilling). ,
Enum:
{
MAU: Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model. ,
Auths: Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing. ,
}
,
Required: False ,
}
enum ,
effectiveStartDateUtc:
{
Description: The data from which the billing type took effect ,
Required: False ,
}
string ,
}
,
tenantId:
{
Description: An identifier of the Azure AD B2C tenant. ,
Required: False ,
}
string ,
}
,
id:
{
Description: An identifier that represents the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Azure AD B2C tenant resource. ,
Required: False ,
}
string ,
location:
{
Description: 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](https://aka.ms/B2CDataResidency) for more information. ,
Required: True ,
}
string ,
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
B2CTenants_Delete (removed)
Description :  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).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Contains the URL/location which can return the deletion status. ,
}
string ,
retry-after:
{
Description: Contains the number of seconds to wait before checking the deletion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists the operations available from this provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureActiveDirectory/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of available operation details ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Display of the operation ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation ,
Required: False ,
}
string ,
resource:
{
Description: Resource of the operation ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_Create (removed)
Description :  Creates a Guest Usages resource, which is used to linking a subscription to an instance of Azure AD External Identities. [Learn more](https://aka.ms/extidbilling).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages/{resourceName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
Resource:
{
Description: Guest Usages resource to be created ,
Required: False ,
}
{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_Update (removed)
Description :  Updates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages/{resourceName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
ResourcePatch:
{
Description: Guest Usages Resource to be updated ,
Required: False ,
}
{
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_Delete (removed)
Description :  Deletes a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages/{resourceName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_Get (removed)
Description :  Gets a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages/{resourceName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The initial domain name of the Azure AD B2C tenant. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_ListBySubscription (removed)
Description :  Gets Guest Usages resources under a subscription for the Microsoft.AzureActiveDirectory resource provider
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/guestUsages
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of guest usages resources ,
Required: False ,
}
[
{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestUsages_ListByResourceGroup (removed)
Description :  Gets Guest Usages resources under a resource group for the Microsoft.AzureActiveDirectory resource provider
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of guest usages resources ,
Required: False ,
}
[
{
id:
{
Description: An identifier that represents the Guest Usages resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Guest Usages resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Guest Usages resource. ,
Required: False ,
}
string ,
location:
{
Description: Location of the Guest Usages resource. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs of additional resource provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: The Guest Usages Resource Properties ,
Required: False ,
}
{
tenantId:
{
Description: An identifier for the tenant for which the resource is being created ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}