Deployment Pipelines - Get Deployment Pipeline

リファレンス

サービス:: Core

API バージョン:: v1

指定したデプロイパイプラインメタデータを返します。

権限

呼び出し元には 、管理者 デプロイパイプラインロールが必要です。

必要な委任されたスコープ

Pipeline.Read.All または Pipeline.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ	支援
ユーザー	イエス
サービスプリンシパルとマネージド ID	イエス

インターフェイス

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

URI パラメーター

名前	/	必須	型	説明
deploymentPipelineId	path	True	string (uuid)	デプロイパイプライン ID。

応答

名前	型	説明
200 OK	DeploymentPipelineExtendedInfo	要求は正常に完了しました。
Other Status Codes	ErrorResponse	一般的なエラーコード: UnknownError - エラーが発生しました。

名前

型

説明

200 OK

DeploymentPipelineExtendedInfo

要求は正常に完了しました。

Other Status Codes

ErrorResponse

一般的なエラーコード:

UnknownError - エラーが発生しました。

例

Get a deployment pipeline example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 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
    }
  ]
}

定義

名前	説明
DeploymentPipelineExtendedInfo	ファブリックデプロイパイプライン。
DeploymentPipelineStage	ファブリックデプロイパイプラインステージ。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。

DeploymentPipelineExtendedInfo

Object

ファブリックデプロイパイプライン。

名前	型	説明
description	string	デプロイパイプラインの説明。
displayName	string	デプロイパイプラインの表示名。
id	string (uuid)	デプロイパイプライン ID。
stages	DeploymentPipelineStage[]	デプロイパイプラインステージのコレクション。

DeploymentPipelineStage

Object

ファブリックデプロイパイプラインステージ。

名前	型	説明
description	string	デプロイパイプラインステージの説明。
displayName	string	デプロイパイプラインステージの表示名。
id	string (uuid)	デプロイパイプラインステージ ID。
isPublic	boolean	デプロイパイプラインステージがパブリックかどうかを示します。 True - ステージがパブリック、False - ステージがパブリックではありません。
order	integer	0 から始まるステージの順序。
workspaceId	string (uuid)	割り当てられたワークスペース ID。割り当てられたワークスペースがある場合にのみ適用されます。
workspaceName	string	割り当てられたワークスペース名。割り当てられたワークスペースがあり、ユーザーがワークスペースにアクセスできる場合にのみ適用されます。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

次の方法で共有

Deployment Pipelines - Get Deployment Pipeline

権限

必要な委任されたスコープ

Microsoft Entra でサポートされている ID

インターフェイス

URI パラメーター

応答

例

Get a deployment pipeline example

要求のサンプル

応答のサンプル

定義

DeploymentPipelineExtendedInfo

DeploymentPipelineStage

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails