CIAM Tenants - Create

リファレンス

サービス:: Azure AD B2C

API バージョン:: 2023-05-17-preview

顧客テナント用の Azure AD と、サブスクリプションにリンクされている対応する Azure リソースの両方を作成する非同期要求を開始します。注: 新しいテナントを作成する前に、名前の可用性を確認してください

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories/{resourceName}?api-version=2023-05-17-preview

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。
resourceName	path	True	string maxLength: 26 pattern: ^[a-zA-Z0-9]{1,26}	テナントの初期サブドメイン。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント要求で使用する API のバージョン。

要求本文

名前	必須	型	説明
location	True	string	リソースがホストされ、データが存在する場所。 "米国"、"ヨーロッパ"、"アジア太平洋"、または "オーストラリア" のいずれかを指定できます。詳細については、このドキュメントを参照してください。
properties.createTenantProperties.countryCode	True	string	Azure テナントの国コード (例: "US")。有効な国コードと対応するデータ所在地については、https://aka.ms/ciam-data-location を参照してください。有効なデータ所在地に国コードが表示されない場合は、一覧から国番号を選択します。
properties.createTenantProperties.displayName	True	string	顧客テナントの Azure AD の表示名。
sku	True	CIAMResourceSKU	顧客テナント用の Azure AD の SKU プロパティ。顧客向け Azure AD の課金の詳細については、https://aka.ms/ciambillingを参照してください。
properties.tenantId		string	顧客テナントの Azure AD の識別子。
tags		object	リソースタグ

応答

名前	型	説明
200 OK	CIAMTenantResource	OK - 顧客テナントリソースの既存の Azure AD が正常に更新されました。
201 Created	CIAMTenantResource	顧客向け Azure AD テナント作成要求が正常に開始され、非同期的に完了します。ヘッダー Azure-AsyncOperation: string Retry-After: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

CIAMTenantResource

OK - 顧客テナントリソースの既存の Azure AD が正常に更新されました。

201 Created

CIAMTenantResource

顧客向け Azure AD テナント作成要求が正常に開始され、非同期的に完了します。

ヘッダー

Azure-AsyncOperation: string
Retry-After: string

Other Status Codes

ErrorResponse

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Create_CIAM_tenant

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories/contoso?api-version=2023-05-17-preview

{
  "location": "United States",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "createTenantProperties": {
      "displayName": "Contoso",
      "countryCode": "US"
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories/contoso",
  "name": "contoso",
  "type": "Microsoft.AzureActiveDirectory/ciamDirectories",
  "location": "United States",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "createTenantProperties": {
      "displayName": "Contoso",
      "countryCode": "US"
    },
    "billingConfig": {
      "billingType": "MAU",
      "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
    },
    "domainName": "contoso.onmicrosoft.com",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "tags": null,
  "systemData": {
    "createdBy": "contosoAdmin@onmicrosoft.com",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "contosoAdmin@onmicrosoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T01:01:01.1075056Z"
  }
}

状態コード:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/e70a6dd9-57ab-481e-9668-a6899e3f13f6/providers/Microsoft.AzureActiveDirectory/operationStatuses/f57cbcaf-5d23-495e-8414-43fe19cb9e82?api-version=2023-05-17-preview
Retry-After: 60

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories/contoso.onmicrosoft.com",
  "name": "contoso.onmicrosoft.com",
  "type": "Microsoft.AzureActiveDirectory/ciamDirectories",
  "location": "United States",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "provisioningState": "Provisioning",
    "createTenantProperties": {
      "displayName": "Contoso",
      "countryCode": "US"
    },
    "billingConfig": {
      "billingType": "MAU",
      "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "tags": null,
  "systemData": {
    "createdBy": "contosoAdmin@onmicrosoft.com",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "contosoAdmin@onmicrosoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T01:01:01.1075056Z"
  }
}

定義

名前	説明
ciamBillingType	課金の種類。すべての新規顧客向けの MAU になります。値が 'MAU' の場合は変更できません。 aka.ms/b2cBillingで課金される顧客向けの Azure AD の詳細について説明します。
CIAMResourceSKU	顧客テナント用の Azure AD の SKU プロパティ。顧客向け Azure AD の課金の詳細については、https://aka.ms/ciambillingを参照してください。
CIAMResourceSKUName	テナントの SKU の名前。
CIAMResourceSKUTier	テナントの層。
CIAMTenantResource	顧客向け Azure AD リソース。
ciamTypeValue	顧客テナントリソースの Azure AD の種類。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ProvisioningState	プロビジョニングの状態
systemData	リソースの作成と最後の変更に関連するメタデータ。

ciamBillingType

列挙

課金の種類。すべての新規顧客向けの MAU になります。値が 'MAU' の場合は変更できません。 aka.ms/b2cBillingで課金される顧客向けの Azure AD の詳細について説明します。

値	説明
MAU	顧客の使用量に対する Azure AD は、リンクされた Azure サブスクリプションに課金され、月間アクティブユーザー (MAU) の課金モデルを使用します。

CIAMResourceSKU

Object

顧客テナント用の Azure AD の SKU プロパティ。顧客向け Azure AD の課金の詳細については、https://aka.ms/ciambillingを参照してください。

名前	型	説明
name	CIAMResourceSKUName	テナントの SKU の名前。
tier	CIAMResourceSKUTier	テナントの層。

CIAMResourceSKUName

列挙

テナントの SKU の名前。

値	説明
PremiumP1
PremiumP2
Standard

CIAMResourceSKUTier

列挙

テナントの層。

値	説明
A0	顧客テナントのすべての Azure AD に使用される SKU レベル。

CIAMTenantResource

Object

顧客向け Azure AD リソース。

名前	型	説明
id	string	顧客テナントリソースの Azure AD を表す識別子。
location	string	リソースがホストされ、データが存在する場所。 "米国"、"ヨーロッパ"、"アジア太平洋"、または "オーストラリア" のいずれかを指定できます。詳細については、このドキュメントを参照してください。
name	string	顧客テナントリソースの Azure AD の名前。
properties.billingConfig.billingType	ciamBillingType	課金の種類。すべての新規顧客向けの MAU になります。値が 'MAU' の場合は変更できません。 aka.ms/b2cBillingで課金される顧客向けの Azure AD の詳細について説明します。
properties.billingConfig.effectiveStartDateUtc	string	課金の種類が有効になったデータ
properties.createTenantProperties.countryCode	string	Azure テナントの国コード (例: "US")。有効な国コードと対応するデータ所在地については、https://aka.ms/ciam-data-location を参照してください。有効なデータ所在地に国コードが表示されない場合は、一覧から国番号を選択します。
properties.createTenantProperties.displayName	string	顧客テナントの Azure AD の表示名。
properties.domainName	string	テナントのドメイン名
properties.provisioningState	ProvisioningState	プロビジョニングの状態
properties.tenantId	string	顧客テナントの Azure AD の識別子。
sku	CIAMResourceSKU	顧客テナント用の Azure AD の SKU プロパティ。顧客向け Azure AD の課金の詳細については、https://aka.ms/ciambillingを参照してください。
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
tags	object	リソースタグ
type	ciamTypeValue	顧客テナントリソースの Azure AD の種類。

ciamTypeValue

列挙

顧客テナントリソースの Azure AD の種類。

値	説明
Microsoft.AzureActiveDirectory/ciamDirectories	顧客テナントリソースの Azure AD のリソースの種類。

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ProvisioningState

列挙

プロビジョニングの状態

値	説明
Canceled
Deleted
Deleting
Failed
Provisioning
Succeeded

systemData

Object

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

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

次の方法で共有

CIAM Tenants - Create

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Create_CIAM_tenant

要求のサンプル

応答のサンプル

定義

ciamBillingType

CIAMResourceSKU

CIAMResourceSKUName

CIAMResourceSKUTier

CIAMTenantResource

ciamTypeValue

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

systemData