B2C Tenants - Update

Referenz

Service:: Azure AD B2C

API Version:: 2021-04-01

Aktualisieren Sie die Azure AD B2C-Mandantenressource.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
resourceName	path	True	string	Der anfängliche Domänenname des Azure AD B2C-Mandanten.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.billingConfig	BillingConfig	Die Abrechnungskonfiguration für den Mandanten.
properties.tenantId	string	Ein Bezeichner des Azure AD B2C-Mandanten.
sku	B2CResourceSKU	SKU-Eigenschaften des Azure AD B2C-Mandanten. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
tags	object	Ressource Tags

Antworten

Name	Typ	Beschreibung
200 OK	B2CTenantResource	Die Azure AD B2C-Mandantenressource wurde aktualisiert.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Sample Response

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

Definitionen

Name	Beschreibung
B2CResourceSKU	SKU-Eigenschaften des Azure AD B2C-Mandanten. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
B2CResourceSKUName	Der Name der SKU für den Mandanten.
B2CResourceSKUTier	Die Ebene des Mandanten.
B2CTenantResource
B2CTenantUpdateRequest	Der Anforderungstext zum Aktualisieren der Azure AD B2C-Mandantenressource.
BillingConfig	Die Abrechnungskonfiguration für den Mandanten.
BillingType	Der Abrechnungstyp. Wird MAU für alle neuen Kunden sein. Wenn "Authentifizierungen", kann sie auf "MAU" aktualisiert werden. Kann nicht geändert werden, wenn der Wert "MAU" ist. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
CloudError	Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Fehlerantwort
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
TypeValue	Der Typ der B2C-Mandantenressource.

B2CResourceSKU

SKU-Eigenschaften des Azure AD B2C-Mandanten. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.

Name	Typ	Beschreibung
name	B2CResourceSKUName	Der Name der SKU für den Mandanten.
tier	B2CResourceSKUTier	Die Ebene des Mandanten.

B2CResourceSKUName

Der Name der SKU für den Mandanten.

Name	Typ	Beschreibung
PremiumP1	string	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet die anzahl von Authentifizierungen basierende Abrechnung.
PremiumP2	string	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet die anzahl von Authentifizierungen basierende Abrechnung.
Standard	string	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet ein monatliches Abrechnungsmodell für aktive Benutzer (MAU).

B2CResourceSKUTier

Die Ebene des Mandanten.

Name	Typ	Beschreibung
A0	string	Der SKU-Tarif, der für alle Azure AD B2C-Mandanten verwendet wird.

B2CTenantResource

Name	Typ	Beschreibung
id	string	Ein Bezeichner, der die Azure AD B2C-Mandantenressource darstellt.
location	string	Der Speicherort, an dem die Ressource gehostet wird und sich die Daten befinden. Kann einer von "USA", "Europa", "Asien-Pazifik" oder "Australien" sein. Weitere Informationen finden Sie in dieser Dokumentation .
name	string	Der Name der Azure AD B2C-Mandantenressource.
properties.billingConfig	BillingConfig	Die Abrechnungskonfiguration für den Mandanten.
properties.tenantId	string	Ein Bezeichner des Azure AD B2C-Mandanten.
sku	B2CResourceSKU	SKU-Eigenschaften des Azure AD B2C-Mandanten. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
systemData	systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
tags	object	Ressource Tags
type	TypeValue	Der Typ der B2C-Mandantenressource.

B2CTenantUpdateRequest

Der Anforderungstext zum Aktualisieren der Azure AD B2C-Mandantenressource.

Name	Typ	Beschreibung
properties.billingConfig	BillingConfig	Die Abrechnungskonfiguration für den Mandanten.
properties.tenantId	string	Ein Bezeichner des Azure AD B2C-Mandanten.
sku	B2CResourceSKU	SKU-Eigenschaften des Azure AD B2C-Mandanten. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
tags	object	Ressource Tags

BillingConfig

Die Abrechnungskonfiguration für den Mandanten.

Name	Typ	Beschreibung
billingType	BillingType	Der Abrechnungstyp. Wird MAU für alle neuen Kunden sein. Wenn "Authentifizierungen", kann sie auf "MAU" aktualisiert werden. Kann nicht geändert werden, wenn der Wert "MAU" ist. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
effectiveStartDateUtc	string	Die Daten, ab denen der Abrechnungstyp wirksam wurde

BillingType

Der Abrechnungstyp. Wird MAU für alle neuen Kunden sein. Wenn "Authentifizierungen", kann sie auf "MAU" aktualisiert werden. Kann nicht geändert werden, wenn der Wert "MAU" ist. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.

Name	Typ	Beschreibung
Auths	string	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet die anzahl von Authentifizierungen basierende Abrechnung.
MAU	string	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet ein monatliches Abrechnungsmodell für aktive Benutzer (MAU).

CloudError

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TypeValue

Der Typ der B2C-Mandantenressource.

Name	Typ	Beschreibung
Microsoft.AzureActiveDirectory/b2cDirectories	string	Der Ressourcentyp für die Azure AD B2C-Mandantenressource.

Freigeben über