B2C Tenants - Create

Referência

Service:: Azure AD B2C

API Version:: 2021-04-01

Inicia um pedido assíncrono para criar o inquilino Azure AD B2C e o recurso do Azure correspondente associado a uma subscrição.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}?api-version=2021-04-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
resourceName	path	True	string	O nome de domínio inicial do Azure AD inquilino B2C.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	A localização na qual o recurso está alojado e os dados residem. Pode ser um dos "Estados Unidos", "Europa", "Ásia-Pacífico" ou "Austrália". Veja esta documentação para obter mais informações.
sku	True	B2CResourceSKU	Propriedades de SKU do Azure AD inquilino B2C. Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Código de país do inquilino do Azure (por exemplo, "E.U.A."). Veja aka.ms/B2CDataResidency para ver os códigos de país/região válidos e as localizações de residência dos dados correspondentes. Se não vir um código de país numa localização de residência de dados válida, escolha um na lista.
properties.createTenantProperties.displayName		string	O nome a apresentar do Azure AD inquilino B2C.
tags		object	Etiquetas de Recursos

Respostas

Name	Tipo	Description
200 OK	B2CTenantResource	OK - Resposta do URL no cabeçalho Localização se a operação assíncrona for bem-sucedida. O recurso será criado.
202 Accepted		Azure AD pedido de criação de inquilino B2C aceite. O cabeçalho Localização indica o URL/localização no qual deve verificar para obter o estado assíncrono da operação. Headers Location: string Retry-After: string
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Name

Tipo

Description

200 OK

B2CTenantResource

OK - Resposta do URL no cabeçalho Localização se a operação assíncrona for bem-sucedida. O recurso será criado.

202 Accepted

Azure AD pedido de criação de inquilino B2C aceite. O cabeçalho Localização indica o URL/localização no qual deve verificar para obter o estado assíncrono da operação.

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Create tenant

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/b2cDirectories/contoso.onmicrosoft.com?api-version=2021-04-01

{
  "location": "United States",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "createTenantProperties": {
      "displayName": "Contoso",
      "countryCode": "US"
    }
  }
}

const { ExternalIdentitiesConfigurationClient } = require("@azure/arm-azureadexternalidentities");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
 *
 * @summary Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
 * x-ms-original-file: specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/stable/2021-04-01/examples/createTenant.json
 */
async function createTenant() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "contosoResourceGroup";
  const resourceName = "contoso.onmicrosoft.com";
  const createTenantRequestBody = {
    countryCode: "US",
    displayName: "Contoso",
    location: "United States",
    sku: { name: "Standard", tier: "A0" },
  };
  const options = { createTenantRequestBody };
  const credential = new DefaultAzureCredential();
  const client = new ExternalIdentitiesConfigurationClient(credential, subscriptionId);
  const result = await client.b2CTenants.beginCreateAndWait(
    resourceGroupName,
    resourceName,
    options
  );
  console.log(result);
}

createTenant().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "type": "Microsoft.AzureActiveDirectory/b2cDirectories",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "billingConfig": {
      "billingType": "MAU",
      "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/b2cDirectories/contoso.onmicrosoft.com",
  "name": "contoso.onmicrosoft.com",
  "location": "United States",
  "tags": null
}

Status code:: 202

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.AzureActiveDirectory/operations/99999999-9999-9999-9999-999999999999
Retry-After: 60

Definições

Name	Description
B2CResourceSKU	Propriedades de SKU do Azure AD inquilino B2C. Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.
B2CResourceSKUName	O nome do SKU do inquilino.
B2CResourceSKUTier	A camada do inquilino.
B2CTenantResource
BillingConfig	A configuração de faturação do inquilino.
BillingType	O tipo de faturação. Será MAU para todos os novos clientes. Se for "Autenticações", pode ser atualizado para "MAU". Não pode ser alterado se o valor for "MAU". Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.
CloudError	Uma resposta de erro para um pedido de gestão de recursos.
createdByType	O tipo de identidade que criou o recurso.
CreateTenantRequestBody	As informações necessárias para criar o Azure AD inquilino B2C e o recurso do Azure correspondente, que é utilizado para fins de faturação.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorResponse	Resposta a Erros
systemData	Metadados relativos à criação e última modificação do recurso.
TypeValue	O tipo do recurso de inquilino B2C.

B2CResourceSKU

Propriedades de SKU do Azure AD inquilino B2C. Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.

Name	Tipo	Description
name	B2CResourceSKUName	O nome do SKU do inquilino.
tier	B2CResourceSKUTier	A camada do inquilino.

B2CResourceSKUName

O nome do SKU do inquilino.

Name	Tipo	Description
PremiumP1	string	Azure AD utilização do B2C é faturada a uma subscrição do Azure associada e utiliza o número de autenticações baseadas na faturação.
PremiumP2	string	Azure AD utilização do B2C é faturada a uma subscrição do Azure associada e utiliza o número de autenticações baseadas na faturação.
Standard	string	Azure AD utilização do B2C é faturada a uma subscrição do Azure associada e utiliza um modelo de faturação de utilizadores ativos mensais (MAU).

B2CResourceSKUTier

A camada do inquilino.

Name	Tipo	Description
A0	string	O escalão de SKU utilizado para todos os inquilinos Azure AD B2C.

B2CTenantResource

Name	Tipo	Description
id	string	Um identificador que representa o Azure AD recurso de inquilino B2C.
location	string	A localização na qual o recurso está alojado e os dados residem. Pode ser um dos "Estados Unidos", "Europa", "Ásia-Pacífico" ou "Austrália". Veja esta documentação para obter mais informações.
name	string	O nome do Azure AD recurso de inquilino B2C.
properties.billingConfig	BillingConfig	A configuração de faturação do inquilino.
properties.tenantId	string	Um identificador do Azure AD inquilino B2C.
sku	B2CResourceSKU	Propriedades de SKU do Azure AD inquilino B2C. Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
tags	object	Etiquetas de Recursos
type	TypeValue	O tipo do recurso de inquilino B2C.

BillingConfig

A configuração de faturação do inquilino.

Name	Tipo	Description
billingType	BillingType	O tipo de faturação. Será MAU para todos os novos clientes. Se for "Autenticações", pode ser atualizado para "MAU". Não pode ser alterado se o valor for "MAU". Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.
effectiveStartDateUtc	string	Os dados a partir dos quais o tipo de faturação entrou em vigor

BillingType

O tipo de faturação. Será MAU para todos os novos clientes. Se for "Autenticações", pode ser atualizado para "MAU". Não pode ser alterado se o valor for "MAU". Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.

Name	Tipo	Description
Auths	string	Azure AD utilização do B2C é faturada a uma subscrição do Azure associada e utiliza o número de autenticações baseadas na faturação.
MAU	string	Azure AD utilização do B2C é faturada a uma subscrição do Azure associada e utiliza um modelo de faturação de utilizadores ativos mensais (MAU).

CloudError

Uma resposta de erro para um pedido de gestão de recursos.

Name	Tipo	Description
error	ErrorResponse	Resposta a Erros Resposta de erro comum para todas as APIs do Azure Resource Manager para devolver detalhes do erro para operações com falhas. (Isto também segue o formato de resposta de erro OData.)

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

As informações necessárias para criar o Azure AD inquilino B2C e o recurso do Azure correspondente, que é utilizado para fins de faturação.

Name	Tipo	Description
location	string	A localização na qual o recurso está alojado e os dados residem. Pode ser um dos "Estados Unidos", "Europa", "Ásia-Pacífico" ou "Austrália". Veja esta documentação para obter mais informações.
properties.createTenantProperties.countryCode	string	Código de país do inquilino do Azure (por exemplo, "E.U.A."). Veja aka.ms/B2CDataResidency para ver os códigos de país/região válidos e as localizações de residência dos dados correspondentes. Se não vir um código de país numa localização de residência de dados válida, escolha um na lista.
properties.createTenantProperties.displayName	string	O nome a apresentar do Azure AD inquilino B2C.
sku	B2CResourceSKU	Propriedades de SKU do Azure AD inquilino B2C. Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.
tags	object	Etiquetas de Recursos

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorResponse

Resposta a Erros

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TypeValue

O tipo do recurso de inquilino B2C.

Name	Tipo	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	O tipo de recurso para Azure AD recurso de inquilino B2C.

Share via

B2C Tenants - Create

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Scopes

Exemplos

Create tenant

Sample Request

Sample Response

Definições

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Recursos adicionais