Get longRunningOperation
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Read the properties and relationships of a longRunningOperation object. This API allows you to retrieve the details and status of the following long-running Microsoft Graph API operations.
The possible states of the long-running operation are notStarted
, running
, succeeded
, failed
, unknownFutureValue
where succeeded
and failed
are terminal states.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
For role management alerts
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | RoleManagementAlert.Read.Directory | RoleManagementAlert.ReadWrite.Directory |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | RoleManagementAlert.Read.Directory | RoleManagementAlert.ReadWrite.Directory |
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.
- Privileged Role Administrator
- Global Reader
- Security Administrator
- Security Reader
For authentication methods (password reset)
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | UserAuthenticationMethod.Read.All | UserAuthenticationMethod.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | UserAuthenticationMethod.Read.All | UserAuthenticationMethod.ReadWrite.All |
In delegated scenarios with work or school accounts where the signed-in user is acting on another user, they must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.
- Global Reader
- Authentication Administrator
- Privileged Authentication Administrator
HTTP request
To retrieve details of a long running operation of role management alert refresh:
GET /identityGovernance/roleManagementAlerts/operations/{longRunningOperationId}
To retrieve the status of a long running operation of authentication method reset:
GET /users/{id | userPrincipalName}/authentication/operations/{id}
Optional query parameters
This method supports the $select
OData query parameter to help customize the response. For general information, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a longRunningOperation object in the response body.
For role management alerts, the resourceLocation contains the url of the role management alert if the operation status is succeeded
; otherwise, the resourceLocation is empty.
Examples
Example 1: Retrieve the details of a long running operation for role management alert refresh when the operation status is running
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/identityGovernance/roleManagementAlerts/operations/refresh:DirectoryRole_19356be4-7e93-4ed6-a7c6-0ae28454d125_StaleSignInAlert
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/roleManagementAlerts/operations/$entity",
"id": "refresh:DirectoryRole_19356be4-7e93-4ed6-a7c6-0ae28454d125_StaleSignInAlert",
"createdDateTime": "2023-06-09T22:50:41.5414467Z",
"lastActionDateTime": "2023-06-09T22:52:09.0296021Z",
"resourceLocation": "",
"status": "running",
"statusDetail": ""
}
Example 2: Retrieve the details of a long running operation for role management alert refresh when the operation status is succeeded
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/identityGovernance/roleManagementAlerts/operations/refresh:DirectoryRole_19356be4-7e93-4ed6-a7c6-0ae28454d125_StaleSignInAlert
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/roleManagementAlerts/operations/$entity",
"id": "refresh:DirectoryRole_19356be4-7e93-4ed6-a7c6-0ae28454d125_StaleSignInAlert",
"createdDateTime": "2023-06-09T22:50:41.5414467Z",
"lastActionDateTime": "2023-06-09T22:56:09.0296021Z",
"resourceLocation": "https://graph.microsoft.com/beta/identityGovernance/roleManagementAlerts/alerts/DirectoryRole_19356be4-7e93-4ed6-a7c6-0ae28454d125_StaleSignInAlert",
"status": "succeeded",
"statusDetail": ""
}
Example 3: Retrieve the status of a password authentication method reset operation.
The ID of the operation to use in this request is retrieved from the response you get from the passwword reset operation.
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/users/{id | userPrincipalName}/authentication/operations/{id}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"status": "running",
"createdDateTime": "2020-03-19T12-01-03.45Z",
"lastActionDateTime": "2020-03-19T12-01-04.23Z",
"id": "2d497bb-57bd-47a6-8749-5ccd0869f2bd"
}
Commenti e suggerimenti
https://aka.ms/ContentUserFeedback.
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedereInvia e visualizza il feedback per