B2C Tenants - Create

Referens

Tjänst:: Azure AD B2C

API-version:: 2021-04-01

Initierar en asynkron begäran om att skapa både Azure AD B2C-klientorganisationen och motsvarande Azure-resurs som är länkad till en prenumeration.

PUT 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	Obligatorisk	Typ	Description
location	True	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 .
sku	True	B2CResourceSKU	SKU-egenskaper för Azure AD B2C-klientorganisationen. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Landskod för Azure-klientorganisation (t.ex. USA). Se aka.ms/B2CDataResidency för att se giltiga landskoder och motsvarande dataplaceringsplatser. Om du inte ser någon landskod på en giltig plats för datahemvist väljer du en i listan.
properties.createTenantProperties.displayName		string	Visningsnamnet för Azure AD B2C-klientorganisationen.
tags		object	Resurstaggar

Svar

Name	Typ	Description
200 OK	B2CTenantResource	OK – Svar på URL:en i platsrubriken om asynkron åtgärden lyckas. Resursen skapas.
202 Accepted		Azure AD begäran om att skapa B2C-klientorganisation har godkänts. Location-huvudet anger den URL/plats där du kan kontrollera för att hämta åtgärdens asynkrona status. Sidhuvuden Location: string Retry-After: string
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

B2CTenantResource

OK – Svar på URL:en i platsrubriken om asynkron åtgärden lyckas. Resursen skapas.

202 Accepted

Azure AD begäran om att skapa B2C-klientorganisation har godkänts. Location-huvudet anger den URL/plats där du kan kontrollera för att hämta åtgärdens asynkrona status.

Sidhuvuden

Location: string
Retry-After: string

Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelsvar

Statuskod:: 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
}

Statuskod:: 202

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

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
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.
CreateTenantRequestBody	Den information som behövs för att skapa Azure AD B2C-klientorganisation och motsvarande Azure-resurs, som används i faktureringssyfte.
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.

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

CreateTenantRequestBody

Den information som behövs för att skapa Azure AD B2C-klientorganisation och motsvarande Azure-resurs, som används i faktureringssyfte.

Name	Typ	Description
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 .
properties.createTenantProperties.countryCode	string	Landskod för Azure-klientorganisation (t.ex. USA). Se aka.ms/B2CDataResidency för att se giltiga landskoder och motsvarande dataplaceringsplatser. Om du inte ser någon landskod på en giltig plats för datahemvist väljer du en i listan.
properties.createTenantProperties.displayName	string	Visningsnamnet 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

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.

Dela via

B2C Tenants - Create

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Create tenant

Exempelbegäran

Exempelsvar

Definitioner

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Ytterligare resurser