Scope Access Review History Definition Instances - List

Service:

Authorization

API Version:

2021-12-01-preview

定義 ID でアクセス レビュー履歴定義インスタンスを取得する

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

URI パラメーター

名前	/	必須	型	説明
historyDefinitionId	path	True	string	アクセス レビュー履歴定義の ID。
scope	path	True	string	リソースのスコープ。
api-version	query	True	string	HTTP 要求で使用される API バージョン。

応答

名前	型	説明
200 OK	AccessReviewHistoryDefinitionInstanceListResult	正常に実行された操作の結果について説明します。
Other Status Codes	ErrorDefinition	予期しないエラーが発生しました。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

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
}

定義

名前	説明
AccessReviewHistoryDefinitionInstanceListResult	アクセス レビュー履歴インスタンスの一覧。
AccessReviewHistoryDefinitionStatus	この読み取り専用フィールドは、要求されたレビュー履歴データの を指定します。 これは、要求、進行中、完了、またはエラーのいずれかです。
AccessReviewHistoryInstance	アクセス レビュー履歴定義インスタンス。
ErrorDefinition	エラー
ErrorDefinitionProperties	エラー

AccessReviewHistoryDefinitionInstanceListResult

アクセス レビュー履歴インスタンスの一覧。

名前	型	説明
nextLink	string	次の結果セットを取得するために使用する URL。
value	AccessReviewHistoryInstance[]	アクセス レビュー履歴定義の [インスタンス] リスト。

AccessReviewHistoryDefinitionStatus

この読み取り専用フィールドは、要求されたレビュー履歴データの を指定します。 これは、要求、進行中、完了、またはエラーのいずれかです。

名前	型	説明
Done	string
Error	string
InProgress	string
Requested	string

AccessReviewHistoryInstance

アクセス レビュー履歴定義インスタンス。

名前	型	説明
id	string	アクセス レビュー履歴定義インスタンス ID。
name	string	アクセス レビュー履歴定義インスタンスの一意の ID。
properties.displayName	string	親履歴定義の表示名。
properties.downloadUri	string	レビュー履歴データを取得するために使用できる URI。 この Uri を生成するには、特定の accessReviewHistoryDefinitionInstance に対して generateDownloadUri() を呼び出す必要があります。 リンクは 24 時間後に期限切れになります。 呼び出し元は、生成された URI の 'se' パラメーターを調べることで有効期限を確認できます。
properties.expiration	string	履歴データ レポートの有効期限が切れ、関連付けられているデータが削除される日時。
properties.fulfilledDateTime	string	履歴データ レポートの生成がスケジュールされている日付時刻。
properties.reviewHistoryPeriodEndDateTime	string	レビュー データを選択するときに使用される日付時刻。データに含まれるすべてのレビューは、この日付以前に終了します。 1 回限り/非定期的なレポートでのみ使用する場合。
properties.reviewHistoryPeriodStartDateTime	string	レビュー データを選択するときに使用される日付時刻。データに含まれるすべてのレビューは、この日付以降に開始されます。 1 回限り/非定期的なレポートでのみ使用する場合。
properties.runDateTime	string	履歴データ レポートの生成がスケジュールされている日付時刻。
properties.status	AccessReviewHistoryDefinitionStatus	要求されたレビュー履歴インスタンス データの状態。 これは、要求、進行中、完了、またはエラーのいずれかです。 状態遷移は次のとおりです - 要求済み -> InProgress -> 完了 -> 期限切れ
type	string	リソースの種類。

ErrorDefinition

エラー

名前	型	説明
error	ErrorDefinitionProperties	エラー ゲートウェイの状態の一覧のエラー。

ErrorDefinitionProperties

エラー

名前	型	説明
code	string	リスト ゲートウェイのエラー コード。
message	string	エラーの説明。