Deployment Pipelines - Add Deployment Pipeline Role Assignment

サービス:
Core
API バージョン:
v1

デプロイ パイプライン ロールの割り当てを追加します。

権限

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

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

Pipeline.ReadWrite.All

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

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

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

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
deploymentPipelineId
 path True

string (uuid)

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

要求本文

名前 必須 型 説明
principal True Principal:

プリンシパル。
role True

DeploymentPipelineRole

プリンシパルのデプロイ パイプライン ロール。

応答

名前 型 説明
200 OK

DeploymentPipelineRoleAssignment

要求は正常に完了しました。
429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

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

例

Add a group role assignment to a deployment pipeline example
Add a service principal role assignment to a deployment pipeline example
Add a user role assignment to a deployment pipeline example

Add a group role assignment to a deployment pipeline example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/roleAssignments

{
  "principal": {
    "id": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
    "type": "Group"
  },
  "role": "Admin"
}

応答のサンプル

状態コード:
200 
{
  "id": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
  "principal": {
    "id": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
    "type": "Group"
  },
  "role": "Admin"
}

Add a service principal role assignment to a deployment pipeline example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/roleAssignments

{
  "principal": {
    "id": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
    "type": "ServicePrincipal"
  },
  "role": "Admin"
}

応答のサンプル

状態コード:
200 
{
  "id": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
  "principal": {
    "id": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
    "type": "ServicePrincipal"
  },
  "role": "Admin"
}

Add a user role assignment to a deployment pipeline example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/roleAssignments

{
  "principal": {
    "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
    "type": "User"
  },
  "role": "Admin"
}

応答のサンプル

状態コード:
200 
{
  "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
  "principal": {
    "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
    "type": "User"
  },
  "role": "Admin"
}

定義

名前 説明
AddDeploymentPipelineRoleAssignmentRequest

デプロイ パイプライン ロールの割り当て要求ペイロードを追加します。
DeploymentPipelineRole

デプロイ パイプライン ロール。 追加のデプロイ パイプライン ロールは、時間の経過と同時に追加される可能性があります。
DeploymentPipelineRoleAssignment

デプロイ パイプラインのファブリック プリンシパル ロールの割り当て。
EntireTenantPrincipal

テナント プリンシパルを表します
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
GroupDetails

グループ固有の詳細。 プリンシパルの種類が Group場合に適用されます。
GroupPrincipal

セキュリティ グループを表します。
GroupType

グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。
PrincipalType

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。
ServicePrincipalDetails

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。
ServicePrincipalPrincipal

Microsoft Entra サービス プリンシパルを表します。
ServicePrincipalProfileDetails

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。
ServicePrincipalProfilePrincipal

サービス プリンシパル プロファイルを表します。
UserDetails

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。
UserPrincipal

Microsoft Entra ユーザー プリンシパルを表します。

AddDeploymentPipelineRoleAssignmentRequest

Object

デプロイ パイプライン ロールの割り当て要求ペイロードを追加します。

名前 型 説明
principal Principal:

プリンシパル。
role

DeploymentPipelineRole

プリンシパルのデプロイ パイプライン ロール。

DeploymentPipelineRole

列挙

デプロイ パイプライン ロール。 追加のデプロイ パイプライン ロールは、時間の経過と同時に追加される可能性があります。

値 説明
Admin

デプロイ パイプラインへの管理アクセスを有効にします。

DeploymentPipelineRoleAssignment

Object

デプロイ パイプラインのファブリック プリンシパル ロールの割り当て。

名前 型 説明
id

string (uuid)

デプロイ パイプライン ロールの割り当て ID。
principal Principal:

プリンシパル。
role

DeploymentPipelineRole

プリンシパルのデプロイ パイプライン ロール。

EntireTenantPrincipal

Object

テナント プリンシパルを表します

名前 型 説明
displayName

string

プリンシパルの表示名。
id

string (uuid)

プリンシパルの ID。
type string:

EntireTenant

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

ErrorRelatedResource

Object

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

名前 型 説明
resourceId

string

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

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

string (uuid)

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

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

GroupDetails

Object

グループ固有の詳細。 プリンシパルの種類が Group場合に適用されます。

名前 型 説明
groupType

GroupType

グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。

GroupPrincipal

Object

セキュリティ グループを表します。

名前 型 説明
displayName

string

プリンシパルの表示名。
groupDetails

GroupDetails

グループ固有の詳細。 プリンシパルの種類が Group場合に適用されます。
id

string (uuid)

プリンシパルの ID。
type string:

Group

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

GroupType

列挙

グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。

値 説明
Unknown

プリンシパル グループの種類が不明です。
SecurityGroup

プリンシパルはセキュリティ グループです。
DistributionList

プリンシパルは配布リストです。

PrincipalType

列挙

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

値 説明
User

プリンシパルは Microsoft Entra ユーザー プリンシパルです。
ServicePrincipal

プリンシパルは Microsoft Entra サービス プリンシパルです。
Group

プリンシパルはセキュリティ グループです。
ServicePrincipalProfile

プリンシパルはサービス プリンシパル プロファイルです。
EntireTenant

プリンシパルは、すべてのテナント ユーザーを表します。

ServicePrincipalDetails

Object

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。

名前 型 説明
aadAppId

string (uuid)

サービス プリンシパルの Microsoft Entra AppId。

ServicePrincipalPrincipal

Object

Microsoft Entra サービス プリンシパルを表します。

名前 型 説明
displayName

string

プリンシパルの表示名。
id

string (uuid)

プリンシパルの ID。
servicePrincipalDetails

ServicePrincipalDetails

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。
type string:

ServicePrincipal

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

ServicePrincipalProfileDetails

Object

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。

名前 型 説明
parentPrincipal Principal:

サービス プリンシパル プロファイルの親プリンシパル。

ServicePrincipalProfilePrincipal

Object

サービス プリンシパル プロファイルを表します。

名前 型 説明
displayName

string

プリンシパルの表示名。
id

string (uuid)

プリンシパルの ID。
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。
type string:

ServicePrincipalProfile

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。

UserDetails

Object

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。

名前 型 説明
userPrincipalName

string

ユーザー プリンシパル名。

UserPrincipal

Object

Microsoft Entra ユーザー プリンシパルを表します。

名前 型 説明
displayName

string

プリンシパルの表示名。
id

string (uuid)

プリンシパルの ID。
type string:

User

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。
userDetails

UserDetails

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。