RoleEligibilityScheduleRequestsOperations Class

RoleEligibilityScheduleRequestsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

RoleEligibilityScheduleRequestsOperations

Constructor

RoleEligibilityScheduleRequestsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

cancel	Cancels a pending role eligibility schedule request.
create	Creates a role eligibility schedule request.
get	Get the specified role eligibility schedule request.
list_for_scope	Gets role eligibility schedule requests for a scope.

cancel

Cancels a pending role eligibility schedule request.

cancel(scope: str, role_eligibility_schedule_request_name: str, **kwargs: Any) -> None

Parameters

scope

str

Required

The scope of the role eligibility request to cancel.

role_eligibility_schedule_request_name

str

Required

The name of the role eligibility request to cancel.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

create

Creates a role eligibility schedule request.

create(scope: str, role_eligibility_schedule_request_name: str, parameters: _models.RoleEligibilityScheduleRequest, **kwargs: Any) -> _models.RoleEligibilityScheduleRequest

Parameters

scope

str

Required

The scope of the role eligibility schedule request to create. The scope can be any REST resource instance. For example, use '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/' for a subscription, '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.

role_eligibility_schedule_request_name

str

Required

The name of the role eligibility to create. It can be any valid GUID.

parameters

RoleEligibilityScheduleRequest

Required

Parameters for the role eligibility schedule request.

cls

callable

A custom type or function that will be passed the direct response

Returns

RoleEligibilityScheduleRequest, or the result of cls(response)

Return type

RoleEligibilityScheduleRequest

Exceptions

HttpResponseError

get

Get the specified role eligibility schedule request.

get(scope: str, role_eligibility_schedule_request_name: str, **kwargs: Any) -> _models.RoleEligibilityScheduleRequest

Parameters

scope

str

Required

The scope of the role eligibility schedule request.

role_eligibility_schedule_request_name

str

Required

The name (guid) of the role eligibility schedule request to get.

cls

callable

A custom type or function that will be passed the direct response

Returns

RoleEligibilityScheduleRequest, or the result of cls(response)

Return type

RoleEligibilityScheduleRequest

Exceptions

HttpResponseError

list_for_scope

Gets role eligibility schedule requests for a scope.

list_for_scope(scope: str, filter: Optional[str] = None, **kwargs: Any) -> Iterable[_models.RoleEligibilityScheduleRequestListResult]

Parameters

scope

str

Required

The scope of the role eligibility schedule requests.

filter

str

default value: None

The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedule requests at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role eligibility schedule requests requested by the current user. Use $filter=asTarget() to return all role eligibility schedule requests created for the current user. Use $filter=asApprover() to return all role eligibility schedule requests where the current user is an approver.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RoleEligibilityScheduleRequestListResult or the result of cls(response)

Return type

ItemPaged[RoleEligibilityScheduleRequestListResult]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\authorization\\v2020_10_01_preview\\models\\__init__.py'>