Microsoft.Authorization accessReviewScheduleDefinitions

Bicep 資源定義

accessReviewScheduleDefinitions 資源類型可以部署到:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.Authorization/accessReviewScheduleDefinitions 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Authorization/accessReviewScheduleDefinitions@2021-12-01-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 排程定義的顯示名稱。 字串
執行個體 這是當實例進行展開時所傳回的實例集合。 AccessReviewInstance[]
評論家 這是檢閱者的集合。 AccessReviewReviewer[]
settings 存取權檢閱設定。 AccessReviewScheduleSettings

AccessReviewReviewer

名稱 描述
principalId 檢閱者 (使用者/servicePrincipal) 的識別碼 字串

AccessReviewInstance

名稱 描述
properties 存取檢閱屬性。 AccessReviewInstanceProperties

AccessReviewInstanceProperties

名稱 描述
backupReviewers 這是備份檢閱者的集合。 AccessReviewReviewer[]
endDateTime 檢閱實例排程為結束時的 DateTime。 字串
評論家 這是檢閱者的集合。 AccessReviewReviewer[]
startDateTime 排程檢閱實例開始時的 DateTime。 字串

AccessReviewScheduleSettings

名稱 描述
autoApplyDecisionsEnabled 旗標,指出是否已啟用自動套用功能,以自動變更目標物件存取資源。 如果未啟用,使用者必須在檢閱完成後套用存取權檢閱。 bool
defaultDecision 這會指定存取權檢閱完成時 autoReview 功能的行為。 '核准'
'Deny'
'Recommendation'
defaultDecisionEnabled 旗標,指出檢閱者是否需要在檢閱存取權時提供理由。 bool
instanceDurationInDays 實例天數的持續時間。 int
justificationRequiredOnApproval 旗標,指出在錄製決策時是否需要檢閱者通過理由。 bool
mailNotificationsEnabled 旗標,指出是否將郵件傳送給檢閱者和檢閱建立者已啟用。 bool
recommendationLookBackDuration 根據預設,存取權檢閱的建議會藉由查看 w.r.t 檢閱) 開始日期 (30 天的資料來計算。 不過,在某些案例中,客戶想要變更回頭查看的時間,並改為想要設定 60 天、90 天等等。 此設定可讓客戶設定此持續時間。 此值應該以 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此程式碼可用來將 TimeSpan 轉換為有效的間隔字串:XmlConvert.ToString (新的 TimeSpan (小時、分鐘、秒) ) 字串
recommendationsEnabled 旗標,指出是否已啟用對檢閱者顯示建議。 bool
週期 存取權檢閱設定。 AccessReviewRecurrenceSettings
reminderNotificationsEnabled 旗標,指出是否已啟用傳送提醒電子郵件給檢閱者。 bool

AccessReviewRecurrenceSettings

名稱 描述
模式 存取權檢閱排程定義週期模式。 AccessReviewRecurrencePattern
range 存取權檢閱排程定義週期範圍。 AccessReviewRecurrenceRange

AccessReviewRecurrencePattern

名稱 描述
interval 週期的間隔。 針對每季檢閱,類型 為 3 的間隔:absoluteMonthly。 int
type 週期類型:每週、每月等。 '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-12-01-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

名稱 描述
type 資源類型 'Microsoft.Authorization/accessReviewScheduleDefinitions'
apiVersion 資源 API 版本 '2021-12-01-preview'
NAME 資源名稱 需要字串 ()
backupReviewers 這是備份檢閱者的集合。 AccessReviewReviewer[]
descriptionForAdmins 存取權檢閱建立者提供的描述,並可供系統管理員看見。 字串
descriptionForReviewers 要向檢閱者顯示之存取權檢閱建立者提供的描述。 字串
displayName 排程定義的顯示名稱。 字串
執行個體 這是當實例進行展開時所傳回的實例集合。 AccessReviewInstance[]
評論家 這是檢閱者的集合。 AccessReviewReviewer[]
settings 存取權檢閱設定。 AccessReviewScheduleSettings

AccessReviewReviewer

名稱 描述
principalId 檢閱者 (使用者/servicePrincipal) 的識別碼 字串

AccessReviewInstance

名稱 描述
properties 存取檢閱屬性。 AccessReviewInstanceProperties

AccessReviewInstanceProperties

名稱 描述
backupReviewers 這是備份檢閱者的集合。 AccessReviewReviewer[]
endDateTime 檢閱實例排程為結束時的 DateTime。 字串
評論家 這是檢閱者的集合。 AccessReviewReviewer[]
startDateTime 排程檢閱實例開始時的 DateTime。 字串

AccessReviewScheduleSettings

名稱 描述
autoApplyDecisionsEnabled 旗標,指出是否已啟用自動套用功能,以自動變更目標物件存取資源。 如果未啟用,使用者必須在檢閱完成後套用存取權檢閱。 bool
defaultDecision 這會指定存取權檢閱完成時 autoReview 功能的行為。 '核准'
'Deny'
'Recommendation'
defaultDecisionEnabled 旗標,指出檢閱者是否需要在檢閱存取權時提供理由。 bool
instanceDurationInDays 實例天數的持續時間。 int
justificationRequiredOnApproval 旗標,指出在錄製決策時是否需要檢閱者通過理由。 bool
mailNotificationsEnabled 旗標,指出是否將郵件傳送給檢閱者和檢閱建立者已啟用。 bool
recommendationLookBackDuration 檢視 w.r.t 檢閱預設) 檢閱開始日期的 30 天 (,計算存取權檢閱的建議。 不過,在某些情況下,客戶想要變更回頭查看的時間,並想要改為設定 60 天、90 天等等。 此設定可讓客戶設定此持續時間。 此值應以 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此程式碼可用來將 TimeSpan 轉換成有效的間隔字串:XmlConvert.ToString (新的 TimeSpan (小時、分鐘、秒) ) 字串
recommendationsEnabled 旗標,指出是否已啟用對檢閱者顯示建議。 bool
週期 存取權檢閱設定。 AccessReviewRecurrenceSettings
reminderNotificationsEnabled 旗標,指出是否已啟用傳送提醒電子郵件給檢閱者。 bool

AccessReviewRecurrenceSettings

名稱 描述
模式 存取權檢閱排程定義週期模式。 AccessReviewRecurrencePattern
range 存取權檢閱排程定義週期範圍。 AccessReviewRecurrenceRange

AccessReviewRecurrencePattern

名稱 描述
interval 週期的間隔。 針對每季檢閱,類型為 3 的間隔:absoluteMonthly。 int
type 週期類型:每週、每月等。 '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-12-01-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

名稱 描述
type 資源類型 「Microsoft.Authorization/accessReviewScheduleDefinitions@2021-12-01-preview」
NAME 資源名稱 需要字串 ()
parent_id 若要部署至資源群組,請使用該資源群組的識別碼。 需要字串 ()
backupReviewers 這是備份檢閱者的集合。 AccessReviewReviewer[]
descriptionForAdmins 存取權檢閱建立者提供的描述,並可供系統管理員看見。 字串
descriptionForReviewers 要向檢閱者顯示之存取權檢閱建立者提供的描述。 字串
displayName 排程定義的顯示名稱。 字串
執行個體 這是當實例進行展開時所傳回的實例集合。 AccessReviewInstance[]
評論家 這是檢閱者的集合。 AccessReviewReviewer[]
settings 存取權檢閱設定。 AccessReviewScheduleSettings

AccessReviewReviewer

名稱 描述
principalId 檢閱者 (使用者/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 根據預設,存取權檢閱的建議會藉由查看 w.r.t 檢閱) 開始日期 (30 天的資料來計算。 不過,在某些案例中,客戶想要變更回頭查看的時間,並改為想要設定 60 天、90 天等等。 此設定可讓客戶設定此持續時間。 此值應該以 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。此程式碼可用來將 TimeSpan 轉換為有效的間隔字串:XmlConvert.ToString (新的 TimeSpan (小時、分鐘、秒) ) 字串
recommendationsEnabled 旗標,指出是否已啟用對檢閱者顯示建議。 bool
週期 存取權檢閱設定。 AccessReviewRecurrenceSettings
reminderNotificationsEnabled 旗標,指出是否已啟用傳送提醒電子郵件給檢閱者。 bool

AccessReviewRecurrenceSettings

名稱 描述
模式 存取權檢閱排程定義週期模式。 AccessReviewRecurrencePattern
range 存取權檢閱排程定義週期範圍。 AccessReviewRecurrenceRange

AccessReviewRecurrencePattern

名稱 描述
interval 週期的間隔。 針對每季檢閱,類型 為 3 的間隔:absoluteMonthly。 int
type 週期類型:每週、每月等。 「absoluteMonthly」
「weekly」

AccessReviewRecurrenceRange

名稱 描述
endDate 排定檢閱結束時的 DateTime。 如果類型為 endDate,則為必要項 字串
numberOfOccurrences 重複存取權檢閱的次數。 必要,如果類型已編號,則必須為正數。 int
startDate 排定檢閱開始時的 DateTime。 這可能是未來的日期。 建立時需要。 字串
type 週期範圍類型。 可能的值為:endDate、noEnd、numbered。 「endDate」
「noEnd」
「numbered」