Deployment Pipelines - Get Deployment Pipeline Operation

Tjänst:: Core

API-version:: v1

Returnerar information om den angivna distributionsåtgärden som utförs på den angivna distributionspipelinen, inklusive distributionskörningsplanen.

Behörigheter

Anroparen måste ha rollen pipelines för administratörsdistribution .

Obligatoriska delegerade omfång

Pipeline.Read.All eller Pipeline.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
deploymentPipelineId	path	True	string (uuid)	Distributionspipeline-ID:t.
operationId	path	True	string (uuid)	Åtgärds-ID:t.

Svar

Name	Typ	Description
200 OK	DeploymentPipelineOperationExtendedInfo	Begäran har slutförts.
Other Status Codes	ErrorResponse	Vanliga felkoder: UnknownError – ett fel uppstod

Name

Typ

Description

200 OK

DeploymentPipelineOperationExtendedInfo

Begäran har slutförts.

Other Status Codes

ErrorResponse

Vanliga felkoder:

UnknownError – ett fel uppstod

Exempel

Get a deployment pipeline operation example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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"
  }
}

Definitioner

Name	Description
DeploymentExecutionPlan	En distributionskörningsplan.
DeploymentExecutionStep	Ett distributionskörningssteg.
DeploymentPipelineOperationExtendedInfo	En pipelineåtgärd för infrastrukturdistribution.
DeploymentPipelineOperationNote	En anteckning som beskriver distributionen.
DeploymentPipelineOperationStatus	Status för distributionspipelinens åtgärd. Ytterligare statusar kan läggas till över tid.
DeploymentPipelineOperationType	Åtgärdstypen. Ytterligare typer kan läggas till över tid.
DeploymentSourceAndTarget	Käll- och målobjekt.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.
ItemPreDeploymentDiffState	Anger om ett objekt är nytt, annorlunda eller identiskt med objekt i målfasen före distributionen. Ytterligare tillstånd kan läggas till över tid.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
PreDeploymentDiffInformation	Antalet nya, olika och identiska distribuerade objekt före distributionen.
Principal	Representerar en identitet eller en Microsoft Entra-grupp.
PrincipalType	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.

DeploymentExecutionPlan

Objekt

En distributionskörningsplan.

Name	Typ	Description
steps	DeploymentExecutionStep[]	Samlingen med körningsplansteg.

DeploymentExecutionStep

Objekt

Ett distributionskörningssteg.

Name	Typ	Description
description	string	Beskrivning av distributionssteget.
error	ErrorResponse	Felinformationen. Gäller endast om distributionspipelineåtgärden misslyckades.
index	integer	Stegindexet.
preDeploymentDiffState	ItemPreDeploymentDiffState	Är ett nytt objekt, annorlunda eller identiskt med objekt i målfasen före distributionen.
sourceAndTarget	DeploymentSourceAndTarget	Stegens käll- och målobjekt.
status	DeploymentPipelineOperationStatus	Status för distributionspipelineåtgärden. Ytterligare statusar kan läggas till över tid.

DeploymentPipelineOperationExtendedInfo

Objekt

En pipelineåtgärd för infrastrukturdistribution.

Name	Typ	Description
executionEndTime	string (date-time)	Datum och tid då åtgärden avslutades.
executionPlan	DeploymentExecutionPlan	Distributionskörningsplanen.
executionStartTime	string (date-time)	Datum och tid då åtgärden startade.
id	string (uuid)	Åtgärds-ID:t.
lastUpdatedTime	string (date-time)	Datum och tid då åtgärden senast uppdaterades.
note	DeploymentPipelineOperationNote	En anteckning som representerar en beskrivning av åtgärden.
performedBy	Principal	Det huvudnamn som utförde distributionspipelineåtgärden.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Antalet distribuerade objekt i källsteget, som är nya, identiska eller skiljer sig från objekt i målfasen, före distributionen.
sourceStageId	string (uuid)	ID för en pipelinefas för källdistribution.
status	DeploymentPipelineOperationStatus	Status för distributionspipelinens åtgärd. Ytterligare statusar kan läggas till över tid.
targetStageId	string (uuid)	ID:t för en pipelinefas för måldistribution.
type	DeploymentPipelineOperationType	Åtgärdstypen. Ytterligare typer kan läggas till över tid.

DeploymentPipelineOperationNote

Objekt

En anteckning som beskriver distributionen.

Name	Typ	Description
content	string	Text som beskriver distributionen.
isTruncated	boolean	Anger om anteckningsinnehållet trunkeras. Sant – anteckningsinnehållet trunkeras, Falskt – anteckningsinnehållet trunkeras inte. Standardvärdet är "falsk".

DeploymentPipelineOperationStatus

Uppräkning

Status för distributionspipelinens åtgärd. Ytterligare statusar kan läggas till över tid.

Värde	Description
NotStarted	Åtgärden har inte startats
Running	Åtgärden körs
Succeeded	Åtgärden har slutförts
Failed	Åtgärden misslyckades

DeploymentPipelineOperationType

Uppräkning

Åtgärdstypen. Ytterligare typer kan läggas till över tid.

Värde	Description
Deploy	Distribuera innehåll mellan faser.

DeploymentSourceAndTarget

Objekt

Käll- och målobjekt.

Name	Typ	Description
itemType	ItemType	Typen av fabric-objekt som ska skrivas över i målfasen. Gäller endast när du skriver över ett fabric-objekt.
sourceItemDisplayName	string	Visningsnamnet för infrastrukturresursobjektet som distribueras från källfasen.
sourceItemId	string (uuid)	ID:t för infrastrukturresursobjektet som distribueras från källfasen.
targetItemDisplayName	string	Namnet på det infrastrukturobjekt som ska skrivas över i målfasen. Gäller endast när du skriver över ett fabric-objekt.
targetItemId	string (uuid)	ID:t för det infrastrukturobjekt som ska skrivas över i målfasen. Gäller endast när du skriver över ett fabric-objekt.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

GroupDetails

Objekt

Gruppera specifik information. Gäller när huvudtypen är Group.

Name	Typ	Description
groupType	GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

GroupType

Uppräkning

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

Värde	Description
Unknown	Huvudgrupptypen är okänd.
SecurityGroup	Huvudnamn är en säkerhetsgrupp.
DistributionList	Huvudnamn är en distributionslista.

ItemPreDeploymentDiffState

Uppräkning

Anger om ett objekt är nytt, annorlunda eller identiskt med objekt i målfasen före distributionen. Ytterligare tillstånd kan läggas till över tid.

Värde	Description
New	Ett nytt distribuerat objekt som inte finns i målfasen.
Different	Före distributionen var objektet i källsteget inte identiskt med det i målfasen.
NoDifference	Före distributionen var objektet i källsteget identiskt med det i målfasen.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
Report	PowerBI-rapport.
SemanticModel	PowerBI-semantisk modell.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Ett sjöhus.
Eventhouse	Ett eventhouse.
Environment	En miljö.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
KQLDashboard	En KQL-instrumentpanel.
DataPipeline	En datapipeline.
Notebook	En notebook-fil.
SparkJobDefinition	En definition för Spark-jobb.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
Warehouse	Ett lager.
Eventstream	En händelseström.
SQLEndpoint	En SQL-slutpunkt.
MirroredWarehouse	Ett speglat lager.
MirroredDatabase	En speglad databas.
Reflex	En reflex.
GraphQLApi	Ett API för GraphQL-objekt.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Ett kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	Ett dataflöde.
ApacheAirflowJob	Ett ApacheAirflowJob.
WarehouseSnapshot	En ögonblicksbild av lagret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ett Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	En speglad azure databricks-katalog.
Map	En karta.
AnomalyDetector	En avvikelseidentifiering.
UserDataFunction	En användardatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	En Graph QuerySet.
SnowflakeDatabase	En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-databas.

PreDeploymentDiffInformation

Objekt

Antalet nya, olika och identiska distribuerade objekt före distributionen.

Name	Typ	Description
differentItemsCount	integer	Antalet distribuerade objekt med skillnader mellan käll- och målfaserna före distributionen.
newItemsCount	integer	Antalet nya objekt som distribuerats till målfasen.
noDifferenceItemsCount	integer	Antalet identiska distribuerade objekt i käll- och målfaserna före distributionen.

Principal

Objekt

Representerar en identitet eller en Microsoft Entra-grupp.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
groupDetails	GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
id	string (uuid)	Huvudmannens ID.
servicePrincipalDetails	ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
type	PrincipalType	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
userDetails	UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.

PrincipalType

Uppräkning

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

Värde	Description
User	Principal är ett Microsoft Entra-användarhuvudnamn.
ServicePrincipal	Principal är microsoft entra-tjänstens huvudnamn.
Group	Huvudnamn är en säkerhetsgrupp.
ServicePrincipalProfile	Huvudnamn är en profil för tjänstens huvudnamn.
EntireTenant	Huvudkontot representerar alla klientanvändare.

ServicePrincipalDetails

Objekt

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.

Name	Typ	Description
aadAppId	string (uuid)	Tjänstens huvudnamns Microsoft Entra AppId.

ServicePrincipalProfileDetails

Objekt

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.

Name	Typ	Description
parentPrincipal	Principal	Tjänstens huvudnamnsprofils överordnade huvudnamn.

UserDetails

Objekt

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.

Name	Typ	Description
userPrincipalName	string	Användarens huvudnamn.

Dela via

Deployment Pipelines - Get Deployment Pipeline Operation

Behörigheter

Obligatoriska delegerade omfång

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Svar

Exempel

Get a deployment pipeline operation example

Exempelbegäran

Exempelsvar

Definitioner

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentPipelineOperationExtendedInfo

DeploymentPipelineOperationNote

DeploymentPipelineOperationStatus

DeploymentPipelineOperationType

DeploymentSourceAndTarget

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemPreDeploymentDiffState

ItemType

PreDeploymentDiffInformation

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails