scope_access_review_default_settings

Creates, updates, deletes, gets or lists a scope_access_review_default_settings resource.

Overview

Name	scope_access_review_default_settings
Type	Resource
Id	azure.authorization.scope_access_review_default_settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoApplyDecisionsEnabled	boolean	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.
defaultDecision	string	This specifies the behavior for the autoReview feature when an access review completes. Known values are: "Approve", "Deny", and "Recommendation". (Approve, Deny, Recommendation)
defaultDecisionEnabled	boolean	Flag to indicate whether reviewers are required to provide a justification when reviewing access.
instanceDurationInDays	integer	The duration in days for an instance.
justificationRequiredOnApproval	boolean	Flag to indicate whether the reviewer is required to pass justification when recording a decision.
mailNotificationsEnabled	boolean	Flag to indicate whether sending mails to reviewers and the review creator is enabled.
recommendationLookBackDuration	string	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)).
recommendationsEnabled	boolean	Flag to indicate whether showing recommendations to reviewers is enabled.
recurrence	object	Access Review Settings.
reminderNotificationsEnabled	boolean	Flag to indicate whether sending reminder emails to reviewers are enabled.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope		Get access review default settings for the subscription.
put	exec	scope		Get access review default settings for the subscription.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
scope	string	The scope of the resource. Required.

SELECT examples

get

Get access review default settings for the subscription.

SELECT
id,
name,
autoApplyDecisionsEnabled,
defaultDecision,
defaultDecisionEnabled,
instanceDurationInDays,
justificationRequiredOnApproval,
mailNotificationsEnabled,
recommendationLookBackDuration,
recommendationsEnabled,
recurrence,
reminderNotificationsEnabled,
systemData,
type
FROM azure.authorization.scope_access_review_default_settings
WHERE scope = '{{ scope }}' -- required
;

Lifecycle Methods

put

Get access review default settings for the subscription.

EXEC azure.authorization.scope_access_review_default_settings.put 
@scope='{{ scope }}' --required 
@@json=
'{
"mailNotificationsEnabled": {{ mailNotificationsEnabled }}, 
"reminderNotificationsEnabled": {{ reminderNotificationsEnabled }}, 
"defaultDecisionEnabled": {{ defaultDecisionEnabled }}, 
"justificationRequiredOnApproval": {{ justificationRequiredOnApproval }}, 
"defaultDecision": "{{ defaultDecision }}", 
"autoApplyDecisionsEnabled": {{ autoApplyDecisionsEnabled }}, 
"recommendationsEnabled": {{ recommendationsEnabled }}, 
"recommendationLookBackDuration": "{{ recommendationLookBackDuration }}", 
"instanceDurationInDays": {{ instanceDurationInDays }}, 
"recurrence": "{{ recurrence }}"
}'
;