B2C Tenants - Create

Odwołanie

Usługa:: Azure AD B2C

Wersja interfejsu API:: 2021-04-01

Inicjuje żądanie asynchroniczne, aby utworzyć zarówno dzierżawę usługi Azure AD B2C, jak i odpowiedni zasób platformy Azure połączony z subskrypcją.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów.
resourceName	path	True	string	Początkowa nazwa domeny dzierżawy usługi Azure AD B2C.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja, w której jest hostowany zasób, a dane znajdują się. Może być jednym z "Stany Zjednoczone", "Europa", "Azja i Pacyfik" lub "Australia". Aby uzyskać więcej informacji, zapoznaj się z tą dokumentacją .
sku	True	B2CResourceSKU	Właściwości jednostki SKU dzierżawy usługi Azure AD B2C. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C w aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Kod kraju dzierżawy platformy Azure (np. "USA"). Zapoznaj się z aka.ms/B2CDataResidency , aby wyświetlić prawidłowe kody krajów i odpowiednie lokalizacje przechowywania danych. Jeśli kod kraju nie jest widoczny w prawidłowej lokalizacji przechowywania danych, wybierz go z listy.
properties.createTenantProperties.displayName		string	Nazwa wyświetlana dzierżawy usługi Azure AD B2C.
tags		object	Tagi zasobów

Odpowiedzi

Nazwa	Typ	Opis
200 OK	B2CTenantResource	OK — odpowiedź adresu URL w nagłówku Location, jeśli operacja asynchronizowa zakończy się pomyślnie. Zasób zostanie utworzony.
202 Accepted		Azure AD zaakceptowane żądanie utworzenia dzierżawy B2C. Nagłówek Location wskazuje adres URL/lokalizację, w której ma być sprawdzany stan asynchroniczny operacji. Nagłówki Location: string Retry-After: string
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

B2CTenantResource

OK — odpowiedź adresu URL w nagłówku Location, jeśli operacja asynchronizowa zakończy się pomyślnie. Zasób zostanie utworzony.

202 Accepted

Azure AD zaakceptowane żądanie utworzenia dzierżawy B2C. Nagłówek Location wskazuje adres URL/lokalizację, w której ma być sprawdzany stan asynchroniczny operacji.

Nagłówki

Location: string
Retry-After: string

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 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
}

Kod stanu:: 202

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

Definicje

Nazwa	Opis
B2CResourceSKU	Właściwości jednostki SKU dzierżawy usługi Azure AD B2C. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C w aka.ms/b2cBilling.
B2CResourceSKUName	Nazwa jednostki SKU dzierżawy.
B2CResourceSKUTier	Warstwa dzierżawy.
B2CTenantResource
BillingConfig	Konfiguracja rozliczeń dla dzierżawy.
BillingType	Typ rozliczeń. Będzie MAU dla wszystkich nowych klientów. Jeśli wartość "Auths", można ją zaktualizować do "MAU". Nie można zmienić, jeśli wartość ma wartość MAU. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C w aka.ms/b2cBilling.
CloudError	Odpowiedź na błąd żądania zarządzania zasobami.
createdByType	Typ tożsamości, która utworzyła zasób.
CreateTenantRequestBody	Informacje potrzebne do utworzenia dzierżawy usługi Azure AD B2C i odpowiedniego zasobu platformy Azure, który jest używany do celów rozliczeniowych.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TypeValue	Typ zasobu dzierżawy B2C.

B2CResourceSKU

Właściwości jednostki SKU dzierżawy usługi Azure AD B2C. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C w aka.ms/b2cBilling.

Nazwa	Typ	Opis
name	B2CResourceSKUName	Nazwa jednostki SKU dzierżawy.
tier	B2CResourceSKUTier	Warstwa dzierżawy.

B2CResourceSKUName

Nazwa jednostki SKU dzierżawy.

Nazwa	Typ	Opis
PremiumP1	string	Azure AD użycie usługi B2C jest rozliczane z połączoną subskrypcją platformy Azure i używa liczby rozliczeń opartych na uwierzytelnieniach.
PremiumP2	string	Azure AD użycie usługi B2C jest rozliczane z połączoną subskrypcją platformy Azure i używa liczby rozliczeń opartych na uwierzytelnieniach.
Standard	string	Azure AD użycie usługi B2C jest rozliczane z połączoną subskrypcją platformy Azure i korzysta z miesięcznego modelu rozliczeniowego aktywnych użytkowników (MAU).

B2CResourceSKUTier

Warstwa dzierżawy.

Nazwa	Typ	Opis
A0	string	Warstwa SKU używana dla wszystkich dzierżaw usługi Azure AD B2C.

B2CTenantResource

Nazwa	Typ	Opis
id	string	Identyfikator reprezentujący zasób dzierżawy usługi Azure AD B2C.
location	string	Lokalizacja, w której jest hostowany zasób, a dane znajdują się. Może być jednym z "Stany Zjednoczone", "Europa", "Azja i Pacyfik" lub "Australia". Aby uzyskać więcej informacji, zapoznaj się z tą dokumentacją .
name	string	Nazwa zasobu dzierżawy usługi Azure AD B2C.
properties.billingConfig	BillingConfig	Konfiguracja rozliczeń dla dzierżawy.
properties.tenantId	string	Identyfikator dzierżawy usługi Azure AD B2C.
sku	B2CResourceSKU	Właściwości jednostki SKU dzierżawy usługi Azure AD B2C. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C w aka.ms/b2cBilling.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów
type	TypeValue	Typ zasobu dzierżawy B2C.

BillingConfig

Konfiguracja rozliczeń dla dzierżawy.

Nazwa	Typ	Opis
billingType	BillingType	Typ rozliczeń. Będzie MAU dla wszystkich nowych klientów. Jeśli wartość "Auths", można ją zaktualizować do "MAU". Nie można zmienić, jeśli wartość ma wartość MAU. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C w aka.ms/b2cBilling.
effectiveStartDateUtc	string	Dane, z których typ rozliczeń wszedł w życie

BillingType

Typ rozliczeń. Będzie MAU dla wszystkich nowych klientów. Jeśli wartość "Auths", można ją zaktualizować do "MAU". Nie można zmienić, jeśli wartość ma wartość MAU. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C w aka.ms/b2cBilling.

Nazwa	Typ	Opis
Auths	string	Azure AD użycie usługi B2C jest rozliczane z połączoną subskrypcją platformy Azure i używa liczby rozliczeń opartych na uwierzytelnieniach.
MAU	string	Azure AD użycie usługi B2C jest rozliczane z połączoną subskrypcją platformy Azure i korzysta z miesięcznego modelu rozliczeniowego aktywnych użytkowników (MAU).

CloudError

Odpowiedź na błąd żądania zarządzania zasobami.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

Informacje potrzebne do utworzenia dzierżawy usługi Azure AD B2C i odpowiedniego zasobu platformy Azure, który jest używany do celów rozliczeniowych.

Nazwa	Typ	Opis
location	string	Lokalizacja, w której jest hostowany zasób, a dane znajdują się. Może być jednym z "Stany Zjednoczone", "Europa", "Azja i Pacyfik" lub "Australia". Aby uzyskać więcej informacji, zapoznaj się z tą dokumentacją .
properties.createTenantProperties.countryCode	string	Kod kraju dzierżawy platformy Azure (np. "USA"). Zapoznaj się z aka.ms/B2CDataResidency , aby wyświetlić prawidłowe kody krajów i odpowiednie lokalizacje przechowywania danych. Jeśli kod kraju nie jest widoczny w prawidłowej lokalizacji przechowywania danych, wybierz go z listy.
properties.createTenantProperties.displayName	string	Nazwa wyświetlana dzierżawy usługi Azure AD B2C.
sku	B2CResourceSKU	Właściwości jednostki SKU dzierżawy usługi Azure AD B2C. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C w aka.ms/b2cBilling.
tags	object	Tagi zasobów

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

TypeValue

Typ zasobu dzierżawy B2C.

Nazwa	Typ	Opis
Microsoft.AzureActiveDirectory/b2cDirectories	string	Typ zasobu dla zasobu dzierżawy usługi Azure AD B2C.

Udostępnij za pośrednictwem

B2C Tenants - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Create tenant

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Dodatkowe zasoby