Deployment Pipelines - Deploy Stage Content

Služba:: Core

Verzia rozhrania API:: v1

Nasadzuje položky zo zadanej fázy zadaného kanála nasadenia.
Ďalšie informácie o položkách, ktoré sú podporované v kanáloch nasadenia, nájdete v téme Podporované položky.

Toto rozhranie API podporuje dlhotrvajúce operácie (LRO).

Povolenia

Volajúci musí mať rolu kanálov nasadenia správcu . Používateľ musí byť aspoň prispievateľom do zdrojových aj cieľových pracovných priestorov nasadenia. Ďalšie informácie nájdete v téme: Povolenia.

Povinné delegované rozsahy

Pipeline.Deploy

Obmedzenia

Maximálne 300 nasadených položiek na požiadavku.

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita	Podpora
Používateľ	Áno
Objekt služby a spravované identity	Podporované len v prípade, že všetky položky, ktoré sú súčasťou operácie, podporujú objekty služby

Rozhranie

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/deploy

Parametre URI

Name	V	Povinné	Typ	Description
deploymentPipelineId	path	True	string (uuid)	ID kanála nasadenia.

Text požiadavky

Name	Povinné	Typ	Description
sourceStageId	True	string (uuid)	ID zdrojovej fázy.
targetStageId	True	string (uuid)	ID cieľovej fázy.
createdWorkspaceDetails		DeploymentPipelineNewWorkspaceConfiguration	Podrobnosti konfigurácie na vytvorenie nového pracovného priestoru. Vyžaduje sa pri nasadzovaní do fázy, ktorá nemá priradené pracovné priestory, v opačnom prípade sa ignoruje. Nasadenie zlyhá, ak sa v prípade potreby neposkytnú nové podrobnosti o konfigurácii pracovného priestoru.
items		ItemDeploymentRequest[]	Zoznam položiek, ktoré sa majú nasadiť. Ak sa nepoužijú, nasadia sa všetky podporované položky fázy.
note		string maxLength: 1024	Poznámka popisujúca nasadenie. Veľkosť textu je obmedzená na 1 024 znakov.
options		DeploymentOptions	Možnosti nasadenia, ktoré riadia správanie nasadenia.

Odpovede

Name	Typ	Description
200 OK	DeploymentPipelineOperationExtendedInfo	Požiadavka sa úspešne dokončila.
202 Accepted		Žiadosť prijatá, nasadenie prebieha. Hlavičky Location: string x-ms-operation-id: string deployment-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Bežné kódy chýb: UnknownError – vyskytla sa chyba. PrincipalTypeNotSupported – Typ identity volajúceho nie je podporovaný.

Name

Typ

Description

200 OK

DeploymentPipelineOperationExtendedInfo

Požiadavka sa úspešne dokončila.

202 Accepted

Žiadosť prijatá, nasadenie prebieha.

Hlavičky

Location: string
x-ms-operation-id: string
deployment-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Bežné kódy chýb:

UnknownError – vyskytla sa chyba.
PrincipalTypeNotSupported – Typ identity volajúceho nie je podporovaný.

Príklady

Example of deploying all Fabric items (such as reports or dashboards) from a deployment pipeline stage

Example of deploying specific Fabric items (such as reports or dashboards) from a deployment pipeline stage

Example of deploying all Fabric items (such as reports or dashboards) from a deployment pipeline stage

Vzorová požiadavka

HTTP

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deploy

{
  "sourceStageId": "db1577e0-0132-4d6d-92b9-952c359988f2",
  "targetStageId": "f1c39546-6282-4590-8af3-847a6226ad16",
  "note": "Deploying business ready items"
}

Vzorová odpoveď

Kód stavu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
deployment-id: 1065e6a3-a020-4c0c-ada7-92b5fe99eec5
Retry-After: 30

Example of deploying specific Fabric items (such as reports or dashboards) from a deployment pipeline stage

Vzorová požiadavka

HTTP

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deploy

{
  "sourceStageId": "db1577e0-0132-4d6d-92b9-952c359988f2",
  "targetStageId": "f1c39546-6282-4590-8af3-847a6226ad16",
  "items": [
    {
      "sourceItemId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
      "itemType": "Datamart"
    },
    {
      "sourceItemId": "1a201f2a-d1d8-45c0-8c61-1676338517de",
      "itemType": "SemanticModel"
    },
    {
      "sourceItemId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
      "itemType": "Report"
    },
    {
      "sourceItemId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
      "itemType": "Dashboard"
    },
    {
      "sourceItemId": "7f08923c-8f57-49d6-a010-8335bb9cbd1b",
      "itemType": "Dashboard"
    }
  ],
  "note": "Deploying business ready items"
}

Vzorová odpoveď

Kód stavu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
deployment-id: 1065e6a3-a020-4c0c-ada7-92b5fe99eec5
Retry-After: 30

Definície

Name	Description
DeploymentExecutionPlan	Plán vykonávania nasadenia.
DeploymentExecutionStep	Krok vykonávania nasadenia.
DeploymentOptions	Možnosti konfigurácie nasadenia pre nasadenie.
DeploymentPipelineNewWorkspaceConfiguration	Podrobnosti konfigurácie na vytvorenie nového pracovného priestoru. Vyžaduje sa pri nasadzovaní do fázy, ktorá nemá priradené pracovné priestory.
DeploymentPipelineOperationExtendedInfo	Operácia kanála nasadenia služby Fabric.
DeploymentPipelineOperationNote	Poznámka popisujúca nasadenie.
DeploymentPipelineOperationStatus	Stav operácie kanála nasadenia. Ďalšie stavy sa môžu pridať v priebehu času.
DeploymentPipelineOperationType	Typ operácie. V priebehu času je možné pridať ďalšie typy.
DeploymentSourceAndTarget	Zdrojové a cieľové položky.
DeployRequest	Žiadosť o nasadenie položiek z fázy kanála nasadenia do ďalšej po sebe idúcej fázy. Nasadenie do predchádzajúcej fázy sa môže vykonať iba vtedy, keď je cieľová fáza prázdna. Ak neboli zadané žiadne položky, nasadia sa všetky podporované položky z fázy kanála nasadenia, v opačnom prípade sa nasadia iba zadané položky.
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
GroupDetails	Podrobnosti špecifické pre skupinu. Platí, ak je `Group`typ objektu .
GroupType	Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.
ItemDeploymentRequest	Žiadosť o nasadenie položky služby Fabric (napríklad zostavy alebo tabule).
ItemPreDeploymentDiffState	Určuje, či je položka nová, odlišná alebo identická s položkami v cieľovej fáze pred nasadením. V priebehu času je možné pridať ďalšie štáty.
ItemType	Typ položky. V priebehu času je možné pridať ďalšie typy položiek.
PreDeploymentDiffInformation	Počet nových, rôznych a identických nasadených položiek pred nasadením.
Principal	Predstavuje identitu alebo skupinu Microsoft Entra.
PrincipalType	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
ServicePrincipalDetails	Konkrétne podrobnosti objektu služby. Platí, ak je `ServicePrincipal`typ objektu .
ServicePrincipalProfileDetails	Podrobnosti o profile objektu služby. Platí, ak je `ServicePrincipalProfile`typ objektu .
UserDetails	Konkrétne podrobnosti o objekte používateľa. Platí, ak je `User`typ objektu .

DeploymentExecutionPlan

Object

Plán vykonávania nasadenia.

Name	Typ	Description
steps	DeploymentExecutionStep[]	Kolekcia krokov plánu vykonávania.

DeploymentExecutionStep

Object

Krok vykonávania nasadenia.

Name	Typ	Description
description	string	Popis kroku nasadenia.
error	ErrorResponse	Podrobnosti o chybe. Platí len v prípade neúspešnej operácie kanála nasadenia.
index	integer	Index krokov.
preDeploymentDiffState	ItemPreDeploymentDiffState	Je nová položka, iná alebo identická s položkami v cieľovej fáze pred nasadením.
sourceAndTarget	DeploymentSourceAndTarget	Zdrojové a cieľové položky kroku.
status	DeploymentPipelineOperationStatus	Stav operácie kanála nasadenia. Ďalšie stavy sa môžu pridať v priebehu času.

DeploymentOptions

Object

Možnosti konfigurácie nasadenia pre nasadenie.

Name	Typ	Description
allowCrossRegionDeployment	boolean	Udáva, či je povolené nasadenie medzi oblasťami. True – povolené, False – zakázané. Predvolená hodnota je nepravda.

DeploymentPipelineNewWorkspaceConfiguration

Object

Podrobnosti konfigurácie na vytvorenie nového pracovného priestoru. Vyžaduje sa pri nasadzovaní do fázy, ktorá nemá priradené pracovné priestory.

Name	Typ	Description
capacityId	string (uuid)	ID kapacity, ku ktorému bude priradený nový pracovný priestor. Ak nie je táto hodnota zadaná a volajúci rozhrania API má povolenia pre kapacitu pracovného priestoru zdrojovej fázy, táto kapacita sa použije. V opačnom prípade fabric vyberie kapacitu, pre ktorú má volajúci rozhrania API povolenia.
name	string maxLength: 256	Názov nového pracovného priestoru. Zobrazovaný názov nemôže obsahovať viac ako 256 znakov.

DeploymentPipelineOperationExtendedInfo

Object

Operácia kanála nasadenia služby Fabric.

Name	Typ	Description
executionEndTime	string (date-time)	Dátum a čas ukončenia operácie.
executionPlan	DeploymentExecutionPlan	Plán vykonávania nasadenia.
executionStartTime	string (date-time)	Dátum a čas začatia operácie.
id	string (uuid)	ID operácie.
lastUpdatedTime	string (date-time)	Dátum a čas poslednej aktualizácie operácie.
note	DeploymentPipelineOperationNote	Poznámka predstavujúca popis operácie.
performedBy	Principal	Objekt, ktorý vykonal operáciu kanála nasadenia.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Počet nasadených položiek v zdrojovej fáze, ktoré sú nové, identické alebo odlišné od položiek v cieľovej fáze pred nasadením.
sourceStageId	string (uuid)	ID fázy kanála nasadenia zdroja.
status	DeploymentPipelineOperationStatus	Stav operácie kanála nasadenia. Ďalšie stavy sa môžu pridať v priebehu času.
targetStageId	string (uuid)	ID cieľovej fázy kanála nasadenia.
type	DeploymentPipelineOperationType	Typ operácie. V priebehu času je možné pridať ďalšie typy.

DeploymentPipelineOperationNote

Object

Poznámka popisujúca nasadenie.

Name	Typ	Description
content	string	Text s popisom nasadenia.
isTruncated	boolean	Udáva, či sa obsah poznámky skráti. Pravda – obsah poznámky sa skráti, nepravda – obsah poznámky sa neskracuje. Predvolená hodnota je nepravda.

DeploymentPipelineOperationStatus

Enumerácia

Stav operácie kanála nasadenia. Ďalšie stavy sa môžu pridať v priebehu času.

Hodnota	Description
NotStarted	Operácia nebola spustená
Running	Spustená operácia
Succeeded	Úspešná operácia
Failed	Operácia zlyhala

DeploymentPipelineOperationType

Enumerácia

Typ operácie. V priebehu času je možné pridať ďalšie typy.

Hodnota	Description
Deploy	Nasadenie obsahu medzi fázami.

DeploymentSourceAndTarget

Object

Zdrojové a cieľové položky.

Name	Typ	Description
itemType	ItemType	Typ položky služby Fabric, ktorá sa prepíše v cieľovej fáze. Vzťahuje sa len na prepisovanie položky služby Fabric.
sourceItemDisplayName	string	Zobrazovaný názov položky služby Fabric, ktorá je nasadená zo zdrojovej fázy.
sourceItemId	string (uuid)	ID položky služby Fabric, ktorá je nasadená zo zdrojovej fázy.
targetItemDisplayName	string	Názov položky služby Fabric, ktorá sa prepíše v cieľovej fáze. Vzťahuje sa len na prepisovanie položky služby Fabric.
targetItemId	string (uuid)	ID položky služby Fabric, ktorá sa prepíše v cieľovej fáze. Vzťahuje sa len na prepisovanie položky služby Fabric.

DeployRequest

Object

Žiadosť o nasadenie položiek z fázy kanála nasadenia do ďalšej po sebe idúcej fázy. Nasadenie do predchádzajúcej fázy sa môže vykonať iba vtedy, keď je cieľová fáza prázdna. Ak neboli zadané žiadne položky, nasadia sa všetky podporované položky z fázy kanála nasadenia, v opačnom prípade sa nasadia iba zadané položky.

Name	Typ	Description
createdWorkspaceDetails	DeploymentPipelineNewWorkspaceConfiguration	Podrobnosti konfigurácie na vytvorenie nového pracovného priestoru. Vyžaduje sa pri nasadzovaní do fázy, ktorá nemá priradené pracovné priestory, v opačnom prípade sa ignoruje. Nasadenie zlyhá, ak sa v prípade potreby neposkytnú nové podrobnosti o konfigurácii pracovného priestoru.
items	ItemDeploymentRequest[]	Zoznam položiek, ktoré sa majú nasadiť. Ak sa nepoužijú, nasadia sa všetky podporované položky fázy.
note	string maxLength: 1024	Poznámka popisujúca nasadenie. Veľkosť textu je obmedzená na 1 024 znakov.
options	DeploymentOptions	Možnosti nasadenia, ktoré riadia správanie nasadenia.
sourceStageId	string (uuid)	ID zdrojovej fázy.
targetStageId	string (uuid)	ID cieľovej fázy.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

GroupDetails

Object

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .

Name	Typ	Description
groupType	GroupType	Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

GroupType

Enumerácia

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

Hodnota	Description
Unknown	Typ hlavnej skupiny nie je známy.
SecurityGroup	Principal je skupina zabezpečenia.
DistributionList	Principal je distribučný zoznam.

ItemDeploymentRequest

Object

Žiadosť o nasadenie položky služby Fabric (napríklad zostavy alebo tabule).

Name	Typ	Description
itemType	ItemType	Typ položky služby Fabric.
sourceItemId	string (uuid)	ID položky služby Fabric, ktorá sa má nasadiť.

ItemPreDeploymentDiffState

Enumerácia

Určuje, či je položka nová, odlišná alebo identická s položkami v cieľovej fáze pred nasadením. V priebehu času je možné pridať ďalšie štáty.

Hodnota	Description
New	Nová nasadená položka, ktorá v cieľovej fáze neexistuje.
Different	Pred nasadením nebola položka v zdrojovej fáze identická s tou v cieľovej fáze.
NoDifference	Pred nasadením bola položka v zdrojovej fáze identická s položkou v cieľovej fáze.

ItemType

Enumerácia

Typ položky. V priebehu času je možné pridať ďalšie typy položiek.

Hodnota	Description
Dashboard	Tabuľa služby PowerBI.
Report	Zostava PowerBI.
SemanticModel	Sémantický model PowerBI.
PaginatedReport	Stránkovaná zostava služby PowerBI.
Datamart	Údajový diagram služby PowerBI.
Lakehouse	Jazero.
Eventhouse	Eventhouse.
Environment	Prostredie.
KQLDatabase	Databáza KQL.
KQLQueryset	Množina dotazov KQL.
KQLDashboard	Tabuľa KQL.
DataPipeline	Kanál údajov.
Notebook	Poznámkový blok.
SparkJobDefinition	Definícia úlohy iskry.
MLExperiment	Experiment strojového učenia.
MLModel	Model strojového učenia.
Warehouse	Sklad.
Eventstream	Udalosť eventstream.
SQLEndpoint	Koncový bod SQL.
MirroredWarehouse	Zrkadlový sklad.
MirroredDatabase	Zrkadlová databáza.
Reflex	A Reflex.
GraphQLApi	Rozhranie API pre položku GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Databáza SQLDatabase.
CopyJob	Kopírovať úlohu.
VariableLibrary	A VariableLibrary.
Dataflow	Tok údajov.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Snímka skladu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digitálny postup Twin Buildera.
MirroredAzureDatabricksCatalog	Zrkadlový katalóg Azure databricks.
Map	Mapa.
AnomalyDetector	Detektor anomálií.
UserDataFunction	Funkcia user data function.
GraphModel	A GraphModel.
GraphQuerySet	Množina dotazov Graphu.

PreDeploymentDiffInformation

Object

Počet nových, rôznych a identických nasadených položiek pred nasadením.

Name	Typ	Description
differentItemsCount	integer	Počet nasadených položiek s rozdielmi medzi zdrojovou a cieľovou fázou pred nasadením.
newItemsCount	integer	Počet nových položiek nasadených do cieľovej fázy.
noDifferenceItemsCount	integer	Počet identických nasadených položiek v zdrojovej a cieľovej fáze pred nasadením.

Principal

Object

Predstavuje identitu alebo skupinu Microsoft Entra.

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
groupDetails	GroupDetails	Podrobnosti špecifické pre skupinu. Platí, ak je `Group`typ objektu .
id	string (uuid)	ID objektu.
servicePrincipalDetails	ServicePrincipalDetails	Konkrétne podrobnosti objektu služby. Platí, ak je `ServicePrincipal`typ objektu .
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Podrobnosti o profile objektu služby. Platí, ak je `ServicePrincipalProfile`typ objektu .
type	PrincipalType	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
userDetails	UserDetails	Konkrétne podrobnosti o objekte používateľa. Platí, ak je `User`typ objektu .

PrincipalType

Enumerácia

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

Hodnota	Description
User	Principal je objekt používateľa služby Microsoft Entra.
ServicePrincipal	Principal je objekt služby Microsoft Entra.
Group	Principal je skupina zabezpečenia.
ServicePrincipalProfile	Principal je profil objektu služby.
EntireTenant	Možnosť Principal predstavuje všetkých používateľov nájomníka.

ServicePrincipalDetails

Object

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .

Name	Typ	Description
aadAppId	string (uuid)	Microsoft Entra AppId objektu služby.

ServicePrincipalProfileDetails

Object

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .

Name	Typ	Description
parentPrincipal	Principal	Nadradený objekt profilu služby.

UserDetails

Object

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .

Name	Typ	Description
userPrincipalName	string	Hlavné meno používateľa.

Zdieľať cez

Deployment Pipelines - Deploy Stage Content

Povolenia

Povinné delegované rozsahy

Obmedzenia

Podporované identity v aplikácii Microsoft Entra

Rozhranie

Parametre URI

Text požiadavky

Odpovede

Príklady

Example of deploying all Fabric items (such as reports or dashboards) from a deployment pipeline stage

Vzorová požiadavka

Vzorová odpoveď

Example of deploying specific Fabric items (such as reports or dashboards) from a deployment pipeline stage

Vzorová požiadavka

Vzorová odpoveď

Definície

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentOptions

DeploymentPipelineNewWorkspaceConfiguration

DeploymentPipelineOperationExtendedInfo

DeploymentPipelineOperationNote

DeploymentPipelineOperationStatus

DeploymentPipelineOperationType

DeploymentSourceAndTarget

DeployRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemDeploymentRequest

ItemPreDeploymentDiffState

ItemType

PreDeploymentDiffInformation

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails