Deployment Pipelines - Get Deployment Pipeline Operation

Service:: Core

API-versie:: v1

Retourneert de details van de opgegeven implementatiebewerking die wordt uitgevoerd op de opgegeven implementatiepijplijn, inclusief het implementatieuitvoeringsplan.

Machtigingen

De aanroeper moet de rol pijplijnen voor beheerdersimplementatie hebben.

Vereiste gedelegeerde bereiken

Pipeline.Read.All of Pipeline.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/operations/{operationId}

URI-parameters

Name	In	Vereist	Type	Description
deploymentPipelineId	path	True	string (uuid)	De implementatiepijplijn-id.
operationId	path	True	string (uuid)	De bewerkings-id.

Antwoorden

Name Type Description

200 OK

Name	Type	Description
200 OK	DeploymentPipelineOperationExtendedInfo	De aanvraag is voltooid.
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError - Er is een fout opgetreden

DeploymentPipelineOperationExtendedInfo

De aanvraag is voltooid.

429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

UnknownError - Er is een fout opgetreden

Voorbeelden

Get a deployment pipeline operation example

Voorbeeldaanvraag

HTTP

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations/1065e6a3-a020-4c0c-ada7-92b5fe99eec5

Voorbeeldrespons

Statuscode:: 200

{
  "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
  "type": "Deploy",
  "status": "Succeeded",
  "lastUpdatedTime": "2020-12-13T09:26:43.153",
  "executionStartTime": "2020-12-13T09:25:43.153Z",
  "executionEndTime": "2020-12-13T09:26:43.153Z",
  "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
  "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
  "executionPlan": {
    "steps": [
      {
        "index": 0,
        "description": "DataflowDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "29efcfb0-0063-44af-a4ed-6c0bee3417d3",
          "sourceItemDisplayName": "Source dataflow",
          "itemType": "Dataflow"
        }
      },
      {
        "index": 1,
        "description": "DatamartDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "645cd81f-1b21-4006-82b6-54cc7ec0352e",
          "sourceItemDisplayName": "Source datamart",
          "itemType": "Datamart"
        }
      },
      {
        "index": 2,
        "description": "DatasetDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "NoDifference",
        "sourceAndTarget": {
          "sourceItemId": "1a201f2a-d1d8-45c0-8c61-1676338517de",
          "sourceItemDisplayName": "Source dataset",
          "targetItemId": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
          "targetItemDisplayName": "Target dataset",
          "itemType": "SemanticModel"
        }
      },
      {
        "index": 3,
        "description": "ReportDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "Different",
        "sourceAndTarget": {
          "sourceItemId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
          "sourceItemDisplayName": "Source report",
          "targetItemId": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
          "targetItemDisplayName": "Target report",
          "itemType": "Report"
        }
      },
      {
        "index": 4,
        "description": "DashboardDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
          "sourceItemDisplayName": "Source dashboard",
          "itemType": "Dashboard"
        }
      }
    ]
  },
  "note": {
    "content": "Sample note"
  },
  "preDeploymentDiffInformation": {
    "newItemsCount": 3,
    "differentItemsCount": 1,
    "noDifferenceItemsCount": 1
  },
  "performedBy": {
    "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
    "type": "User"
  }
}

Definities

Name	Description
DeploymentExecutionPlan	Een implementatieuitvoeringsplan.
DeploymentExecutionStep	Een implementatieuitvoeringsstap.
DeploymentPipelineOperationExtendedInfo	Een infrastructuurimplementatiepijplijnbewerking.
DeploymentPipelineOperationNote	Een opmerking waarin de implementatie wordt beschreven.
DeploymentPipelineOperationStatus	De status van de implementatiepijplijnbewerking. Er kunnen na verloop van tijd extra statussen worden toegevoegd.
DeploymentPipelineOperationType	Het bewerkingstype. Er kunnen in de loop van de tijd extra typen worden toegevoegd.
DeploymentSourceAndTarget	Bron- en doelitems.
EntireTenantPrincipal	Vertegenwoordigt een tenant-principal
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
GroupDetails	Groepsspecifieke details. Van toepassing wanneer het principal-type is `Group`.
GroupPrincipal	Vertegenwoordigt een beveiligingsgroep.
GroupType	Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.
ItemPreDeploymentDiffState	Hiermee geeft u op of een item nieuw, anders of identiek is aan items in de doelfase vóór de implementatie. Er kunnen na verloop van tijd extra statussen worden toegevoegd.
ItemType	Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.
PreDeploymentDiffInformation	Het aantal nieuwe, verschillende en identieke geïmplementeerde items vóór de implementatie.
PrincipalType	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
ServicePrincipalDetails	Specifieke details van de service-principal. Van toepassing wanneer het principal-type is `ServicePrincipal`.
ServicePrincipalPrincipal	Vertegenwoordigt een Microsoft Entra-service-principal.
ServicePrincipalProfileDetails	Details van service-principalprofiel. Van toepassing wanneer het principal-type is `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Vertegenwoordigt een service-principalprofiel.
UserDetails	Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is `User`.
UserPrincipal	Vertegenwoordigt een Microsoft Entra-gebruikersprincipaal.

DeploymentExecutionPlan

Object

Een implementatieuitvoeringsplan.

Name	Type	Description
steps	DeploymentExecutionStep[]	De verzameling stappen voor het uitvoeringsplan.

DeploymentExecutionStep

Object

Een implementatieuitvoeringsstap.

Name	Type	Description
description	string	De beschrijving van de implementatiestap.
error	ErrorResponse	De foutdetails. Alleen van toepassing als de implementatiepijplijnbewerking is mislukt.
index	integer	De stapindex.
preDeploymentDiffState	ItemPreDeploymentDiffState	Is een item nieuw, anders dan of identiek aan items in de doelfase vóór de implementatie.
sourceAndTarget	DeploymentSourceAndTarget	De bron- en doelitems van de stap.
status	DeploymentPipelineOperationStatus	De status van de implementatiepijplijnbewerking. Er kunnen na verloop van tijd extra statussen worden toegevoegd.

DeploymentPipelineOperationExtendedInfo

Object

Een infrastructuurimplementatiepijplijnbewerking.

Name	Type	Description
executionEndTime	string (date-time)	De datum en tijd waarop de bewerking is beëindigd.
executionPlan	DeploymentExecutionPlan	Het implementatieuitvoeringsplan.
executionStartTime	string (date-time)	De datum en tijd waarop de bewerking is gestart.
id	string (uuid)	De bewerkings-id.
lastUpdatedTime	string (date-time)	De datum en tijd waarop de bewerking het laatst is bijgewerkt.
note	DeploymentPipelineOperationNote	Een notitie die een beschrijving van de bewerking aangeeft.
performedBy	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	De principal die de implementatiepijplijnbewerking heeft uitgevoerd.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Het aantal geïmplementeerde items in de bronfase, dat nieuw, identiek of anders is aan items in de doelfase, vóór de implementatie.
sourceStageId	string (uuid)	De id van een pijplijnfase voor de bronimplementatie.
status	DeploymentPipelineOperationStatus	De bewerkingsstatus van de implementatiepijplijn. Er kunnen na verloop van tijd extra statussen worden toegevoegd.
targetStageId	string (uuid)	De id van een pijplijnfase voor de doelimplementatie.
type	DeploymentPipelineOperationType	Het bewerkingstype. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

DeploymentPipelineOperationNote

Object

Een opmerking waarin de implementatie wordt beschreven.

Name	Type	Description
content	string	Tekst met een beschrijving van de implementatie.
isTruncated	boolean	Geeft aan of de notitie-inhoud is afgekapt. Waar- de inhoud van de notitie is afgekapt, Onwaar - de inhoud van de notitie wordt niet afgekapt. De standaardwaarde is onwaar.

DeploymentPipelineOperationStatus

Opsomming

De status van de implementatiepijplijnbewerking. Er kunnen na verloop van tijd extra statussen worden toegevoegd.

Waarde	Description
NotStarted	De implementatiepijplijnbewerking is niet gestart.
Running	De implementatiepijplijnbewerking wordt uitgevoerd.
Succeeded	De implementatiepijplijnbewerking is voltooid.
Failed	De implementatiepijplijnbewerking is mislukt.

DeploymentPipelineOperationType

Opsomming

Het bewerkingstype. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

Waarde	Description
Deploy	Inhoud tussen fasen implementeren.

DeploymentSourceAndTarget

Object

Bron- en doelitems.

Name	Type	Description
itemType	ItemType	Het type fabric-item dat wordt overschreven in de doelfase. Alleen van toepassing bij het overschrijven van een Fabric-item.
sourceItemDisplayName	string	De weergavenaam van het Fabric-item dat is geïmplementeerd vanuit de bronfase.
sourceItemId	string (uuid)	De id van het Fabric-item dat is geïmplementeerd vanuit de bronfase.
targetItemDisplayName	string	De naam van het fabric-item dat wordt overschreven in de doelfase. Alleen van toepassing bij het overschrijven van een Fabric-item.
targetItemId	string (uuid)	De id van het fabric-item dat in de doelfase wordt overschreven. Alleen van toepassing bij het overschrijven van een Fabric-item.

EntireTenantPrincipal

Object

Vertegenwoordigt een tenant-principal

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
type	string: EntireTenant	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

GroupDetails

Object

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.

Name	Type	Description
groupType	GroupType	Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

GroupPrincipal

Object

Vertegenwoordigt een beveiligingsgroep.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
groupDetails	GroupDetails	Groepsspecifieke details. Van toepassing wanneer het principal-type is `Group`.
id	string (uuid)	De id van de principal.
type	string: Group	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

GroupType

Opsomming

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

Waarde	Description
Unknown	Het type Principal-groep is onbekend.
SecurityGroup	Principal is een beveiligingsgroep.
DistributionList	Principal is een distributielijst.

ItemPreDeploymentDiffState

Opsomming

Hiermee geeft u op of een item nieuw, anders of identiek is aan items in de doelfase vóór de implementatie. Er kunnen na verloop van tijd extra statussen worden toegevoegd.

Waarde	Description
New	Een nieuw geïmplementeerd item dat niet bestaat in de doelfase.
Different	Vóór de implementatie was het item in de bronfase niet identiek aan het item in de doelfase.
NoDifference	Vóór de implementatie was het item in de bronfase identiek aan het item in de doelfase.

ItemType

Opsomming

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde	Description
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisch Power BI-model.
PaginatedReport	Gepagineerd Power BI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Een lakehouse.
Eventhouse	Een eventhouse.
Environment	Een omgeving.
KQLDatabase	Een KQL-database.
KQLQueryset	Een KQL-queryset.
KQLDashboard	Een KQL-dashboard.
DataPipeline	Een gegevenspijplijn.
Notebook	Een notitieblok.
SparkJobDefinition	Een Spark-taakdefinitie.
MLExperiment	Een machine learning-experiment.
MLModel	Een machine learning-model.
Warehouse	Een magazijn.
Eventstream	Een eventstream.
SQLEndpoint	Een SQL-eindpunt.
MirroredWarehouse	Een gespiegeld magazijn.
MirroredDatabase	Een gespiegelde database.
Reflex	Een reflex.
GraphQLApi	Een API voor GraphQL-item.
MountedDataFactory	Een MountedDataFactory.
SQLDatabase	Een SQLDatabase.
CopyJob	Een kopieertaak.
VariableLibrary	Een VariableLibrary.
Dataflow	Een gegevensstroom.
ApacheAirflowJob	Een ApacheAirflowJob.
WarehouseSnapshot	Een momentopname van een magazijn.
DigitalTwinBuilder	Een DigitalTwinBuilder.
DigitalTwinBuilderFlow	Een Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Een gespiegelde Azure Databricks-catalogus.
Map	Een kaart.
AnomalyDetector	Een Anomaly Detector.
UserDataFunction	Een gebruikersgegevensfunctie.
GraphModel	Een GraphModel.
GraphQuerySet	Een Graph QuerySet.
SnowflakeDatabase	Een Snowflake-database voor het opslaan van Iceberg-tabellen die zijn gemaakt op basis van het Snowflake-account.
OperationsAgent	Een OperationsAgent.
CosmosDBDatabase	Een Cosmos DB-database.
Ontology	Een Ontologie.
EventSchemaSet	Een EventSchemaSet.
DataAgent	Een DataAgent.
MirroredCatalog	Een mirroredCatalog.

PreDeploymentDiffInformation

Object

Het aantal nieuwe, verschillende en identieke geïmplementeerde items vóór de implementatie.

Name	Type	Description
differentItemsCount	integer	Het aantal geïmplementeerde items met verschillen tussen bron- en doelfasen, vóór de implementatie.
newItemsCount	integer	Het aantal nieuwe items dat is geïmplementeerd in de doelfase.
noDifferenceItemsCount	integer	Het aantal identieke geïmplementeerde items in de bron- en doelfasen vóór de implementatie.

PrincipalType

Opsomming

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

Waarde	Description
User	Principal is een Microsoft Entra-gebruikersprincipaal.
ServicePrincipal	Principal is een Microsoft Entra-service-principal.
Group	Principal is een beveiligingsgroep.
ServicePrincipalProfile	Principal is een service-principalprofiel.
EntireTenant	Principal vertegenwoordigt alle tenantgebruikers.

ServicePrincipalDetails

Object

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.

Name	Type	Description
aadAppId	string (uuid)	De Microsoft Entra AppId van de service-principal.

ServicePrincipalPrincipal

Object

Vertegenwoordigt een Microsoft Entra-service-principal.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
servicePrincipalDetails	ServicePrincipalDetails	Specifieke details van de service-principal. Van toepassing wanneer het principal-type is `ServicePrincipal`.
type	string: ServicePrincipal	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

ServicePrincipalProfileDetails

Object

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.

Name	Type	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	De bovenliggende principal van het service-principalprofiel.

ServicePrincipalProfilePrincipal

Object

Vertegenwoordigt een service-principalprofiel.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Details van service-principalprofiel. Van toepassing wanneer het principal-type is `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

UserDetails

Object

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

Name	Type	Description
userPrincipalName	string	De principal-naam van de gebruiker.

UserPrincipal

Object

Vertegenwoordigt een Microsoft Entra-gebruikersprincipaal.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
type	string: User	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
userDetails	UserDetails	Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is `User`.