Pipelines - Deploy All

Referensi

Service:: Power BI REST APIs

API Version:: v1.0

Menyebarkan semua item yang didukung dari tahap sumber alur penyebaran yang ditentukan.

Untuk mempelajari tentang item yang tidak didukung dalam alur penyebaran, lihat Item yang tidak didukung.

Izin

Pengguna setidaknya harus menjadi anggota di ruang kerja penyebaran sumber dan target. Untuk informasi selengkapnya, lihat Izin.

Cakupan yang Diperlukan

Pipeline.Deploy

Batasan

Maksimum 300 item yang disebarkan per permintaan.

POST https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}/deployAll

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
pipelineId	path	True	string uuid	ID alur penyebaran

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
sourceStageOrder	True	integer	Pengidentifikasi numerik dari tahap penyebaran alur tempat konten harus disebarkan. Pengembangan (0), Pengujian (1), Produksi (2).
isBackwardDeployment		boolean	Apakah penyebaran akan dari tahap selanjutnya dalam alur penyebaran, ke yang sebelumnya. Nilai defaultnya adalah `false`.
newWorkspace		PipelineNewWorkspaceRequest	Detail konfigurasi untuk membuat ruang kerja baru. Diperlukan saat menyebarkan ke tahap yang tidak memiliki ruang kerja yang ditetapkan. Penyebaran akan gagal jika detail konfigurasi ruang kerja baru tidak disediakan saat diperlukan.
note		string	Catatan yang menjelaskan penyebaran.
options		DeploymentOptions	Opsi yang mengontrol perilaku seluruh penyebaran
updateAppSettings		PipelineUpdateAppSettings	Memperbarui aplikasi organisasi di pengaturan ruang kerja target

Respons

Nama	Jenis	Deskripsi
202 Accepted	PipelineOperation	Diterima

Contoh

Example of deploying all Power BI items (such as reports or dashboards) from the 'Development' stage

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deployAll

Request Body

{
  "sourceStageOrder": 0,
  "options": {
    "allowOverwriteArtifact": true,
    "allowCreateArtifact": true
  },
  "note": "Deploying business ready items"
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
      "type": "Deploy",
      "status": "NotStarted",
      "lastUpdatedTime": "2020-12-13T09:26:43.153",
      "executionStartTime": "2020-12-13T09:25:43.153Z",
      "executionEndTime": "2020-12-13T09:26:43.153Z",
      "sourceStageOrder": 0,
      "targetStageOrder": 1
    }
  ]
}

Definisi

Nama	Deskripsi
DeployAllRequest	Permintaan untuk menyebarkan semua item yang didukung dari tahap alur penyebaran
DeploymentError	Detail kesalahan untuk langkah penyebaran
DeploymentExecutionPlan	Rencana eksekusi penyebaran
DeploymentExecutionStep	Langkah eksekusi penyebaran
DeploymentExecutionStepPreDeploymentDiffState	Adalah item baru, berbeda, atau identik dengan item dalam tahap target sebelum penyebaran.
DeploymentOptions	Opsi konfigurasi penyebaran. Dapat ditentukan baik untuk seluruh penyebaran atau untuk item Power BI tertentu (seperti laporan atau dasbor). Jika keduanya ditentukan, hanya opsi penyebaran untuk item Power BI yang digunakan.
DeploymentSourceAndTarget	Item sumber dan target
DeploymentStepType	Jenis langkah penyebaran
PipelineNewWorkspaceRequest	Detail konfigurasi untuk membuat ruang kerja baru. Diperlukan saat menyebarkan ke tahap yang tidak memiliki ruang kerja yang ditetapkan.
PipelineOperation	Operasi alur penyebaran Power BI
PipelineOperationNote	Catatan yang menjelaskan penyebaran.
PipelineOperationStatus	Status operasi alur
PipelineOperationType	Jenis operasi
PipelineOperationUser	Pengguna atau perwakilan layanan yang melakukan operasi alur.
PipelineUpdateAppSettings	Aplikasi org pembaruan konfigurasi setelah penyebaran
PreDeploymentDiffInformation	Jumlah item baru yang disebarkan, berbeda, dan identik sebelum penyebaran.
PrincipalType	Jenis utama

DeployAllRequest

Permintaan untuk menyebarkan semua item yang didukung dari tahap alur penyebaran

Nama	Jenis	Deskripsi
isBackwardDeployment	boolean	Apakah penyebaran akan dari tahap selanjutnya dalam alur penyebaran, ke yang sebelumnya. Nilai defaultnya adalah `false`.
newWorkspace	PipelineNewWorkspaceRequest	Detail konfigurasi untuk membuat ruang kerja baru. Diperlukan saat menyebarkan ke tahap yang tidak memiliki ruang kerja yang ditetapkan. Penyebaran akan gagal jika detail konfigurasi ruang kerja baru tidak disediakan saat diperlukan.
note	string	Catatan yang menjelaskan penyebaran.
options	DeploymentOptions	Opsi yang mengontrol perilaku seluruh penyebaran
sourceStageOrder	integer	Pengidentifikasi numerik dari tahap penyebaran alur tempat konten harus disebarkan. Pengembangan (0), Pengujian (1), Produksi (2).
updateAppSettings	PipelineUpdateAppSettings	Memperbarui aplikasi organisasi di pengaturan ruang kerja target

DeploymentError

Detail kesalahan untuk langkah penyebaran

Nama	Jenis	Deskripsi
errorCode	string	Kode kesalahan
errorDetails	string	Detail kesalahan tambahan

DeploymentExecutionPlan

Rencana eksekusi penyebaran

Nama	Jenis	Deskripsi
steps	DeploymentExecutionStep[]	Pengumpulan langkah-langkah rencana eksekusi

DeploymentExecutionStep

Langkah eksekusi penyebaran

Nama	Jenis	Deskripsi
error	DeploymentError	Detail kesalahan. Hanya berlaku jika operasi alur gagal.
index	integer	Indeks langkah
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Adalah item baru, berbeda, atau identik dengan item dalam tahap target sebelum penyebaran.
sourceAndTarget	DeploymentSourceAndTarget	Item sumber dan target langkah
status	PipelineOperationStatus	Status operasi alur
type	DeploymentStepType	Jenis langkah penyebaran

DeploymentExecutionStepPreDeploymentDiffState

Adalah item baru, berbeda, atau identik dengan item dalam tahap target sebelum penyebaran.

Nama	Jenis	Deskripsi
Different	string	Sebelum penyebaran, item dalam tahap sumber tidak identik dengan item dalam tahap target.
New	string	Item baru yang disebarkan yang tidak ada di tahap target.
NoDifference	string	Sebelum penyebaran, item dalam tahap sumber identik dengan yang ada di tahap target.

DeploymentOptions

Opsi konfigurasi penyebaran. Dapat ditentukan baik untuk seluruh penyebaran atau untuk item Power BI tertentu (seperti laporan atau dasbor). Jika keduanya ditentukan, hanya opsi penyebaran untuk item Power BI yang digunakan.

Nama	Jenis	Deskripsi
allowCreateArtifact	boolean	Apakah membuat item Power BI baru (seperti laporan atau dasbor) di ruang kerja tahap target diizinkan. Jika opsi ini tidak diatur ke `true` saat diperlukan untuk penyebaran, penyebaran akan gagal.
allowOverwriteArtifact	boolean	Apakah menimpa item Power BI (seperti laporan atau dasbor) di ruang kerja tahap target diizinkan. Jika opsi ini tidak diatur ke `true` saat diperlukan untuk penyebaran, penyebaran akan gagal.
allowOverwriteTargetArtifactLabel	boolean	Apakah label item Power BI target (seperti laporan atau dasbor) dapat diubah. Label akan diubah ketika sumber dilindungi tetapi targetnya tidak. Jika opsi ini tidak diatur ke `true` saat diperlukan untuk penyebaran, penyebaran akan gagal.
allowPurgeData	boolean	Apakah akan menghapus semua data dari item Power BI target (seperti laporan atau dasbor) saat ada ketidakcocokan skema. Jika opsi ini tidak diatur ke `true` saat diperlukan untuk penyebaran, penyebaran akan gagal.
allowSkipTilesWithMissingPrerequisites	boolean	Apakah akan melewati petak peta yang tidak memiliki model atau laporan di ruang kerja tahap target. Jika opsi ini tidak diatur ke `true` saat diperlukan untuk penyebaran, penyebaran akan gagal.
allowTakeOver	boolean	Apakah mengizinkan penimpaan pemilik laporan paginasi sebelumnya dan menjadi pemilik laporan paginasi. Berlaku saat menyebarkan laporan paginasi ke tahap yang sudah berisi salinan laporan paginasi yang tidak dimiliki oleh Anda. Jika opsi ini tidak diatur ke `true` saat diperlukan untuk penyebaran, penyebaran akan gagal.

DeploymentSourceAndTarget

Item sumber dan target

Nama	Jenis	Deskripsi
source	string	ID item Power BI yang disebarkan dari tahap sumber
sourceDisplayName	string	Nama tampilan item Power BI yang disebarkan dari tahap sumber
target	string	ID item Power BI yang akan ditimpa dalam tahap target. Hanya berlaku saat menimpa item Power BI.
targetDisplayName	string	Nama item Power BI yang akan ditimpa dalam tahap target. Hanya berlaku saat menimpa item Power BI.
type	string	Jenis item Power BI yang akan ditimpa dalam tahap target. Hanya berlaku saat menimpa item Power BI.

DeploymentStepType

Jenis langkah penyebaran

Nama	Jenis	Deskripsi
DashboardDeployment	string	Langkah untuk menyebarkan satu dasbor
DataflowDeployment	string	Langkah untuk menyebarkan satu aliran data
DatamartDeployment	string	Langkah untuk menyebarkan satu datamart
DatasetDeployment	string	Langkah untuk menyebarkan satu himpunan data
ReportDeployment	string	Langkah untuk menyebarkan satu laporan

PipelineNewWorkspaceRequest

Detail konfigurasi untuk membuat ruang kerja baru. Diperlukan saat menyebarkan ke tahap yang tidak memiliki ruang kerja yang ditetapkan.

Nama	Jenis	Deskripsi
capacityId	string	ID kapasitas tempat ruang kerja baru akan ditetapkan. Jika tidak ditentukan dan pemanggil API memiliki izin untuk kapasitas ruang kerja tahap sumber, maka kapasitas tersebut akan digunakan. Jika tidak, Power BI akan memilih kapasitas yang izinnya dimiliki pemanggil API.
name	string	Nama ruang kerja baru

PipelineOperation

Operasi alur penyebaran Power BI

Nama	Jenis	Deskripsi
executionEndTime	string	Tanggal dan waktu operasi berakhir
executionPlan	DeploymentExecutionPlan	Rencana eksekusi penyebaran. Hanya berlaku untuk satu operasi alur.
executionStartTime	string	Tanggal dan waktu operasi dimulai
id	string	ID operasi
lastUpdatedTime	string	Tanggal dan waktu operasi terakhir diperbarui
note	PipelineOperationNote	Catatan yang mewakili deskripsi operasi.
performedBy	PipelineOperationUser	Pengguna atau perwakilan layanan yang melakukan operasi alur.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Jumlah item yang disebarkan dalam tahap sumber, yang baru, identik atau berbeda dengan item dalam tahap target, sebelum penyebaran.
sourceStageOrder	integer	Pengidentifikasi numerik dari tahap penyebaran alur sumber. Pengembangan (0), Pengujian (1), Produksi (2).
status	PipelineOperationStatus	Status operasi alur
targetStageOrder	integer	Pengidentifikasi numerik dari tahap penyebaran alur target. Pengembangan (0), Pengujian (1), Produksi (2).
type	PipelineOperationType	Jenis operasi

PipelineOperationNote

Catatan yang menjelaskan penyebaran.

Nama	Jenis	Deskripsi
content	string	Teks yang menjelaskan penyebaran.
isTruncated	boolean	Menunjukkan apakah catatan tidak lengkap. Benar, hanya sebagian catatan yang dikembalikan. False, catatan selesai.

PipelineOperationStatus

Status operasi alur

Nama	Jenis	Deskripsi
Executing	string	Operasi yang dijalankan
Failed	string	Operasi gagal
NotStarted	string	Operasi tidak dimulai
Succeeded	string	Operasi berhasil

PipelineOperationType

Jenis operasi

Nama	Jenis	Deskripsi
Deploy	string	Menyebarkan konten antar tahap

PipelineOperationUser

Pengguna atau perwakilan layanan yang melakukan operasi alur.

Nama	Jenis	Deskripsi
principalObjectID	string	ID perwakilan layanan yang melakukan penyebaran.
principalType	PrincipalType	Jenis pengguna yang melakukan penyebaran.
userPrincipalName	string	UPN pengguna yang melakukan penyebaran.

PipelineUpdateAppSettings

Aplikasi org pembaruan konfigurasi setelah penyebaran

Nama	Jenis	Deskripsi
updateAppInTargetWorkspace	boolean	Apakah akan memperbarui aplikasi di ruang kerja target. Hanya item yang disebarkan yang sudah ada di aplikasi yang diperbarui. Item baru yang disebarkan tidak ditambahkan ke aplikasi.

PreDeploymentDiffInformation

Jumlah item baru yang disebarkan, berbeda, dan identik sebelum penyebaran.

Nama	Jenis	Deskripsi
differentArtifactsCount	integer	Jumlah item yang disebarkan dengan perbedaan antara tahap sumber dan target, sebelum penyebaran.
newArtifactsCount	integer	Jumlah item baru yang disebarkan ke tahap target.
noDifferenceArtifactsCount	integer	Jumlah item yang disebarkan yang identik dalam tahap sumber dan target, sebelum penyebaran.

PrincipalType

Jenis utama

Nama	Jenis	Deskripsi
App	string	Jenis perwakilan layanan
Group	string	Jenis prinsipal grup
None	string	Tidak ada jenis utama. Gunakan untuk akses tingkat seluruh organisasi.
User	string	Jenis prinsipal pengguna