B2C Tenants - Create

Serviço:: Azure AD B2C

Versão da API:: 2021-04-01

Inicia uma solicitação assíncrona para criar o locatário do Azure AD B2C e o recurso correspondente do Azure vinculado a uma assinatura.

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 locatário do Azure AD B2C.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	O local em que o recurso está hospedado e os dados residem. Pode ser um dos "Estados Unidos", "Europa", "Ásia-Pacífico" ou "Austrália". Consulte esta documentação para obter mais informações.
sku	True	B2CResourceSKU	Propriedades de SKU do locatário do Azure AD B2C. Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Código do país do locatário do Azure (por exemplo, 'EUA'). Consulte aka.ms/B2CDataResidency para ver os códigos de país válidos e os locais de residência de dados correspondentes. Se você não vir um código de país em um local de residência de dados válido, escolha um na lista.
properties.createTenantProperties.displayName		string	O nome para exibição do locatário do Azure AD B2C.
tags		object	Tags de recursos

Respostas

Name	Tipo	Description
200 OK	B2CTenantResource	OK - Resposta do URL no cabeçalho Location se a operação assíncrona for bem-sucedida. O recurso será criado.
202 Accepted		Solicitação de criação de locatário do Azure AD B2C aceita. O cabeçalho Location indica o URL/local no qual verificar para obter o status assíncrono da operação. Cabeçalhos Location: string Retry-After: string
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

B2CTenantResource

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

202 Accepted

Solicitação de criação de locatário do Azure AD B2C aceita. O cabeçalho Location indica o URL/local no qual verificar para obter o status assíncrono da operação.

Cabeçalhos

Location: string
Retry-After: string

Other Status Codes

CloudError

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Create tenant

Pedido de amostra

HTTP

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"
    }
  }
}

Resposta da amostra

Código de estado:: 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
}

Código de estado:: 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 locatário do Azure AD B2C. Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.
B2CResourceSKUName	O nome da SKU para o locatário.
B2CResourceSKUTier	A camada do locatário.
B2CTenantResource
BillingConfig	A configuração de faturamento para o locatário.
BillingType	O tipo de faturação. Será MAU para todos os novos clientes. Se 'Auths', 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 uma solicitação de gerenciamento de recursos.
createdByType	O tipo de identidade que criou o recurso.
CreateTenantRequestBody	As informações necessárias para criar o locatário do Azure AD B2C e o recurso correspondente do Azure, que é usado para fins de cobrança.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorResponse	Resposta de erro
systemData	Metadados referentes à criação e última modificação do recurso.
TypeValue	O tipo do recurso de locatário B2C.

B2CResourceSKU

Object

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

Name	Tipo	Description
name	B2CResourceSKUName	O nome da SKU para o locatário.
tier	B2CResourceSKUTier	A camada do locatário.

B2CResourceSKUName

Enumeração

O nome da SKU para o locatário.

Valor	Description
Standard	O uso do Azure AD B2C é cobrado em uma assinatura vinculada do Azure e usa um modelo de cobrança de usuários ativos mensais (MAU).
PremiumP1	O uso do Azure AD B2C é cobrado em uma assinatura vinculada do Azure e usa o número de autenticações com base na cobrança.
PremiumP2	O uso do Azure AD B2C é cobrado em uma assinatura vinculada do Azure e usa o número de autenticações com base na cobrança.

B2CResourceSKUTier

Enumeração

A camada do locatário.

Valor	Description
A0	A camada de SKU usada para todos os locatários do Azure AD B2C.

B2CTenantResource

Object

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

BillingConfig

Object

A configuração de faturamento para o locatário.

Name	Tipo	Description
billingType	BillingType	O tipo de faturação. Será MAU para todos os novos clientes. Se 'Auths', 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 faturamento entrou em vigor

BillingType

Enumeração

O tipo de faturação. Será MAU para todos os novos clientes. Se 'Auths', 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.

Valor	Description
MAU	O uso do Azure AD B2C é cobrado em uma assinatura vinculada do Azure e usa um modelo de cobrança de usuários ativos mensais (MAU).
Auths	O uso do Azure AD B2C é cobrado em uma assinatura vinculada do Azure e usa o número de autenticações com base na cobrança.

CloudError

Object

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

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

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CreateTenantRequestBody

Object

As informações necessárias para criar o locatário do Azure AD B2C e o recurso correspondente do Azure, que é usado para fins de cobrança.

Name	Tipo	Description
location	string	O local em que o recurso está hospedado e os dados residem. Pode ser um dos "Estados Unidos", "Europa", "Ásia-Pacífico" ou "Austrália". Consulte esta documentação para obter mais informações.
properties.createTenantProperties.countryCode	string	Código do país do locatário do Azure (por exemplo, 'EUA'). Consulte aka.ms/B2CDataResidency para ver os códigos de país válidos e os locais de residência de dados correspondentes. Se você não vir um código de país em um local de residência de dados válido, escolha um na lista.
properties.createTenantProperties.displayName	string	O nome para exibição do locatário do Azure AD B2C.
sku	B2CResourceSKU	Propriedades de SKU do locatário do Azure AD B2C. Saiba mais sobre a faturação do Azure AD B2C em aka.ms/b2cBilling.
tags	object	Tags de recursos

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

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

Name	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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

Enumeração

O tipo do recurso de locatário B2C.

Valor	Description
Microsoft.AzureActiveDirectory/b2cDirectories	O tipo de recurso para o recurso de locatário do Azure AD B2C.

Partilhar via

B2C Tenants - Create

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Create tenant

Pedido de amostra

Resposta da amostra

Definições

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue