Deployment Pipelines - Get Deployment Pipeline

Tjeneste:
Core
API-version:
v1

Returnerer de angivne metadata for udrulningspipelinen.

Tilladelser

Kalderen skal have rollen administratorinstallationspipelines.

Påkrævede delegerede områder

Pipeline.Read.All eller Pipeline.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet Support
Bruger Ja
tjenesteprincipal og administrerede identiteter Ja

Grænseflade

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

URI-parametre

Navn I Påkrævet Type Beskrivelse
deploymentPipelineId
 path True

string (uuid)

Id'et for udrulningspipelinen.

Svar

Navn Type Beskrivelse
200 OK

DeploymentPipelineExtendedInfo

Anmodningen blev fuldført.
429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer
Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • UnknownError – Der opstod en fejl.

Eksempler

Get a deployment pipeline example

Eksempelanmodning

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

Eksempelsvar

Statuskode:
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
    }
  ]
}

Definitioner

Navn Beskrivelse
DeploymentPipelineExtendedInfo

En Fabric-udrulningspipeline.
DeploymentPipelineStage

En fase i en Fabric-udrulningspipeline.
ErrorParameter

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.

DeploymentPipelineExtendedInfo

Objekt

En Fabric-udrulningspipeline.

Navn Type Beskrivelse
description

string

Beskrivelsen af udrulningspipelinen.
displayName

string

Vist navn på udrulningspipeline.
id

string (uuid)

Id'et for udrulningspipelinen.
stages

DeploymentPipelineStage[]

Samlingen af udrulningspipelinefaser.

DeploymentPipelineStage

Objekt

En fase i en Fabric-udrulningspipeline.

Navn Type Beskrivelse
description

string

Beskrivelsen af udrulningspipelinefasen.
displayName

string

Vist navn på udrulningspipelinefasen.
id

string (uuid)

Fase-id'et for udrulningspipelinen.
isPublic

boolean

Angiver, om udrulningspipelinefasen er offentlig. Sand – fasen er offentlig, Falsk – fasen er ikke offentlig.
order

integer

Faserækkefølgen, der starter fra nul.
workspaceId

string (uuid)

Det tildelte arbejdsområde-id. Gælder kun, når der er et tildelt arbejdsområde.
workspaceName

string

Navnet på det tildelte arbejdsområde. Gælder kun, når der er et tildelt arbejdsområde, og brugeren har adgang til arbejdsområdet.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn Type Beskrivelse
message

string

En læsevenlig beskrivelse af parameterens betydning.
name

string

Parameter-id'et.
value

string

Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.
resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable

boolean

Når sand, kan anmodningen prøves igen. Brug svarheaderen Retry-After til at bestemme forsinkelsen, hvis den er tilgængelig.
message

string

En menneskelig læsbar gengivelse af fejlen.
moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.
parameters

ErrorParameter[]

Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string (uuid)

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
parameters

ErrorParameter[]

Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.