B2C Tenants - Update

Riferimento

Servizio:: Azure AD B2C

Versione API:: 2021-04-01

Aggiornare la risorsa tenant di Azure AD B2C.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse.
resourceName	path	True	string	Nome di dominio iniziale del tenant di Azure AD B2C.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.billingConfig	BillingConfig	Configurazione della fatturazione per il tenant.
properties.tenantId	string	Identificatore del tenant di Azure AD B2C.
sku	B2CResourceSKU	Proprietà SKU del tenant di Azure AD B2C. Altre informazioni sulla fatturazione di Azure AD B2C in aka.ms/b2cBilling.
tags	object	Tag delle risorse

Risposte

Nome	Tipo	Descrizione
200 OK	B2CTenantResource	Aggiornamento della risorsa tenant di Azure AD B2C.
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
B2CResourceSKU	Proprietà SKU del tenant di Azure AD B2C. Altre informazioni sulla fatturazione di Azure AD B2C in aka.ms/b2cBilling.
B2CResourceSKUName	Nome dello SKU per il tenant.
B2CResourceSKUTier	Livello del tenant.
B2CTenantResource
B2CTenantUpdateRequest	Corpo della richiesta per aggiornare la risorsa tenant di Azure AD B2C.
BillingConfig	Configurazione della fatturazione per il tenant.
BillingType	Tipo di fatturazione. Sarà MAU per tutti i nuovi clienti. Se 'Auths', può essere aggiornato a 'MAU'. Impossibile modificare se il valore è 'MAU'. Altre informazioni sulla fatturazione di Azure AD B2C in aka.ms/b2cBilling.
CloudError	Risposta di errore per una richiesta di gestione delle risorse.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorResponse	Risposta di errore
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
TypeValue	Tipo della risorsa tenant B2C.

B2CResourceSKU

Proprietà SKU del tenant di Azure AD B2C. Altre informazioni sulla fatturazione di Azure AD B2C in aka.ms/b2cBilling.

Nome	Tipo	Descrizione
name	B2CResourceSKUName	Nome dello SKU per il tenant.
tier	B2CResourceSKUTier	Livello del tenant.

B2CResourceSKUName

Nome dello SKU per il tenant.

Nome	Tipo	Descrizione
PremiumP1	string	L'utilizzo di Azure AD B2C viene addebitato a una sottoscrizione di Azure collegata e usa il numero di autenticazioni basate sulla fatturazione.
PremiumP2	string	L'utilizzo di Azure AD B2C viene addebitato a una sottoscrizione di Azure collegata e usa il numero di autenticazioni basate sulla fatturazione.
Standard	string	L'utilizzo di Azure AD B2C viene addebitato a una sottoscrizione di Azure collegata e usa un modello di fatturazione di utenti attivi mensili (MAU).

B2CResourceSKUTier

Livello del tenant.

Nome	Tipo	Descrizione
A0	string	Livello SKU usato per tutti i tenant di Azure AD B2C.

B2CTenantResource

Nome	Tipo	Descrizione
id	string	Identificatore che rappresenta la risorsa tenant di Azure AD B2C.
location	string	Posizione in cui risiede la risorsa e i dati. Può essere uno dei "Stati Uniti", "Europa", "Asia Pacifico" o "Australia". Per altre informazioni, vedere questa documentazione .
name	string	Nome della risorsa tenant di Azure AD B2C.
properties.billingConfig	BillingConfig	Configurazione della fatturazione per il tenant.
properties.tenantId	string	Identificatore del tenant di Azure AD B2C.
sku	B2CResourceSKU	Proprietà SKU del tenant di Azure AD B2C. Altre informazioni sulla fatturazione di Azure AD B2C in aka.ms/b2cBilling.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags	object	Tag delle risorse
type	TypeValue	Tipo della risorsa tenant B2C.

B2CTenantUpdateRequest

Corpo della richiesta per aggiornare la risorsa tenant di Azure AD B2C.

Nome	Tipo	Descrizione
properties.billingConfig	BillingConfig	Configurazione della fatturazione per il tenant.
properties.tenantId	string	Identificatore del tenant di Azure AD B2C.
sku	B2CResourceSKU	Proprietà SKU del tenant di Azure AD B2C. Altre informazioni sulla fatturazione di Azure AD B2C in aka.ms/b2cBilling.
tags	object	Tag delle risorse

BillingConfig

Configurazione della fatturazione per il tenant.

Nome	Tipo	Descrizione
billingType	BillingType	Tipo di fatturazione. Sarà MAU per tutti i nuovi clienti. Se 'Auths', può essere aggiornato a 'MAU'. Impossibile modificare se il valore è 'MAU'. Altre informazioni sulla fatturazione di Azure AD B2C in aka.ms/b2cBilling.
effectiveStartDateUtc	string	Dati da cui è stato eseguito il tipo di fatturazione

BillingType

Tipo di fatturazione. Sarà MAU per tutti i nuovi clienti. Se 'Auths', può essere aggiornato a 'MAU'. Impossibile modificare se il valore è 'MAU'. Altre informazioni sulla fatturazione di Azure AD B2C in aka.ms/b2cBilling.

Nome	Tipo	Descrizione
Auths	string	L'utilizzo di Azure AD B2C viene addebitato a una sottoscrizione di Azure collegata e usa il numero di autenticazioni basate sulla fatturazione.
MAU	string	L'utilizzo di Azure AD B2C viene addebitato a una sottoscrizione di Azure collegata e usa un modello di fatturazione di utenti attivi mensili (MAU).

CloudError

Risposta di errore per una richiesta di gestione delle risorse.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta di errore Risposta di errore comune per tutte le API di Resource Manager di Azure per restituire i dettagli degli errori per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.

TypeValue

Tipo della risorsa tenant B2C.

Nome	Tipo	Descrizione
Microsoft.AzureActiveDirectory/b2cDirectories	string	Tipo di risorsa per la risorsa tenant di Azure AD B2C.

Condividi tramite