azure.mgmt.authorization.v2021_12_01_preview.operations module¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_default_settingsattribute.Get access review default settings for the subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AccessReviewDefaultSettings or the result of cls(response)
- Return type
- Raises
-
put(properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessReviewDefaultSettings Get access review default settings for the subscription.
- Parameters
properties (AccessReviewScheduleSettings or IO) – Access review schedule settings. Is either a AccessReviewScheduleSettings type or a IO type. Required.
- Keyword Arguments
- Returns
AccessReviewDefaultSettings or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_history_definition_instanceattribute.Generates a uri which can be used to retrieve review history data. This URI has a TTL of 1 day and can be retrieved by fetching the accessReviewHistoryDefinition object.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AccessReviewHistoryInstance or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_history_definition_instancesattribute.Get access review history definition instances by definition Id.
- Parameters
history_definition_id (str) – The id of the access review history definition. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewHistoryInstance or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_history_definitionattribute.-
create(history_definition_id: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessReviewHistoryDefinition Create a scheduled or one-time Access Review History Definition.
- Parameters
history_definition_id (str) – The id of the access review history definition. Required.
properties (AccessReviewHistoryDefinitionProperties or IO) – Access review history definition properties. Is either a AccessReviewHistoryDefinitionProperties type or a IO type. Required.
- Keyword Arguments
- Returns
AccessReviewHistoryDefinition or the result of cls(response)
- Return type
- Raises
Delete an access review history definition.
-
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_history_definitionsattribute.Get access review history definition by definition Id.
Lists the accessReviewHistoryDefinitions available from this provider, definition instances are only available for 30 days after creation.
- Parameters
filter (str) – The filter to apply on the operation. Only standard filters on definition name and created date are supported. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewHistoryDefinition or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_instance_contacted_reviewersattribute.Get access review instance contacted reviewers.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewContactedReviewer or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_instance_decisionsattribute.Get access review instance decisions.
- Parameters
schedule_definition_id (str) – The id of the access review schedule definition. Required.
id (str) – The id of the access review instance. Required.
filter (str) – The filter to apply on the operation. Other than standard filters, one custom filter option is supported : ‘assignedToMeToReview()’. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewDecision or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_instance_my_decisionsattribute.Get my single access review instance decision.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AccessReviewDecision or the result of cls(response)
- Return type
- Raises
Get my access review instance decisions.
- Parameters
schedule_definition_id (str) – The id of the access review schedule definition. Required.
id (str) – The id of the access review instance. Required.
filter (str) – The filter to apply on the operation. Other than standard filters, one custom filter option is supported : ‘assignedToMeToReview()’. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewDecision or the result of cls(response)
- Return type
- Raises
-
patch(schedule_definition_id: str, id: str, decision_id: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessReviewDecision Record a decision.
- Parameters
schedule_definition_id (str) – The id of the access review schedule definition. Required.
id (str) – The id of the access review instance. Required.
decision_id (str) – The id of the decision record. Required.
properties (AccessReviewDecisionProperties or IO) – Access review decision properties to patch. Is either a AccessReviewDecisionProperties type or a IO type. Required.
- Keyword Arguments
- Returns
AccessReviewDecision or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_instanceattribute.An action to accept recommendations for decision in an access review instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
An action to apply all decisions for an access review instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
An action to reset all decisions for an access review instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
An action to send reminders for an access review instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
An action to stop an access review instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_instances_assigned_for_my_approvalattribute.Get single access review instance assigned for my approval.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AccessReviewInstance or the result of cls(response)
- Return type
- Raises
Get access review instances assigned for my approval.
- Parameters
schedule_definition_id (str) – The id of the access review schedule definition. Required.
filter (str) – The filter to apply on the operation. Other than standard filters, one custom filter option is supported : ‘assignedToMeToReview()’. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewInstance or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_instancesattribute.-
create(schedule_definition_id: str, id: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessReviewInstance Update access review instance.
- Parameters
schedule_definition_id (str) – The id of the access review schedule definition. Required.
id (str) – The id of the access review instance. Required.
properties (AccessReviewInstanceProperties or IO) – Access review instance properties. Is either a AccessReviewInstanceProperties type or a IO type. Required.
- Keyword Arguments
- Returns
AccessReviewInstance or the result of cls(response)
- Return type
- Raises
Get access review instances.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AccessReviewInstance or the result of cls(response)
- Return type
- Raises
Get access review instances.
- Parameters
schedule_definition_id (str) – The id of the access review schedule definition. Required.
filter (str) – The filter to apply on the operation. Other than standard filters, one custom filter option is supported : ‘assignedToMeToReview()’. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewInstance or the result of cls(response)
- Return type
- Raises
-
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_schedule_definitions_assigned_for_my_approvalattribute.Get access review instances assigned for my approval.
- Parameters
filter (str) – The filter to apply on the operation. Other than standard filters, one custom filter option is supported : ‘assignedToMeToReview()’. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewScheduleDefinition or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’saccess_review_schedule_definitionsattribute.-
create_or_update_by_id(schedule_definition_id: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessReviewScheduleDefinition Create or Update access review schedule definition.
- Parameters
schedule_definition_id (str) – The id of the access review schedule definition. Required.
properties (AccessReviewScheduleDefinitionProperties or IO) – Access review schedule definition properties. Is either a AccessReviewScheduleDefinitionProperties type or a IO type. Required.
- Keyword Arguments
- Returns
AccessReviewScheduleDefinition or the result of cls(response)
- Return type
- Raises
Delete access review schedule definition.
Get single access review definition.
Get access review schedule definitions.
- Parameters
filter (str) – The filter to apply on the operation. Other than standard filters, one custom filter option is supported : ‘assignedToMeToReview()’. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewScheduleDefinition or the result of cls(response)
- Return type
- Raises
Stop access review definition.
-
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’soperationsattribute.Lists the operations available from this provider.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Operation or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sscope_access_review_default_settingsattribute.Get access review default settings for the subscription.
-
put(scope: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessReviewDefaultSettings Get access review default settings for the subscription.
- Parameters
scope (str) – The scope of the resource. Required.
properties (AccessReviewScheduleSettings or IO) – Access review schedule settings. Is either a AccessReviewScheduleSettings type or a IO type. Required.
- Keyword Arguments
- Returns
AccessReviewDefaultSettings or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sscope_access_review_history_definition_instanceattribute.Generates a uri which can be used to retrieve review history data. This URI has a TTL of 1 day and can be retrieved by fetching the accessReviewHistoryDefinition object.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AccessReviewHistoryInstance or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sscope_access_review_history_definition_instancesattribute.Get access review history definition instances by definition Id.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewHistoryInstance or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sscope_access_review_history_definitionattribute.-
create(scope: str, history_definition_id: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessReviewHistoryDefinition Create a scheduled or one-time Access Review History Definition.
- Parameters
scope (str) – The scope of the resource. Required.
history_definition_id (str) – The id of the access review history definition. Required.
properties (AccessReviewHistoryDefinitionProperties or IO) – Access review history definition properties. Is either a AccessReviewHistoryDefinitionProperties type or a IO type. Required.
- Keyword Arguments
- Returns
AccessReviewHistoryDefinition or the result of cls(response)
- Return type
- Raises
Delete an access review history definition.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
-
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sscope_access_review_history_definitionsattribute.Get access review history definition by definition Id.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AccessReviewHistoryDefinition or the result of cls(response)
- Return type
- Raises
Lists the accessReviewHistoryDefinitions available from this provider, definition instances are only available for 30 days after creation.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewHistoryDefinition or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sscope_access_review_instance_contacted_reviewersattribute.Get access review instance contacted reviewers.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewContactedReviewer or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sscope_access_review_instance_decisionsattribute.Get access review instance decisions.
- Parameters
scope (str) – The scope of the resource. Required.
schedule_definition_id (str) – The id of the access review schedule definition. Required.
id (str) – The id of the access review instance. Required.
filter (str) – The filter to apply on the operation. Other than standard filters, one custom filter option is supported : ‘assignedToMeToReview()’. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewDecision or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sscope_access_review_instanceattribute.An action to apply all decisions for an access review instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
-
record_all_decisions(scope: str, schedule_definition_id: str, id: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None An action to approve/deny all decisions for a review with certain filters.
- Parameters
scope (str) – The scope of the resource. Required.
schedule_definition_id (str) – The id of the access review schedule definition. Required.
id (str) – The id of the access review instance. Required.
properties (RecordAllDecisionsProperties or IO) – Record all decisions payload. Is either a RecordAllDecisionsProperties type or a IO type. Required.
- Keyword Arguments
- Returns
None or the result of cls(response)
- Return type
- Raises
An action to reset all decisions for an access review instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
An action to send reminders for an access review instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
An action to stop an access review instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sscope_access_review_instancesattribute.-
create(scope: str, schedule_definition_id: str, id: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessReviewInstance Update access review instance.
- Parameters
scope (str) – The scope of the resource. Required.
schedule_definition_id (str) – The id of the access review schedule definition. Required.
id (str) – The id of the access review instance. Required.
properties (AccessReviewInstanceProperties or IO) – Access review instance properties. Is either a AccessReviewInstanceProperties type or a IO type. Required.
- Keyword Arguments
- Returns
AccessReviewInstance or the result of cls(response)
- Return type
- Raises
Get access review instances.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AccessReviewInstance or the result of cls(response)
- Return type
- Raises
Get access review instances.
- Parameters
scope (str) – The scope of the resource. Required.
schedule_definition_id (str) – The id of the access review schedule definition. Required.
filter (str) – The filter to apply on the operation. Other than standard filters, one custom filter option is supported : ‘assignedToMeToReview()’. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewInstance or the result of cls(response)
- Return type
- Raises
-
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sscope_access_review_schedule_definitionsattribute.-
create_or_update_by_id(scope: str, schedule_definition_id: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessReviewScheduleDefinition Create or Update access review schedule definition.
- Parameters
scope (str) – The scope of the resource. Required.
schedule_definition_id (str) – The id of the access review schedule definition. Required.
properties (AccessReviewScheduleDefinitionProperties or IO) – Access review schedule definition properties. Is either a AccessReviewScheduleDefinitionProperties type or a IO type. Required.
- Keyword Arguments
- Returns
AccessReviewScheduleDefinition or the result of cls(response)
- Return type
- Raises
Delete access review schedule definition.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
Get single access review definition.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AccessReviewScheduleDefinition or the result of cls(response)
- Return type
- Raises
Get access review schedule definitions.
- Parameters
scope (str) – The scope of the resource. Required.
filter (str) – The filter to apply on the operation. Other than standard filters, one custom filter option is supported : ‘assignedToMeToReview()’. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewScheduleDefinition or the result of cls(response)
- Return type
- Raises
Stop access review definition.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
-
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’stenant_level_access_review_instance_contacted_reviewersattribute.Get access review instance contacted reviewers.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AccessReviewContactedReviewer or the result of cls(response)
- Return type
- Raises