RoleAssignmentScheduleRequests interface
Interface representing a RoleAssignmentScheduleRequests.
Methods
cancel(string, string, Role |
Cancels a pending role assignment schedule request. |
create(string, string, Role |
Creates a role assignment schedule request. |
get(string, string, Role |
Get the specified role assignment schedule request. |
list |
Gets role assignment schedule requests for a scope. |
validate(string, string, Role |
Validates a new role assignment schedule request. |
Method Details
cancel(string, string, RoleAssignmentScheduleRequestsCancelOptionalParams)
Cancels a pending role assignment schedule request.
function cancel(scope: string, roleAssignmentScheduleRequestName: string, options?: RoleAssignmentScheduleRequestsCancelOptionalParams): Promise<void>
Parameters
- scope
-
string
The scope of the role assignment request to cancel.
- roleAssignmentScheduleRequestName
-
string
The name of the role assignment request to cancel.
The options parameters.
Returns
Promise<void>
create(string, string, RoleAssignmentScheduleRequest, RoleAssignmentScheduleRequestsCreateOptionalParams)
Creates a role assignment schedule request.
function create(scope: string, roleAssignmentScheduleRequestName: string, parameters: RoleAssignmentScheduleRequest, options?: RoleAssignmentScheduleRequestsCreateOptionalParams): Promise<RoleAssignmentScheduleRequest>
Parameters
- scope
-
string
The scope of the role assignment 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.
- roleAssignmentScheduleRequestName
-
string
A GUID for the role assignment to create. The name must be unique and different for each role assignment.
- parameters
- RoleAssignmentScheduleRequest
Parameters for the role assignment schedule request.
The options parameters.
Returns
Promise<RoleAssignmentScheduleRequest>
get(string, string, RoleAssignmentScheduleRequestsGetOptionalParams)
Get the specified role assignment schedule request.
function get(scope: string, roleAssignmentScheduleRequestName: string, options?: RoleAssignmentScheduleRequestsGetOptionalParams): Promise<RoleAssignmentScheduleRequest>
Parameters
- scope
-
string
The scope of the role assignment schedule request.
- roleAssignmentScheduleRequestName
-
string
The name (guid) of the role assignment schedule request to get.
The options parameters.
Returns
Promise<RoleAssignmentScheduleRequest>
listForScope(string, RoleAssignmentScheduleRequestsListForScopeOptionalParams)
Gets role assignment schedule requests for a scope.
function listForScope(scope: string, options?: RoleAssignmentScheduleRequestsListForScopeOptionalParams): PagedAsyncIterableIterator<RoleAssignmentScheduleRequest, RoleAssignmentScheduleRequest[], PageSettings>
Parameters
- scope
-
string
The scope of the role assignments schedule requests.
The options parameters.
Returns
validate(string, string, RoleAssignmentScheduleRequest, RoleAssignmentScheduleRequestsValidateOptionalParams)
Validates a new role assignment schedule request.
function validate(scope: string, roleAssignmentScheduleRequestName: string, parameters: RoleAssignmentScheduleRequest, options?: RoleAssignmentScheduleRequestsValidateOptionalParams): Promise<RoleAssignmentScheduleRequest>
Parameters
- scope
-
string
The scope of the role assignment request to validate.
- roleAssignmentScheduleRequestName
-
string
The name of the role assignment request to validate.
- parameters
- RoleAssignmentScheduleRequest
Parameters for the role assignment schedule request.
The options parameters.
Returns
Promise<RoleAssignmentScheduleRequest>