B2C Tenants - Create

참조

서비스:: Azure AD B2C

API 버전:: 2021-04-01

비동기 요청을 시작하여 Azure AD B2C 테넌트와 구독에 연결된 해당 Azure 리소스를 모두 만듭니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
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의 버전입니다.

요청 본문

Name	필수	형식	Description
location	True	string	리소스가 호스트되고 데이터가 상주하는 위치입니다. '미국', '유럽', '아시아 태평양' 또는 '오스트레일리아' 중 하나일 수 있습니다. 자세한 내용은 이 설명서를 참조하세요.
sku	True	B2CResourceSKU	Azure AD B2C 테넌트의 SKU 속성입니다. aka.ms/b2cBilling B2C 청구 Azure AD 대해 자세히 알아보세요.
properties.createTenantProperties.countryCode		string	Azure 테넌트의 국가 코드(예: 'US'). 유효한 국가 코드 및 해당 데이터 상주 위치를 보려면 aka.ms/B2CDataResidency 참조하세요. 유효한 데이터 상주 위치에 국가 코드가 표시되지 않으면 목록에서 하나를 선택합니다.
properties.createTenantProperties.displayName		string	Azure AD B2C 테넌트 표시 이름입니다.
tags		object	리소스 태그

응답

Name	형식	Description
200 OK	B2CTenantResource	확인 - 비동기 작업이 성공한 경우 위치 헤더의 URL 응답입니다. 리소스가 만들어집니다.
202 Accepted		Azure AD B2C 테넌트 만들기 요청이 수락되었습니다. 위치 헤더는 작업의 비동기 상태 가져오기 위해 검사 URL/위치를 나타냅니다. 헤더 Location: string Retry-After: string
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

Name

형식

Description

200 OK

B2CTenantResource

확인 - 비동기 작업이 성공한 경우 위치 헤더의 URL 응답입니다. 리소스가 만들어집니다.

202 Accepted

Azure AD B2C 테넌트 만들기 요청이 수락되었습니다. 위치 헤더는 작업의 비동기 상태 가져오기 위해 검사 URL/위치를 나타냅니다.

헤더

Location: string
Retry-After: string

Other Status Codes

CloudError

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Create tenant

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/b2cDirectories/contoso.onmicrosoft.com?api-version=2021-04-01

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

const { ExternalIdentitiesConfigurationClient } = require("@azure/arm-azureadexternalidentities");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
 *
 * @summary Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
 * x-ms-original-file: specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/stable/2021-04-01/examples/createTenant.json
 */
async function createTenant() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "contosoResourceGroup";
  const resourceName = "contoso.onmicrosoft.com";
  const createTenantRequestBody = {
    countryCode: "US",
    displayName: "Contoso",
    location: "United States",
    sku: { name: "Standard", tier: "A0" },
  };
  const options = { createTenantRequestBody };
  const credential = new DefaultAzureCredential();
  const client = new ExternalIdentitiesConfigurationClient(credential, subscriptionId);
  const result = await client.b2CTenants.beginCreateAndWait(
    resourceGroupName,
    resourceName,
    options
  );
  console.log(result);
}

createTenant().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

샘플 응답

상태 코드:: 200

{
  "type": "Microsoft.AzureActiveDirectory/b2cDirectories",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "billingConfig": {
      "billingType": "MAU",
      "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
    },
    "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": null
}

상태 코드:: 202

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.AzureActiveDirectory/operations/99999999-9999-9999-9999-999999999999
Retry-After: 60

정의

Name	Description
B2CResourceSKU	Azure AD B2C 테넌트의 SKU 속성입니다. aka.ms/b2cBilling B2C 청구 Azure AD 대해 자세히 알아보세요.
B2CResourceSKUName	테넌트의 SKU 이름입니다.
B2CResourceSKUTier	테넌트 계층입니다.
B2CTenantResource
BillingConfig	테넌트 청구 구성입니다.
BillingType	청구 유형입니다. 모든 신규 고객을 위한 MAU가 됩니다. '인증'인 경우 'MAU'로 업데이트할 수 있습니다. 값이 'MAU'인 경우 변경할 수 없습니다. aka.ms/b2cBilling B2C 청구 Azure AD 대해 자세히 알아보세요.
CloudError	리소스 관리 요청에 대한 오류 응답입니다.
createdByType	리소스를 만든 ID 유형입니다.
CreateTenantRequestBody	청구 목적으로 사용되는 Azure AD B2C 테넌트 및 해당 Azure 리소스를 만드는 데 필요한 정보입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorResponse	오류 응답
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
TypeValue	B2C 테넌트 리소스의 형식입니다.

B2CResourceSKU

Azure AD B2C 테넌트의 SKU 속성입니다. aka.ms/b2cBilling B2C 청구 Azure AD 대해 자세히 알아보세요.

Name	형식	Description
name	B2CResourceSKUName	테넌트의 SKU 이름입니다.
tier	B2CResourceSKUTier	테넌트 계층입니다.

B2CResourceSKUName

테넌트의 SKU 이름입니다.

Name	형식	Description
PremiumP1	string	Azure AD B2C 사용량은 연결된 Azure 구독에 청구되며 인증 기반 청구 수를 사용합니다.
PremiumP2	string	Azure AD B2C 사용량은 연결된 Azure 구독에 청구되며 인증 기반 청구 수를 사용합니다.
Standard	string	Azure AD B2C 사용량은 연결된 Azure 구독에 청구되며 MAU(월간 활성 사용자) 청구 모델을 사용합니다.

B2CResourceSKUTier

테넌트 계층입니다.

Name	형식	Description
A0	string	모든 Azure AD B2C 테넌트에서 사용되는 SKU 계층입니다.

B2CTenantResource

Name	형식	Description
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 속성입니다. aka.ms/b2cBilling B2C 청구 Azure AD 대해 자세히 알아보세요.
systemData	systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
tags	object	리소스 태그
type	TypeValue	B2C 테넌트 리소스의 형식입니다.

BillingConfig

테넌트 청구 구성입니다.

Name	형식	Description
billingType	BillingType	청구 유형입니다. 모든 신규 고객을 위한 MAU가 됩니다. '인증'인 경우 'MAU'로 업데이트할 수 있습니다. 값이 'MAU'인 경우 변경할 수 없습니다. aka.ms/b2cBilling B2C 청구 Azure AD 대해 자세히 알아보세요.
effectiveStartDateUtc	string	청구 유형이 적용된 데이터

BillingType

청구 유형입니다. 모든 신규 고객을 위한 MAU가 됩니다. '인증'인 경우 'MAU'로 업데이트할 수 있습니다. 값이 'MAU'인 경우 변경할 수 없습니다. aka.ms/b2cBilling B2C 청구 Azure AD 대해 자세히 알아보세요.

Name	형식	Description
Auths	string	Azure AD B2C 사용량은 연결된 Azure 구독에 청구되며 인증 기반 청구 수를 사용합니다.
MAU	string	Azure AD B2C 사용량은 연결된 Azure 구독에 청구되며 MAU(월간 활성 사용자) 청구 모델을 사용합니다.

CloudError

리소스 관리 요청에 대한 오류 응답입니다.

Name	형식	Description
error	ErrorResponse	오류 응답 실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. OData 오류 응답 형식도 따릅니다.

createdByType

리소스를 만든 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

청구 목적으로 사용되는 Azure AD B2C 테넌트 및 해당 Azure 리소스를 만드는 데 필요한 정보입니다.

Name	형식	Description
location	string	리소스가 호스트되고 데이터가 상주하는 위치입니다. '미국', '유럽', '아시아 태평양' 또는 '오스트레일리아' 중 하나일 수 있습니다. 자세한 내용은 이 설명서를 참조하세요.
properties.createTenantProperties.countryCode	string	Azure 테넌트의 국가 코드(예: 'US'). 유효한 국가 코드 및 해당 데이터 상주 위치를 보려면 aka.ms/B2CDataResidency 참조하세요. 유효한 데이터 상주 위치에 국가 코드가 표시되지 않으면 목록에서 하나를 선택합니다.
properties.createTenantProperties.displayName	string	Azure AD B2C 테넌트 표시 이름입니다.
sku	B2CResourceSKU	Azure AD B2C 테넌트의 SKU 속성입니다. aka.ms/b2cBilling B2C 청구 Azure AD 대해 자세히 알아보세요.
tags	object	리소스 태그

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorResponse

오류 응답

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorResponse[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID 유형입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

TypeValue

B2C 테넌트 리소스의 형식입니다.

Name	형식	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	Azure AD B2C 테넌트 리소스의 리소스 종류입니다.

다음을 통해 공유

B2C Tenants - Create

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

Create tenant

샘플 요청

샘플 응답

정의

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

추가 리소스