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

Microsoft.Authorization accessReviewScheduleDefinitions 2021-11-16-preview

Bicep 资源定义

accessReviewScheduleDefinitions 资源类型可以使用面向以下对象的操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Authorization/accessReviewScheduleDefinitions 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Authorization/accessReviewScheduleDefinitions@2021-11-16-preview' = {
  name: 'string'
  backupReviewers: [
    {
      principalId: 'string'
    }
  ]
  descriptionForAdmins: 'string'
  descriptionForReviewers: 'string'
  displayName: 'string'
  instances: [
    {
      properties: {
        backupReviewers: [
          {
            principalId: 'string'
          }
        ]
        endDateTime: 'string'
        reviewers: [
          {
            principalId: 'string'
          }
        ]
        startDateTime: 'string'
      }
    }
  ]
  reviewers: [
    {
      principalId: 'string'
    }
  ]
  settings: {
    autoApplyDecisionsEnabled: bool
    defaultDecision: 'string'
    defaultDecisionEnabled: bool
    instanceDurationInDays: int
    justificationRequiredOnApproval: bool
    mailNotificationsEnabled: bool
    recommendationLookBackDuration: 'string'
    recommendationsEnabled: bool
    recurrence: {
      pattern: {
        interval: int
        type: 'string'
      }
      range: {
        endDate: 'string'
        numberOfOccurrences: int
        startDate: 'string'
        type: 'string'
      }
    }
    reminderNotificationsEnabled: bool
  }
}

属性值

accessReviewScheduleDefinitions

名称 说明
name 资源名称 字符串 (必需)
backupReviewers 这是备份审阅者的集合。 AccessReviewReviewer[]
descriptionForAdmins 由访问评审创建者提供且对管理员可见的说明。 字符串
descriptionForReviewers 由访问评审创建者提供的说明,要向审阅者显示。 字符串
displayName 计划定义的显示名称。 字符串
instances 这是在进行扩展时返回的实例集合。 AccessReviewInstance[]
评论家 这是审阅者的集合。 AccessReviewReviewer[]
设置 访问评审设置。 AccessReviewScheduleSettings

AccessReviewReviewer

名称 说明
principalId 审阅者的 ID (user/servicePrincipal) 字符串

AccessReviewInstance

名称 说明
properties Access Review 属性。 AccessReviewInstanceProperties

AccessReviewInstanceProperties

名称 说明
backupReviewers 这是备份审阅者的集合。 AccessReviewReviewer[]
endDateTime 审阅实例计划结束时的 DateTime。 字符串
评论家 这是审阅者的集合。 AccessReviewReviewer[]
startDateTime 计划启动审阅实例时的 DateTime。 字符串

AccessReviewScheduleSettings

名称 说明
autoApplyDecisionsEnabled 指示是否启用自动应用功能以自动更改目标对象访问资源的标志。 如果未启用,则用户必须在评审完成后应用访问评审。 bool
defaultDecision 这指定在访问评审完成时自动查看功能的行为。 “批准”
“拒绝”
“建议”
defaultDecisionEnabled 用于指示审阅者在评审访问权限时是否需要提供理由的标志。 bool
instanceDurationInDays 实例的持续时间(以天为单位)。 int
justificationRequiredOnApproval 用于指示在记录决策时是否要求审阅者传递理由的标志。 bool
mailNotificationsEnabled 指示是否启用向审阅者和审阅创建者发送邮件的标志。 bool
recommendationLookBackDuration 访问评审的建议是通过查看 30 天的数据 (w.r.t 默认) 开始计算的。 但是,在某些情况下,客户希望更改回溯时间,并改为配置 60 天、90 天等。 此设置允许客户配置此持续时间。 该值应采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此代码可用于将 TimeSpan 转换为有效的间隔字符串:XmlConvert.ToString (新的 TimeSpan (小时、分钟、秒) ) 字符串
recommendationsEnabled 指示是否启用向审阅者显示建议的标志。 bool
recurrence 访问评审设置。 AccessReviewRecurrenceSettings
reminderNotificationsEnabled 指示是否启用向审阅者发送提醒电子邮件的标志。 bool

AccessReviewRecurrenceSettings

名称 说明
pattern 访问评审计划定义定期模式。 AccessReviewRecurrencePattern
range 访问评审计划定义重复周期范围。 AccessReviewRecurrenceRange

AccessReviewRecurrencePattern

名称 说明
interval 重复周期的间隔。 对于季度评审,对于类型:absoluteMonthly,间隔为 3。 int
类型 定期类型:每周、每月等。 “absoluteMonthly”
“weekly”

AccessReviewRecurrenceRange

名称 说明
endDate 计划评审结束时的 DateTime。 如果类型为 endDate,则为必需项 字符串
numberOfOccurrences 重复访问评审的次数。 必需,如果类型已编号,则必须为正数。 int
startDate 计划开始评审时的 DateTime。 这可能是将来的日期。 创建时必需。 字符串
type 定期范围类型。 可能的值为:endDate、noEnd、numbered。 'endDate'
“noEnd”
“numbered”

ARM 模板资源定义

accessReviewScheduleDefinitions 资源类型可以使用面向以下对象的操作进行部署:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Authorization/accessReviewScheduleDefinitions 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Authorization/accessReviewScheduleDefinitions",
  "apiVersion": "2021-11-16-preview",
  "name": "string",
  "backupReviewers": [
    {
      "principalId": "string"
    }
  ],
  "descriptionForAdmins": "string",
  "descriptionForReviewers": "string",
  "displayName": "string",
  "instances": [
    {
      "properties": {
        "backupReviewers": [
          {
            "principalId": "string"
          }
        ],
        "endDateTime": "string",
        "reviewers": [
          {
            "principalId": "string"
          }
        ],
        "startDateTime": "string"
      }
    }
  ],
  "reviewers": [
    {
      "principalId": "string"
    }
  ],
  "settings": {
    "autoApplyDecisionsEnabled": "bool",
    "defaultDecision": "string",
    "defaultDecisionEnabled": "bool",
    "instanceDurationInDays": "int",
    "justificationRequiredOnApproval": "bool",
    "mailNotificationsEnabled": "bool",
    "recommendationLookBackDuration": "string",
    "recommendationsEnabled": "bool",
    "recurrence": {
      "pattern": {
        "interval": "int",
        "type": "string"
      },
      "range": {
        "endDate": "string",
        "numberOfOccurrences": "int",
        "startDate": "string",
        "type": "string"
      }
    },
    "reminderNotificationsEnabled": "bool"
  }
}

属性值

accessReviewScheduleDefinitions

名称 说明 Value
type 资源类型 'Microsoft.Authorization/accessReviewScheduleDefinitions'
apiVersion 资源 API 版本 '2021-11-16-preview'
name 资源名称 字符串 (必需)
backupReviewers 这是备份审阅者的集合。 AccessReviewReviewer[]
descriptionForAdmins 由访问评审创建者提供且对管理员可见的说明。 字符串
descriptionForReviewers 访问评审创建者提供的说明,要向审阅者显示。 字符串
displayName 计划定义的显示名称。 字符串
instances 这是在进行扩展时返回的实例集合。 AccessReviewInstance[]
评论家 这是审阅者的集合。 AccessReviewReviewer[]
设置 访问评审设置。 AccessReviewScheduleSettings

AccessReviewReviewer

名称 说明
principalId user/servicePrincipal) (审阅者的 ID 字符串

AccessReviewInstance

名称 说明
properties Access Review 属性。 AccessReviewInstanceProperties

AccessReviewInstanceProperties

名称 说明
backupReviewers 这是备份审阅者的集合。 AccessReviewReviewer[]
endDateTime 计划审阅实例结束时的 DateTime。 字符串
评论家 这是审阅者的集合。 AccessReviewReviewer[]
startDateTime 计划启动评审实例时的 DateTime。 字符串

AccessReviewScheduleSettings

名称 说明
autoApplyDecisionsEnabled 指示是否启用自动应用功能以自动更改目标对象访问资源的标志。 如果未启用,则用户必须在评审完成后应用访问评审。 bool
defaultDecision 这指定访问评审完成时 autoReview 功能的行为。 “批准”
“拒绝”
'建议'
defaultDecisionEnabled 指示审阅者在评审访问权限时是否需要提供理由的标志。 bool
instanceDurationInDays 实例的持续时间(以天为单位)。 int
justificationRequiredOnApproval 用于指示在记录决策时是否要求审阅者传递理由的标志。 bool
mailNotificationsEnabled 指示是否启用向审阅者和审阅创建者发送邮件的标志。 bool
recommendationLookBackDuration 访问评审的建议是通过查看 30 天的数据 (w.r.t 默认) 开始计算的。 但是,在某些情况下,客户希望更改回溯时间,并改为配置 60 天、90 天等。 此设置允许客户配置此持续时间。 该值应采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此代码可用于将 TimeSpan 转换为有效的间隔字符串:XmlConvert.ToString (新的 TimeSpan (小时、分钟、秒) ) 字符串
recommendationsEnabled 指示是否启用向审阅者显示建议的标志。 bool
recurrence 访问评审设置。 AccessReviewRecurrenceSettings
reminderNotificationsEnabled 指示是否启用向审阅者发送提醒电子邮件的标志。 bool

AccessReviewRecurrenceSettings

名称 说明
pattern 访问评审计划定义定期模式。 AccessReviewRecurrencePattern
range 访问评审计划定义重复周期范围。 AccessReviewRecurrenceRange

AccessReviewRecurrencePattern

名称 说明
interval 重复周期的间隔。 对于季度评审,对于类型:absoluteMonthly,间隔为 3。 int
类型 定期类型:每周、每月等。 “absoluteMonthly”
“weekly”

AccessReviewRecurrenceRange

名称 说明
endDate 计划评审结束时的 DateTime。 如果类型为 endDate,则为必需项 字符串
numberOfOccurrences 重复访问评审的次数。 必需,如果类型已编号,则必须为正数。 int
startDate 计划开始评审时的 DateTime。 这可能是将来的日期。 创建时是必需的。 字符串
type 定期范围类型。 可能的值为:endDate、noEnd、numbered。 “endDate”
“noEnd”
“numbered”

Terraform (AzAPI 提供程序) 资源定义

accessReviewScheduleDefinitions 资源类型可以使用面向以下对象的操作进行部署:

  • 订阅

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Authorization/accessReviewScheduleDefinitions 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/accessReviewScheduleDefinitions@2021-11-16-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    backupReviewers = [
      {
        principalId = "string"
      }
    ]
    descriptionForAdmins = "string"
    descriptionForReviewers = "string"
    displayName = "string"
    instances = [
      {
        properties = {
          backupReviewers = [
            {
              principalId = "string"
            }
          ]
          endDateTime = "string"
          reviewers = [
            {
              principalId = "string"
            }
          ]
          startDateTime = "string"
        }
      }
    ]
    reviewers = [
      {
        principalId = "string"
      }
    ]
    settings = {
      autoApplyDecisionsEnabled = bool
      defaultDecision = "string"
      defaultDecisionEnabled = bool
      instanceDurationInDays = int
      justificationRequiredOnApproval = bool
      mailNotificationsEnabled = bool
      recommendationLookBackDuration = "string"
      recommendationsEnabled = bool
      recurrence = {
        pattern = {
          interval = int
          type = "string"
        }
        range = {
          endDate = "string"
          numberOfOccurrences = int
          startDate = "string"
          type = "string"
        }
      }
      reminderNotificationsEnabled = bool
    }
  })
}

属性值

accessReviewScheduleDefinitions

名称 说明 Value
type 资源类型 “Microsoft.Authorization/accessReviewScheduleDefinitions@2021-11-16-preview”
name 资源名称 字符串 (必需)
parent_id 若要部署到订阅,请使用该订阅的 ID。 字符串 (必需)
backupReviewers 这是备份审阅者的集合。 AccessReviewReviewer[]
descriptionForAdmins 由访问评审创建者提供且对管理员可见的说明。 字符串
descriptionForReviewers 由访问评审创建者提供的说明,要向审阅者显示。 字符串
displayName 计划定义的显示名称。 字符串
instances 这是在进行扩展时返回的实例集合。 AccessReviewInstance[]
评论家 这是审阅者的集合。 AccessReviewReviewer[]
设置 访问评审设置。 AccessReviewScheduleSettings

AccessReviewReviewer

名称 说明
principalId 审阅者的 ID (user/servicePrincipal) 字符串

AccessReviewInstance

名称 说明
properties Access Review 属性。 AccessReviewInstanceProperties

AccessReviewInstanceProperties

名称 说明
backupReviewers 这是备份审阅者的集合。 AccessReviewReviewer[]
endDateTime 审阅实例计划结束时的 DateTime。 字符串
评论家 这是审阅者的集合。 AccessReviewReviewer[]
startDateTime 计划启动审阅实例时的 DateTime。 字符串

AccessReviewScheduleSettings

名称 说明
autoApplyDecisionsEnabled 指示是否启用自动应用功能以自动更改目标对象访问资源的标志。 如果未启用,则用户必须在评审完成后应用访问评审。 bool
defaultDecision 这指定在访问评审完成时自动查看功能的行为。 “批准”
“拒绝”
“建议”
defaultDecisionEnabled 指示审阅者在评审访问权限时是否需要提供理由的标志。 bool
instanceDurationInDays 实例的持续时间(以天为单位)。 int
justificationRequiredOnApproval 用于指示在记录决策时是否要求审阅者传递理由的标志。 bool
mailNotificationsEnabled 指示是否启用向审阅者和审阅创建者发送邮件的标志。 bool
recommendationLookBackDuration 访问评审的建议是通过查看 30 天的数据 (w.r.t 默认) 开始计算的。 但是,在某些情况下,客户希望更改回溯时间,并改为配置 60 天、90 天等。 此设置允许客户配置此持续时间。 该值应采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此代码可用于将 TimeSpan 转换为有效的间隔字符串:XmlConvert.ToString (新的 TimeSpan (小时、分钟、秒) ) 字符串
recommendationsEnabled 指示是否启用向审阅者显示建议的标志。 bool
recurrence 访问评审设置。 AccessReviewRecurrenceSettings
reminderNotificationsEnabled 指示是否启用向审阅者发送提醒电子邮件的标志。 bool

AccessReviewRecurrenceSettings

名称 说明
pattern 访问评审计划定义定期模式。 AccessReviewRecurrencePattern
range 访问评审计划定义重复周期范围。 AccessReviewRecurrenceRange

AccessReviewRecurrencePattern

名称 说明
interval 重复周期的间隔。 对于季度评审,对于类型:absoluteMonthly,间隔为 3。 int
类型 定期类型:每周、每月等。 “absoluteMonthly”
“weekly”

AccessReviewRecurrenceRange

名称 说明
endDate 计划评审结束时的 DateTime。 如果类型为 endDate,则为必需项 字符串
numberOfOccurrences 重复访问评审的次数。 必需,如果类型已编号,则必须为正数。 int
startDate 计划开始评审时的 DateTime。 这可能是将来的日期。 创建时必需。 字符串
type 定期范围类型。 可能的值为:endDate、noEnd、numbered。 “endDate”
“noEnd”
“numbered”