Deployment Pipelines - Get Deployment Pipeline

Služba:

Core

Verzia rozhrania API:

v1

Vráti zadané metaúdaje kanála nasadenia.

Povolenia

Volajúci musí mať rolu kanálov nasadenia správcu .

Povinné delegované rozsahy

Pipeline.Read.All alebo Pipeline.ReadWrite.All

Podporované identity v aplikácii Microsoft Entra

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

Identita	Podpora
Používateľ	Yes
Objekt služby a spravované identity	Yes

Rozhranie

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

Parametre URI

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

Odpovede

Name	Typ	Description
200 OK	DeploymentPipelineExtendedInfo	Požiadavka sa úspešne dokončila.
Other Status Codes	ErrorResponse	Bežné kódy chýb: UnknownError – vyskytla sa chyba.

Príklady

Get a deployment pipeline example

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:

200

{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Marketing Deployment Pipeline",
  "description": "Fabric deployment pipeline to manage marketing reports",
  "stages": [
    {
      "id": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "order": 0,
      "displayName": "Development",
      "description": "Design, review, and revise your content in a development workspace. When it's ready to test and preview, deploy the content to the test stage.",
      "workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
      "workspaceName": "Workpsace-Development",
      "isPublic": false
    },
    {
      "id": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "order": 1,
      "displayName": "Test",
      "description": "Test and verify your content in a preproduction workspace. When it's ready, deploy the content to the production stage.",
      "workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e",
      "isPublic": false
    },
    {
      "id": "4c3eb03b-fbbb-4605-9b1a-6fba1003679e",
      "order": 2,
      "displayName": "Production",
      "description": "Your content has been tested and is ready for your customers as an app or by access to the production workspace.",
      "isPublic": true
    }
  ]
}

Definície

Name	Description
DeploymentPipelineExtendedInfo	Kanál nasadenia služby Fabric.
DeploymentPipelineStage	Fáza kanála nasadenia služby Fabric.
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.

DeploymentPipelineExtendedInfo

Object

Kanál nasadenia služby Fabric.

Name	Typ	Description
description	string	Popis kanála nasadenia.
displayName	string	Zobrazovaný názov kanála nasadenia.
id	string (uuid)	ID kanála nasadenia.
stages	DeploymentPipelineStage[]	Kolekcia fáz kanálov nasadenia.

DeploymentPipelineStage

Object

Fáza kanála nasadenia služby Fabric.

Name	Typ	Description
description	string	Popis fázy kanála nasadenia.
displayName	string	Zobrazovaný názov fázy kanála nasadenia.
id	string (uuid)	ID fázy kanála nasadenia.
isPublic	boolean	Udáva, či je fáza kanála nasadenia verejná. Pravda – fáza je verejná, False – fáza nie je verejná.
order	integer	Poradie etáp začínajúce od nuly.
workspaceId	string (uuid)	Priradené ID pracovného priestoru. Platí len vtedy, keď existuje priradený pracovný priestor.
workspaceName	string	Názov priradeného pracovného priestoru. Platí len vtedy, ak je k dispozícii priradený pracovný priestor a používateľ má prístup k pracovnému priestoru.

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.