Partilhar via

Admin - Get Capacities As Admin

Serviço:
Power BI REST APIs
Versão da API:
v1.0

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

Permissões

  • O usuário deve ser um administrador do Fabric 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 quaisquer pré-remissões necessárias de consentimento do administrador para o Power BI definidas 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.

Limitações

Máximo de 200 solicitações por hora.

GET https://api.powerbi.com/v1.0/myorg/admin/capacities
Com parâmetros opcionais: 
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

OKEY

Exemplos

Example
Example with expand on tenant key

Example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Objeto

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

Objeto

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 (uuid)

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 (uuid)

A ID de uma chave de criptografia (aplicável somente à rota do administrador)

CapacityState

Enumeração

O estado de capacidade

Valor Description
NotActivated

Unsupported
Active

A capacidade está pronta para uso
Provisioning

A ativação da capacidade está em andamento
ProvisionFailed

Falha no provisionamento da capacidade
PreSuspended

Unsupported
Suspended

O uso da capacidade é suspenso
Deleting

A exclusão da capacidade está em andamento
Deleted

A capacidade foi excluída e não está disponível
Invalid

A capacidade não pode ser usada
UpdatingSku

Uma alteração de SKU de capacidade está em andamento

capacityUserAccessRight

Enumeração

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

Valor Description
None

O usuário não tem acesso à capacidade
Assign

O usuário tem direitos de colaborador e pode atribuir workspaces à capacidade
Admin

O usuário tem direitos de administrador sobre a capacidade

TenantKey

Objeto

Informações de chave de criptografia

Nome Tipo Description
createdAt

string (date-time)

A data e a hora de criação da chave de criptografia
id

string (uuid)

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 (date-time)

A data e a hora da última atualização da chave de criptografia