CIAM Tenants - List By Resource Group

Referencia

Servicio:: Azure AD B2C

Versión de la API:: 2023-05-17-preview

Obtenga todos los recursos de Azure AD para los inquilinos de los clientes en un grupo de recursos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	CIAMTenantResourceList	Lista de Azure AD para los inquilinos de clientes en el grupo de recursos recuperado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

CIAMTenants_ListByResourceGroup

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
ciamBillingType	Tipo de facturación. Será MAU para todos los nuevos clientes. No se puede cambiar si el valor es 'MAU'. Obtenga más información sobre Azure AD para la facturación de los clientes en aka.ms/b2cBilling.
CIAMResourceSKU	Propiedades de SKU del inquilino de Azure AD para clientes. Obtenga más información sobre Azure AD para la facturación de los clientes en https://aka.ms/ciambilling.
CIAMResourceSKUName	Nombre de la SKU para el inquilino.
CIAMResourceSKUTier	Nivel del inquilino.
CIAMTenantResource	Recurso de Azure AD para clientes.
CIAMTenantResourceList	La colección de Azure AD para los recursos de inquilino de clientes
ciamTypeValue	Tipo de recurso de inquilino de Azure AD para clientes.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ProvisioningState	Estado de aprovisionamiento
systemData	Metadatos relativos a la creación y última modificación del recurso.

ciamBillingType

Enumeración

Tipo de facturación. Será MAU para todos los nuevos clientes. No se puede cambiar si el valor es 'MAU'. Obtenga más información sobre Azure AD para la facturación de los clientes en aka.ms/b2cBilling.

Valor	Description
MAU	El uso de Azure AD para clientes se factura a una suscripción de Azure vinculada y usa un modelo de facturación de usuarios activos mensuales (MAU).

CIAMResourceSKU

Object

Propiedades de SKU del inquilino de Azure AD para clientes. Obtenga más información sobre Azure AD para la facturación de los clientes en https://aka.ms/ciambilling.

Nombre	Tipo	Description
name	CIAMResourceSKUName	Nombre de la SKU para el inquilino.
tier	CIAMResourceSKUTier	Nivel del inquilino.

CIAMResourceSKUName

Enumeración

Nombre de la SKU para el inquilino.

Valor	Description
PremiumP1
PremiumP2
Standard

CIAMResourceSKUTier

Enumeración

Nivel del inquilino.

Valor	Description
A0	Nivel de SKU que se usa para todos los inquilinos de Azure AD para clientes.

CIAMTenantResource

Object

Recurso de Azure AD para clientes.

Nombre	Tipo	Description
id	string	Identificador que representa el recurso de inquilino de Azure AD para clientes.
location	string	Ubicación en la que se hospeda el recurso y los datos residen. Puede ser uno de los "Estados Unidos", "Europa", "Asia Pacífico" o "Australia". Consulte esta documentación para obtener más información.
name	string	Nombre del recurso de inquilino de Azure AD para clientes.
properties.billingConfig.billingType	ciamBillingType	Tipo de facturación. Será MAU para todos los nuevos clientes. No se puede cambiar si el valor es 'MAU'. Obtenga más información sobre Azure AD para la facturación de los clientes en aka.ms/b2cBilling.
properties.billingConfig.effectiveStartDateUtc	string	Datos desde los que surtió efecto el tipo de facturación.
properties.createTenantProperties.countryCode	string	Código de país del inquilino de Azure (por ejemplo, "EE. UU."). Consulte https://aka.ms/ciam-data-location para ver códigos de país válidos y ubicaciones de residencia de datos correspondientes. Si no ve un código de país en una ubicación de residencia de datos válida, elija uno de la lista.
properties.createTenantProperties.displayName	string	Nombre para mostrar del inquilino de Azure AD para clientes.
properties.domainName	string	Nombre de dominio del inquilino
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento
properties.tenantId	string	Identificador del inquilino de Azure AD para clientes.
sku	CIAMResourceSKU	Propiedades de SKU del inquilino de Azure AD para clientes. Obtenga más información sobre Azure AD para la facturación de los clientes en https://aka.ms/ciambilling.
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas de recursos
type	ciamTypeValue	Tipo de recurso de inquilino de Azure AD para clientes.

CIAMTenantResourceList

Object

La colección de Azure AD para los recursos de inquilino de clientes

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de recursos de inquilino de Azure AD para clientes.
value	CIAMTenantResource[]	Lista de Azure AD para los recursos de inquilino de clientes

ciamTypeValue

Enumeración

Tipo de recurso de inquilino de Azure AD para clientes.

Valor	Description
Microsoft.AzureActiveDirectory/ciamDirectories	Tipo de recurso para Azure AD para el recurso de inquilino de clientes.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ProvisioningState

Enumeración

Estado de aprovisionamiento

Valor	Description
Canceled
Deleted
Deleting
Failed
Provisioning
Succeeded

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

CIAM Tenants - List By Resource Group

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

CIAMTenants_ListByResourceGroup

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ciamBillingType

CIAMResourceSKU

CIAMResourceSKUName

CIAMResourceSKUTier

CIAMTenantResource

CIAMTenantResourceList

ciamTypeValue

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

systemData