Admin - Get Capacities As Admin

Service:

Power BI REST APIs

API Version:

v1.0

Devuelve una lista de capacidades para la organización.

Permisos

• El usuario debe tener derechos de administrador (como Office 365 administrador global o administrador del servicio Power BI) o autenticarse mediante una entidad de servicio.
• Se admiten permisos delegados.

Cuando se ejecuta con la autenticación prinicipal del servicio, una aplicación no debe tener ninguna premisión necesaria de consentimiento del administrador para Power BI establecida en él en el Azure Portal.

Ámbito requerido

Tenant.Read.All o Tenant.ReadWrite.All

Solo es relevante al autenticarse a través de un token de acceso de administrador delegado estándar. No debe estar presente cuando se usa la autenticación a través de una entidad de servicio.

GET https://api.powerbi.com/v1.0/myorg/admin/capacities

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/capacities?$expand={$expand}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
$expand	query		string	Expande las entidades relacionadas insertadas

Respuestas

Nombre	Tipo	Description
200 OK	Capacities	Aceptar

Ejemplos

Example

Example with expand on tenant key

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/capacities

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "displayName": "MyCapacity",
      "admins": [
        "john@contoso.com"
      ],
      "sku": "A1",
      "state": "Active",
      "region": "West Central US",
      "capacityUserAccessRight": "Admin",
      "tenantKeyId": "82d9a37a-2b45-4221-b012-cb109b8e30c7"
    }
  ]
}

Example with expand on tenant key

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/capacities?$expand=tenantKey

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "displayName": "MyCapacity",
      "admins": [
        "john@contoso.com"
      ],
      "sku": "A1",
      "state": "Active",
      "region": "West Central US",
      "capacityUserAccessRight": "Admin",
      "tenantKeyId": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
      "tenantKey": {
        "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
        "name": "Contoso Sales",
        "keyVaultKeyIdentifier": "https://contoso-vault2.vault.azure.net/keys/ContosoKeyVault/b2ab4ba1c7b341eea5ecaaa2wb54c4d2",
        "isDefault": true,
        "createdAt": "2019-04-30T21:35:15.867-07:00",
        "updatedAt": "2019-04-30T21:35:15.867-07:00"
      }
    }
  ]
}

Definiciones

Nombre	Description
Capacities	Contenedor de respuesta de OData para una lista de capacidad de Power BI
Capacity	Una capacidad de Power BI
CapacityState	El estado de la capacidad
capacityUserAccessRight	El derecho de acceso que tiene el usuario en la capacidad
TenantKey	Información de clave de cifrado

Capacities

Contenedor de respuesta de OData para una lista de capacidad de Power BI

Nombre	Tipo	Description
odata.context	string
value	Capacity[]	Lista de capacidad

Capacity

Una capacidad de Power BI

Nombre	Tipo	Description
admins	string[]	Matriz de administradores de capacidad
capacityUserAccessRight	capacityUserAccessRight	El derecho de acceso que tiene un usuario en la capacidad
displayName	string	Nombre para mostrar de la capacidad
id	string	Identificador de capacidad
region	string	Región de Azure donde se aprovisionó la capacidad
sku	string	SKU de capacidad
state	CapacityState	El estado de la capacidad
tenantKey	TenantKey	Información de clave de cifrado (solo se aplica a las rutas de administración)
tenantKeyId	string	Identificador de una clave de cifrado (solo aplicable a la ruta de administración)

CapacityState

El estado de la capacidad

Nombre	Tipo	Description
Active	string	La capacidad está lista para usarse
Deleted	string	La capacidad se eliminó y no está disponible.
Deleting	string	La eliminación de la capacidad está en curso
Invalid	string	No se puede usar la capacidad
NotActivated	string	No compatible
PreSuspended	string	No compatible
ProvisionFailed	string	Error en el aprovisionamiento de la capacidad
Provisioning	string	La activación de la capacidad está en curso
Suspended	string	El uso de la capacidad se suspende
UpdatingSku	string	Hay un cambio de SKU de capacidad en curso

capacityUserAccessRight

El derecho de acceso que tiene el usuario en la capacidad

Nombre	Tipo	Description
Admin	string	El usuario tiene derechos de administrador en la capacidad
Assign	string	El usuario tiene derechos de colaborador y puede asignar áreas de trabajo a la capacidad.
None	string	El usuario no tiene acceso a la capacidad

TenantKey

Información de clave de cifrado

Nombre	Tipo	Description
createdAt	string	Fecha y hora de creación de la clave de cifrado
id	string	Identificador de la clave de cifrado
isDefault	boolean	Si la clave de cifrado es la clave predeterminada para todo el inquilino. Cualquier capacidad recién creada hereda la clave predeterminada.
keyVaultKeyIdentifier	string	Identificador URI que especifica de forma única la clave de cifrado en Azure Key Vault
name	string	Nombre de la clave de cifrado
updatedAt	string	Fecha y hora de la última actualización de la clave de cifrado