แชร์ผ่าน

Deployment Pipelines - Update Deployment Pipeline

บริการ:
Core
เวอร์ชัน API:
v1

อัปเดตคุณสมบัติของไปป์ไลน์การปรับใช้งานที่ระบุ

การอนุญาต

ผู้เรียกต้องมีบทบาทไปป์ไลน์การปรับใช้ผู้ดูแลระบบ

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

Pipeline.ReadWrite.All

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

เอกลักษณ์ การสนับสนุน
User ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ ใช่

อินเตอร์เฟซ

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

ไปป์ไลน์การปรับใช้ Fabric
DeploymentPipelineStage

ขั้นตอนไปป์ไลน์การปรับใช้ Fabric
ErrorRelatedResource

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse

การตอบสนองข้อผิดพลาด
ErrorResponseDetails

รายละเอียดการตอบสนองข้อผิดพลาด
UpdateDeploymentPipelineRequest

คําขอในการอัปเดตไปป์ไลน์การปรับใช้งานที่มีอยู่ จําเป็นต้องมีชื่อที่ใช้แสดงและ/หรือคําอธิบายที่อัปเดตแล้ว

DeploymentPipelineExtendedInfo

ออบเจ็กต์

ไปป์ไลน์การปรับใช้ Fabric

ชื่อ พิมพ์ คำอธิบาย
description

string

คําอธิบายไปป์ไลน์การปรับใช้
displayName

string

ชื่อที่แสดงของไปป์ไลน์การปรับใช้
id

string (uuid)

ID ไปป์ไลน์การปรับใช้
stages

DeploymentPipelineStage[]

คอลเลกชันของขั้นตอนไปป์ไลน์การปรับใช้

DeploymentPipelineStage

ออบเจ็กต์

ขั้นตอนไปป์ไลน์การปรับใช้ Fabric

ชื่อ พิมพ์ คำอธิบาย
description

string

คําอธิบายขั้นตอนไปป์ไลน์การปรับใช้
displayName

string

ชื่อที่แสดงของขั้นตอนไปป์ไลน์การปรับใช้
id

string (uuid)

ID ขั้นตอนไปป์ไลน์การปรับใช้
isPublic

boolean

ระบุว่าขั้นตอนไปป์ไลน์การปรับใช้เป็นสาธารณะหรือไม่ จริง - ขั้นตอนเป็นสาธารณะเท็จ - ขั้นตอนไม่ใช่สาธารณะ
order

integer

ลําดับขั้นเริ่มต้นจากศูนย์
workspaceId

string (uuid)

ID พื้นที่ทํางานที่กําหนด ใช้ได้เฉพาะเมื่อมีพื้นที่ทํางานที่กําหนดไว้เท่านั้น
workspaceName

string

ชื่อพื้นที่ทํางานที่กําหนด ใช้ได้เฉพาะเมื่อมีพื้นที่ทํางานที่กําหนดไว้และผู้ใช้มีสิทธิ์เข้าถึงพื้นที่ทํางานเท่านั้น

ErrorRelatedResource

ออบเจ็กต์

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

ออบเจ็กต์

การตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId

string

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

ออบเจ็กต์

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

UpdateDeploymentPipelineRequest

ออบเจ็กต์

คําขอในการอัปเดตไปป์ไลน์การปรับใช้งานที่มีอยู่ จําเป็นต้องมีชื่อที่ใช้แสดงและ/หรือคําอธิบายที่อัปเดตแล้ว

ชื่อ พิมพ์ คำอธิบาย
description

string

maxLength: 1024

คําอธิบายสําหรับไปป์ไลน์การปรับใช้
คําอธิบายต้องมีอักขระมากกว่า 1024 อักขระ
displayName

string

maxLength: 256

ชื่อที่แสดงสําหรับไปป์ไลน์การปรับใช้
ชื่อที่แสดงต้องไม่เกิน 256 อักขระ