Zdieľať cez

Deployment Pipelines - Add Deployment Pipeline Role Assignment

Služba:
Core
Verzia rozhrania API:
v1

Pridá priradenie roly kanála nasadenia.

Povolenia

Volajúci musí mať rolu kanálov nasadenia správcu .

Povinné delegované rozsahy

Pipeline.ReadWrite.All

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita Podpora
Používateľ Áno
Objekt služby a spravované identity Áno

Rozhranie

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

Parametre URI

Name V Povinné Typ Description
deploymentPipelineId
 path True

string (uuid)

ID kanála nasadenia.

Text požiadavky

Name Povinné Typ Description
principal True

Principal

Hlavný názov.
role True

DeploymentPipelineRole

Rola kanála nasadenia objektu.

Odpovede

Name Typ Description
200 OK

DeploymentPipelineRoleAssignment

Požiadavka sa úspešne dokončila.
Other Status Codes

ErrorResponse

Bežné kódy chýb:

  • UnknownError – vyskytla sa chyba

Príklady

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

Vzorová požiadavka

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"
}

Vzorová odpoveď

Kód stavu:
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

Vzorová požiadavka

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"
}

Vzorová odpoveď

Kód stavu:
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

Vzorová požiadavka

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"
}

Vzorová odpoveď

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

Definície

Name Description
AddDeploymentPipelineRoleAssignmentRequest

Pridanie údajovej časti požiadavky na priradenie roly kanála nasadenia.
DeploymentPipelineRole

Rola Kanál nasadenia. V priebehu času možno pridať aj ďalšie roly kanála nasadenia.
DeploymentPipelineRoleAssignment

Priradenie hlavnej roly služby Fabric pre kanál nasadenia.
ErrorRelatedResource

Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse

Odpoveď na chybu.
ErrorResponseDetails

Podrobnosti o chybovej odpovedi.
GroupDetails

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .
GroupType

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.
Principal

Predstavuje identitu alebo skupinu Microsoft Entra.
PrincipalType

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
ServicePrincipalDetails

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .
ServicePrincipalProfileDetails

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .
UserDetails

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .

AddDeploymentPipelineRoleAssignmentRequest

Object

Pridanie údajovej časti požiadavky na priradenie roly kanála nasadenia.

Name Typ Description
principal

Principal

Hlavný názov.
role

DeploymentPipelineRole

Rola kanála nasadenia objektu.

DeploymentPipelineRole

Enumerácia

Rola Kanál nasadenia. V priebehu času možno pridať aj ďalšie roly kanála nasadenia.

Hodnota Description
Admin

Umožňuje správcovský prístup ku kanálu nasadenia.

DeploymentPipelineRoleAssignment

Object

Priradenie hlavnej roly služby Fabric pre kanál nasadenia.

Name Typ Description
id

string (uuid)

ID priradenia roly kanála nasadenia.
principal

Principal

Hlavný názov.
role

DeploymentPipelineRole

Rola kanála nasadenia objektu.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name Typ Description
resourceId

string

ID prostriedku, ktoré je súčasťou chyby.
resourceType

string

Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name Typ Description
errorCode

string

Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message

string

Zobrazenie chyby čitateľné ľuďmi.
moreDetails

ErrorResponseDetails[]

Zoznam ďalších podrobností o chybe.
relatedResource

ErrorRelatedResource

Podrobnosti o zdrojoch súvisiacich s chybou.
requestId

string

ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name Typ Description
errorCode

string

Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message

string

Zobrazenie chyby čitateľné ľuďmi.
relatedResource

ErrorRelatedResource

Podrobnosti o zdrojoch súvisiacich s chybou.

GroupDetails

Object

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .

Name Typ Description
groupType

GroupType

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

GroupType

Enumerácia

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

Hodnota Description
Unknown

Typ hlavnej skupiny nie je známy.
SecurityGroup

Principal je skupina zabezpečenia.
DistributionList

Principal je distribučný zoznam.

Principal

Object

Predstavuje identitu alebo skupinu Microsoft Entra.

Name Typ Description
displayName

string

Zobrazovaný názov objektu.
groupDetails

GroupDetails

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .
id

string (uuid)

ID objektu.
servicePrincipalDetails

ServicePrincipalDetails

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .
type

PrincipalType

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
userDetails

UserDetails

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .

PrincipalType

Enumerácia

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

Hodnota Description
User

Principal je objekt používateľa služby Microsoft Entra.
ServicePrincipal

Principal je objekt služby Microsoft Entra.
Group

Principal je skupina zabezpečenia.
ServicePrincipalProfile

Principal je profil objektu služby.
EntireTenant

Možnosť Principal predstavuje všetkých používateľov nájomníka.

ServicePrincipalDetails

Object

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .

Name Typ Description
aadAppId

string (uuid)

Microsoft Entra AppId objektu služby.

ServicePrincipalProfileDetails

Object

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .

Name Typ Description
parentPrincipal

Principal

Nadradený objekt profilu služby.

UserDetails

Object

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .

Name Typ Description
userPrincipalName

string

Hlavné meno používateľa.