AccessReviewScheduleDefinitionsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient's
<xref:access_review_schedule_definitions> attribute.
Constructor
AccessReviewScheduleDefinitionsOperations(*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.
async create_or_update_by_id(schedule_definition_id: str, properties: _models.AccessReviewScheduleDefinitionProperties, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AccessReviewScheduleDefinitionParameters
| Name | Description |
|---|---|
|
schedule_definition_id
Required
|
The id of the access review schedule definition. Required. |
|
properties
Required
|
Access review schedule definition properties. Is either a AccessReviewScheduleDefinitionProperties type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
AccessReviewScheduleDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete_by_id
Delete access review schedule definition.
async delete_by_id(schedule_definition_id: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
schedule_definition_id
Required
|
The id of the access review schedule definition. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_by_id
Get single access review definition.
async get_by_id(schedule_definition_id: str, **kwargs: Any) -> AccessReviewScheduleDefinitionParameters
| Name | Description |
|---|---|
|
schedule_definition_id
Required
|
The id of the access review schedule definition. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
AccessReviewScheduleDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Get access review schedule definitions.
list(filter: str | None = None, **kwargs: Any) -> AsyncIterable[AccessReviewScheduleDefinition]Parameters
| Name | Description |
|---|---|
|
filter
|
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. Default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either AccessReviewScheduleDefinition or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
stop
Stop access review definition.
async stop(schedule_definition_id: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
schedule_definition_id
Required
|
The id of the access review schedule definition. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.authorization.v2021_12_01_preview.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv71\\Lib\\site-packages\\azure\\mgmt\\authorization\\v2021_12_01_preview\\models\\__init__.py'>