B2C Tenants - List By Subscription

Referência

Service:: Azure AD B2C

API Version:: 2021-04-01

Obtenha todos os recursos de locatário do Azure AD B2C em uma assinatura.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Respostas

Nome	Tipo	Description
200 OK	B2CTenantResourceList	Azure AD recursos de locatário B2C na assinatura recuperados com êxito.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

B2CTenants_ListBySubscription

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

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

/**
 * This sample demonstrates how to Get all the Azure AD B2C tenant resources in a subscription.
 *
 * @summary Get all the Azure AD B2C tenant resources in a subscription.
 * x-ms-original-file: specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/stable/2021-04-01/examples/listTenantsBySubscription.json
 */
async function b2CTenantsListBySubscription() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const credential = new DefaultAzureCredential();
  const client = new ExternalIdentitiesConfigurationClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.b2CTenants.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "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
    }
  ]
}

Definições

Nome	Description
B2CResourceSKU	Propriedades de SKU do locatário Azure AD B2C. Saiba mais sobre Azure AD cobrança B2C em aka.ms/b2cBilling.
B2CResourceSKUName	O nome do SKU para o locatário.
B2CResourceSKUTier	A camada do locatário.
B2CTenantResource
B2CTenantResourceList	A coleção de recursos de locatário do Azure AD B2C
BillingConfig	A configuração de cobrança para o locatário.
BillingType	O tipo de cobrança. Será MAU para todos os novos clientes. Se 'Autenticações', ele poderá ser atualizado para 'MAU'. Não será possível alterar se o valor for 'MAU'. Saiba mais sobre Azure AD cobrança B2C em aka.ms/b2cBilling.
CloudError	Uma resposta de erro para uma solicitação de gerenciamento de recursos.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorResponse	Resposta de erro
systemData	Metadados relativos à criação e à última modificação do recurso.
TypeValue	O tipo do recurso de locatário B2C.

B2CResourceSKU

Propriedades de SKU do locatário Azure AD B2C. Saiba mais sobre Azure AD cobrança B2C em aka.ms/b2cBilling.

Nome	Tipo	Description
name	B2CResourceSKUName	O nome do SKU para o locatário.
tier	B2CResourceSKUTier	A camada do locatário.

B2CResourceSKUName

O nome do SKU para o locatário.

Nome	Tipo	Description
PremiumP1	string	Azure AD uso do B2C é cobrado em uma assinatura vinculada do Azure e usa o número de cobranças baseadas em autenticações.
PremiumP2	string	Azure AD uso do B2C é cobrado em uma assinatura vinculada do Azure e usa o número de cobranças baseadas em autenticações.
Standard	string	Azure AD uso de B2C é cobrado para uma assinatura vinculada do Azure e usa um modelo de cobrança de usuários ativos mensais (MAU).

B2CResourceSKUTier

A camada do locatário.

Nome	Tipo	Description
A0	string	A camada de SKU usada para todos os locatários do Azure AD B2C.

B2CTenantResource

Nome	Tipo	Description
id	string	Um identificador que representa o Azure AD recurso de locatário B2C.
location	string	O local no qual o recurso está hospedado e os dados residem. Pode ser um dos "Estados Unidos", "Europa", "Pacífico Asiático" ou "Austrália". Consulte esta documentação para obter mais informações.
name	string	O nome do recurso de locatário Azure AD B2C.
properties.billingConfig	BillingConfig	A configuração de cobrança para o locatário.
properties.tenantId	string	Um identificador do locatário Azure AD B2C.
sku	B2CResourceSKU	Propriedades de SKU do locatário Azure AD B2C. Saiba mais sobre Azure AD cobrança B2C em aka.ms/b2cBilling.
systemData	systemData	Metadados relativos à criação e à última modificação do recurso.
tags	object	Marcações de recursos
type	TypeValue	O tipo do recurso de locatário B2C.

B2CTenantResourceList

A coleção de recursos de locatário do Azure AD B2C

Nome	Tipo	Description
value	B2CTenantResource[]	Lista de recursos de locatário do Azure AD B2C

BillingConfig

A configuração de cobrança para o locatário.

Nome	Tipo	Description
billingType	BillingType	O tipo de cobrança. Será MAU para todos os novos clientes. Se 'Autenticações', ele poderá ser atualizado para 'MAU'. Não será possível alterar se o valor for 'MAU'. Saiba mais sobre Azure AD cobrança B2C em aka.ms/b2cBilling.
effectiveStartDateUtc	string	Os dados dos quais o tipo de cobrança entrou em vigor

BillingType

O tipo de cobrança. Será MAU para todos os novos clientes. Se 'Autenticações', ele poderá ser atualizado para 'MAU'. Não será possível alterar se o valor for 'MAU'. Saiba mais sobre Azure AD cobrança B2C em aka.ms/b2cBilling.

Nome	Tipo	Description
Auths	string	Azure AD uso do B2C é cobrado em uma assinatura vinculada do Azure e usa o número de cobranças baseadas em autenticações.
MAU	string	Azure AD uso de B2C é cobrado para uma assinatura vinculada do Azure e usa um modelo de cobrança de usuários ativos mensais (MAU).

CloudError

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.)

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TypeValue

O tipo do recurso de locatário B2C.

Nome	Tipo	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	O tipo de recurso para Azure AD recurso de locatário B2C.