Udostępnij za pośrednictwem


Microsoft.AzureActiveDirectory b2cDirectories

Uwagi

Dzierżawę B2C można utworzyć przy użyciu szablonu usługi ARM lub pliku Bicep, ale nie można zaktualizować istniejącej dzierżawy usługi B2C. Ponadto nie można ponownie wdrożyć szablonu o tej samej nazwie dzierżawy. Jeśli musisz zaktualizować dzierżawę usługi B2C, użyj dzierżaw B2C — Aktualizuj.

Definicja zasobu Bicep

Typ zasobu b2cDirectories można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.AzureActiveDirectory/b2cDirectories, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    createTenantProperties: {
      countryCode: 'string'
      displayName: 'string'
      isGoLocalTenant: bool
    }
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

B2CResourceSKU

Nazwa Opis Wartość
nazwa Nazwa jednostki SKU dzierżawy. "PremiumP1"
"PremiumP2"
"Standardowa"
kondygnacja Warstwa dzierżawy. "A0"

CreateTenantProperties

Nazwa Opis Wartość
countryCode Kod kraju dzierżawy platformy Azure (np. "USA"). Zapoznaj się z aka.ms/B2CDataResidency, aby wyświetlić prawidłowe kody kraju i odpowiednie lokalizacje przechowywania danych. Jeśli nie widzisz kodu kraju w prawidłowej lokalizacji przechowywania danych, wybierz go z listy. struna
displayName Nazwa wyświetlana dzierżawy usługi Azure AD B2C. struna
isGoLocalTenant Włącz dodatek GoLocal, aby przechowywać dane magazynowane w określonym obszarze geograficznym. Zapoznaj się z aka.ms/B2CDataResidency, aby wyświetlić opcje rezydencji danych lokalnych. Bool

CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties

Nazwa Opis Wartość
createTenantProperties Te właściwości są używane do tworzenia dzierżawy usługi Azure AD B2C. Te właściwości nie są częścią zasobu platformy Azure. createTenantProperties

CreateTenantRequestBodyTags

Nazwa Opis Wartość

Microsoft.AzureActiveDirectory/b2cDirectories

Nazwa Opis Wartość
lokalizacja Lokalizacja, w której jest hostowany zasób, a dane znajdują się. Może być jednym z "Stanów Zjednoczonych", "Europa", "Azja i Pacyfik" lub "Australia". Aby uzyskać więcej informacji, zobacz tej dokumentacji. ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości createTenantRequestBodyPropertiesOrB2CTenantResourceProperties (wymagane)
Numer jednostki magazynowej Właściwości jednostki SKU dzierżawy usługi Azure AD B2C. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C na stronie aka.ms/b2cBilling. B2CResourceSKU (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Definicja zasobu szablonu usługi ARM

Typ zasobu b2cDirectories można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.AzureActiveDirectory/b2cDirectories, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.AzureActiveDirectory/b2cDirectories",
  "apiVersion": "2023-05-17-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "createTenantProperties": {
      "countryCode": "string",
      "displayName": "string",
      "isGoLocalTenant": "bool"
    }
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

B2CResourceSKU

Nazwa Opis Wartość
nazwa Nazwa jednostki SKU dzierżawy. "PremiumP1"
"PremiumP2"
"Standardowa"
kondygnacja Warstwa dzierżawy. "A0"

CreateTenantProperties

Nazwa Opis Wartość
countryCode Kod kraju dzierżawy platformy Azure (np. "USA"). Zapoznaj się z aka.ms/B2CDataResidency, aby wyświetlić prawidłowe kody kraju i odpowiednie lokalizacje przechowywania danych. Jeśli nie widzisz kodu kraju w prawidłowej lokalizacji przechowywania danych, wybierz go z listy. struna
displayName Nazwa wyświetlana dzierżawy usługi Azure AD B2C. struna
isGoLocalTenant Włącz dodatek GoLocal, aby przechowywać dane magazynowane w określonym obszarze geograficznym. Zapoznaj się z aka.ms/B2CDataResidency, aby wyświetlić opcje rezydencji danych lokalnych. Bool

CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties

Nazwa Opis Wartość
createTenantProperties Te właściwości są używane do tworzenia dzierżawy usługi Azure AD B2C. Te właściwości nie są częścią zasobu platformy Azure. createTenantProperties

CreateTenantRequestBodyTags

Nazwa Opis Wartość

Microsoft.AzureActiveDirectory/b2cDirectories

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2023-05-17-preview"
lokalizacja Lokalizacja, w której jest hostowany zasób, a dane znajdują się. Może być jednym z "Stanów Zjednoczonych", "Europa", "Azja i Pacyfik" lub "Australia". Aby uzyskać więcej informacji, zobacz tej dokumentacji. ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości createTenantRequestBodyPropertiesOrB2CTenantResourceProperties (wymagane)
Numer jednostki magazynowej Właściwości jednostki SKU dzierżawy usługi Azure AD B2C. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C na stronie aka.ms/b2cBilling. B2CResourceSKU (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.AzureActiveDirectory/b2cDirectories"

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu b2cDirectories można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.AzureActiveDirectory/b2cDirectories, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      createTenantProperties = {
        countryCode = "string"
        displayName = "string"
        isGoLocalTenant = bool
      }
    }
    sku = {
      name = "string"
      tier = "string"
    }
  }
}

Wartości właściwości

B2CResourceSKU

Nazwa Opis Wartość
nazwa Nazwa jednostki SKU dzierżawy. "PremiumP1"
"PremiumP2"
"Standardowa"
kondygnacja Warstwa dzierżawy. "A0"

CreateTenantProperties

Nazwa Opis Wartość
countryCode Kod kraju dzierżawy platformy Azure (np. "USA"). Zapoznaj się z aka.ms/B2CDataResidency, aby wyświetlić prawidłowe kody kraju i odpowiednie lokalizacje przechowywania danych. Jeśli nie widzisz kodu kraju w prawidłowej lokalizacji przechowywania danych, wybierz go z listy. struna
displayName Nazwa wyświetlana dzierżawy usługi Azure AD B2C. struna
isGoLocalTenant Włącz dodatek GoLocal, aby przechowywać dane magazynowane w określonym obszarze geograficznym. Zapoznaj się z aka.ms/B2CDataResidency, aby wyświetlić opcje rezydencji danych lokalnych. Bool

CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties

Nazwa Opis Wartość
createTenantProperties Te właściwości są używane do tworzenia dzierżawy usługi Azure AD B2C. Te właściwości nie są częścią zasobu platformy Azure. createTenantProperties

CreateTenantRequestBodyTags

Nazwa Opis Wartość

Microsoft.AzureActiveDirectory/b2cDirectories

Nazwa Opis Wartość
lokalizacja Lokalizacja, w której jest hostowany zasób, a dane znajdują się. Może być jednym z "Stanów Zjednoczonych", "Europa", "Azja i Pacyfik" lub "Australia". Aby uzyskać więcej informacji, zobacz tej dokumentacji. ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości createTenantRequestBodyPropertiesOrB2CTenantResourceProperties (wymagane)
Numer jednostki magazynowej Właściwości jednostki SKU dzierżawy usługi Azure AD B2C. Dowiedz się więcej o rozliczeniach usługi Azure AD B2C na stronie aka.ms/b2cBilling. B2CResourceSKU (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview"