你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Access Review History Definitions - List
列出此提供程序提供的 accessReviewHistoryDefinitions,定义实例仅在创建后的 30 天内可用。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions?api-version=2021-12-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions?api-version=2021-12-01-preview&$filter={$filter}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要与 HTTP 请求一起使用的 API 版本。 |
$filter
|
query |
string |
要应用于操作的筛选器。 仅支持定义名称和创建日期的标准筛选器 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
描述成功操作的结果。 |
|
Other Status Codes |
错误 |
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
定义
名称 | 说明 |
---|---|
Access |
标识类型:user/servicePrincipal |
Access |
访问评审历史记录定义。 |
Access |
访问评审历史记录定义列表。 |
Access |
此只读字段指定所请求的审阅历史记录数据的 。 这要么是请求的、正在进行的、已完成的,要么是错误。 |
Access |
访问评审历史记录定义实例。 |
Access |
定期类型:每周、每月等。 |
Access |
定期范围类型。 可能的值为:endDate、noEnd、numbered。 |
Access |
应筛选历史记录数据的评审决策的集合。 例如,如果提供了“批准”和“拒绝”,则数据将仅包含决策者批准或拒绝评审请求的评审结果。 |
Access |
需要查看的内容的描述符 |
Access |
要评审的角色分配状态符合条件/活动 |
Access |
要评审的标识类型 user/servicePrincipal |
Error |
错误 |
Error |
错误 |
AccessReviewActorIdentityType
标识类型:user/servicePrincipal
名称 | 类型 | 说明 |
---|---|---|
servicePrincipal |
string |
|
user |
string |
AccessReviewHistoryDefinition
访问评审历史记录定义。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
访问评审历史记录定义 ID。 |
name |
string |
访问评审历史记录定义唯一 ID。 |
properties.createdBy.principalId |
string |
标识 ID |
properties.createdBy.principalName |
string |
标识显示名称 |
properties.createdBy.principalType |
标识类型:user/servicePrincipal |
|
properties.createdBy.userPrincipalName |
string |
如果) 有效,则 (用户主体名称 |
properties.createdDateTime |
string |
创建历史记录定义的日期时间 |
properties.decisions |
应筛选历史记录数据的评审决策的集合。 例如,如果提供了“批准”和“拒绝”,则数据将仅包含决策者批准或拒绝评审请求的评审结果。 |
|
properties.displayName |
string |
历史记录定义的显示名称。 |
properties.instances |
此历史记录定义的访问评审历史记录实例集。 |
|
properties.reviewHistoryPeriodEndDateTime |
string |
选择评审数据时所用的日期时间,数据中包含的所有评审在此日期或之前结束。 仅用于一次性/非定期报告。 |
properties.reviewHistoryPeriodStartDateTime |
string |
选择评审数据时所用的日期时间,即数据中包含的所有评审在此日期或之后开始。 仅用于一次性/非定期报告。 |
properties.scopes |
选择审阅历史记录数据时使用的范围集合 |
|
properties.settings.pattern.interval |
integer |
定期的间隔。 对于季度评审,对于类型:absoluteMonthly,间隔为 3。 |
properties.settings.pattern.type |
定期类型:每周、每月等。 |
|
properties.settings.range.endDate |
string |
审阅计划结束时的 DateTime。 如果类型为 endDate,则为必需 |
properties.settings.range.numberOfOccurrences |
integer |
重复访问评审的次数。 必需,如果类型已编号,则必须为正数。 |
properties.settings.range.startDate |
string |
计划开始评审时的 DateTime。 这可能是将来的日期。 创建时是必需的。 |
properties.settings.range.type |
定期范围类型。 可能的值为:endDate、noEnd、numbered。 |
|
properties.status |
此只读字段指定所请求的审阅历史记录数据的 。 这要么是请求的、正在进行的、已完成的,要么是错误。 |
|
type |
string |
资源类型。 |
AccessReviewHistoryDefinitionListResult
访问评审历史记录定义列表。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
用于获取下一组结果的 URL。 |
value |
访问评审历史记录定义列表。 |
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 |
选择评审数据时所用的日期时间,数据中包含的所有评审在此日期或之前结束。 仅用于一次性/非定期报告。 |
properties.reviewHistoryPeriodStartDateTime |
string |
选择评审数据时所用的日期时间,即数据中包含的所有评审在此日期或之后开始。 仅用于一次性/非定期报告。 |
properties.runDateTime |
string |
计划生成历史记录数据报告的日期时间。 |
properties.status |
请求的审阅历史记录实例数据的状态。 这要么是请求的、正在进行的、已完成的,要么是错误。 状态转换如下所示 - 请求 -> InProgress -> 完成 -> 已过期 |
|
type |
string |
资源类型。 |
AccessReviewRecurrencePatternType
定期类型:每周、每月等。
名称 | 类型 | 说明 |
---|---|---|
absoluteMonthly |
string |
|
weekly |
string |
AccessReviewRecurrenceRangeType
定期范围类型。 可能的值为:endDate、noEnd、numbered。
名称 | 类型 | 说明 |
---|---|---|
endDate |
string |
|
noEnd |
string |
|
numbered |
string |
AccessReviewResult
应筛选历史记录数据的评审决策的集合。 例如,如果提供了“批准”和“拒绝”,则数据将仅包含决策者批准或拒绝评审请求的评审结果。
名称 | 类型 | 说明 |
---|---|---|
Approve |
string |
|
Deny |
string |
|
DontKnow |
string |
|
NotNotified |
string |
|
NotReviewed |
string |
AccessReviewScope
需要查看的内容的描述符
名称 | 类型 | 说明 |
---|---|---|
assignmentState |
要评审的角色分配状态符合条件/活动 |
|
excludeResourceId |
string |
这用于指示要排除的资源 id () |
excludeRoleDefinitionId |
string |
这用于指示要排除的角色定义 ID () |
expandNestedMemberships |
boolean |
指示是否展开嵌套成员身份的标志。 |
inactiveDuration |
string |
用户处于非活动状态的持续时间。 该值应采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此代码可用于将 TimeSpan 转换为有效的间隔字符串:XmlConvert.ToString (新的 TimeSpan (小时、分钟、秒) ) |
includeAccessBelowResource |
boolean |
指示是否展开嵌套成员身份的标志。 |
includeInheritedAccess |
boolean |
指示是否展开嵌套成员身份的标志。 |
principalType |
要评审的标识类型 user/servicePrincipal |
|
resourceId |
string |
在其中创建此评审的 ResourceId |
roleDefinitionId |
string |
这用于指示正在审查的角色 |
AccessReviewScopeAssignmentState
要评审的角色分配状态符合条件/活动
名称 | 类型 | 说明 |
---|---|---|
active |
string |
|
eligible |
string |
AccessReviewScopePrincipalType
要评审的标识类型 user/servicePrincipal
名称 | 类型 | 说明 |
---|---|---|
guestUser |
string |
|
redeemedGuestUser |
string |
|
servicePrincipal |
string |
|
user |
string |
|
user,group |
string |
ErrorDefinition
错误
名称 | 类型 | 说明 |
---|---|---|
error |
错误 |
ErrorDefinitionProperties
错误
名称 | 类型 | 说明 |
---|---|---|
code |
string |
列表网关的错误代码。 |
message |
string |
错误的说明。 |