Deployment Pipelines - Add Deployment Pipeline Role Assignment

Service:: Core

API-versie:: v1

Hiermee voegt u een toewijzing van een implementatiepijplijnrol toe.

Machtigingen

De aanroeper moet de rol pijplijnen voor beheerdersimplementatie hebben.

Vereiste gedelegeerde bereiken

Pipeline.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

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

URI-parameters

Name	In	Vereist	Type	Description
deploymentPipelineId	path	True	string (uuid)	De implementatiepijplijn-id.

Aanvraagbody

Name	Vereist	Type	Description
principal	True	Principal: UserPrincipal ServicePrincipalPrincipal GroupPrincipal ServicePrincipalProfilePrincipal EntireTenantPrincipal	De principal.
role	True	DeploymentPipelineRole	De rol van de implementatiepijplijn van de principal.

Antwoorden

Name Type Description

200 OK

Name	Type	Description
200 OK	DeploymentPipelineRoleAssignment	De aanvraag is voltooid.
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError - Er is een fout opgetreden

DeploymentPipelineRoleAssignment

De aanvraag is voltooid.

429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

UnknownError - Er is een fout opgetreden

Voorbeelden

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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
AddDeploymentPipelineRoleAssignmentRequest	Voeg de nettolading van de toewijzingsaanvraag voor implementatiepijplijnrollen toe.
DeploymentPipelineRole	Een implementatiepijplijnrol. Er kunnen in de loop van de tijd extra implementatiepijplijnrollen worden toegevoegd.
DeploymentPipelineRoleAssignment	Een toewijzing van een infrastructuurprincipaalrol voor een implementatiepijplijn.
EntireTenantPrincipal	Vertegenwoordigt een tenant-principal
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
GroupDetails	Groepsspecifieke details. Van toepassing wanneer het principal-type is `Group`.
GroupPrincipal	Vertegenwoordigt een beveiligingsgroep.
GroupType	Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.
PrincipalType	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
ServicePrincipalDetails	Specifieke details van de service-principal. Van toepassing wanneer het principal-type is `ServicePrincipal`.
ServicePrincipalPrincipal	Vertegenwoordigt een Microsoft Entra-service-principal.
ServicePrincipalProfileDetails	Details van service-principalprofiel. Van toepassing wanneer het principal-type is `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Vertegenwoordigt een service-principalprofiel.
UserDetails	Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is `User`.
UserPrincipal	Vertegenwoordigt een Microsoft Entra-gebruikersprincipaal.

AddDeploymentPipelineRoleAssignmentRequest

Object

Voeg de nettolading van de toewijzingsaanvraag voor implementatiepijplijnrollen toe.

Name	Type	Description
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	De principal.
role	DeploymentPipelineRole	De rol van de implementatiepijplijn van de principal.

DeploymentPipelineRole

Opsomming

Een implementatiepijplijnrol. Er kunnen in de loop van de tijd extra implementatiepijplijnrollen worden toegevoegd.

Waarde	Description
Admin	Hiermee wordt beheerderstoegang tot de implementatiepijplijn mogelijk.

DeploymentPipelineRoleAssignment

Object

Een toewijzing van een infrastructuurprincipaalrol voor een implementatiepijplijn.

Name	Type	Description
id	string (uuid)	De toewijzings-id van de implementatiepijplijnrol.
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	De principal.
role	DeploymentPipelineRole	De rol van de implementatiepijplijn van de principal.

EntireTenantPrincipal

Object

Vertegenwoordigt een tenant-principal

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
type	string: EntireTenant	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

GroupDetails

Object

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.

Name	Type	Description
groupType	GroupType	Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

GroupPrincipal

Object

Vertegenwoordigt een beveiligingsgroep.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
groupDetails	GroupDetails	Groepsspecifieke details. Van toepassing wanneer het principal-type is `Group`.
id	string (uuid)	De id van de principal.
type	string: Group	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

GroupType

Opsomming

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

Waarde	Description
Unknown	Het type Principal-groep is onbekend.
SecurityGroup	Principal is een beveiligingsgroep.
DistributionList	Principal is een distributielijst.

PrincipalType

Opsomming

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

Waarde	Description
User	Principal is een Microsoft Entra-gebruikersprincipaal.
ServicePrincipal	Principal is een Microsoft Entra-service-principal.
Group	Principal is een beveiligingsgroep.
ServicePrincipalProfile	Principal is een service-principalprofiel.
EntireTenant	Principal vertegenwoordigt alle tenantgebruikers.

ServicePrincipalDetails

Object

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.

Name	Type	Description
aadAppId	string (uuid)	De Microsoft Entra AppId van de service-principal.

ServicePrincipalPrincipal

Object

Vertegenwoordigt een Microsoft Entra-service-principal.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
servicePrincipalDetails	ServicePrincipalDetails	Specifieke details van de service-principal. Van toepassing wanneer het principal-type is `ServicePrincipal`.
type	string: ServicePrincipal	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

ServicePrincipalProfileDetails

Object

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.

Name	Type	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	De bovenliggende principal van het service-principalprofiel.

ServicePrincipalProfilePrincipal

Object

Vertegenwoordigt een service-principalprofiel.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Details van service-principalprofiel. Van toepassing wanneer het principal-type is `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

UserDetails

Object

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

Name	Type	Description
userPrincipalName	string	De principal-naam van de gebruiker.

UserPrincipal

Object

Vertegenwoordigt een Microsoft Entra-gebruikersprincipaal.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
id	string (uuid)	De id van de principal.
type	string: User	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
userDetails	UserDetails	Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is `User`.