你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Access Review Schedule Definitions - Create Or Update By Id

创建或更新访问评审计划定义。

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}?api-version=2021-12-01-preview

URI 参数

Name In Required Type Description
scheduleDefinitionId
path True
  • string

访问评审计划定义的 ID。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要与 HTTP 请求一起使用的 API 版本。

请求正文

Name Type Description
backupReviewers

这是备份审阅者集合。

descriptionForAdmins
  • string

访问评审创建者和管理员可见的说明。

descriptionForReviewers
  • string

要向审阅者显示的访问权限评审创建者提供的说明。

displayName
  • string

计划定义的显示名称。

instances

这是当实例进行扩展时返回的实例的集合。

reviewers

这是审阅者集合。

scope.excludeResourceId
  • string

这用于指示要排除的资源 ID (s)

scope.excludeRoleDefinitionId
  • string

这用于指示要排除的角色定义 ID (s)

scope.expandNestedMemberships
  • boolean

用于指示是否展开嵌套成员身份的标志。

scope.inactiveDuration
  • string

持续时间用户处于非活动状态。 该值应采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此代码可用于将 TimeSpan 转换为有效的间隔字符串:XmlConvert.ToString (新的 TimeSpan (小时、分钟、秒) )

scope.includeAccessBelowResource
  • boolean

用于指示是否展开嵌套成员身份的标志。

scope.includeInheritedAccess
  • boolean

用于指示是否展开嵌套成员身份的标志。

settings.autoApplyDecisionsEnabled
  • boolean

指示是否启用自动应用功能以自动更改目标对象访问资源的标志。 如果未启用,用户必须在评审完成后应用访问评审。

settings.defaultDecision

这指定访问评审完成后 autoReview 功能的行为。

settings.defaultDecisionEnabled
  • boolean

用于指示审阅者是否需要在评审访问权限时提供理由的标志。

settings.instanceDurationInDays
  • integer

实例的持续时间(以天为单位)。

settings.justificationRequiredOnApproval
  • boolean

用于指示在录制决策时是否需要审阅者传递理由的标志。

settings.mailNotificationsEnabled
  • boolean

用于指示是否向审阅者和审阅创建者发送邮件的标志。

settings.recommendationLookBackDuration
  • string

默认情况下,通过查看 30 天的数据来计算访问评审的建议, (w.r.t 查看评审的开始日期) 。 但是,在某些情况下,客户希望更改回头看的距离,并希望改为配置 60 天、90 天等。 此设置允许客户配置此持续时间。 该值应采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此代码可用于将 TimeSpan 转换为有效的间隔字符串:XmlConvert.ToString (新的 TimeSpan (小时、分钟、秒) )

settings.recommendationsEnabled
  • boolean

用于指示是否启用对审阅者的建议的标志。

settings.recurrence.pattern.interval
  • integer

重复周期的间隔。 对于季度评审,类型为 3:绝对月。

settings.recurrence.pattern.type

重复类型:每周、每月等。

settings.recurrence.range.endDate
  • string

计划评审结束时的 DateTime。 如果类型为 endDate,则为必需

settings.recurrence.range.numberOfOccurrences
  • integer

重复访问评审的次数。 必需,如果类型已编号,则必须为正值。

settings.recurrence.range.startDate
  • string

计划开始评审时的 DateTime。 这可能是将来的日期。 创建时需要。

settings.recurrence.range.type

重复范围类型。 可能的值包括:endDate、noEnd、numbered。

settings.reminderNotificationsEnabled
  • boolean

用于指示是否向审阅者发送提醒电子邮件的标志。

响应

Name Type Description
200 OK

成功更新

Other Status Codes

错误

安全性

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 模拟用户帐户

定义

AccessReviewActorIdentityType

标识类型:user/servicePrincipal

AccessReviewInstance

访问评审实例。

AccessReviewInstanceReviewersType

此字段指定审阅者的类型。 通常对于审阅,会显式分配审阅者。 但是,在某些情况下,可能不会分配审阅者,而是动态选择审阅者。 例如经理评审或自我评审。

AccessReviewInstanceStatus

此只读字段指定访问评审实例的状态。

AccessReviewRecurrencePatternType

重复类型:每周、每月等。

AccessReviewRecurrenceRangeType

重复范围类型。 可能的值包括:endDate、noEnd、numbered。

AccessReviewReviewer

需要审阅的内容的描述符

AccessReviewReviewerType

标识类型:user/servicePrincipal

AccessReviewScheduleDefinition

访问评审计划定义。

AccessReviewScheduleDefinitionProperties

访问评审。

AccessReviewScheduleDefinitionReviewersType

此字段指定审阅者的类型。 通常对于审阅,会显式分配审阅者。 但是,在某些情况下,可能不会分配审阅者,而是动态选择审阅者。 例如经理评审或自我评审。

AccessReviewScheduleDefinitionStatus

此只读字段指定 accessReview 的状态。

AccessReviewScopeAssignmentState

要评审的角色分配状态符合条件/活动

AccessReviewScopePrincipalType

要审阅的标识类型用户/servicePrincipal

DefaultDecisionType

这指定访问评审完成后 autoReview 功能的行为。

ErrorDefinition

错误

ErrorDefinitionProperties

错误

AccessReviewActorIdentityType

标识类型:user/servicePrincipal

Name Type Description
servicePrincipal
  • string
user
  • string

AccessReviewInstance

访问评审实例。

Name Type Description
id
  • string

访问评审实例 ID。

name
  • string

访问评审实例名称。

properties.backupReviewers

这是备份审阅者集合。

properties.endDateTime
  • string

计划到结束评审实例的 DateTime。

properties.reviewers

这是审阅者集合。

properties.reviewersType

此字段指定审阅者的类型。 通常对于审阅,会显式分配审阅者。 但是,在某些情况下,可能不会分配审阅者,而是动态选择审阅者。 例如经理评审或自我评审。

properties.startDateTime
  • string

计划启动评审实例时的 DateTime。

properties.status

此只读字段指定访问评审实例的状态。

type
  • string

资源类型。

AccessReviewInstanceReviewersType

此字段指定审阅者的类型。 通常对于审阅,会显式分配审阅者。 但是,在某些情况下,可能不会分配审阅者,而是动态选择审阅者。 例如经理评审或自我评审。

Name Type Description
Assigned
  • string
Managers
  • string
Self
  • string

AccessReviewInstanceStatus

此只读字段指定访问评审实例的状态。

Name Type Description
Applied
  • string
Applying
  • string
AutoReviewed
  • string
AutoReviewing
  • string
Completed
  • string
Completing
  • string
InProgress
  • string
Initializing
  • string
NotStarted
  • string
Scheduled
  • string
Starting
  • string

AccessReviewRecurrencePatternType

重复类型:每周、每月等。

Name Type Description
absoluteMonthly
  • string
weekly
  • string

AccessReviewRecurrenceRangeType

重复范围类型。 可能的值包括:endDate、noEnd、numbered。

Name Type Description
endDate
  • string
noEnd
  • string
numbered
  • string

AccessReviewReviewer

需要审阅的内容的描述符

Name Type Description
principalId
  • string

审阅者 (用户/servicePrincipal) 的 ID

principalType

标识类型:user/servicePrincipal

AccessReviewReviewerType

标识类型:user/servicePrincipal

Name Type Description
servicePrincipal
  • string
user
  • string

AccessReviewScheduleDefinition

访问评审计划定义。

Name Type Description
id
  • string

访问评审计划定义 ID。

name
  • string

访问评审计划定义唯一 ID。

properties.backupReviewers

这是备份审阅者集合。

properties.createdBy.principalId
  • string

标识 ID

properties.createdBy.principalName
  • string

标识显示名称

properties.createdBy.principalType

标识类型:user/servicePrincipal

properties.createdBy.userPrincipalName
  • string

如果有效) ,则用户主体名称 (

properties.descriptionForAdmins
  • string

访问评审创建者和管理员可见的说明。

properties.descriptionForReviewers
  • string

要向审阅者显示的访问权限评审创建者提供的说明。

properties.displayName
  • string

计划定义的显示名称。

properties.instances

这是当实例进行扩展时返回的实例的集合。

properties.reviewers

这是审阅者集合。

properties.reviewersType

此字段指定审阅者的类型。 通常对于审阅,会显式分配审阅者。 但是,在某些情况下,可能不会分配审阅者,而是动态选择审阅者。 例如经理评审或自我评审。

properties.scope.assignmentState

要评审的角色分配状态符合条件/活动

properties.scope.excludeResourceId
  • string

这用于指示要排除的资源 ID (s)

properties.scope.excludeRoleDefinitionId
  • string

这用于指示要排除的角色定义 ID (s)

properties.scope.expandNestedMemberships
  • boolean

用于指示是否展开嵌套成员身份的标志。

properties.scope.inactiveDuration
  • string

持续时间用户处于非活动状态。 该值应采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此代码可用于将 TimeSpan 转换为有效的间隔字符串:XmlConvert.ToString (新的 TimeSpan (小时、分钟、秒) )

properties.scope.includeAccessBelowResource
  • boolean

用于指示是否展开嵌套成员身份的标志。

properties.scope.includeInheritedAccess
  • boolean

用于指示是否展开嵌套成员身份的标志。

properties.scope.principalType

要审阅的标识类型用户/servicePrincipal

properties.scope.resourceId
  • string

创建此评审的 ResourceId

properties.scope.roleDefinitionId
  • string

这用于指示正在审阅的角色

properties.settings.autoApplyDecisionsEnabled
  • boolean

指示是否启用自动应用功能以自动更改目标对象访问资源的标志。 如果未启用,用户必须在评审完成后应用访问评审。

properties.settings.defaultDecision

这指定访问评审完成后 autoReview 功能的行为。

properties.settings.defaultDecisionEnabled
  • boolean

用于指示审阅者是否需要在评审访问权限时提供理由的标志。

properties.settings.instanceDurationInDays
  • integer

实例的持续时间(以天为单位)。

properties.settings.justificationRequiredOnApproval
  • boolean

用于指示在录制决策时是否需要审阅者传递理由的标志。

properties.settings.mailNotificationsEnabled
  • boolean

用于指示是否向审阅者和审阅创建者发送邮件的标志。

properties.settings.recommendationLookBackDuration
  • string

默认情况下,通过查看 30 天的数据来计算访问评审的建议, (w.r.t 查看评审的开始日期) 。 但是,在某些情况下,客户希望更改回头看的距离,并希望改为配置 60 天、90 天等。 此设置允许客户配置此持续时间。 该值应采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此代码可用于将 TimeSpan 转换为有效的间隔字符串:XmlConvert.ToString (新的 TimeSpan (小时、分钟、秒) )

properties.settings.recommendationsEnabled
  • boolean

用于指示是否启用对审阅者的建议的标志。

properties.settings.recurrence.pattern.interval
  • integer

重复周期的间隔。 对于季度评审,类型为 3:绝对月。

properties.settings.recurrence.pattern.type

重复类型:每周、每月等。

properties.settings.recurrence.range.endDate
  • string

计划评审结束时的 DateTime。 如果类型为 endDate,则为必需

properties.settings.recurrence.range.numberOfOccurrences
  • integer

重复访问评审的次数。 必需,如果类型已编号,则必须为正值。

properties.settings.recurrence.range.startDate
  • string

计划开始评审时的 DateTime。 这可能是将来的日期。 创建时需要。

properties.settings.recurrence.range.type

重复范围类型。 可能的值包括:endDate、noEnd、numbered。

properties.settings.reminderNotificationsEnabled
  • boolean

用于指示是否向审阅者发送提醒电子邮件的标志。

properties.status

此只读字段指定 accessReview 的状态。

type
  • string

资源类型。

AccessReviewScheduleDefinitionProperties

访问评审。

Name Type Description
backupReviewers

这是备份审阅者集合。

createdBy.principalId
  • string

标识 ID

createdBy.principalName
  • string

标识显示名称

createdBy.principalType

标识类型:user/servicePrincipal

createdBy.userPrincipalName
  • string

如果有效) ,则用户主体名称 (

descriptionForAdmins
  • string

访问评审创建者和管理员可见的说明。

descriptionForReviewers
  • string

要向审阅者显示的访问权限评审创建者提供的说明。

displayName
  • string

计划定义的显示名称。

instances

这是当实例进行扩展时返回的实例的集合。

reviewers

这是审阅者集合。

reviewersType

此字段指定审阅者的类型。 通常对于审阅,会显式分配审阅者。 但是,在某些情况下,可能不会分配审阅者,而是动态选择审阅者。 例如经理评审或自我评审。

scope.assignmentState

要评审的角色分配状态符合条件/活动

scope.excludeResourceId
  • string

这用于指示要排除的资源 ID (s)

scope.excludeRoleDefinitionId
  • string

这用于指示要排除的角色定义 ID (s)

scope.expandNestedMemberships
  • boolean

用于指示是否展开嵌套成员身份的标志。

scope.inactiveDuration
  • string

持续时间用户处于非活动状态。 该值应采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此代码可用于将 TimeSpan 转换为有效的间隔字符串:XmlConvert.ToString (新的 TimeSpan (小时、分钟、秒) )

scope.includeAccessBelowResource
  • boolean

用于指示是否展开嵌套成员身份的标志。

scope.includeInheritedAccess
  • boolean

用于指示是否展开嵌套成员身份的标志。

scope.principalType

要审阅的标识类型用户/servicePrincipal

scope.resourceId
  • string

创建此评审的 ResourceId

scope.roleDefinitionId
  • string

这用于指示正在审阅的角色

settings.autoApplyDecisionsEnabled
  • boolean

指示是否启用自动应用功能以自动更改目标对象访问资源的标志。 如果未启用,用户必须在评审完成后应用访问评审。

settings.defaultDecision

这指定访问评审完成后 autoReview 功能的行为。

settings.defaultDecisionEnabled
  • boolean

用于指示审阅者是否需要在评审访问权限时提供理由的标志。

settings.instanceDurationInDays
  • integer

实例的持续时间(以天为单位)。

settings.justificationRequiredOnApproval
  • boolean

用于指示在录制决策时是否需要审阅者传递理由的标志。

settings.mailNotificationsEnabled
  • boolean

用于指示是否向审阅者和审阅创建者发送邮件的标志。

settings.recommendationLookBackDuration
  • string

默认情况下,通过查看 30 天的数据来计算访问评审的建议, (w.r.t 查看评审的开始日期) 。 但是,在某些情况下,客户希望更改回头看的距离,并希望改为配置 60 天、90 天等。 此设置允许客户配置此持续时间。 该值应采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此代码可用于将 TimeSpan 转换为有效的间隔字符串:XmlConvert.ToString (新的 TimeSpan (小时、分钟、秒) )

settings.recommendationsEnabled
  • boolean

用于指示是否启用对审阅者的建议的标志。

settings.recurrence.pattern.interval
  • integer

重复周期的间隔。 对于季度评审,类型为 3:绝对月。

settings.recurrence.pattern.type

重复类型:每周、每月等。

settings.recurrence.range.endDate
  • string

计划评审结束时的 DateTime。 如果类型为 endDate,则为必需

settings.recurrence.range.numberOfOccurrences
  • integer

重复访问评审的次数。 必需,如果类型已编号,则必须为正值。

settings.recurrence.range.startDate
  • string

计划开始评审时的 DateTime。 这可能是将来的日期。 创建时需要。

settings.recurrence.range.type

重复范围类型。 可能的值包括:endDate、noEnd、numbered。

settings.reminderNotificationsEnabled
  • boolean

用于指示是否向审阅者发送提醒电子邮件的标志。

status

此只读字段指定 accessReview 的状态。

AccessReviewScheduleDefinitionReviewersType

此字段指定审阅者的类型。 通常对于审阅,会显式分配审阅者。 但是,在某些情况下,可能不会分配审阅者,而是动态选择审阅者。 例如经理评审或自我评审。

Name Type Description
Assigned
  • string
Managers
  • string
Self
  • string

AccessReviewScheduleDefinitionStatus

此只读字段指定 accessReview 的状态。

Name Type Description
Applied
  • string
Applying
  • string
AutoReviewed
  • string
AutoReviewing
  • string
Completed
  • string
Completing
  • string
InProgress
  • string
Initializing
  • string
NotStarted
  • string
Scheduled
  • string
Starting
  • string

AccessReviewScopeAssignmentState

要评审的角色分配状态符合条件/活动

Name Type Description
active
  • string
eligible
  • string

AccessReviewScopePrincipalType

要审阅的标识类型用户/servicePrincipal

Name Type Description
guestUser
  • string
redeemedGuestUser
  • string
servicePrincipal
  • string
user
  • string
user,group
  • string

DefaultDecisionType

这指定访问评审完成后 autoReview 功能的行为。

Name Type Description
Approve
  • string
Deny
  • string
Recommendation
  • string

ErrorDefinition

错误

Name Type Description
error

错误
列表网关状态错误。

ErrorDefinitionProperties

错误

Name Type Description
code
  • string

列表网关的错误代码。

message
  • string

错误的说明。