Deployment Pipelines - Get Deployment Pipeline

Serviço:
Core
Versão da API:
v1

Retorna os metadados do pipeline de implantação especificados.

Permissões

O chamador deve ter uma função de pipelines de implantação de administrador .

Escopos delegados necessários

Pipeline.Read.All ou Pipeline.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Apoio
Utilizador Yes
Entidade de serviço e identidades geridas Yes

Interfaz

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

Parâmetros do URI

Name Em Obrigatório Tipo Descrição
deploymentPipelineId
 path True

string (uuid)

O ID do pipeline de implantação.

Respostas

Name Tipo Descrição
200 OK

DeploymentPipelineExtendedInfo

Pedido concluído com sucesso.
429 Too Many Requests

ErrorResponse

O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais.

Cabeçalhos

Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • UnknownError - Ocorreu um erro.

Exemplos

Get a deployment pipeline example

Pedido de amostra

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

Resposta da amostra

Código de estado:
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
    }
  ]
}

Definições

Name Descrição
DeploymentPipelineExtendedInfo

Um pipeline de implantação de malha.
DeploymentPipelineStage

Um estágio de pipeline de implantação de malha.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.

DeploymentPipelineExtendedInfo

Object

Um pipeline de implantação de malha.

Name Tipo Descrição
description

string

A descrição do pipeline de implantação.
displayName

string

O nome de exibição do pipeline de implantação.
id

string (uuid)

O ID do pipeline de implantação.
stages

DeploymentPipelineStage[]

A coleção de estágios de pipeline de implantação.

DeploymentPipelineStage

Object

Um estágio de pipeline de implantação de malha.

Name Tipo Descrição
description

string

A descrição do estágio do pipeline de implantação.
displayName

string

O nome de exibição do estágio do pipeline de implantação.
id

string (uuid)

A ID do estágio do pipeline de implantação.
isPublic

boolean

Indica se o estágio do pipeline de implantação é público. Verdadeiro - o palco é público, Falso - o palco não é público.
order

integer

A ordem de estágio, começando do zero.
workspaceId

string (uuid)

O ID do espaço de trabalho atribuído. Aplicável apenas quando há um espaço de trabalho atribuído.
workspaceName

string

O nome do espaço de trabalho atribuído. Aplicável apenas quando há um espaço de trabalho atribuído e o usuário tem acesso ao espaço de trabalho.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Descrição
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Descrição
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
isRetriable

boolean

Quando confirmado, o pedido pode ser retentado. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Descrição
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.