B2C Tenants - Update

Référence

Service:: Azure AD B2C

Version d'API:: 2021-04-01

Mettez à jour la ressource de locataire Azure AD B2C.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources.
resourceName	path	True	string	Nom de domaine initial du locataire Azure AD B2C.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Corps de la demande

Nom	Type	Description
properties.billingConfig	BillingConfig	Configuration de facturation pour le locataire.
properties.tenantId	string	Identificateur du locataire Azure AD B2C.
sku	B2CResourceSKU	Propriétés de la référence SKU du locataire Azure AD B2C. Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
tags	object	Balises de ressource

Réponses

Nom	Type	Description
200 OK	B2CTenantResource	Mise à jour de la ressource de locataire Azure AD B2C.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

Nom	Description
B2CResourceSKU	Propriétés de la référence SKU du locataire Azure AD B2C. Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
B2CResourceSKUName	Nom de la référence SKU du locataire.
B2CResourceSKUTier	Niveau du locataire.
B2CTenantResource
B2CTenantUpdateRequest	Corps de la demande de mise à jour de la ressource de locataire Azure AD B2C.
BillingConfig	Configuration de facturation pour le locataire.
BillingType	Type de facturation. Sera MAU pour tous les nouveaux clients. Si « Auths », il peut être mis à jour vers « MAU ». Impossible de modifier si la valeur est « MAU ». Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
CloudError	Réponse d’erreur pour une demande de gestion des ressources.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TypeValue	Type de la ressource de locataire B2C.

B2CResourceSKU

Propriétés de la référence SKU du locataire Azure AD B2C. Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.

Nom	Type	Description
name	B2CResourceSKUName	Nom de la référence SKU du locataire.
tier	B2CResourceSKUTier	Niveau du locataire.

B2CResourceSKUName

Nom de la référence SKU du locataire.

Nom	Type	Description
PremiumP1	string	L’utilisation d’Azure AD B2C est facturée à un abonnement Azure lié et utilise le nombre de facturations basées sur les authentifications.
PremiumP2	string	L’utilisation d’Azure AD B2C est facturée à un abonnement Azure lié et utilise le nombre de facturations basées sur les authentifications.
Standard	string	L’utilisation d’Azure AD B2C est facturée à un abonnement Azure lié et utilise un modèle de facturation mensuel des utilisateurs actifs (MAU).

B2CResourceSKUTier

Niveau du locataire.

Nom	Type	Description
A0	string	Niveau de référence SKU utilisé pour tous les locataires Azure AD B2C.

B2CTenantResource

Nom	Type	Description
id	string	Identificateur qui représente la ressource de locataire Azure AD B2C.
location	string	Emplacement dans lequel la ressource est hébergée et où résident les données. Il peut s’agir de l’un des « États-Unis », « Europe », « Asie-Pacifique » ou « Australie ». Pour plus d’informations, consultez cette documentation .
name	string	Nom de la ressource de locataire Azure AD B2C.
properties.billingConfig	BillingConfig	Configuration de facturation pour le locataire.
properties.tenantId	string	Identificateur du locataire Azure AD B2C.
sku	B2CResourceSKU	Propriétés de la référence SKU du locataire Azure AD B2C. Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
systemData	systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
tags	object	Balises de ressource
type	TypeValue	Type de la ressource de locataire B2C.

B2CTenantUpdateRequest

Corps de la demande de mise à jour de la ressource de locataire Azure AD B2C.

Nom	Type	Description
properties.billingConfig	BillingConfig	Configuration de facturation pour le locataire.
properties.tenantId	string	Identificateur du locataire Azure AD B2C.
sku	B2CResourceSKU	Propriétés de la référence SKU du locataire Azure AD B2C. Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
tags	object	Balises de ressource

BillingConfig

Configuration de facturation pour le locataire.

Nom	Type	Description
billingType	BillingType	Type de facturation. Sera MAU pour tous les nouveaux clients. Si « Auths », il peut être mis à jour vers « MAU ». Impossible de modifier si la valeur est « MAU ». Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
effectiveStartDateUtc	string	Données à partir desquelles le type de facturation a pris effet

BillingType

Type de facturation. Sera MAU pour tous les nouveaux clients. Si « Auths », il peut être mis à jour vers « MAU ». Impossible de modifier si la valeur est « MAU ». Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.

Nom	Type	Description
Auths	string	L’utilisation d’Azure AD B2C est facturée à un abonnement Azure lié et utilise le nombre de facturations basées sur les authentifications.
MAU	string	L’utilisation d’Azure AD B2C est facturée à un abonnement Azure lié et utilise un modèle de facturation mensuel des utilisateurs actifs (MAU).

CloudError

Réponse d’erreur pour une demande de gestion des ressources.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.

TypeValue

Type de la ressource de locataire B2C.

Nom	Type	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	Type de ressource pour la ressource de locataire Azure AD B2C.

Partager via