Deployment Pipelines - Add Deployment Pipeline Role Assignment
デプロイ パイプライン ロールの割り当てを追加します。
権限
呼び出し元には 、管理者 デプロイ パイプライン ロールが必要です。
必要な委任されたスコープ
Pipeline.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
アイデンティティ | 支援 |
---|---|
ユーザー | イエス |
サービス プリンシパルとマネージド ID | イエス |
インターフェイス
POST https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/roleAssignments
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
deployment
|
path | True |
string (uuid) |
デプロイ パイプライン ID。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
principal | True |
プリンシパル。 |
|
role | True |
プリンシパルのデプロイ パイプライン ロール。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は正常に完了しました。 |
|
Other Status Codes |
一般的なエラー コード:
|
例
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"
}
応答のサンプル
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"
}
応答のサンプル
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"
}
応答のサンプル
定義
名前 | 説明 |
---|---|
Add |
デプロイ パイプライン ロールの割り当て要求ペイロードを追加します。 |
Deployment |
デプロイ パイプライン ロール。 追加のデプロイ パイプライン ロールは、時間の経過と同時に追加される可能性があります。 |
Error |
エラー関連のリソース詳細オブジェクト。 |
Error |
エラー応答。 |
Error |
エラー応答の詳細。 |
Group |
グループ固有の詳細。 プリンシパルの種類が |
Group |
グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。 |
Principal |
ID または Microsoft Entra グループを表します。 |
Principal |
プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。 |
Service |
サービス プリンシパル固有の詳細。 プリンシパルの種類が |
Service |
サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が |
User |
ユーザー プリンシパル固有の詳細。 プリンシパルの種類が |
AddDeploymentPipelineRoleAssignmentRequest
デプロイ パイプライン ロールの割り当て要求ペイロードを追加します。
名前 | 型 | 説明 |
---|---|---|
principal |
プリンシパル。 |
|
role |
プリンシパルのデプロイ パイプライン ロール。 |
DeploymentPipelineRole
デプロイ パイプライン ロール。 追加のデプロイ パイプライン ロールは、時間の経過と同時に追加される可能性があります。
値 | 説明 |
---|---|
Admin |
デプロイ パイプラインへの管理アクセスを有効にします。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
名前 | 型 | 説明 |
---|---|---|
resourceId |
string |
エラーに関係するリソース ID。 |
resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
message |
string |
エラーの人間が判読できる表現。 |
moreDetails |
その他のエラーの詳細の一覧。 |
|
relatedResource |
エラー関連のリソースの詳細。 |
|
requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
message |
string |
エラーの人間が判読できる表現。 |
relatedResource |
エラー関連のリソースの詳細。 |
GroupDetails
グループ固有の詳細。 プリンシパルの種類が Group
場合に適用されます。
名前 | 型 | 説明 |
---|---|---|
groupType |
グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。 |
GroupType
グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。
値 | 説明 |
---|---|
DistributionList |
プリンシパルは配布リストです。 |
SecurityGroup |
プリンシパルはセキュリティ グループです。 |
Unknown |
プリンシパル グループの種類が不明です。 |
Principal
ID または Microsoft Entra グループを表します。
名前 | 型 | 説明 |
---|---|---|
displayName |
string |
プリンシパルの表示名。 |
groupDetails |
グループ固有の詳細。 プリンシパルの種類が |
|
id |
string (uuid) |
プリンシパルの ID。 |
servicePrincipalDetails |
サービス プリンシパル固有の詳細。 プリンシパルの種類が |
|
servicePrincipalProfileDetails |
サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が |
|
type |
プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。 |
|
userDetails |
ユーザー プリンシパル固有の詳細。 プリンシパルの種類が |
PrincipalType
プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。
値 | 説明 |
---|---|
Group |
プリンシパルはセキュリティ グループです。 |
ServicePrincipal |
プリンシパルは Microsoft Entra サービス プリンシパルです。 |
ServicePrincipalProfile |
プリンシパルはサービス プリンシパル プロファイルです。 |
User |
プリンシパルは Microsoft Entra ユーザー プリンシパルです。 |
ServicePrincipalDetails
サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal
場合に適用されます。
名前 | 型 | 説明 |
---|---|---|
aadAppId |
string (uuid) |
サービス プリンシパルの Microsoft Entra AppId。 |
ServicePrincipalProfileDetails
サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile
場合に適用されます。
名前 | 型 | 説明 |
---|---|---|
parentPrincipal |
サービス プリンシパル プロファイルの親プリンシパル。 |
UserDetails
ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User
場合に適用されます。
名前 | 型 | 説明 |
---|---|---|
userPrincipalName |
string |
ユーザー プリンシパル名。 |