Admin - Get Refreshables For Capacity
ユーザーがアクセスできる指定された容量の更新可能な一覧を返します。
Power BI では、データセットごとに 7 日間の更新履歴が保持され、最大 60 回の更新が保持されます。
権限
- ユーザーは、ファブリック管理者であるか、サービス プリンシパルを使用して認証されている必要があります。
- 委任されたアクセス許可がサポートされています。
サービス 特権認証で実行する場合、アプリ は、Azure portal で Power BI に対して管理者の同意が必要な事前使用許可を設定 することはできません。
必要なスコープ
Tenant.Read.All または Tenant.ReadWrite.All
標準の委任された管理者アクセス トークンを使用して認証する場合にのみ関連します。 サービス プリンシパル経由の認証を使用する場合は、存在しない必要があります。
制限事項
1 時間あたり最大 200 要求。
GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables?$top={$top}
GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
capacity
|
path | True |
string uuid |
容量 ID |
$top
|
query | True |
integer int32 |
最初の n 個の結果のみを返します。 |
$expand
|
query |
string |
応答でインラインで展開されるデータ型のコンマ区切りのリストを受け入れます。
|
|
$filter
|
query |
string |
Odata フィルター クエリ パラメーター条件 |
|
$skip
|
query |
integer int32 |
最初の n 個の結果をスキップします。 top と共に使用して、最初の 1000 を超える結果をフェッチします。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました |
例
Example |
Get refreshables, filtering for an average refresh duration of greater than 30 minutes example. |
Get refreshables with their 'capacity' and 'group' expanded example |
Example
要求のサンプル
GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables
応答のサンプル
{
"value": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"kind": "Dataset",
"startTime": "2017-06-13T09:25:43.153Z",
"endTime": "2017-06-19T11:22:32.445Z",
"refreshCount": 22,
"refreshFailures": 0,
"averageDuration": 289.3814,
"medianDuration": 268.6245,
"refreshesPerDay": 11,
"lastRefresh": {
"refreshType": "ViaApi",
"startTime": "2017-06-13T09:25:43.153Z",
"endTime": "2017-06-13T09:31:43.153Z",
"status": "Completed",
"requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
},
"refreshSchedule": {
"days": [
"Sunday",
"Friday",
"Saturday"
],
"times": [
"05:00",
"11:30",
"17:30",
"23:00"
],
"enabled": true,
"localTimeZoneId": "UTC",
"notifyOption": "MailOnFailure"
},
"configuredBy": [
"john@contoso.com"
]
}
]
}
Get refreshables, filtering for an average refresh duration of greater than 30 minutes example.
要求のサンプル
GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables?$filter=averageDuration gt 1800
応答のサンプル
{
"value": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"kind": "Dataset",
"startTime": "2017-06-13T09:25:43.153Z",
"endTime": "2017-06-19T11:22:32.445Z",
"refreshCount": 22,
"refreshFailures": 0,
"averageDuration": 3289.3814,
"medianDuration": 2268.6245,
"refreshesPerDay": 11,
"lastRefresh": {
"refreshType": "ViaApi",
"startTime": "2017-06-13T09:25:43.153Z",
"endTime": "2017-06-13T09:58:05.221Z",
"status": "Completed",
"requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
},
"refreshSchedule": {
"days": [
"Sunday",
"Friday",
"Saturday"
],
"times": [
"05:00",
"11:30",
"17:30",
"23:00"
],
"enabled": true,
"localTimeZoneId": "UTC",
"notifyOption": "MailOnFailure"
},
"configuredBy": [
"john@contoso.com"
]
}
]
}
Get refreshables with their 'capacity' and 'group' expanded example
要求のサンプル
GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables?$expand=capacity,group
応答のサンプル
{
"value": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"kind": "Dataset",
"startTime": "2017-06-13T09:25:43.153Z",
"endTime": "2017-06-19T11:22:32.445Z",
"refreshCount": 22,
"refreshFailures": 0,
"averageDuration": 289.3814,
"medianDuration": 268.6245,
"refreshesPerDay": 11,
"lastRefresh": {
"refreshType": "ViaApi",
"startTime": "2017-06-13T09:25:43.153Z",
"endTime": "2017-06-13T09:31:43.153Z",
"status": "Completed",
"requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
},
"refreshSchedule": {
"days": [
"Sunday",
"Friday",
"Saturday"
],
"times": [
"05:00",
"11:30",
"17:30",
"23:00"
],
"enabled": true,
"localTimeZoneId": "UTC",
"notifyOption": "MailOnFailure"
},
"configuredBy": [
"john@contoso.com"
],
"capacity": {
"id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
"displayName": "MyCapacity",
"sku": "A1"
},
"group": {
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing"
}
}
]
}
定義
名前 | 説明 |
---|---|
Capacity |
Power BI 容量 |
Capacity |
容量の状態 |
capacity |
ユーザーが容量に対して持っているアクセス権 |
days |
更新を実行する日 |
Refresh |
Power BI の更新履歴エントリ |
Refreshable |
Power BI 更新可能とは、少なくとも 1 回更新されたデータセット、または有効な更新スケジュールが存在するデータセットです。 データセットがこれらの条件のいずれかを満たしていない場合、API 応答には表示されません。 Power BI では、データセットごとに 7 日間の更新履歴が保持され、最大 60 回の更新が保持されます。 |
Refreshable |
更新可能なアイテムに関連付けられている Power BI グループ |
Refreshable |
更新可能な種類 |
Refreshables |
Power BI の更新可能な一覧 |
Refresh |
Power BI では、更新エラーが発生した場合に、データセットの更新が複数回試行されます。 このオブジェクトには、各更新の試行に関する情報が含まれています。 |
Refresh |
更新の試行の種類。 |
Refresh |
インポートされたモデル の Power BI 更新スケジュール |
Refresh |
更新要求の種類 |
Schedule |
スケジュールされた更新の終了時の通知オプション。 サービス プリンシパルは、 |
Tenant |
暗号化キーの情報 |
Capacity
Power BI 容量
名前 | 型 | 説明 |
---|---|---|
admins |
string[] |
容量管理者の配列 |
capacityUserAccessRight |
ユーザーが容量に対して持っているアクセス権 |
|
displayName |
string |
容量の表示名 |
id |
string |
容量 ID |
region |
string |
容量がプロビジョニングされた Azure リージョン |
sku |
string |
容量 SKU |
state |
容量の状態 |
|
tenantKey |
暗号化キー情報 (管理者ルートにのみ適用されます) |
|
tenantKeyId |
string |
暗号化キーの ID (管理者ルートにのみ適用されます) |
CapacityState
容量の状態
名前 | 型 | 説明 |
---|---|---|
Active |
string |
容量を使用する準備ができました |
Deleted |
string |
容量が削除され、使用できません |
Deleting |
string |
容量の削除が進行中です |
Invalid |
string |
容量を使用できない |
NotActivated |
string |
サポート |
PreSuspended |
string |
サポート |
ProvisionFailed |
string |
容量のプロビジョニングに失敗しました |
Provisioning |
string |
容量のアクティブ化が進行中です |
Suspended |
string |
容量の使用が中断される |
UpdatingSku |
string |
容量 SKU の変更が進行中です |
capacityUserAccessRight
ユーザーが容量に対して持っているアクセス権
名前 | 型 | 説明 |
---|---|---|
Admin |
string |
ユーザーが容量に対する管理者権限を持っている |
Assign |
string |
ユーザーは共同作成者の権限を持ち、ワークスペースを容量に割り当てることができます |
None |
string |
ユーザーが容量にアクセスできない |
days
更新を実行する日
名前 | 型 | 説明 |
---|---|---|
Friday |
string |
|
Monday |
string |
|
Saturday |
string |
|
Sunday |
string |
|
Thursday |
string |
|
Tuesday |
string |
|
Wednesday |
string |
Refresh
Power BI の更新履歴エントリ
名前 | 型 | 説明 |
---|---|---|
endTime |
string |
更新の終了日時 (更新が進行中の場合は空になる場合があります) |
refreshAttempts |
更新の試行の一覧。 |
|
refreshType |
更新要求の種類 |
|
requestId |
string |
更新要求の識別子。 すべてのサービス要求でこの識別子を指定します。 |
serviceExceptionJson |
string |
JSON 形式のエラー エラー コード (エラーがない場合は空) |
startTime |
string |
更新の開始日時 |
status |
string |
|
Refreshable
Power BI 更新可能とは、少なくとも 1 回更新されたデータセット、または有効な更新スケジュールが存在するデータセットです。 データセットがこれらの条件のいずれかを満たしていない場合、API 応答には表示されません。 Power BI では、データセットごとに 7 日間の更新履歴が保持され、最大 60 回の更新が保持されます。
名前 | 型 | 説明 |
---|---|---|
averageDuration |
number |
更新データが存在する時間枠内の更新の平均期間 (秒) |
capacity |
更新可能な項目の容量 |
|
configuredBy |
string[] |
更新可能な所有者 |
endTime |
string |
更新データが存在するウィンドウの終了時刻 |
group |
更新可能な項目の関連付けられているグループ |
|
id |
string |
更新可能なオブジェクト ID |
kind |
更新可能な種類 |
|
lastRefresh |
更新可能な項目の最後の Power BI 更新履歴エントリ |
|
medianDuration |
number |
更新データが存在する時間枠内の更新の中央値 (秒単位) |
name |
string |
更新可能なファイルの表示名 |
refreshCount |
integer |
更新データが存在する時間枠内の更新の数 |
refreshFailures |
integer |
更新データが存在する時間枠内の更新エラーの数 |
refreshSchedule |
更新可能な項目の更新スケジュール |
|
refreshesPerDay |
integer |
更新データが存在する時間枠内の 1 日あたりの更新の数 (スケジュールおよびオンデマンド) |
startTime |
string |
更新データが存在するウィンドウの開始時刻 |
RefreshableGroup
更新可能なアイテムに関連付けられている Power BI グループ
名前 | 型 | 説明 |
---|---|---|
id |
string |
ワークスペース ID |
name |
string |
グループ名 |
RefreshableKind
更新可能な種類
名前 | 型 | 説明 |
---|---|---|
Dataset |
string |
データセット |
Refreshables
Power BI の更新可能な一覧
名前 | 型 | 説明 |
---|---|---|
odata.context |
string |
OData コンテキスト |
value |
更新可能な |
RefreshAttempt
Power BI では、更新エラーが発生した場合に、データセットの更新が複数回試行されます。 このオブジェクトには、各更新の試行に関する情報が含まれています。
名前 | 型 | 説明 |
---|---|---|
attemptId |
integer |
更新の試行のインデックス。 |
endTime |
string |
更新の試行の終了日時。 更新の試行が進行中の場合、値は void です。 |
serviceExceptionJson |
string |
JSON 形式のエラー エラー コード。 エラーがない場合は Void。 |
startTime |
string |
更新の試行の開始日時。 |
type |
更新の試行の種類。 |
RefreshAttemptType
更新の試行の種類。
名前 | 型 | 説明 |
---|---|---|
Data |
string |
更新によってデータセットにデータが読み込まれます。 |
Query |
string |
Premium クエリ キャッシュとダッシュボード タイルの更新の試行。u |
RefreshSchedule
インポートされたモデル の Power BI 更新スケジュール
名前 | 型 | 説明 |
---|---|---|
NotifyOption |
スケジュールされた更新の終了時の通知オプション。 サービス プリンシパルは、 |
|
days |
days[] |
更新を実行する日 |
enabled |
boolean |
更新が有効になっているかどうか |
localTimeZoneId |
string |
使用するタイム ゾーンの ID。 詳細については、「タイム ゾーン情報 |
times |
string[] |
更新を実行する時刻 |
RefreshType
更新要求の種類
名前 | 型 | 説明 |
---|---|---|
OnDemand |
string |
Power BI ポータルを使用して対話形式で更新がトリガーされました |
OnDemandTraining |
string |
更新は、自動集計トレーニングを使用して Power BI ポータルを介して対話形式でトリガーされました |
Scheduled |
string |
データセットの更新スケジュール設定によって更新がトリガーされました |
ViaApi |
string |
更新は API 呼び出しによってトリガーされました |
ViaEnhancedApi |
string |
更新は、強化された更新 REST API 呼び出しによってトリガーされました |
ViaXmlaEndpoint |
string |
Power BI パブリック XMLA エンドポイントを介して更新がトリガーされました |
ScheduleNotifyOption
スケジュールされた更新の終了時の通知オプション。 サービス プリンシパルは、NoNotification
値のみをサポートします。
名前 | 型 | 説明 |
---|---|---|
MailOnFailure |
string |
更新エラー時にメール通知が送信される |
NoNotification |
string |
通知は送信されません |
TenantKey
暗号化キーの情報
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
暗号化キーの作成日時 |
id |
string |
暗号化キーの ID |
isDefault |
boolean |
暗号化キーがテナント全体の既定のキーかどうか。 新しく作成された容量は、既定のキーを継承します。 |
keyVaultKeyIdentifier |
string |
Azure Key Vault の暗号化キーを一意に指定する URI |
name |
string |
暗号化キーの名前 |
updatedAt |
string |
暗号化キーの最終更新日時 |