RoleEligibilityScheduleRequestsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient's
<xref:role_eligibility_schedule_requests> attribute.
Constructor
RoleEligibilityScheduleRequestsOperations(*args, **kwargs)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) -> NoneParameters
| Name | Description |
|---|---|
|
scope
Required
|
The scope of the role eligibility request to cancel. Required. |
|
role_eligibility_schedule_request_name
Required
|
The name of the role eligibility request to cancel. 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 |
|---|---|
create
Creates a role eligibility schedule request.
create(scope: str, role_eligibility_schedule_request_name: str, parameters: _models.RoleEligibilityScheduleRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RoleEligibilityScheduleRequestParameters
| Name | Description |
|---|---|
|
scope
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. Required. |
|
role_eligibility_schedule_request_name
Required
|
The name of the role eligibility to create. It can be any valid GUID. Required. |
|
parameters
Required
|
Parameters for the role eligibility schedule request. Is either a RoleEligibilityScheduleRequest 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 |
|---|---|
|
RoleEligibilityScheduleRequest or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get the specified role eligibility schedule request.
get(scope: str, role_eligibility_schedule_request_name: str, **kwargs: Any) -> RoleEligibilityScheduleRequestParameters
| Name | Description |
|---|---|
|
scope
Required
|
The scope of the role eligibility schedule request. Required. |
|
role_eligibility_schedule_request_name
Required
|
The name (guid) of the role eligibility schedule request to get. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
RoleEligibilityScheduleRequest or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_for_scope
Gets role eligibility schedule requests for a scope.
list_for_scope(scope: str, filter: str | None = None, **kwargs: Any) -> Iterable[RoleEligibilityScheduleRequest]Parameters
| Name | Description |
|---|---|
|
scope
Required
|
The scope of the role eligibility schedule requests. Required. |
|
filter
|
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. 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 RoleEligibilityScheduleRequest or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv71\\Lib\\site-packages\\azure\\mgmt\\authorization\\v2020_10_01_preview\\models\\__init__.py'>