ArmAuthorizationModelFactory.AccessReviewScheduleDefinitionData Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public static Azure.ResourceManager.Authorization.AccessReviewScheduleDefinitionData AccessReviewScheduleDefinitionData(Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, string displayName = default, Azure.ResourceManager.Authorization.Models.AccessReviewScheduleDefinitionStatus? status = default, string descriptionForAdmins = default, string descriptionForReviewers = default, Azure.ResourceManager.Authorization.Models.AccessReviewScope scope = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Authorization.Models.AccessReviewReviewer> reviewers = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Authorization.Models.AccessReviewReviewer> backupReviewers = default, Azure.ResourceManager.Authorization.Models.AccessReviewScheduleDefinitionReviewersType? reviewersType = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Authorization.AccessReviewInstanceData> instances = default, string principalId = default, Azure.ResourceManager.Authorization.Models.AccessReviewActorIdentityType? principalType = default, string principalName = default, string userPrincipalName = default, bool? isMailNotificationsEnabled = default, bool? isReminderNotificationsEnabled = default, bool? isDefaultDecisionEnabled = default, bool? isJustificationRequiredOnApproval = default, Azure.ResourceManager.Authorization.Models.AccessReviewDefaultDecisionType? defaultDecision = default, bool? isAutoApplyDecisionsEnabled = default, bool? isRecommendationsEnabled = default, TimeSpan? recommendationLookBackDuration = default, int? instanceDurationInDays = default, Azure.ResourceManager.Authorization.Models.AccessReviewRecurrencePattern pattern = default, Azure.ResourceManager.Authorization.Models.AccessReviewRecurrenceRange range = default);
static member AccessReviewScheduleDefinitionData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * string * Nullable<Azure.ResourceManager.Authorization.Models.AccessReviewScheduleDefinitionStatus> * string * string * Azure.ResourceManager.Authorization.Models.AccessReviewScope * seq<Azure.ResourceManager.Authorization.Models.AccessReviewReviewer> * seq<Azure.ResourceManager.Authorization.Models.AccessReviewReviewer> * Nullable<Azure.ResourceManager.Authorization.Models.AccessReviewScheduleDefinitionReviewersType> * seq<Azure.ResourceManager.Authorization.AccessReviewInstanceData> * string * Nullable<Azure.ResourceManager.Authorization.Models.AccessReviewActorIdentityType> * string * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.Authorization.Models.AccessReviewDefaultDecisionType> * Nullable<bool> * Nullable<bool> * Nullable<TimeSpan> * Nullable<int> * Azure.ResourceManager.Authorization.Models.AccessReviewRecurrencePattern * Azure.ResourceManager.Authorization.Models.AccessReviewRecurrenceRange -> Azure.ResourceManager.Authorization.AccessReviewScheduleDefinitionData
Public Shared Function AccessReviewScheduleDefinitionData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional displayName As String = Nothing, Optional status As Nullable(Of AccessReviewScheduleDefinitionStatus) = Nothing, Optional descriptionForAdmins As String = Nothing, Optional descriptionForReviewers As String = Nothing, Optional scope As AccessReviewScope = Nothing, Optional reviewers As IEnumerable(Of AccessReviewReviewer) = Nothing, Optional backupReviewers As IEnumerable(Of AccessReviewReviewer) = Nothing, Optional reviewersType As Nullable(Of AccessReviewScheduleDefinitionReviewersType) = Nothing, Optional instances As IEnumerable(Of AccessReviewInstanceData) = Nothing, Optional principalId As String = Nothing, Optional principalType As Nullable(Of AccessReviewActorIdentityType) = Nothing, Optional principalName As String = Nothing, Optional userPrincipalName As String = Nothing, Optional isMailNotificationsEnabled As Nullable(Of Boolean) = Nothing, Optional isReminderNotificationsEnabled As Nullable(Of Boolean) = Nothing, Optional isDefaultDecisionEnabled As Nullable(Of Boolean) = Nothing, Optional isJustificationRequiredOnApproval As Nullable(Of Boolean) = Nothing, Optional defaultDecision As Nullable(Of AccessReviewDefaultDecisionType) = Nothing, Optional isAutoApplyDecisionsEnabled As Nullable(Of Boolean) = Nothing, Optional isRecommendationsEnabled As Nullable(Of Boolean) = Nothing, Optional recommendationLookBackDuration As Nullable(Of TimeSpan) = Nothing, Optional instanceDurationInDays As Nullable(Of Integer) = Nothing, Optional pattern As AccessReviewRecurrencePattern = Nothing, Optional range As AccessReviewRecurrenceRange = Nothing) As AccessReviewScheduleDefinitionData
Parameters
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
- name
- String
The name of the resource.
- resourceType
- ResourceType
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
- systemData
- SystemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
- displayName
- String
The display name for the schedule definition.
This read-only field specifies the status of an accessReview.
- descriptionForAdmins
- String
The description provided by the access review creator and visible to admins.
- descriptionForReviewers
- String
The description provided by the access review creator to be shown to reviewers.
- scope
- AccessReviewScope
This is used to define what to include in scope of the review. The scope definition includes the resourceId and roleDefinitionId.
- reviewers
- IEnumerable<AccessReviewReviewer>
This is the collection of reviewers.
- backupReviewers
- IEnumerable<AccessReviewReviewer>
This is the collection of backup reviewers.
- reviewersType
- Nullable<AccessReviewScheduleDefinitionReviewersType>
This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review.
- instances
- IEnumerable<AccessReviewInstanceData>
This is the collection of instances returned when one does an expand on it.
- principalId
- String
The identity id.
- principalType
- Nullable<AccessReviewActorIdentityType>
The identity type : user/servicePrincipal.
- principalName
- String
The identity display name.
- userPrincipalName
- String
The user principal name(if valid).
Flag to indicate whether sending mails to reviewers and the review creator is enabled.
Flag to indicate whether sending reminder emails to reviewers are enabled.
Flag to indicate whether reviewers are required to provide a justification when reviewing access.
Flag to indicate whether the reviewer is required to pass justification when recording a decision.
- defaultDecision
- Nullable<AccessReviewDefaultDecisionType>
This specifies the behavior for the autoReview feature when an access review completes.
Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.
Flag to indicate whether showing recommendations to reviewers is enabled.
Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
- pattern
- AccessReviewRecurrencePattern
Access Review schedule definition recurrence pattern.
Access Review schedule definition recurrence range.
Returns
A new AccessReviewScheduleDefinitionData instance for mocking.