B2C Tenants - Update

Referencia

Servicio:: Azure AD B2C

Versión de la API:: 2021-04-01

Actualice el recurso de inquilino de Azure AD B2C.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos.
resourceName	path	True	string	Nombre de dominio inicial del inquilino de Azure AD B2C.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.billingConfig	BillingConfig	Configuración de facturación del inquilino.
properties.tenantId	string	Identificador del inquilino de Azure AD B2C.
sku	B2CResourceSKU	Propiedades de SKU del inquilino de Azure AD B2C. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
tags	object	Etiquetas de recursos

Respuestas

Nombre	Tipo	Description
200 OK	B2CTenantResource	Se ha actualizado el recurso de inquilino de Azure AD B2C.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Respuesta de muestra

status code:: 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"
  }
}

Definiciones

Nombre	Description
B2CResourceSKU	Propiedades de SKU del inquilino de Azure AD B2C. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
B2CResourceSKUName	Nombre de la SKU para el inquilino.
B2CResourceSKUTier	Nivel del inquilino.
B2CTenantResource
B2CTenantUpdateRequest	Cuerpo de la solicitud para actualizar el recurso de inquilino de Azure AD B2C.
BillingConfig	Configuración de facturación del inquilino.
BillingType	Tipo de facturación. Será MAU para todos los nuevos clientes. Si "Auths", se puede actualizar a "MAU". No se puede cambiar si el valor es 'MAU'. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
CloudError	Respuesta de error para una solicitud de administración de recursos.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error
systemData	Metadatos relativos a la creación y última modificación del recurso.
TypeValue	Tipo del recurso de inquilino B2C.

B2CResourceSKU

Object

Propiedades de SKU del inquilino de Azure AD B2C. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.

Nombre	Tipo	Description
name	B2CResourceSKUName	Nombre de la SKU para el inquilino.
tier	B2CResourceSKUTier	Nivel del inquilino.

B2CResourceSKUName

Enumeración

Nombre de la SKU para el inquilino.

Valor	Description
PremiumP1	El uso de Azure AD B2C se factura a una suscripción de Azure vinculada y usa el número de autenticaciones basadas en la facturación.
PremiumP2	El uso de Azure AD B2C se factura a una suscripción de Azure vinculada y usa el número de autenticaciones basadas en la facturación.
Standard	El uso de Azure AD B2C se factura a una suscripción de Azure vinculada y usa un modelo de facturación de usuarios activos mensuales (MAU).

B2CResourceSKUTier

Enumeración

Nivel del inquilino.

Valor	Description
A0	Nivel de SKU que se usa para todos los inquilinos de Azure AD B2C.

B2CTenantResource

Object

Nombre	Tipo	Description
id	string	Identificador que representa el recurso de inquilino de Azure AD B2C.
location	string	Ubicación en la que se hospeda el recurso y los datos residen. Puede ser uno de los "Estados Unidos", "Europa", "Asia Pacífico" o "Australia". Consulte esta documentación para obtener más información.
name	string	Nombre del recurso de inquilino de Azure AD B2C.
properties.billingConfig	BillingConfig	Configuración de facturación del inquilino.
properties.tenantId	string	Identificador del inquilino de Azure AD B2C.
sku	B2CResourceSKU	Propiedades de SKU del inquilino de Azure AD B2C. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas de recursos
type	TypeValue	Tipo del recurso de inquilino B2C.

B2CTenantUpdateRequest

Object

Cuerpo de la solicitud para actualizar el recurso de inquilino de Azure AD B2C.

Nombre	Tipo	Description
properties.billingConfig	BillingConfig	Configuración de facturación del inquilino.
properties.tenantId	string	Identificador del inquilino de Azure AD B2C.
sku	B2CResourceSKU	Propiedades de SKU del inquilino de Azure AD B2C. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
tags	object	Etiquetas de recursos

BillingConfig

Object

Configuración de facturación del inquilino.

Nombre	Tipo	Description
billingType	BillingType	Tipo de facturación. Será MAU para todos los nuevos clientes. Si "Auths", se puede actualizar a "MAU". No se puede cambiar si el valor es 'MAU'. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
effectiveStartDateUtc	string	Datos desde los que surtió efecto el tipo de facturación.

BillingType

Enumeración

Tipo de facturación. Será MAU para todos los nuevos clientes. Si "Auths", se puede actualizar a "MAU". No se puede cambiar si el valor es 'MAU'. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.

Valor	Description
Auths	El uso de Azure AD B2C se factura a una suscripción de Azure vinculada y usa el número de autenticaciones basadas en la facturación.
MAU	El uso de Azure AD B2C se factura a una suscripción de Azure vinculada y usa un modelo de facturación de usuarios activos mensuales (MAU).

CloudError

Object

Respuesta de error para una solicitud de administración de recursos.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TypeValue

Enumeración

Tipo del recurso de inquilino B2C.

Valor	Description
Microsoft.AzureActiveDirectory/b2cDirectories	Tipo de recurso para el recurso de inquilino de Azure AD B2C.

Compartir a través de

B2C Tenants - Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Update tenant

Solicitud de ejemplo

Respuesta de muestra

Definiciones

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

B2CTenantUpdateRequest

BillingConfig

BillingType

CloudError

createdByType

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Recursos adicionales