共用方式為


Scope Access Review History Definitions - List

列出此提供者提供的 accessReviewHistoryDefinitions,定義實例只能在建立後的 30 天內使用。

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

URI 參數

名稱 位於 必要 類型 Description
scope
path True

string

資源的範圍。

api-version
query True

string

要與 HTTP 要求搭配使用的 API 版本。

$filter
query

string

要套用至作業的篩選條件。 僅支援定義名稱和建立日期的標準篩選

回應

名稱 類型 Description
200 OK

AccessReviewHistoryDefinitionListResult

描述成功作業的結果。

Other Status Codes

ErrorDefinition

未預期的錯誤

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

GetAccessReviewHistoryDefinitions

範例要求

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

範例回覆

{
  "value": [
    {
      "id": "/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/44724910-d7a5-4c29-b28f-db73e717165a",
      "name": "44724910-d7a5-4c29-b28f-db73e717165a",
      "type": "Microsoft.Authorization/accessReviewHistoryDefinition",
      "properties": {
        "displayName": "Hello world name",
        "reviewHistoryPeriodStartDateTime": "2021-10-01T00:00:00-07:00",
        "reviewHistoryPeriodEndDateTime": "2021-12-01T00:00:00-08:00",
        "decisions": [
          "Approve",
          "Deny",
          "NotReviewed",
          "DontKnow",
          "NotNotified"
        ],
        "status": "Done",
        "createdDateTime": "2021-12-23T00:27:33.6905189+00:00",
        "createdBy": {
          "principalId": "673ad0d8-7b0e-4201-aaeb-74cdcbf22af9",
          "principalType": null,
          "principalName": "levi",
          "userPrincipalName": "levi"
        },
        "scopes": [
          {
            "resourceId": "/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a",
            "roleDefinitionId": "/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a/providers/Microsoft.Authorization/roleDefinitions",
            "principalType": "user",
            "assignmentState": null,
            "inactiveDuration": null,
            "expandNestedMemberships": true
          },
          {
            "resourceId": "/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a",
            "roleDefinitionId": "/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a/providers/Microsoft.Authorization/roleDefinitions/1562cf42-00b9-457c-86ef-5702d4132904",
            "principalType": "user",
            "assignmentState": null,
            "inactiveDuration": null,
            "expandNestedMemberships": false
          }
        ],
        "settings": {
          "range": {
            "type": "endDate",
            "numberOfOccurrences": 1,
            "startDate": "2021-12-01T00:00:00-08:00",
            "endDate": "2023-12-01T00:00:00-08:00"
          }
        }
      }
    }
  ],
  "nextLink": null
}

定義

名稱 Description
AccessReviewActorIdentityType

身分識別類型:user/servicePrincipal

AccessReviewHistoryDefinition

存取權檢閱歷程記錄定義。

AccessReviewHistoryDefinitionListResult

存取權檢閱歷程記錄定義的清單。

AccessReviewHistoryDefinitionStatus

這個唯讀欄位會指定所要求檢閱歷程記錄資料的 。 這是要求、進行中、完成或錯誤。

AccessReviewHistoryInstance

存取權檢閱歷程記錄定義實例。

AccessReviewRecurrencePatternType

週期類型:每周、每月等。

AccessReviewRecurrenceRangeType

週期範圍類型。 可能的值為:endDate、noEnd、numbered。

AccessReviewResult

應篩選歷程記錄數據的檢閱決策集合。 例如,如果提供核准和拒絕,數據將只會包含決策者核准或拒絕檢閱要求之檢閱結果。

AccessReviewScope

需要檢閱之專案的描述項

AccessReviewScopeAssignmentState

要檢閱的角色指派狀態符合資格/作用中

AccessReviewScopePrincipalType

要檢閱的身分識別類型使用者/servicePrincipal

ErrorDefinition

錯誤

ErrorDefinitionProperties

錯誤

AccessReviewActorIdentityType

身分識別類型:user/servicePrincipal

名稱 類型 Description
servicePrincipal

string

user

string

AccessReviewHistoryDefinition

存取權檢閱歷程記錄定義。

名稱 類型 Description
id

string

存取權檢閱歷程記錄定義標識碼。

name

string

存取權檢閱歷程記錄定義唯一標識符。

properties.createdBy.principalId

string

身分識別標識碼

properties.createdBy.principalName

string

身分識別顯示名稱

properties.createdBy.principalType

AccessReviewActorIdentityType

身分識別類型:user/servicePrincipal

properties.createdBy.userPrincipalName

string

如果有效) ,則為用戶主體名稱 (

properties.createdDateTime

string

建立歷程記錄定義的日期時間

properties.decisions

AccessReviewResult[]

應篩選歷程記錄數據的檢閱決策集合。 例如,如果提供核准和拒絕,數據將只會包含決策者核准或拒絕檢閱要求之檢閱結果。

properties.displayName

string

歷程記錄定義的顯示名稱。

properties.instances

AccessReviewHistoryInstance[]

此歷程記錄定義的一組存取權檢閱歷程記錄實例。

properties.reviewHistoryPeriodEndDateTime

string

選取檢閱數據時所使用的日期時間,數據中包含的所有檢閱都會在此日期或之前結束。 僅適用於一次性/非週期性報告。

properties.reviewHistoryPeriodStartDateTime

string

選取檢閱數據時所使用的日期時間,數據中包含的所有評論都會在此日期開始或之後。 僅適用於一次性/非週期性報告。

properties.scopes

AccessReviewScope[]

選取檢閱歷程記錄數據時所使用的範圍集合

properties.settings.pattern.interval

integer

週期的間隔。 針對每季檢閱,類型 為 3 的間隔:absoluteMonthly。

properties.settings.pattern.type

AccessReviewRecurrencePatternType

週期類型:每周、每月等。

properties.settings.range.endDate

string

排定檢閱結束時的 DateTime。 如果類型為 endDate,則為必要項

properties.settings.range.numberOfOccurrences

integer

重複存取權檢閱的次數。 必要且如果類型已編號,則必須為正數。

properties.settings.range.startDate

string

排定檢閱開始時的 DateTime。 這可能是未來的日期。 建立時需要。

properties.settings.range.type

AccessReviewRecurrenceRangeType

週期範圍類型。 可能的值為:endDate、noEnd、numbered。

properties.status

AccessReviewHistoryDefinitionStatus

這個唯讀欄位會指定所要求檢閱歷程記錄資料的 。 這是要求、進行中、完成或錯誤。

type

string

資源類型。

AccessReviewHistoryDefinitionListResult

存取權檢閱歷程記錄定義的清單。

名稱 類型 Description
nextLink

string

用於取得下一組結果的 URL。

value

AccessReviewHistoryDefinition[]

存取權檢閱歷程記錄定義清單。

AccessReviewHistoryDefinitionStatus

這個唯讀欄位會指定所要求檢閱歷程記錄資料的 。 這是要求、進行中、完成或錯誤。

名稱 類型 Description
Done

string

Error

string

InProgress

string

Requested

string

AccessReviewHistoryInstance

存取權檢閱歷程記錄定義實例。

名稱 類型 Description
id

string

存取權檢閱歷程記錄定義實例標識碼。

name

string

存取權檢閱歷程記錄定義實例唯一標識符。

properties.displayName

string

父歷程記錄定義的顯示名稱。

properties.downloadUri

string

可用來擷取檢閱記錄數據的 URI。 若要產生此 Uri,必須針對特定 accessReviewHistoryDefinitionInstance 呼叫 generateDownloadUri () 。 連結會在24小時之後到期。 呼叫端可以在產生的 URI 中查看 『se』 參數,以查看到期日期時間。

properties.expiration

string

記錄數據報表到期且刪除相關聯數據的日期時間。

properties.fulfilledDateTime

string

排定產生記錄數據報表的日期時間。

properties.reviewHistoryPeriodEndDateTime

string

選取檢閱數據時所使用的日期時間,數據中包含的所有檢閱都會在此日期或之前結束。 僅適用於一次性/非週期性報告。

properties.reviewHistoryPeriodStartDateTime

string

選取檢閱數據時所使用的日期時間,數據中包含的所有評論都會在此日期開始或之後。 僅適用於一次性/非週期性報告。

properties.runDateTime

string

排定產生記錄數據報表的日期時間。

properties.status

AccessReviewHistoryDefinitionStatus

要求之檢閱歷程記錄實例數據的狀態。 這是要求、進行中、完成或錯誤。 狀態轉換如下所示 - 要求 -> InProgress - 完成 ->> 已過期

type

string

資源類型。

AccessReviewRecurrencePatternType

週期類型:每周、每月等。

名稱 類型 Description
absoluteMonthly

string

weekly

string

AccessReviewRecurrenceRangeType

週期範圍類型。 可能的值為:endDate、noEnd、numbered。

名稱 類型 Description
endDate

string

noEnd

string

numbered

string

AccessReviewResult

應篩選歷程記錄數據的檢閱決策集合。 例如,如果提供核准和拒絕,數據將只會包含決策者核准或拒絕檢閱要求之檢閱結果。

名稱 類型 Description
Approve

string

Deny

string

DontKnow

string

NotNotified

string

NotReviewed

string

AccessReviewScope

需要檢閱之專案的描述項

名稱 類型 Description
assignmentState

AccessReviewScopeAssignmentState

要檢閱的角色指派狀態符合資格/作用中

excludeResourceId

string

這會用來指出要排除的資源標識碼 ()

excludeRoleDefinitionId

string

這會用來指出要排除的角色定義標識碼 ()

expandNestedMemberships

boolean

旗標,指出是否要展開巢狀成員資格。

inactiveDuration

string

用戶處於非作用中的持續時間。 此值應該以 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此程式代碼可用來將 TimeSpan 轉換為有效的間隔字串:XmlConvert.ToString (新的 TimeSpan (小時、分鐘、秒) )

includeAccessBelowResource

boolean

旗標,指出是否要展開巢狀成員資格。

includeInheritedAccess

boolean

旗標,指出是否要展開巢狀成員資格。

principalType

AccessReviewScopePrincipalType

要檢閱的身分識別類型使用者/servicePrincipal

resourceId

string

建立此檢閱所在的 ResourceId

roleDefinitionId

string

這是用來指出正在檢閱的角色

AccessReviewScopeAssignmentState

要檢閱的角色指派狀態符合資格/作用中

名稱 類型 Description
active

string

eligible

string

AccessReviewScopePrincipalType

要檢閱的身分識別類型使用者/servicePrincipal

名稱 類型 Description
guestUser

string

redeemedGuestUser

string

servicePrincipal

string

user

string

user,group

string

ErrorDefinition

錯誤

名稱 類型 Description
error

ErrorDefinitionProperties

錯誤
清單閘道狀態的錯誤。

ErrorDefinitionProperties

錯誤

名稱 類型 Description
code

string

清單閘道的錯誤碼。

message

string

錯誤的描述。