B2C Tenants - Update

Referência

Serviço:: Azure AD B2C

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

Atualize o Azure AD recurso de inquilino B2C.

PATCH 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	Tipo	Description
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 inquilino Azure AD B2C. Saiba mais sobre Azure AD faturação B2C na aka.ms/b2cBilling.
tags	object	Etiquetas de Recursos

Respostas

Name	Tipo	Description
200 OK	B2CTenantResource	Atualizou o Azure AD recurso de inquilino B2C.
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Update tenant

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

{
  "sku": {
    "name": "PremiumP1"
  },
  "properties": {
    "billingConfig": {
      "billingType": "MAU"
    }
  },
  "tags": {
    "key": "value"
  }
}

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

/**
 * This sample demonstrates how to Update the Azure AD B2C tenant resource.
 *
 * @summary Update the Azure AD B2C tenant resource.
 * x-ms-original-file: specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/stable/2021-04-01/examples/updateTenant.json
 */
async function updateTenant() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "contosoResourceGroup";
  const resourceName = "contoso.onmicrosoft.com";
  const updateTenantRequestBody = {
    billingConfig: { billingType: "MAU" },
    sku: { name: "PremiumP1" },
    tags: { key: "value" },
  };
  const options = { updateTenantRequestBody };
  const credential = new DefaultAzureCredential();
  const client = new ExternalIdentitiesConfigurationClient(credential, subscriptionId);
  const result = await client.b2CTenants.update(resourceGroupName, resourceName, options);
  console.log(result);
}

updateTenant().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

Resposta da amostra

Código de estado:: 200

{
  "type": "Microsoft.AzureActiveDirectory/b2cDirectories",
  "sku": {
    "name": "PremiumP1",
    "tier": "A0"
  },
  "properties": {
    "billingConfig": {
      "billingType": "MAU"
    },
    "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": {
    "key": "value"
  }
}

Definições

Name	Description
B2CResourceSKU	Propriedades de SKU do inquilino Azure AD B2C. Saiba mais sobre Azure AD faturação B2C na aka.ms/b2cBilling.
B2CResourceSKUName	O nome do SKU do inquilino.
B2CResourceSKUTier	A camada do inquilino.
B2CTenantResource
B2CTenantUpdateRequest	O corpo do pedido para atualizar o Azure AD recurso de inquilino B2C.
BillingConfig	A configuração de faturação do inquilino.
BillingType	O tipo de faturação. Será MAU para todos os novos clientes. Se "Autenticações", pode ser atualizado para "MAU". Não é possível alterar se o valor for "MAU". Saiba mais sobre Azure AD faturação B2C na 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.
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 inquilino Azure AD B2C. Saiba mais sobre Azure AD faturação B2C na 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 B2C é faturada para uma subscrição do Azure ligada e utiliza o número de autenticações baseadas na faturação.
PremiumP2	string	Azure AD utilização B2C é faturada para uma subscrição do Azure ligada e utiliza o número de autenticações baseadas na faturação.
Standard	string	Azure AD utilização B2C é faturada para uma subscrição do Azure ligada e utiliza um modelo de faturação mensal de utilizadores ativos (MAU).

B2CResourceSKUTier

A camada do inquilino.

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

B2CTenantResource

Name	Tipo	Description
id	string	Um identificador que representa o Azure AD recurso de inquilino B2C.
location	string	A localização onde 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 inquilino Azure AD B2C. Saiba mais sobre Azure AD faturação B2C na 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.

B2CTenantUpdateRequest

O corpo do pedido para atualizar o Azure AD recurso de inquilino B2C.

Name	Tipo	Description
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 inquilino Azure AD B2C. Saiba mais sobre Azure AD faturação B2C na aka.ms/b2cBilling.
tags	object	Etiquetas de Recursos

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 "Autenticações", pode ser atualizado para "MAU". Não é possível alterar se o valor for "MAU". Saiba mais sobre Azure AD faturação B2C na 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 "Autenticações", pode ser atualizado para "MAU". Não é possível alterar se o valor for "MAU". Saiba mais sobre Azure AD faturação B2C na aka.ms/b2cBilling.

Name	Tipo	Description
Auths	string	Azure AD utilização B2C é faturada para uma subscrição do Azure ligada e utiliza o número de autenticações baseadas na faturação.
MAU	string	Azure AD utilização B2C é faturada para uma subscrição do Azure ligada e utiliza um modelo de faturação mensal de utilizadores ativos (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 Resource Manager do Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta a erros OData.)

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

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ção adicional.

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.

Partilhar via