Dela via

Deployment Pipelines - Update Deployment Pipeline

Tjänst:
Core
API-version:
v1

Uppdaterar egenskaperna för den angivna distributionspipelinen.

Behörigheter

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

Obligatoriska delegerade omfång

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

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

URI-parametrar

Name I Obligatorisk Typ Description
deploymentPipelineId
 path True

string (uuid)

Distributionspipeline-ID:t.

Begärandetext

Name Typ Description
description

string

maxLength: 1024

Beskrivningen för distributionspipelinen.
Beskrivningen får inte innehålla fler än 1 024 tecken.
displayName

string

maxLength: 256

Visningsnamnet för distributionspipelinen.
Visningsnamnet får inte innehålla fler än 256 tecken.

Svar

Name Typ Description
200 OK

DeploymentPipelineExtendedInfo

Begäran har slutförts.
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • UnknownError – ett fel uppstod

Exempel

Update a deployment pipeline example

Exempelbegäran

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

{
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description"
}

Exempelsvar

Statuskod:
200 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description",
  "stages": [
    {
      "id": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "order": 0,
      "displayName": "Development",
      "description": "Development stage description",
      "isPublic": false
    },
    {
      "id": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "order": 1,
      "displayName": "Test",
      "description": "Test stage description",
      "isPublic": false
    },
    {
      "id": "4c3eb03b-fbbb-4605-9b1a-6fba1003679e",
      "order": 2,
      "displayName": "Production",
      "description": "Production stage description",
      "isPublic": true
    }
  ]
}

Definitioner

Name Description
DeploymentPipelineExtendedInfo

En infrastrukturdistributionspipeline.
DeploymentPipelineStage

En pipelinefas för infrastrukturdistribution.
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Information om felsvar.
UpdateDeploymentPipelineRequest

En begäran om att uppdatera en befintlig distributionspipeline. Ett uppdaterat visningsnamn och/eller en beskrivning krävs.

DeploymentPipelineExtendedInfo

Objekt

En infrastrukturdistributionspipeline.

Name Typ Description
description

string

Beskrivning av distributionspipelinen.
displayName

string

Visningsnamnet för distributionspipelinen.
id

string (uuid)

Distributionspipeline-ID:t.
stages

DeploymentPipelineStage[]

Samlingen av distributionspipelinesteg.

DeploymentPipelineStage

Objekt

En pipelinefas för infrastrukturdistribution.

Name Typ Description
description

string

Beskrivning av distributionspipelinens fas.
displayName

string

Visningsnamnet för distributionspipelinens fas.
id

string (uuid)

Fas-ID för distributionspipelinen.
isPublic

boolean

Anger om distributionspipelinesteget är offentligt. Sant - scenen är offentlig, Falsk - scenen är inte offentlig.
order

integer

Stegordningen, med början från noll.
workspaceId

string (uuid)

Det tilldelade arbetsyte-ID:t. Gäller endast när det finns en tilldelad arbetsyta.
workspaceName

string

Namnet på den tilldelade arbetsytan. Gäller endast när det finns en tilldelad arbetsyta och användaren har åtkomst till arbetsytan.

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.

UpdateDeploymentPipelineRequest

Objekt

En begäran om att uppdatera en befintlig distributionspipeline. Ett uppdaterat visningsnamn och/eller en beskrivning krävs.

Name Typ Description
description

string

maxLength: 1024

Beskrivningen för distributionspipelinen.
Beskrivningen får inte innehålla fler än 1 024 tecken.
displayName

string

maxLength: 256

Visningsnamnet för distributionspipelinen.
Visningsnamnet får inte innehålla fler än 256 tecken.