Role Assignment Approval Step - Get By Id

Get role assignment approval.

GET 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.

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

GET 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

{
  "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",
    "assignedToMe": true,
    "status": "InProgress",
    "reviewedBy": null,
    "reviewedDateTime": null,
    "reviewResult": "NotReviewed",
    "justification": ""
  }
}

Definitions

Name Description
ErrorDefinition

Error

ErrorDefinitionProperties

Error

RoleAssignmentApprovalActorIdentityType

The identity type : user/servicePrincipal

RoleAssignmentApprovalStep

Role assignment approval stage properties.

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.

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