次の方法で共有

Deployment Pipelines - Update Deployment Pipeline

  • リファレンス
サービス:
Core
API バージョン:
v1

指定したデプロイ パイプラインのプロパティを更新します。

権限

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

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

Pipeline.ReadWrite.All

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

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

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

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
deploymentPipelineId
 path True

string (uuid)

デプロイ パイプライン ID。

要求本文

名前 型 説明
description

string

maxLength: 1024

デプロイ パイプラインの説明。
説明には 1024 文字を超えることはできません。
displayName

string

maxLength: 256

デプロイ パイプラインの表示名。
表示名には 256 文字を超えることはできません。

応答

名前 型 説明
200 OK

DeploymentPipelineExtendedInfo

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

ErrorResponse

一般的なエラー コード:

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

例

Update a deployment pipeline example

要求のサンプル

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

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

応答のサンプル

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

定義

名前 説明
DeploymentPipelineExtendedInfo

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

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

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
UpdateDeploymentPipelineRequest

既存のデプロイ パイプラインを更新する要求。 更新された表示名または説明が必要です。

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

エラー関連のリソースの詳細。

UpdateDeploymentPipelineRequest

Object

既存のデプロイ パイプラインを更新する要求。 更新された表示名または説明が必要です。

名前 型 説明
description

string

maxLength: 1024

デプロイ パイプラインの説明。
説明には 1024 文字を超えることはできません。
displayName

string

maxLength: 256

デプロイ パイプラインの表示名。
表示名には 256 文字を超えることはできません。