Capacities - Get Details

服务:

Power BI Embedded

API 版本:

2021-01-01

获取有关指定专用容量的详细信息。

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

URI 参数

名称	在	必需	类型	说明
dedicatedCapacityName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	专用容量的名称。 它必须至少为 3 个字符，最多为 63 个字符。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	DedicatedCapacity	Azure作已成功完成。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get details of a capacity

示例请求

HTTP

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

示例响应

状态代码:

200

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

定义

名称	说明
CapacityProvisioningState	PowerBI 专用资源的当前部署状态。 provisioningState 用于指示资源预配的状态。
CapacitySku	表示 PowerBI 专用容量资源的 SKU 名称和 Azure 定价层。
CapacitySkuTier	SKU 应用到的 Azure 定价层的名称。
createdByType	创建资源的标识的类型。
DedicatedCapacity	表示专用容量资源的实例。
DedicatedCapacityAdministrators	管理员用户标识数组
Error	错误对象。
ErrorResponse	错误对象
Mode	指定 Power BI Embedded 容量的生成。 如果未指定任何值，则使用默认值“Gen2”。 了解更多
State	PowerBI 专用资源的当前状态。 状态是指示资源预配之外的更多状态。
systemData	与创建和上次修改资源相关的元数据。

CapacityProvisioningState

枚举

PowerBI 专用资源的当前部署状态。 provisioningState 用于指示资源预配的状态。

值	说明
Deleting
Succeeded
Failed
Paused
Suspended
Provisioning
Updating
Suspending
Pausing
Resuming
Preparing
Scaling

CapacitySku

Object

表示 PowerBI 专用容量资源的 SKU 名称和 Azure 定价层。

名称	类型	说明
capacity	integer (int32)	SKU 的容量。
name	string	SKU 级别的名称。
tier	CapacitySkuTier	SKU 应用到的 Azure 定价层的名称。

CapacitySkuTier

枚举

SKU 应用到的 Azure 定价层的名称。

值	说明
PBIE_Azure
Premium
AutoPremiumHost

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DedicatedCapacity

Object

表示专用容量资源的实例。

名称	类型	说明
id	string	资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	资源所在的地理位置
name	string	资源的名称
properties.administration	DedicatedCapacityAdministrators	专用容量管理员的集合
properties.friendlyName	string	容量名称
properties.mode	Mode	指定 Power BI Embedded 容量的生成。 如果未指定任何值，则使用默认值“Gen2”。 了解更多
properties.provisioningState	CapacityProvisioningState	PowerBI 专用资源的当前部署状态。 provisioningState 用于指示资源预配的状态。
properties.state	State	PowerBI 专用资源的当前状态。 状态是指示资源预配之外的更多状态。
properties.tenantId	string	容量的租户 ID。 用于创建 Pro Plus 容量。
sku	CapacitySku	PowerBI 专用容量资源的 SKU。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

DedicatedCapacityAdministrators

Object

管理员用户标识数组

名称	类型	说明
members	string[]	管理员用户标识数组。

Error

Object

错误对象。

名称	类型	说明
code	string	错误代码
message	string	指示作失败的原因的错误消息。

ErrorResponse

Object

错误对象

名称	类型	说明
error	Error	错误对象。

Mode

枚举

指定 Power BI Embedded 容量的生成。 如果未指定任何值，则使用默认值“Gen2”。 了解更多

值	说明
Gen1
Gen2

State

枚举

PowerBI 专用资源的当前状态。 状态是指示资源预配之外的更多状态。

值	说明
Deleting
Succeeded
Failed
Paused
Suspended
Provisioning
Updating
Suspending
Pausing
Resuming
Preparing
Scaling

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。