Deployment Pipelines - Update Deployment Pipeline Stage

Služba:

Core

Verzia rozhrania API:

v1

Aktualizuje vlastnosti zadanej fázy kanála nasadenia.

Povolenia

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

Povinné delegované rozsahy

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

PATCH https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/stages/{stageId}

Parametre URI

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

Text požiadavky

Name	Povinné	Typ	Description
displayName	True	string maxLength: 256	Zobrazovaný názov fázy kanála nasadenia. Zobrazovaný názov nemôže obsahovať viac ako 256 znakov.
description		string maxLength: 1024	Popis fázy kanála nasadenia. Popis nemôže obsahovať viac ako 1 024 znakov.
isPublic		boolean	Určuje, či je fáza kanála nasadenia verejná.

Odpovede

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

Príklady

Update a deployment pipeline stage example

Vzorová požiadavka

HTTP

PATCH https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/stages/2e6f0272-e809-410a-be63-50e1d97ba75a

{
  "displayName": "Updated Stage Name",
  "description": "Updated deployment pipeline stage description",
  "isPublic": true
}

Vzorová odpoveď

Kód stavu:

200

{
  "id": "2e6f0272-e809-410a-be63-50e1d97ba75a",
  "order": 0,
  "displayName": "Updated Stage Name",
  "description": "Updated deployment pipeline stage description",
  "isPublic": true
}

Definície

Name	Description
DeploymentPipelineStage	Fáza kanála nasadenia služby Fabric.
DeploymentPipelineStageRequest	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.

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.

DeploymentPipelineStageRequest

Object

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

Name	Typ	Description
description	string maxLength: 1024	Popis fázy kanála nasadenia. Popis nemôže obsahovať viac ako 1 024 znakov.
displayName	string maxLength: 256	Zobrazovaný názov fázy kanála nasadenia. Zobrazovaný názov nemôže obsahovať viac ako 256 znakov.
isPublic	boolean	Určuje, či je fáza kanála nasadenia verejná.

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.