B2C Tenants - Update

リファレンス

Service:: Azure AD B2C

API Version:: 2021-04-01

Azure AD B2C テナントリソースを更新します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。
resourceName	path	True	string	Azure AD B2C テナントの初期ドメイン名。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント要求で使用される API のバージョン。

要求本文

名前	型	説明
properties.billingConfig	BillingConfig	テナントの課金構成。
properties.tenantId	string	Azure AD B2C テナントの識別子。
sku	B2CResourceSKU	Azure AD B2C テナントの SKU プロパティ。 Azure AD B2C の課金の詳細については、aka.ms/b2cBilling を参照してください。
tags	object	リソースタグ

応答

名前	型	説明
200 OK	B2CTenantResource	Azure AD B2C テナントリソースを更新しました。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

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

定義

名前	説明
B2CResourceSKU	Azure AD B2C テナントの SKU プロパティ。 Azure AD B2C の課金の詳細については、aka.ms/b2cBilling を参照してください。
B2CResourceSKUName	テナントの SKU の名前。
B2CResourceSKUTier	テナントの層。
B2CTenantResource
B2CTenantUpdateRequest	Azure AD B2C テナントリソースを更新するための要求本文。
BillingConfig	テナントの課金構成。
BillingType	課金の種類。すべての新規顧客向けの MAU になります。 'Auths' の場合は、"MAU" に更新できます。値が 'MAU' の場合は変更できません。 Azure AD B2C の課金の詳細については、aka.ms/b2cBilling を参照してください。
CloudError	リソース管理要求のエラー応答。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
systemData	リソースの作成と最後の変更に関連するメタデータ。
TypeValue	B2C テナントリソースの種類。

B2CResourceSKU

Azure AD B2C テナントの SKU プロパティ。 Azure AD B2C の課金の詳細については、aka.ms/b2cBilling を参照してください。

名前	型	説明
name	B2CResourceSKUName	テナントの SKU の名前。
tier	B2CResourceSKUTier	テナントの層。

B2CResourceSKUName

テナントの SKU の名前。

名前	型	説明
PremiumP1	string	Azure AD B2C の使用量は、リンクされた Azure サブスクリプションに課金され、認証ベースの課金の数が使用されます。
PremiumP2	string	Azure AD B2C の使用量は、リンクされた Azure サブスクリプションに課金され、認証ベースの課金の数が使用されます。
Standard	string	Azure AD B2C の使用量は、リンクされた Azure サブスクリプションに課金され、月間アクティブユーザー (MAU) の課金モデルが使用されます。

B2CResourceSKUTier

テナントの層。

名前	型	説明
A0	string	すべての Azure AD B2C テナントに使用される SKU レベル。

B2CTenantResource

名前	型	説明
id	string	Azure AD B2C テナントリソースを表す識別子。
location	string	リソースがホストされ、データが存在する場所。 "米国"、"ヨーロッパ"、"アジア太平洋"、または "オーストラリア" のいずれかです。詳細については、こちらのドキュメントを参照してください。
name	string	Azure AD B2C テナントリソースの名前。
properties.billingConfig	BillingConfig	テナントの課金構成。
properties.tenantId	string	Azure AD B2C テナントの識別子。
sku	B2CResourceSKU	Azure AD B2C テナントの SKU プロパティ。 Azure AD B2C の課金の詳細については、aka.ms/b2cBilling を参照してください。
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
tags	object	リソースタグ
type	TypeValue	B2C テナントリソースの種類。

B2CTenantUpdateRequest

Azure AD B2C テナントリソースを更新するための要求本文。

名前	型	説明
properties.billingConfig	BillingConfig	テナントの課金構成。
properties.tenantId	string	Azure AD B2C テナントの識別子。
sku	B2CResourceSKU	Azure AD B2C テナントの SKU プロパティ。 Azure AD B2C の課金の詳細については、aka.ms/b2cBilling を参照してください。
tags	object	リソースタグ

BillingConfig

テナントの課金構成。

名前	型	説明
billingType	BillingType	課金の種類。すべての新規顧客向けの MAU になります。 'Auths' の場合は、"MAU" に更新できます。値が 'MAU' の場合は変更できません。 Azure AD B2C の課金の詳細については、aka.ms/b2cBilling を参照してください。
effectiveStartDateUtc	string	課金の種類が有効になったデータ

BillingType

課金の種類。すべての新規顧客向けの MAU になります。 'Auths' の場合は、"MAU" に更新できます。値が 'MAU' の場合は変更できません。 Azure AD B2C の課金の詳細については、aka.ms/b2cBilling を参照してください。

名前	型	説明
Auths	string	Azure AD B2C の使用量は、リンクされた Azure サブスクリプションに課金され、認証ベースの課金の数が使用されます。
MAU	string	Azure AD B2C の使用量は、リンクされた Azure サブスクリプションに課金され、月間アクティブユーザー (MAU) の課金モデルが使用されます。

CloudError

リソース管理要求のエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは、OData エラー応答形式にも従います)。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorResponse

エラー応答

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorResponse[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TypeValue

B2C テナントリソースの種類。

名前	型	説明
Microsoft.AzureActiveDirectory/b2cDirectories	string	Azure AD B2C テナントリソースのリソースの種類。