Admin - Get Capacities As Admin

Service:

Power BI REST APIs

API Version:

v1.0

Retorna uma lista de capacidades para a organização.

Permissões

• O usuário deve ter direitos de administrador (como Office 365 Administrador Global ou Administrador de Serviços do Power BI) ou autenticar usando uma entidade de serviço.
• Há suporte para permissões delegadas.

Ao executar em autenticação prinicipal de serviço, um aplicativo não deve ter nenhuma pré-solicitação de consentimento de administrador necessária para o Power BI definida nele no portal do Azure.

Escopo necessário

Tenant.Read.All ou Tenant.ReadWrite.All

Relevante somente ao autenticar por meio de um token de acesso de administrador delegado padrão. Não deve estar presente quando a autenticação por meio de uma entidade de serviço é usada.

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 URI

Nome	Em	Obrigatório	Tipo	Description
$expand	query		string	Expande entidades relacionadas embutidas

Respostas

Nome	Tipo	Description
200 OK	Capacities	OK

Exemplos

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"
      }
    }
  ]
}

Definições

Nome	Description
Capacities	Wrapper de resposta OData para uma lista de capacidade do Power BI
Capacity	Uma capacidade do Power BI
CapacityState	O estado de capacidade
capacityUserAccessRight	O direito de acesso que o usuário tem na capacidade
TenantKey	Informações de chave de criptografia

Capacities

Wrapper de resposta OData para uma lista de capacidade do Power BI

Nome	Tipo	Description
odata.context	string
value	Capacity[]	A lista de capacidade

Capacity

Uma capacidade do Power BI

Nome	Tipo	Description
admins	string[]	Uma matriz de administradores de capacidade
capacityUserAccessRight	capacityUserAccessRight	O direito de acesso que um usuário tem na capacidade
displayName	string	O nome de exibição da capacidade
id	string	A ID da capacidade
region	string	A região do Azure em que a capacidade foi provisionada
sku	string	O SKU de capacidade
state	CapacityState	O estado de capacidade
tenantKey	TenantKey	Informações de chave de criptografia (aplica-se apenas a rotas de administrador)
tenantKeyId	string	A ID de uma chave de criptografia (aplicável somente à rota de administrador)

CapacityState

O estado de capacidade

Nome	Tipo	Description
Active	string	A capacidade está pronta para uso
Deleted	string	A capacidade foi excluída e não está disponível
Deleting	string	A exclusão da capacidade está em andamento
Invalid	string	A capacidade não pode ser usada
NotActivated	string	Sem suporte
PreSuspended	string	Sem suporte
ProvisionFailed	string	Falha no provisionamento da capacidade
Provisioning	string	A ativação da capacidade está em andamento
Suspended	string	O uso da capacidade é suspenso
UpdatingSku	string	Uma alteração de SKU de capacidade está em andamento

capacityUserAccessRight

O direito de acesso que o usuário tem na capacidade

Nome	Tipo	Description
Admin	string	O usuário tem direitos de administrador sobre a capacidade
Assign	string	O usuário tem direitos de colaborador e pode atribuir workspaces à capacidade
None	string	O usuário não tem acesso à capacidade

TenantKey

Informações de chave de criptografia

Nome	Tipo	Description
createdAt	string	A data e a hora da criação da chave de criptografia
id	string	A ID da chave de criptografia
isDefault	boolean	Se a chave de criptografia é a chave padrão para todo o locatário. Qualquer capacidade recém-criada herda a chave padrão.
keyVaultKeyIdentifier	string	O URI que especifica exclusivamente a chave de criptografia no Azure Key Vault
name	string	O nome da chave de criptografia
updatedAt	string	A data e a hora da última atualização da chave de criptografia