Capacities - Get Details

Service:

Power BI Embedded

API Version:

2021-01-01

Ruft Details zur angegebenen dedizierten Kapazität ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}?api-version=2021-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dedicatedCapacityName	path	True	string	Der Name der dedizierten Kapazität. Es muss mindestens 3 Zeichen und maximal 63 Zeichen lang sein. Regex pattern: ^[a-z][a-z0-9]*$
resourceGroupName	path	True	string	Der Name der Azure-Ressourcengruppe, zu der eine bestimmte PowerBIDedizierte Kapazität gehört. Dieser Name muss mindestens 1 Zeichen lang und nicht mehr als 90 sein. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Ein eindeutiger Bezeichner für ein Microsoft Azure-Abonnement. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Die Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	DedicatedCapacity	OK. Der Vorgang wurde durchgeführt.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get details of a capacity

Sample Request

HTTP

GET https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest?api-version=2021-01-01

Sample Response

Status code:

200

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {},
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z"
  }
}

Definitionen

Name	Beschreibung
CapacityProvisioningState	Der aktuelle Bereitstellungsstatus der dedizierten PowerBI-Ressource. ProvisioningState soll Zustände für die Ressourcenbereitstellung angeben.
CapacitySku	Stellt den SKU-Namen und den Azure-Tarif für die PowerBI Dedicated-Kapazitätsressource dar.
CapacitySkuTier	Der Name des Azure-Tarifs, für den die SKU gilt.
DedicatedCapacity	Stellt einen instance einer Dedizierten Kapazitätsressource dar.
DedicatedCapacityAdministrators	Ein Array von Administratorbenutzeridentitäten
Error	Das Fehlerobjekt
ErrorResponse	Beschreibt das Format der Fehlerantwort.
IdentityType	Der Identitätstyp, der die Ressource erstellt/geändert hat.
Mode	Gibt die Generierung der Power BI Embedded Kapazität an. Wenn kein Wert angegeben wird, wird der Standardwert "Gen2" verwendet. Weitere Informationen
State	Der aktuelle Status der powerBI Dedicated-Ressource. Der Status soll mehr Zustände außerhalb der Ressourcenbereitstellung angeben.
SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

CapacityProvisioningState

Der aktuelle Bereitstellungsstatus der dedizierten PowerBI-Ressource. ProvisioningState soll Zustände für die Ressourcenbereitstellung angeben.

Name	Typ	Beschreibung
Deleting	string
Failed	string
Paused	string
Pausing	string
Preparing	string
Provisioning	string
Resuming	string
Scaling	string
Succeeded	string
Suspended	string
Suspending	string
Updating	string

CapacitySku

Stellt den SKU-Namen und den Azure-Tarif für die PowerBI Dedicated-Kapazitätsressource dar.

Name	Typ	Beschreibung
capacity	integer	Die Kapazität der SKU.
name	string	Name der SKU-Ebene.
tier	CapacitySkuTier	Der Name des Azure-Tarifs, für den die SKU gilt.

CapacitySkuTier

Der Name des Azure-Tarifs, für den die SKU gilt.

Name	Typ	Beschreibung
AutoPremiumHost	string
PBIE_Azure	string
Premium	string

DedicatedCapacity

Stellt einen instance einer Dedizierten Kapazitätsressource dar.

Name	Typ	Beschreibung
id	string	Ein Bezeichner, der die dedizierte PowerBI-Ressource darstellt.
location	string	Speicherort der dedizierten PowerBI-Ressource.
name	string	Der Name der dedizierten PowerBI-Ressource.
properties.administration	DedicatedCapacityAdministrators	Eine Sammlung von Dedizierten Kapazitätsadministratoren
properties.friendlyName	string	Kapazitätsname
properties.mode	Mode	Gibt die Generierung der Power BI Embedded Kapazität an. Wenn kein Wert angegeben wird, wird der Standardwert "Gen2" verwendet. Weitere Informationen
properties.provisioningState	CapacityProvisioningState	Der aktuelle Bereitstellungsstatus der dedizierten PowerBI-Ressource. ProvisioningState soll Zustände für die Ressourcenbereitstellung angeben.
properties.state	State	Der aktuelle Status der powerBI Dedicated-Ressource. Der Status soll mehr Zustände außerhalb der Ressourcenbereitstellung angeben.
properties.tenantId	string	Mandanten-ID für die Kapazität. Wird zum Erstellen von Pro Plus-Kapazität verwendet.
sku	CapacitySku	Die SKU der PowerBI Dedicated-Kapazitätsressource.
systemData	SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
tags	object	Schlüssel-Wert-Paare mit zusätzlichen Ressourcenbereitstellungseigenschaften.
type	string	Der Typ der PowerBI Dedicated-Ressource.

DedicatedCapacityAdministrators

Ein Array von Administratorbenutzeridentitäten

Name	Typ	Beschreibung
members	string[]	Ein Array von Administratorbenutzeridentitäten.

Error

Das Fehlerobjekt

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Beschreibt das Format der Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt

IdentityType

Der Identitätstyp, der die Ressource erstellt/geändert hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

Mode

Gibt die Generierung der Power BI Embedded Kapazität an. Wenn kein Wert angegeben wird, wird der Standardwert "Gen2" verwendet. Weitere Informationen

Name	Typ	Beschreibung
Gen1	string
Gen2	string

State

Der aktuelle Status der powerBI Dedicated-Ressource. Der Status soll mehr Zustände außerhalb der Ressourcenbereitstellung angeben.

Name	Typ	Beschreibung
Deleting	string
Failed	string
Paused	string
Pausing	string
Preparing	string
Provisioning	string
Resuming	string
Scaling	string
Succeeded	string
Suspended	string
Suspending	string
Updating	string

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC)
createdBy	string	Ein Bezeichner für die Identität, die die Ressource erstellt hat
createdByType	IdentityType	Der Identitätstyp, der die Ressource erstellt hat
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Ein Bezeichner für die Identität, die die Ressource zuletzt geändert hat
lastModifiedByType	IdentityType	Der Identitätstyp, der die Ressource zuletzt geändert hat