Role Assignment Approval Step - Patch

Reference

Service:: Authorization

API Version:: 2021-01-01-preview

Record a decision.

PATCH https://management.azure.com/providers/Microsoft.Authorization/roleAssignmentApprovals/{approvalId}/stages/{stageId}?api-version=2021-01-01-preview

URI Parameters

Name	In	Required	Type	Description
approvalId	path	True	string	The id of the role assignment approval.
stageId	path	True	string	The id of the role assignment approval stage.
api-version	query	True	string	The API version to be used with the HTTP request.

Request Body

Name	Type	Description
displayName	string	The display name for the approval stage.
justification	string	Justification provided by approvers for their action
reviewResult	RoleAssignmentApprovalStepReviewResult	The decision on the approval stage. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny

Responses

Name	Type	Description
200 OK	RoleAssignmentApprovalStep	Describe the result of a successful operation.
Other Status Codes	ErrorDefinition	Unexpected error

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

GetAccessReviews

Sample request

HTTP

PATCH https://management.azure.com/providers/Microsoft.Authorization/roleAssignmentApprovals/488a6d0e-0a63-4946-86e3-1f5bbc934661/stages/4135f961-be78-4005-8101-c72a5af307a2?api-version=2021-01-01-preview

{}

Sample response

Status code:: 200

{
  "id": "/providers/Microsoft.Authorization/roleAssignmentApprovals/488a6d0e-0a63-4946-86e3-1f5bbc934661/stages/4135f961-be78-4005-8101-c72a5af307a2",
  "type": "Microsoft.Authorization/roleAssignmentApprovals/stages",
  "name": "4135f961-be78-4005-8101-c72a5af307a2",
  "properties": {
    "displayName": "Vice President Approval Step",
    "status": "Completed",
    "assignedToMe": true,
    "reviewedBy": {
      "principalType": "user",
      "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9",
      "principalName": "Shubham Gupta",
      "userPrincipalName": "shugup@microsoft.com"
    },
    "reviewedDateTime": "2018-08-03T21:02:30.667Z",
    "reviewResult": "Approve",
    "justification": "I trust this person"
  }
}

Definitions

Name	Description
ErrorDefinition	Error
ErrorDefinitionProperties	Error
RoleAssignmentApprovalActorIdentityType	The identity type : user/servicePrincipal
RoleAssignmentApprovalStep	Role assignment approval stage properties.
RoleAssignmentApprovalStepProperties	Approval Step.
RoleAssignmentApprovalStepReviewResult	The decision on the approval stage. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny
RoleAssignmentApprovalStepStatus	This read-only field specifies the status of an approval.

ErrorDefinition

Error

Name	Type	Description
error	ErrorDefinitionProperties	Error Error of the list gateway status.

ErrorDefinitionProperties

Error

Name	Type	Description
code	string	Error code of list gateway.
message	string	Description of the error.

RoleAssignmentApprovalActorIdentityType

The identity type : user/servicePrincipal

Name	Type	Description
servicePrincipal	string
user	string

RoleAssignmentApprovalStep

Role assignment approval stage properties.

Name	Type	Description
id	string	The role assignment approval stage id.
name	string	The role assignment approval stage name.
properties.assignedToMe	boolean	Indicates whether the stage is assigned to me for review
properties.displayName	string	The display name for the approval stage.
properties.justification	string	Justification provided by approvers for their action
properties.reviewResult	RoleAssignmentApprovalStepReviewResult	The decision on the approval stage. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny
properties.reviewedBy.principalId	string	The identity id
properties.reviewedBy.principalName	string	The identity display name
properties.reviewedBy.principalType	RoleAssignmentApprovalActorIdentityType	The identity type : user/servicePrincipal
properties.reviewedBy.userPrincipalName	string	The user principal name(if valid)
properties.reviewedDateTime	string	Date Time when a decision was taken.
properties.status	RoleAssignmentApprovalStepStatus	This read-only field specifies the status of an approval.
type	string	The resource type.

RoleAssignmentApprovalStepProperties

Approval Step.

Name	Type	Description
assignedToMe	boolean	Indicates whether the stage is assigned to me for review
displayName	string	The display name for the approval stage.
justification	string	Justification provided by approvers for their action
reviewResult	RoleAssignmentApprovalStepReviewResult	The decision on the approval stage. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny
reviewedBy.principalId	string	The identity id
reviewedBy.principalName	string	The identity display name
reviewedBy.principalType	RoleAssignmentApprovalActorIdentityType	The identity type : user/servicePrincipal
reviewedBy.userPrincipalName	string	The user principal name(if valid)
reviewedDateTime	string	Date Time when a decision was taken.
status	RoleAssignmentApprovalStepStatus	This read-only field specifies the status of an approval.

RoleAssignmentApprovalStepReviewResult

The decision on the approval stage. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny

Name	Type	Description
Approve	string
Deny	string
NotReviewed	string

RoleAssignmentApprovalStepStatus

This read-only field specifies the status of an approval.

Name	Type	Description
Completed	string
Completing	string
Escalated	string
Escalating	string
Expired	string
InProgress	string
Initializing	string
NotStarted	string

Share via