CIAM Tenants - Get

Serviço:: Azure AD B2C

Versão da API:: 2023-05-17-preview

Obtenha o recurso de locatário do Azure AD para clientes.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories/{resourceName}?api-version=2023-05-17-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
resourceName	path	True	string maxLength: 26 pattern: ^[a-zA-Z0-9]{1,26}	O subdomínio inicial do locatário.
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	CIAMTenantResource	Recurso de locatário do Azure AD para clientes recuperado com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get_CIAM_tenant

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories/contoso?api-version=2023-05-17-preview

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories/contoso",
  "name": "contoso",
  "type": "Microsoft.AzureActiveDirectory/ciamDirectories",
  "location": "United States",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "createTenantProperties": {
      "displayName": "Contoso",
      "countryCode": "US"
    },
    "billingConfig": {
      "billingType": "MAU",
      "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
    },
    "domainName": "contoso.onmicrosoft.com",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "tags": null,
  "systemData": {
    "createdBy": "contosoAdmin@onmicrosoft.com",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "contosoAdmin@onmicrosoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T01:01:01.1075056Z"
  }
}

Definições

Nome	Description
ciamBillingType	O tipo de cobrança. Será MAU para todos os novos clientes. Não será possível alterar se o valor for 'MAU'. Saiba mais sobre a cobrança do Azure AD para clientes no aka.ms/b2cBilling.
CIAMResourceSKU	Propriedades de SKU do locatário do Azure AD para clientes. Saiba mais sobre a cobrança do Azure AD para clientes em https://aka.ms/ciambilling.
CIAMResourceSKUName	O nome da SKU para o locatário.
CIAMResourceSKUTier	A camada do locatário.
CIAMTenantResource	O recurso do Azure AD para clientes.
ciamTypeValue	O tipo do recurso de locatário do Azure AD para clientes.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ProvisioningState	Estado de provisionamento
systemData	Metadados relativos à criação e última modificação do recurso.

ciamBillingType

Enumeração

O tipo de cobrança. Será MAU para todos os novos clientes. Não será possível alterar se o valor for 'MAU'. Saiba mais sobre a cobrança do Azure AD para clientes no aka.ms/b2cBilling.

Valor	Description
MAU	O uso do Azure AD para clientes é cobrado em uma assinatura vinculada do Azure e usa um modelo de cobrança de MAU (usuários ativos mensais).

CIAMResourceSKU

Objeto

Propriedades de SKU do locatário do Azure AD para clientes. Saiba mais sobre a cobrança do Azure AD para clientes em https://aka.ms/ciambilling.

Nome	Tipo	Description
name	CIAMResourceSKUName	O nome da SKU para o locatário.
tier	CIAMResourceSKUTier	A camada do locatário.

CIAMResourceSKUName

Enumeração

O nome da SKU para o locatário.

Valor	Description
Standard
PremiumP1
PremiumP2

CIAMResourceSKUTier

Enumeração

A camada do locatário.

Valor	Description
A0	A camada de SKU usada para todos os locatários do Azure AD para clientes.

CIAMTenantResource

Objeto

O recurso do Azure AD para clientes.

Nome	Tipo	Description
id	string	Um identificador que representa o recurso de locatário do Azure AD para clientes.
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 do Azure AD para clientes.
properties.billingConfig.billingType	ciamBillingType	O tipo de cobrança. Será MAU para todos os novos clientes. Não será possível alterar se o valor for 'MAU'. Saiba mais sobre a cobrança do Azure AD para clientes no aka.ms/b2cBilling.
properties.billingConfig.effectiveStartDateUtc	string	Os dados dos quais o tipo de cobrança entrou em vigor
properties.createTenantProperties.countryCode	string	Código do país do locatário do Azure (por exemplo, 'EUA'). Consulte https://aka.ms/ciam-data-location para ver códigos de país válidos e locais de residência de dados correspondentes. Se você não vir um código de país em um local de residência de dados válido, escolha um na lista.
properties.createTenantProperties.displayName	string	O nome de exibição do locatário do Azure AD para clientes.
properties.domainName	string	O nome de domínio do locatário
properties.provisioningState	ProvisioningState	Estado de provisionamento
properties.tenantId	string	Um identificador do locatário do Azure AD para clientes.
sku	CIAMResourceSKU	Propriedades de SKU do locatário do Azure AD para clientes. Saiba mais sobre a cobrança do Azure AD para clientes em https://aka.ms/ciambilling.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
tags	object	Marcas de recurso
type	ciamTypeValue	O tipo do recurso de locatário do Azure AD para clientes.

ciamTypeValue

Enumeração

O tipo do recurso de locatário do Azure AD para clientes.

Valor	Description
Microsoft.AzureActiveDirectory/ciamDirectories	O tipo de recurso para o recurso de locatário do Azure AD para clientes.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

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.

ErrorDetail

Objeto

O detalhe do erro.

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

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ProvisioningState

Enumeração

Estado de provisionamento

Valor	Description
Succeeded
Failed
Canceled
Provisioning
Deleting
Deleted

systemData

Objeto

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

Nome	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.

Compartilhar via

CIAM Tenants - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Get_CIAM_tenant

Solicitação de exemplo

Resposta de exemplo

Definições

ciamBillingType

CIAMResourceSKU

CIAMResourceSKUName

CIAMResourceSKUTier

CIAMTenantResource

ciamTypeValue

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

systemData