B2C Tenants - Update

Referens

Service:: Azure AD B2C

API Version:: 2021-04-01

Uppdatera Azure AD B2C-klientresurs.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen.
resourceName	path	True	string	Det första domännamnet för Azure AD B2C-klientorganisationen.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran.

Begärandetext

Name	Typ	Description
properties.billingConfig	BillingConfig	Faktureringskonfigurationen för klientorganisationen.
properties.tenantId	string	En identifierare för Azure AD B2C-klientorganisationen.
sku	B2CResourceSKU	SKU-egenskaper för Azure AD B2C-klientorganisationen. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling.
tags	object	Resurstaggar

Svar

Name	Typ	Description
200 OK	B2CTenantResource	Uppdaterade Azure AD B2C-klientresursen.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
B2CResourceSKU	SKU-egenskaper för Azure AD B2C-klientorganisationen. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling.
B2CResourceSKUName	Namnet på SKU:n för klientorganisationen.
B2CResourceSKUTier	Klientorganisationens nivå.
B2CTenantResource
B2CTenantUpdateRequest	Begärandetexten för att uppdatera Azure AD B2C-klientresurs.
BillingConfig	Faktureringskonfigurationen för klientorganisationen.
BillingType	Typen av fakturering. Blir MAU för alla nya kunder. Om "Auths" (autentiseringar) kan uppdateras till "MAU". Det går inte att ändra värdet om värdet är MAU. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling.
CloudError	Ett felsvar för en resurshanteringsbegäran.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Felsvar
systemData	Metadata som rör skapande och senaste ändring av resursen.
TypeValue	Typ av B2C-klientresurs.

B2CResourceSKU

SKU-egenskaper för Azure AD B2C-klientorganisationen. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling.

Name	Typ	Description
name	B2CResourceSKUName	Namnet på SKU:n för klientorganisationen.
tier	B2CResourceSKUTier	Klientorganisationens nivå.

B2CResourceSKUName

Namnet på SKU:n för klientorganisationen.

Name	Typ	Description
PremiumP1	string	Azure AD B2C-användning faktureras till en länkad Azure-prenumeration och använder antalet autentiseringsbaserade fakturering.
PremiumP2	string	Azure AD B2C-användning faktureras till en länkad Azure-prenumeration och använder antalet autentiseringsbaserade fakturering.
Standard	string	Azure AD B2C-användning debiteras till en länkad Azure-prenumeration och använder en faktureringsmodell för månatliga aktiva användare (MAU).

B2CResourceSKUTier

Klientorganisationens nivå.

Name	Typ	Description
A0	string	Den SKU-nivå som används för alla Azure AD B2C-klientorganisationer.

B2CTenantResource

Name	Typ	Description
id	string	En identifierare som representerar Azure AD B2C-klientresurs.
location	string	Platsen där resursen finns och data finns. Kan vara en av "USA", "Europa", "Asien och Stillahavsområdet" eller "Australien". Mer information finns i den här dokumentationen .
name	string	Namnet på Azure AD B2C-klientresurs.
properties.billingConfig	BillingConfig	Faktureringskonfigurationen för klientorganisationen.
properties.tenantId	string	En identifierare för Azure AD B2C-klientorganisationen.
sku	B2CResourceSKU	SKU-egenskaper för Azure AD B2C-klientorganisationen. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling.
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
tags	object	Resurstaggar
type	TypeValue	Typ av B2C-klientresurs.

B2CTenantUpdateRequest

Begärandetexten för att uppdatera Azure AD B2C-klientresurs.

Name	Typ	Description
properties.billingConfig	BillingConfig	Faktureringskonfigurationen för klientorganisationen.
properties.tenantId	string	En identifierare för Azure AD B2C-klientorganisationen.
sku	B2CResourceSKU	SKU-egenskaper för Azure AD B2C-klientorganisationen. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling.
tags	object	Resurstaggar

BillingConfig

Faktureringskonfigurationen för klientorganisationen.

Name	Typ	Description
billingType	BillingType	Typen av fakturering. Blir MAU för alla nya kunder. Om "Auths" (autentiseringar) kan uppdateras till "MAU". Det går inte att ändra värdet om värdet är MAU. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling.
effectiveStartDateUtc	string	De data som faktureringstypen trädde i kraft från

BillingType

Typen av fakturering. Blir MAU för alla nya kunder. Om "Auths" (autentiseringar) kan uppdateras till "MAU". Det går inte att ändra värdet om värdet är MAU. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling.

Name	Typ	Description
Auths	string	Azure AD B2C-användning faktureras till en länkad Azure-prenumeration och använder antalet autentiseringsbaserade fakturering.
MAU	string	Azure AD B2C-användning debiteras till en länkad Azure-prenumeration och använder en faktureringsmodell för månatliga aktiva användare (MAU).

CloudError

Ett felsvar för en resurshanteringsbegäran.

Name	Typ	Description
error	ErrorResponse	Felsvar Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.)

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorResponse

Felsvar

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

TypeValue

Typ av B2C-klientresurs.

Name	Typ	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	Resurstypen för Azure AD B2C-klientresurs.