Scope Access Review History Definition Instances - List

Service:

Authorization

API Version:

2021-12-01-preview

Abrufen von Zugriffsüberprüfungsverlaufsdefinitionsinstanzen nach Definitions-ID

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
historyDefinitionId	path	True	string	Die ID der Definition des Zugriffsüberprüfungsverlaufs.
scope	path	True	string	Der Bereich der Ressource.
api-version	query	True	string	Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AccessReviewHistoryDefinitionInstanceListResult	Beschreiben sie das Ergebnis eines erfolgreichen Vorgangs.
Other Status Codes	ErrorDefinition	Unerwarteter Fehler

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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
}

Definitionen

Name	Beschreibung
AccessReviewHistoryDefinitionInstanceListResult	Liste der Zugriffsüberprüfungsverlaufsinstanzen.
AccessReviewHistoryDefinitionStatus	Dieses schreibgeschützte Feld gibt die der angeforderten Überprüfungsverlaufsdaten an. Dies ist entweder angefordert, in Bearbeitung, fertig oder fehler.
AccessReviewHistoryInstance	Zugriffsüberprüfungsverlaufsdefinitionsinstanz.
ErrorDefinition	Fehler
ErrorDefinitionProperties	Fehler

AccessReviewHistoryDefinitionInstanceListResult

Liste der Zugriffsüberprüfungsverlaufsinstanzen.

Name	Typ	Beschreibung
nextLink	string	Die URL, die zum Abrufen des nächsten Resultsets verwendet werden soll.
value	AccessReviewHistoryInstance[]	Instanzliste der Zugriffsüberprüfungsverlaufsdefinition.

AccessReviewHistoryDefinitionStatus

Dieses schreibgeschützte Feld gibt die der angeforderten Überprüfungsverlaufsdaten an. Dies ist entweder angefordert, in Bearbeitung, fertig oder fehler.

Name	Typ	Beschreibung
Done	string
Error	string
InProgress	string
Requested	string

AccessReviewHistoryInstance

Zugriffsüberprüfungsverlaufsdefinitionsinstanz.

Name	Typ	Beschreibung
id	string	Die Definition des Zugriffsüberprüfungsverlaufs instance ID.
name	string	Die Definition des Zugriffsüberprüfungsverlaufs instance eindeutige ID.
properties.displayName	string	Der Anzeigename für die definition des übergeordneten Verlaufs.
properties.downloadUri	string	URI, der zum Abrufen von Überprüfungsverlaufsdaten verwendet werden kann. Um diesen URI zu generieren, muss generateDownloadUri() für eine bestimmte accessReviewHistoryDefinitionInstance aufgerufen werden. Der Link läuft nach einem Zeitraum von 24 Stunden ab. Aufrufer können die Ablaufdatumszeit anzeigen, indem sie den Parameter "se" im generierten URI betrachten.
properties.expiration	string	Datum der Uhrzeit, zu der der Verlaufsdatenbericht abläuft und die zugeordneten Daten gelöscht werden.
properties.fulfilledDateTime	string	Datum, zu der der Verlaufsdatenbericht generiert werden soll.
properties.reviewHistoryPeriodEndDateTime	string	Datumszeit, die beim Auswählen von Überprüfungsdaten verwendet wird. Alle in den Daten enthaltenen Überprüfungen enden an oder vor diesem Datum. Nur für einmalige/nicht wiederkehrende Berichte.
properties.reviewHistoryPeriodStartDateTime	string	Datumszeit, die beim Auswählen von Überprüfungsdaten verwendet wird. Alle überprüfungen, die in daten enthalten sind, beginnen am oder nach diesem Datum. Nur für einmalige/nicht wiederkehrende Berichte.
properties.runDateTime	string	Datum, zu der der Verlaufsdatenbericht generiert werden soll.
properties.status	AccessReviewHistoryDefinitionStatus	Status des angeforderten Überprüfungsverlaufs instance Daten. Dies ist entweder angefordert, in Bearbeitung, fertig oder fehler. Die Zustandsübergänge sind wie folgt: Angefordert –> InProgress –> Done –> Expired
type	string	Der Ressourcentyp.

ErrorDefinition

Fehler

Name	Typ	Beschreibung
error	ErrorDefinitionProperties	Fehler Fehler des listengateways status.

ErrorDefinitionProperties

Fehler

Name	Typ	Beschreibung
code	string	Fehlercode des Listengateways.
message	string	Beschreibung des Fehlers