RoleEligibilityScheduleRequests interface
Interface representing a RoleEligibilityScheduleRequests.
Methods
| cancel(string, string, Role |
Cancels a pending role eligibility schedule request. |
| create(string, string, Role |
Creates a role eligibility schedule request. |
| get(string, string, Role |
Get the specified role eligibility schedule request. |
| list |
Gets role eligibility schedule requests for a scope. |
| validate(string, string, Role |
Validates a new role eligibility schedule request. |
Method Details
cancel(string, string, RoleEligibilityScheduleRequestsCancelOptionalParams)
Cancels a pending role eligibility schedule request.
function cancel(scope: string, roleEligibilityScheduleRequestName: string, options?: RoleEligibilityScheduleRequestsCancelOptionalParams): Promise<void>Parameters
- scope
-
string
The scope of the role eligibility request to cancel.
- roleEligibilityScheduleRequestName
-
string
The name of the role eligibility request to cancel.
The options parameters.
Returns
Promise<void>
create(string, string, RoleEligibilityScheduleRequest, RoleEligibilityScheduleRequestsCreateOptionalParams)
Creates a role eligibility schedule request.
function create(scope: string, roleEligibilityScheduleRequestName: string, parameters: RoleEligibilityScheduleRequest, options?: RoleEligibilityScheduleRequestsCreateOptionalParams): Promise<RoleEligibilityScheduleRequest>Parameters
- scope
-
string
The scope of the role eligibility schedule request to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.
- roleEligibilityScheduleRequestName
-
string
The name of the role eligibility to create. It can be any valid GUID.
- parameters
- RoleEligibilityScheduleRequest
Parameters for the role eligibility schedule request.
The options parameters.
Returns
Promise<RoleEligibilityScheduleRequest>
get(string, string, RoleEligibilityScheduleRequestsGetOptionalParams)
Get the specified role eligibility schedule request.
function get(scope: string, roleEligibilityScheduleRequestName: string, options?: RoleEligibilityScheduleRequestsGetOptionalParams): Promise<RoleEligibilityScheduleRequest>Parameters
- scope
-
string
The scope of the role eligibility schedule request.
- roleEligibilityScheduleRequestName
-
string
The name (guid) of the role eligibility schedule request to get.
The options parameters.
Returns
Promise<RoleEligibilityScheduleRequest>
listForScope(string, RoleEligibilityScheduleRequestsListForScopeOptionalParams)
Gets role eligibility schedule requests for a scope.
function listForScope(scope: string, options?: RoleEligibilityScheduleRequestsListForScopeOptionalParams): PagedAsyncIterableIterator<RoleEligibilityScheduleRequest, RoleEligibilityScheduleRequest[], PageSettings>Parameters
- scope
-
string
The scope of the role eligibility schedule requests.
The options parameters.
Returns
validate(string, string, RoleEligibilityScheduleRequest, RoleEligibilityScheduleRequestsValidateOptionalParams)
Validates a new role eligibility schedule request.
function validate(scope: string, roleEligibilityScheduleRequestName: string, parameters: RoleEligibilityScheduleRequest, options?: RoleEligibilityScheduleRequestsValidateOptionalParams): Promise<RoleEligibilityScheduleRequest>Parameters
- scope
-
string
The scope of the role eligibility request to validate.
- roleEligibilityScheduleRequestName
-
string
The name of the role eligibility request to validate.
- parameters
- RoleEligibilityScheduleRequest
Parameters for the role eligibility schedule request.
The options parameters.
Returns
Promise<RoleEligibilityScheduleRequest>