Scope Access Review History Definition Instances - List

Service:

Authorization

API Version:

2021-12-01-preview

Get access review history definition instances by definition Id

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/{historyDefinitionId}/instances?api-version=2021-12-01-preview

URI Parameters

Name	In	Required	Type	Description
historyDefinitionId	path	True	string	The id of the access review history definition.
scope	path	True	string	The scope of the resource.
api-version	query	True	string	The API version to be used with the HTTP request.

Responses

Name	Type	Description
200 OK	AccessReviewHistoryDefinitionInstanceListResult	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

GetAccessReviewHistoryDefinitionInstances

Sample Request

HTTP

GET https://management.azure.com/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/44724910-d7a5-4c29-b28f-db73e717165a/instances?api-version=2021-12-01-preview

Go

package armauthorization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/310a0100f5b020c1900c527a6aa70d21992f078a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-12-01-preview/examples/GetAccessReviewHistoryDefinitionInstances.json
func ExampleScopeAccessReviewHistoryDefinitionInstancesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armauthorization.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewScopeAccessReviewHistoryDefinitionInstancesClient().NewListPager("subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a", "44724910-d7a5-4c29-b28f-db73e717165a", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AccessReviewHistoryDefinitionInstanceListResult = armauthorization.AccessReviewHistoryDefinitionInstanceListResult{
		// 	Value: []*armauthorization.AccessReviewHistoryInstance{
		// 		{
		// 			Name: to.Ptr("44724910-d7a5-4c29-b28f-db73e717165a"),
		// 			Type: to.Ptr("Microsoft.Authorization/accessReviewHistoryInstance"),
		// 			ID: to.Ptr("44724910-d7a5-4c29-b28f-db73e717165a"),
		// 			Properties: &armauthorization.AccessReviewHistoryInstanceProperties{
		// 				DisplayName: to.Ptr("Hello world name"),
		// 				Expiration: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-22T00:28:33.690Z"); return t}()),
		// 				FulfilledDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-12-23T00:28:33.690Z"); return t}()),
		// 				ReviewHistoryPeriodEndDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-12-01T08:00:00.000Z"); return t}()),
		// 				ReviewHistoryPeriodStartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-01T07:00:00.000Z"); return t}()),
		// 				RunDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-12-23T00:27:33.690Z"); return t}()),
		// 				Status: to.Ptr(armauthorization.AccessReviewHistoryDefinitionStatusRequested),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AuthorizationManagementClient } = require("@azure/arm-authorization");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get access review history definition instances by definition Id
 *
 * @summary Get access review history definition instances by definition Id
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-12-01-preview/examples/GetAccessReviewHistoryDefinitionInstances.json
 */
async function getAccessReviewHistoryDefinitionInstances() {
  const scope = "subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a";
  const historyDefinitionId = "44724910-d7a5-4c29-b28f-db73e717165a";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.scopeAccessReviewHistoryDefinitionInstances.list(
    scope,
    historyDefinitionId
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "44724910-d7a5-4c29-b28f-db73e717165a",
      "name": "44724910-d7a5-4c29-b28f-db73e717165a",
      "type": "Microsoft.Authorization/accessReviewHistoryInstance",
      "properties": {
        "reviewHistoryPeriodStartDateTime": "2021-10-01T00:00:00-07:00",
        "reviewHistoryPeriodEndDateTime": "2021-12-01T00:00:00-08:00",
        "displayName": "Hello world name",
        "status": "Requested",
        "runDateTime": "2021-12-23T00:27:33.6905189+00:00",
        "fulfilledDateTime": "2021-12-23T00:28:33.6905189+00:00",
        "expiration": "2022-01-22T00:28:33.6905189+00:00"
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
AccessReviewHistoryDefinitionInstanceListResult	List of Access Review History Instances.
AccessReviewHistoryDefinitionStatus	This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
AccessReviewHistoryInstance	Access Review History Definition Instance.
ErrorDefinition	Error
ErrorDefinitionProperties	Error

AccessReviewHistoryDefinitionInstanceListResult

List of Access Review History Instances.

Name	Type	Description
nextLink	string	The URL to use for getting the next set of results.
value	AccessReviewHistoryInstance[]	Access Review History Definition's Instance list.

AccessReviewHistoryDefinitionStatus

This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.

Name	Type	Description
Done	string
Error	string
InProgress	string
Requested	string

AccessReviewHistoryInstance

Access Review History Definition Instance.

Name	Type	Description
id	string	The access review history definition instance id.
name	string	The access review history definition instance unique id.
properties.displayName	string	The display name for the parent history definition.
properties.downloadUri	string	Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
properties.expiration	string	Date time when history data report expires and the associated data is deleted.
properties.fulfilledDateTime	string	Date time when the history data report is scheduled to be generated.
properties.reviewHistoryPeriodEndDateTime	string	Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
properties.reviewHistoryPeriodStartDateTime	string	Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
properties.runDateTime	string	Date time when the history data report is scheduled to be generated.
properties.status	AccessReviewHistoryDefinitionStatus	Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired
type	string	The resource type.

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.