ScopeAccessReviewScheduleDefinitionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AuthorizationManagementClient's

<xref:scope_access_review_schedule_definitions> attribute.

Inheritance

builtins.object

ScopeAccessReviewScheduleDefinitionsOperations

Constructor

ScopeAccessReviewScheduleDefinitionsOperations(*args, **kwargs)

Methods

create_or_update_by_id	Create or Update access review schedule definition.
delete_by_id	Delete access review schedule definition.
get_by_id	Get single access review definition.
list	Get access review schedule definitions.
stop	Stop access review definition.

create_or_update_by_id

Create or Update access review schedule definition.

create_or_update_by_id(scope: str, schedule_definition_id: str, properties: _models.AccessReviewScheduleDefinitionProperties, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AccessReviewScheduleDefinition

Parameters

Name	Description
scope Required	str The scope of the resource. Required.
schedule_definition_id Required	str The id of the access review schedule definition. Required.
properties Required	AccessReviewScheduleDefinitionProperties or IO Access review schedule definition properties. Is either a AccessReviewScheduleDefinitionProperties type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AccessReviewScheduleDefinition	AccessReviewScheduleDefinition or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_by_id

Delete access review schedule definition.

delete_by_id(scope: str, schedule_definition_id: str, **kwargs: Any) -> None

Parameters

Name	Description
scope Required	str The scope of the resource. Required.
schedule_definition_id Required	str The id of the access review schedule definition. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_by_id

Get single access review definition.

get_by_id(scope: str, schedule_definition_id: str, **kwargs: Any) -> AccessReviewScheduleDefinition

Parameters

Name	Description
scope Required	str The scope of the resource. Required.
schedule_definition_id Required	str The id of the access review schedule definition. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AccessReviewScheduleDefinition	AccessReviewScheduleDefinition or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Get access review schedule definitions.

list(scope: str, filter: str | None = None, **kwargs: Any) -> Iterable[AccessReviewScheduleDefinition]

Parameters

Name	Description
scope Required	str The scope of the resource. Required.
filter Required	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-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[AccessReviewScheduleDefinition]	An iterator like instance of either AccessReviewScheduleDefinition or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

stop

Stop access review definition.

stop(scope: str, schedule_definition_id: str, **kwargs: Any) -> None

Parameters

Name	Description
scope Required	str The scope of the resource. Required.
schedule_definition_id Required	str The id of the access review schedule definition. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.authorization.v2021_12_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\authorization\\v2021_12_01_preview\\models\\__init__.py'>