Pipelines - Selective Deploy

Başvuru

Service:: Power BI REST APIs

API Version:: v1.0

Belirtilen öğeleri belirtilen dağıtım işlem hattının kaynak aşamasından dağıtır.

İzinler

Kullanıcı en azından hem kaynak hem de hedef dağıtım çalışma alanlarında üye olmalıdır. Daha fazla bilgi için bkz. İzinler.

Gerekli Kapsam

Pipeline.Deploy

Sınırlamalar

İstek başına en fazla 300 dağıtılan öğe.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
pipelineId	path	True	string uuid	Dağıtım işlem hattı kimliği

İstek Gövdesi

Name	Gerekli	Tür	Description
sourceStageOrder	True	integer	İçeriğin dağıtılması gereken işlem hattı dağıtım aşamasının sayısal tanımlayıcısı. Geliştirme (0), Test (1), Üretim (2).
dashboards		DeployArtifactRequest[]	Dağıtılacak panoların listesi
dataflows		DeployArtifactRequest[]	Dağıtılacak veri akışlarının listesi
datamarts		DeployArtifactRequest[]	Dağıtılacak datamart'ların listesi
datasets		DeployArtifactRequest[]	Dağıtılacak veri kümelerinin listesi
isBackwardDeployment		boolean	Dağıtımın dağıtım işlem hattının sonraki bir aşamasından önceki bir aşamaya kadar olup olmayacağı. `false` varsayılan değerdir.
newWorkspace		PipelineNewWorkspaceRequest	Yeni çalışma alanı oluşturmaya yönelik yapılandırma ayrıntıları. Atanmış çalışma alanı olmayan bir aşamaya dağıtım yaparken gereklidir. Gerektiğinde yeni çalışma alanı yapılandırma ayrıntıları sağlanmazsa dağıtım başarısız olur.
note		string	Dağıtımı açıklayan bir not.
options		DeploymentOptions	Dağıtımın tamamının davranışını denetleyebilen seçenekler
reports		DeployArtifactRequest[]	Dağıtılacak raporların listesi
updateAppSettings		PipelineUpdateAppSettings	Hedef çalışma alanı ayarlarında kuruluş uygulamasını güncelleştirme

Yanıtlar

Name	Tür	Description
202 Accepted	PipelineOperation	Kabul edildi

Örnekler

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

Example of deploying specific Power BI items with custom options

Example of deploying specific 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/deploy

Request Body

{
  "sourceStageOrder": 0,
  "dataflows": [
    {
      "sourceId": "29efcfb0-0063-44af-a4ed-6c0bee3417d3"
    }
  ],
  "datamarts": [
    {
      "sourceId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b"
    }
  ],
  "datasets": [
    {
      "sourceId": "1a201f2a-d1d8-45c0-8c61-1676338517de"
    }
  ],
  "reports": [
    {
      "sourceId": "2d225191-65f8-4ec3-b77d-06100602b1f7"
    }
  ],
  "dashboards": [
    {
      "sourceId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82"
    },
    {
      "sourceId": "7f08923c-8f57-49d6-a010-8335bb9cbd1b"
    }
  ],
  "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
    }
  ]
}

Example of deploying specific Power BI items with custom options

Sample Request

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

Request Body

{
  "sourceStageOrder": 0,
  "datamarts": [
    {
      "sourceId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
      "options": {
        "allowOverwriteArtifact": true,
        "allowCreateArtifact": true
      }
    }
  ],
  "reports": [
    {
      "sourceId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
      "options": {
        "allowOverwriteArtifact": 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
    }
  ]
}

Tanımlar

Name	Description
DeployArtifactRequest	Power BI öğesi (rapor veya pano gibi) dağıtma isteği
DeploymentError	Dağıtım adımı için hata ayrıntıları
DeploymentExecutionPlan	Dağıtım yürütme planı
DeploymentExecutionStep	Dağıtım yürütme adımı
DeploymentExecutionStepPreDeploymentDiffState	Yeni, farklı veya dağıtımdan önceki hedef aşamadaki öğelerle aynı öğedir.
DeploymentOptions	Dağıtım yapılandırma seçenekleri. Dağıtımın tamamı için veya belirli bir Power BI öğesi (rapor veya pano gibi) için belirtilebilir. Her ikisi de belirtilirse, yalnızca Power BI öğesinin dağıtım seçenekleri kullanılır.
DeploymentSourceAndTarget	Kaynak ve hedef öğeler
DeploymentStepType	Dağıtım adımının türü
PipelineNewWorkspaceRequest	Yeni çalışma alanı oluşturmaya yönelik yapılandırma ayrıntıları. Atanmış çalışma alanı olmayan bir aşamaya dağıtım yaparken gereklidir.
PipelineOperation	Power BI dağıtım işlem hattı işlemi
PipelineOperationNote	Dağıtımı açıklayan bir not.
PipelineOperationStatus	İşlem hattı işlemi durumu
PipelineOperationType	İşlem türü
PipelineOperationUser	İşlem hattı işlemini gerçekleştiren kullanıcı veya hizmet sorumlusu.
PipelineUpdateAppSettings	Dağıtımdan sonra yapılandırma güncelleştirme kuruluş uygulaması
PreDeploymentDiffInformation	Dağıtımdan önce yeni, farklı ve özdeş dağıtılan öğelerin miktarı.
PrincipalType	Asıl tür
SelectiveDeployRequest	Dağıtım işlem hattı aşamasından öğeleri seçmeli olarak dağıtma isteği

DeployArtifactRequest

Power BI öğesi (rapor veya pano gibi) dağıtma isteği

Name	Tür	Description
options	DeploymentOptions	Belirli bir Power BI öğesi için dağıtım yapılandırma seçenekleri (rapor veya pano gibi)
sourceId	string	Dağıtılacak Power BI öğesinin kimliği (rapor veya pano gibi)

DeploymentError

Dağıtım adımı için hata ayrıntıları

Name	Tür	Description
errorCode	string	Hata kodu
errorDetails	string	Ek hata ayrıntıları

DeploymentExecutionPlan

Dağıtım yürütme planı

Name	Tür	Description
steps	DeploymentExecutionStep[]	Yürütme planı adımlarının koleksiyonu

DeploymentExecutionStep

Dağıtım yürütme adımı

Name	Tür	Description
error	DeploymentError	Hata ayrıntıları. Yalnızca işlem hattı işlemi başarısız olursa geçerlidir.
index	integer	Adım dizini
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Yeni, farklı veya dağıtımdan önceki hedef aşamadaki öğelerle aynı olan bir öğedir.
sourceAndTarget	DeploymentSourceAndTarget	Adımın kaynak ve hedef öğeleri
status	PipelineOperationStatus	İşlem hattı işleminin durumu
type	DeploymentStepType	Dağıtım adımının türü

DeploymentExecutionStepPreDeploymentDiffState

Yeni, farklı veya dağıtımdan önceki hedef aşamadaki öğelerle aynı öğedir.

Name	Tür	Description
Different	string	Dağıtımdan önce, kaynak aşamadaki öğe hedef aşamadaki öğeyle aynı değildi.
New	string	Hedef aşamada mevcut olmayan yeni bir dağıtılan öğe.
NoDifference	string	Dağıtımdan önce, kaynak aşamadaki öğe hedef aşamadaki öğeyle aynıydı.

DeploymentOptions

Dağıtım yapılandırma seçenekleri. Dağıtımın tamamı için veya belirli bir Power BI öğesi (rapor veya pano gibi) için belirtilebilir. Her ikisi de belirtilirse, yalnızca Power BI öğesinin dağıtım seçenekleri kullanılır.

Name	Tür	Description
allowCreateArtifact	boolean	Hedef aşama çalışma alanında yeni bir Power BI öğesi (rapor veya pano gibi) oluşturmaya izin verilip verilmeyeceği. Bu seçenek, dağıtım için gerekli olduğunda olarak ayarlı `true` değilse, dağıtım başarısız olur.
allowOverwriteArtifact	boolean	Hedef aşama çalışma alanındaki bir Power BI öğesinin (rapor veya pano gibi) üzerine yazılıp yazılmadığı. Bu seçenek, dağıtım için gerekli olduğunda olarak ayarlı `true` değilse, dağıtım başarısız olur.
allowOverwriteTargetArtifactLabel	boolean	Hedef Power BI öğesinin (rapor veya pano gibi) etiketinin değiştirilip değiştirilemeyeceği. Kaynak korunduğunda ancak hedef korunmuyorsa etiket değiştirilir. Bu seçenek, dağıtım için gerekli olduğunda olarak ayarlı `true` değilse, dağıtım başarısız olur.
allowPurgeData	boolean	Şema uyuşmazlığı olduğunda hedef Power BI öğesinden (rapor veya pano gibi) tüm verilerin silinip silinmeyeceği. Bu seçenek, dağıtım için gerekli olduğunda olarak ayarlı `true` değilse, dağıtım başarısız olur.
allowSkipTilesWithMissingPrerequisites	boolean	Hedef aşama çalışma alanında modeli veya raporu olmayan kutucukların atlanıp atlanmayacağı. Bu seçenek, dağıtım için gerekli olduğunda olarak ayarlı `true` değilse, dağıtım başarısız olur.
allowTakeOver	boolean	Önceki sayfalandırılmış rapor sahibinin geçersiz kılınmasına ve sayfalandırılmış raporun sahibi olmasına izin verilip verilmeyeceği. Sayfalandırılmış raporu, size ait olmayan sayfalandırılmış raporun bir kopyasını içeren bir aşamaya dağıtırken geçerlidir. Bu seçenek, dağıtım için gerekli olduğunda olarak ayarlı `true` değilse, dağıtım başarısız olur.

DeploymentSourceAndTarget

Kaynak ve hedef öğeler

Name	Tür	Description
source	string	Kaynak aşamadan dağıtılan Power BI öğesinin kimliği
sourceDisplayName	string	Kaynak aşamadan dağıtılan Power BI öğesinin görünen adı
target	string	Hedef aşamada üzerine yazılacak Power BI öğesinin kimliği. Yalnızca Power BI öğesinin üzerine yazılırken geçerlidir.
targetDisplayName	string	Hedef aşamada üzerine yazılacak Power BI öğesinin adı. Yalnızca Power BI öğesinin üzerine yazılırken geçerlidir.
type	string	Hedef aşamada üzerine yazılacak Power BI öğesinin türü. Yalnızca Power BI öğesinin üzerine yazılırken geçerlidir.

DeploymentStepType

Dağıtım adımının türü

Name	Tür	Description
DashboardDeployment	string	Tek bir panoyu dağıtma adımı
DataflowDeployment	string	Tek bir veri akışını dağıtma adımı
DatamartDeployment	string	Tek bir datamart dağıtma adımı
DatasetDeployment	string	Tek bir veri kümesini dağıtma adımı
ReportDeployment	string	Tek bir raporu dağıtma adımı

PipelineNewWorkspaceRequest

Yeni çalışma alanı oluşturmaya yönelik yapılandırma ayrıntıları. Atanmış çalışma alanı olmayan bir aşamaya dağıtım yaparken gereklidir.

Name	Tür	Description
capacityId	string	Yeni çalışma alanının atanacağı kapasitenin kimliği. Belirtilmemişse ve API çağıranın kaynak aşama çalışma alanı kapasitesi için izinleri varsa, bu kapasite kullanılır. Aksi takdirde Power BI, API çağıranın izinlerine sahip olduğu bir kapasite seçer.
name	string	Yeni çalışma alanının adı

PipelineOperation

Power BI dağıtım işlem hattı işlemi

Name	Tür	Description
executionEndTime	string	İşlemin sona erdiğini tarih ve saat
executionPlan	DeploymentExecutionPlan	Dağıtım yürütme planı. Yalnızca tek bir işlem hattı işlemi için geçerlidir.
executionStartTime	string	İşlemin başlatıldığını tarih ve saat
id	string	İşlem kimliği
lastUpdatedTime	string	İşlemin son güncelleştirildiği tarih ve saat
note	PipelineOperationNote	İşlemin açıklamasını temsil eden bir not.
performedBy	PipelineOperationUser	İşlem hattı işlemini gerçekleştiren kullanıcı veya hizmet sorumlusu.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Dağıtımdan önce kaynak aşamada dağıtılan, yeni, özdeş veya hedef aşamadaki öğelerden farklı olan öğelerin miktarı.
sourceStageOrder	integer	Kaynak işlem hattı dağıtım aşamasının sayısal tanımlayıcısı. Geliştirme (0), Test (1), Üretim (2).
status	PipelineOperationStatus	İşlem hattı işlemi durumu
targetStageOrder	integer	Hedef işlem hattı dağıtım aşamasının sayısal tanımlayıcısı. Geliştirme (0), Test (1), Üretim (2).
type	PipelineOperationType	İşlem türü

PipelineOperationNote

Dağıtımı açıklayan bir not.

Name	Tür	Description
content	string	Dağıtımı açıklayan metin.
isTruncated	boolean	Notunun eksik olup olmadığını gösterir. Doğru, notun yalnızca bir bölümü döndürülür. False, not tamamlandı.

PipelineOperationStatus

İşlem hattı işlemi durumu

Name	Tür	Description
Executing	string	İşlem yürütülüyor
Failed	string	İşlem başarısız oldu
NotStarted	string	İşlem başlatılmaz
Succeeded	string	İşlem başarılı oldu

PipelineOperationType

İşlem türü

Name	Tür	Description
Deploy	string	Aşamalar arasında içerik dağıtma

PipelineOperationUser

İşlem hattı işlemini gerçekleştiren kullanıcı veya hizmet sorumlusu.

Name	Tür	Description
principalObjectID	string	Dağıtımı gerçekleştiren hizmet sorumlusunun kimliği.
principalType	PrincipalType	Dağıtımı gerçekleştiren kullanıcının türü.
userPrincipalName	string	Dağıtımı gerçekleştiren kullanıcının UPN'i.

PipelineUpdateAppSettings

Dağıtımdan sonra yapılandırma güncelleştirme kuruluş uygulaması

Name	Tür	Description
updateAppInTargetWorkspace	boolean	Hedef çalışma alanında uygulamanın güncelleştirilip güncelleştirilmeyeceği. Yalnızca uygulamada zaten var olan dağıtılan öğeler güncelleştirilir. Yeni dağıtılan öğeler uygulamaya eklenmez.

PreDeploymentDiffInformation

Dağıtımdan önce yeni, farklı ve özdeş dağıtılan öğelerin miktarı.

Name	Tür	Description
differentArtifactsCount	integer	Dağıtımdan önce kaynak ve hedef aşamalar arasındaki farklara sahip dağıtılan öğelerin sayısı.
newArtifactsCount	integer	Hedef aşamaya dağıtılan yeni öğelerin sayısı.
noDifferenceArtifactsCount	integer	Dağıtımdan önce kaynak ve hedef aşamalardaki aynı dağıtılan öğelerin sayısı.

PrincipalType

Asıl tür

Name	Tür	Description
App	string	Hizmet sorumlusu türü
Group	string	Grup sorumlusu türü
None	string	Sorumlu türü yok. Tüm kuruluş düzeyinde erişim için kullanın.
User	string	Kullanıcı asıl türü

SelectiveDeployRequest

Dağıtım işlem hattı aşamasından öğeleri seçmeli olarak dağıtma isteği

Name	Tür	Description
dashboards	DeployArtifactRequest[]	Dağıtılacak panoların listesi
dataflows	DeployArtifactRequest[]	Dağıtılacak veri akışlarının listesi
datamarts	DeployArtifactRequest[]	Dağıtılacak datamart'ların listesi
datasets	DeployArtifactRequest[]	Dağıtılacak veri kümelerinin listesi
isBackwardDeployment	boolean	Dağıtımın dağıtım işlem hattının sonraki bir aşamasından önceki bir aşamaya kadar olup olmayacağı. `false` varsayılan değerdir.
newWorkspace	PipelineNewWorkspaceRequest	Yeni çalışma alanı oluşturmaya yönelik yapılandırma ayrıntıları. Atanmış çalışma alanı olmayan bir aşamaya dağıtım yaparken gereklidir. Gerektiğinde yeni çalışma alanı yapılandırma ayrıntıları sağlanmazsa dağıtım başarısız olur.
note	string	Dağıtımı açıklayan bir not.
options	DeploymentOptions	Tüm dağıtımın davranışını denetleyebilen seçenekler
reports	DeployArtifactRequest[]	Dağıtılacak raporların listesi
sourceStageOrder	integer	İçeriğin dağıtılması gereken işlem hattı dağıtım aşamasının sayısal tanımlayıcısı. Geliştirme (0), Test (1), Üretim (2).
updateAppSettings	PipelineUpdateAppSettings	Hedef çalışma alanı ayarlarında kuruluş uygulamasını güncelleştirme

Pipelines - Selective Deploy

İzinler

Gerekli Kapsam

Sınırlamalar

URI Parametreleri

İstek Gövdesi

Yanıtlar

Örnekler

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

Sample Request

Sample Response

Example of deploying specific Power BI items with custom options

Sample Request

Sample Response

Tanımlar

DeployArtifactRequest

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentOptions

DeploymentSourceAndTarget

DeploymentStepType

PipelineNewWorkspaceRequest

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PipelineUpdateAppSettings

PreDeploymentDiffInformation

PrincipalType

SelectiveDeployRequest

Ek kaynaklar