@azure/arm-authorization package

Classes

AuthorizationManagementClient

Interfaces

ApprovalSettings	The approval settings.
ApprovalStage	The approval stage.
AuthorizationManagementClientOptionalParams	Optional parameters.
ClassicAdministrator	Classic Administrators
ClassicAdministratorListResult	ClassicAdministrator list result information.
ClassicAdministrators	Interface representing a ClassicAdministrators.
ClassicAdministratorsListNextOptionalParams	Optional parameters.
ClassicAdministratorsListOptionalParams	Optional parameters.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
DenyAssignment	Deny Assignment
DenyAssignmentFilter	Deny Assignments filter
DenyAssignmentListResult	Deny assignment list operation result.
DenyAssignmentPermission	Deny assignment permissions.
DenyAssignments	Interface representing a DenyAssignments.
DenyAssignmentsGetByIdOptionalParams	Optional parameters.
DenyAssignmentsGetOptionalParams	Optional parameters.
DenyAssignmentsListForResourceGroupNextOptionalParams	Optional parameters.
DenyAssignmentsListForResourceGroupOptionalParams	Optional parameters.
DenyAssignmentsListForResourceNextOptionalParams	Optional parameters.
DenyAssignmentsListForResourceOptionalParams	Optional parameters.
DenyAssignmentsListForScopeNextOptionalParams	Optional parameters.
DenyAssignmentsListForScopeOptionalParams	Optional parameters.
DenyAssignmentsListNextOptionalParams	Optional parameters.
DenyAssignmentsListOptionalParams	Optional parameters.
EligibleChildResource	Eligible child resource
EligibleChildResources	Interface representing a EligibleChildResources.
EligibleChildResourcesGetNextOptionalParams	Optional parameters.
EligibleChildResourcesGetOptionalParams	Optional parameters.
EligibleChildResourcesListResult	Eligible child resources list operation result.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
ExpandedProperties
ExpandedPropertiesPrincipal	Details of the principal
ExpandedPropertiesRoleDefinition	Details of role definition
ExpandedPropertiesScope	Details of the resource scope
GlobalAdministrator	Interface representing a GlobalAdministrator.
GlobalAdministratorElevateAccessOptionalParams	Optional parameters.
Permission	Role definition permissions.
PermissionGetResult	Permissions information.
Permissions	Interface representing a Permissions.
PermissionsListForResourceGroupNextOptionalParams	Optional parameters.
PermissionsListForResourceGroupOptionalParams	Optional parameters.
PermissionsListForResourceNextOptionalParams	Optional parameters.
PermissionsListForResourceOptionalParams	Optional parameters.
PolicyAssignmentProperties	Expanded info of resource scope, role definition and policy
PolicyAssignmentPropertiesPolicy	Details of the policy
PolicyAssignmentPropertiesRoleDefinition	Details of role definition
PolicyAssignmentPropertiesScope	Details of the resource scope
PolicyProperties	Expanded info of resource scope
PolicyPropertiesScope	Details of the resource scope
Principal	The name of the entity last modified it
ProviderOperation	Operation
ProviderOperationsMetadata	Provider Operations metadata
ProviderOperationsMetadataGetOptionalParams	Optional parameters.
ProviderOperationsMetadataListNextOptionalParams	Optional parameters.
ProviderOperationsMetadataListOptionalParams	Optional parameters.
ProviderOperationsMetadataListResult	Provider operations metadata list
ProviderOperationsMetadataOperations	Interface representing a ProviderOperationsMetadataOperations.
ResourceType	Resource Type
RoleAssignment	Role Assignments
RoleAssignmentCreateParameters	Role assignment create parameters.
RoleAssignmentFilter	Role Assignments filter
RoleAssignmentListResult	Role assignment list operation result.
RoleAssignmentSchedule	Role Assignment schedule
RoleAssignmentScheduleFilter	Role assignment schedule filter
RoleAssignmentScheduleInstance	Information about current or upcoming role assignment schedule instance
RoleAssignmentScheduleInstanceFilter	Role assignment schedule instance filter
RoleAssignmentScheduleInstanceListResult	Role assignment schedule instance list operation result.
RoleAssignmentScheduleInstances	Interface representing a RoleAssignmentScheduleInstances.
RoleAssignmentScheduleInstancesGetOptionalParams	Optional parameters.
RoleAssignmentScheduleInstancesListForScopeNextOptionalParams	Optional parameters.
RoleAssignmentScheduleInstancesListForScopeOptionalParams	Optional parameters.
RoleAssignmentScheduleListResult	Role assignment schedule list operation result.
RoleAssignmentScheduleRequest	Role Assignment schedule request
RoleAssignmentScheduleRequestFilter	Role assignment schedule request filter
RoleAssignmentScheduleRequestListResult	Role assignment schedule request list operation result.
RoleAssignmentScheduleRequestPropertiesScheduleInfo	Schedule info of the role assignment schedule
RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration	Expiration of the role assignment schedule
RoleAssignmentScheduleRequestPropertiesTicketInfo	Ticket Info of the role assignment
RoleAssignmentScheduleRequests	Interface representing a RoleAssignmentScheduleRequests.
RoleAssignmentScheduleRequestsCancelOptionalParams	Optional parameters.
RoleAssignmentScheduleRequestsCreateOptionalParams	Optional parameters.
RoleAssignmentScheduleRequestsGetOptionalParams	Optional parameters.
RoleAssignmentScheduleRequestsListForScopeNextOptionalParams	Optional parameters.
RoleAssignmentScheduleRequestsListForScopeOptionalParams	Optional parameters.
RoleAssignmentScheduleRequestsValidateOptionalParams	Optional parameters.
RoleAssignmentSchedules	Interface representing a RoleAssignmentSchedules.
RoleAssignmentSchedulesGetOptionalParams	Optional parameters.
RoleAssignmentSchedulesListForScopeNextOptionalParams	Optional parameters.
RoleAssignmentSchedulesListForScopeOptionalParams	Optional parameters.
RoleAssignments	Interface representing a RoleAssignments.
RoleAssignmentsCreateByIdOptionalParams	Optional parameters.
RoleAssignmentsCreateOptionalParams	Optional parameters.
RoleAssignmentsDeleteByIdOptionalParams	Optional parameters.
RoleAssignmentsDeleteOptionalParams	Optional parameters.
RoleAssignmentsGetByIdOptionalParams	Optional parameters.
RoleAssignmentsGetOptionalParams	Optional parameters.
RoleAssignmentsListForResourceGroupNextOptionalParams	Optional parameters.
RoleAssignmentsListForResourceGroupOptionalParams	Optional parameters.
RoleAssignmentsListForResourceNextOptionalParams	Optional parameters.
RoleAssignmentsListForResourceOptionalParams	Optional parameters.
RoleAssignmentsListForScopeNextOptionalParams	Optional parameters.
RoleAssignmentsListForScopeOptionalParams	Optional parameters.
RoleAssignmentsListForSubscriptionNextOptionalParams	Optional parameters.
RoleAssignmentsListForSubscriptionOptionalParams	Optional parameters.
RoleDefinition	Role definition.
RoleDefinitionFilter	Role Definitions filter
RoleDefinitionListResult	Role definition list operation result.
RoleDefinitions	Interface representing a RoleDefinitions.
RoleDefinitionsCreateOrUpdateOptionalParams	Optional parameters.
RoleDefinitionsDeleteOptionalParams	Optional parameters.
RoleDefinitionsGetByIdOptionalParams	Optional parameters.
RoleDefinitionsGetOptionalParams	Optional parameters.
RoleDefinitionsListNextOptionalParams	Optional parameters.
RoleDefinitionsListOptionalParams	Optional parameters.
RoleEligibilitySchedule	Role eligibility schedule
RoleEligibilityScheduleFilter	Role eligibility schedule filter
RoleEligibilityScheduleInstance	Information about current or upcoming role eligibility schedule instance
RoleEligibilityScheduleInstanceFilter	Role eligibility schedule instance filter
RoleEligibilityScheduleInstanceListResult	Role eligibility schedule instance list operation result.
RoleEligibilityScheduleInstances	Interface representing a RoleEligibilityScheduleInstances.
RoleEligibilityScheduleInstancesGetOptionalParams	Optional parameters.
RoleEligibilityScheduleInstancesListForScopeNextOptionalParams	Optional parameters.
RoleEligibilityScheduleInstancesListForScopeOptionalParams	Optional parameters.
RoleEligibilityScheduleListResult	role eligibility schedule list operation result.
RoleEligibilityScheduleRequest	Role Eligibility schedule request
RoleEligibilityScheduleRequestFilter	Role eligibility schedule request filter
RoleEligibilityScheduleRequestListResult	Role eligibility schedule request list operation result.
RoleEligibilityScheduleRequestPropertiesScheduleInfo	Schedule info of the role eligibility schedule
RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration	Expiration of the role eligibility schedule
RoleEligibilityScheduleRequestPropertiesTicketInfo	Ticket Info of the role eligibility
RoleEligibilityScheduleRequests	Interface representing a RoleEligibilityScheduleRequests.
RoleEligibilityScheduleRequestsCancelOptionalParams	Optional parameters.
RoleEligibilityScheduleRequestsCreateOptionalParams	Optional parameters.
RoleEligibilityScheduleRequestsGetOptionalParams	Optional parameters.
RoleEligibilityScheduleRequestsListForScopeNextOptionalParams	Optional parameters.
RoleEligibilityScheduleRequestsListForScopeOptionalParams	Optional parameters.
RoleEligibilityScheduleRequestsValidateOptionalParams	Optional parameters.
RoleEligibilitySchedules	Interface representing a RoleEligibilitySchedules.
RoleEligibilitySchedulesGetOptionalParams	Optional parameters.
RoleEligibilitySchedulesListForScopeNextOptionalParams	Optional parameters.
RoleEligibilitySchedulesListForScopeOptionalParams	Optional parameters.
RoleManagementPolicies	Interface representing a RoleManagementPolicies.
RoleManagementPoliciesDeleteOptionalParams	Optional parameters.
RoleManagementPoliciesGetOptionalParams	Optional parameters.
RoleManagementPoliciesListForScopeNextOptionalParams	Optional parameters.
RoleManagementPoliciesListForScopeOptionalParams	Optional parameters.
RoleManagementPoliciesUpdateOptionalParams	Optional parameters.
RoleManagementPolicy	Role management policy
RoleManagementPolicyApprovalRule	The role management policy approval rule.
RoleManagementPolicyAssignment	Role management policy
RoleManagementPolicyAssignmentListResult	Role management policy assignment list operation result.
RoleManagementPolicyAssignments	Interface representing a RoleManagementPolicyAssignments.
RoleManagementPolicyAssignmentsCreateOptionalParams	Optional parameters.
RoleManagementPolicyAssignmentsDeleteOptionalParams	Optional parameters.
RoleManagementPolicyAssignmentsGetOptionalParams	Optional parameters.
RoleManagementPolicyAssignmentsListForScopeNextOptionalParams	Optional parameters.
RoleManagementPolicyAssignmentsListForScopeOptionalParams	Optional parameters.
RoleManagementPolicyAuthenticationContextRule	The role management policy authentication context rule.
RoleManagementPolicyEnablementRule	The role management policy enablement rule.
RoleManagementPolicyExpirationRule	The role management policy expiration rule.
RoleManagementPolicyListResult	Role management policy list operation result.
RoleManagementPolicyNotificationRule	The role management policy notification rule.
RoleManagementPolicyRule	The role management policy rule.
RoleManagementPolicyRuleTarget	The role management policy rule target.
UserSet	The detail of a user.
ValidationResponse	Validation response
ValidationResponseErrorInfo	Failed validation result details

Type Aliases

ApprovalMode	Defines values for ApprovalMode. KnownApprovalMode can be used interchangeably with ApprovalMode, this enum contains the known values that the service supports. Known values supported by the service SingleStage Serial Parallel NoApproval
AssignmentType	Defines values for AssignmentType. KnownAssignmentType can be used interchangeably with AssignmentType, this enum contains the known values that the service supports. Known values supported by the service Activated Assigned
ClassicAdministratorsListNextResponse	Contains response data for the listNext operation.
ClassicAdministratorsListResponse	Contains response data for the list operation.
DenyAssignmentsGetByIdResponse	Contains response data for the getById operation.
DenyAssignmentsGetResponse	Contains response data for the get operation.
DenyAssignmentsListForResourceGroupNextResponse	Contains response data for the listForResourceGroupNext operation.
DenyAssignmentsListForResourceGroupResponse	Contains response data for the listForResourceGroup operation.
DenyAssignmentsListForResourceNextResponse	Contains response data for the listForResourceNext operation.
DenyAssignmentsListForResourceResponse	Contains response data for the listForResource operation.
DenyAssignmentsListForScopeNextResponse	Contains response data for the listForScopeNext operation.
DenyAssignmentsListForScopeResponse	Contains response data for the listForScope operation.
DenyAssignmentsListNextResponse	Contains response data for the listNext operation.
DenyAssignmentsListResponse	Contains response data for the list operation.
EligibleChildResourcesGetNextResponse	Contains response data for the getNext operation.
EligibleChildResourcesGetResponse	Contains response data for the get operation.
EnablementRules	Defines values for EnablementRules. KnownEnablementRules can be used interchangeably with EnablementRules, this enum contains the known values that the service supports. Known values supported by the service MultiFactorAuthentication Justification Ticketing
MemberType	Defines values for MemberType. KnownMemberType can be used interchangeably with MemberType, this enum contains the known values that the service supports. Known values supported by the service Inherited Direct Group
NotificationDeliveryMechanism	Defines values for NotificationDeliveryMechanism. KnownNotificationDeliveryMechanism can be used interchangeably with NotificationDeliveryMechanism, this enum contains the known values that the service supports. Known values supported by the service Email
NotificationLevel	Defines values for NotificationLevel. KnownNotificationLevel can be used interchangeably with NotificationLevel, this enum contains the known values that the service supports. Known values supported by the service None Critical All
PermissionsListForResourceGroupNextResponse	Contains response data for the listForResourceGroupNext operation.
PermissionsListForResourceGroupResponse	Contains response data for the listForResourceGroup operation.
PermissionsListForResourceNextResponse	Contains response data for the listForResourceNext operation.
PermissionsListForResourceResponse	Contains response data for the listForResource operation.
PrincipalType	Defines values for PrincipalType. KnownPrincipalType can be used interchangeably with PrincipalType, this enum contains the known values that the service supports. Known values supported by the service User Group ServicePrincipal ForeignGroup Device
ProviderOperationsMetadataGetResponse	Contains response data for the get operation.
ProviderOperationsMetadataListNextResponse	Contains response data for the listNext operation.
ProviderOperationsMetadataListResponse	Contains response data for the list operation.
RecipientType	Defines values for RecipientType. KnownRecipientType can be used interchangeably with RecipientType, this enum contains the known values that the service supports. Known values supported by the service Requestor Approver Admin
RequestType	Defines values for RequestType. KnownRequestType can be used interchangeably with RequestType, this enum contains the known values that the service supports. Known values supported by the service AdminAssign AdminRemove AdminUpdate AdminExtend AdminRenew SelfActivate SelfDeactivate SelfExtend SelfRenew
RoleAssignmentScheduleInstancesGetResponse	Contains response data for the get operation.
RoleAssignmentScheduleInstancesListForScopeNextResponse	Contains response data for the listForScopeNext operation.
RoleAssignmentScheduleInstancesListForScopeResponse	Contains response data for the listForScope operation.
RoleAssignmentScheduleRequestsCreateResponse	Contains response data for the create operation.
RoleAssignmentScheduleRequestsGetResponse	Contains response data for the get operation.
RoleAssignmentScheduleRequestsListForScopeNextResponse	Contains response data for the listForScopeNext operation.
RoleAssignmentScheduleRequestsListForScopeResponse	Contains response data for the listForScope operation.
RoleAssignmentScheduleRequestsValidateResponse	Contains response data for the validate operation.
RoleAssignmentSchedulesGetResponse	Contains response data for the get operation.
RoleAssignmentSchedulesListForScopeNextResponse	Contains response data for the listForScopeNext operation.
RoleAssignmentSchedulesListForScopeResponse	Contains response data for the listForScope operation.
RoleAssignmentsCreateByIdResponse	Contains response data for the createById operation.
RoleAssignmentsCreateResponse	Contains response data for the create operation.
RoleAssignmentsDeleteByIdResponse	Contains response data for the deleteById operation.
RoleAssignmentsDeleteResponse	Contains response data for the delete operation.
RoleAssignmentsGetByIdResponse	Contains response data for the getById operation.
RoleAssignmentsGetResponse	Contains response data for the get operation.
RoleAssignmentsListForResourceGroupNextResponse	Contains response data for the listForResourceGroupNext operation.
RoleAssignmentsListForResourceGroupResponse	Contains response data for the listForResourceGroup operation.
RoleAssignmentsListForResourceNextResponse	Contains response data for the listForResourceNext operation.
RoleAssignmentsListForResourceResponse	Contains response data for the listForResource operation.
RoleAssignmentsListForScopeNextResponse	Contains response data for the listForScopeNext operation.
RoleAssignmentsListForScopeResponse	Contains response data for the listForScope operation.
RoleAssignmentsListForSubscriptionNextResponse	Contains response data for the listForSubscriptionNext operation.
RoleAssignmentsListForSubscriptionResponse	Contains response data for the listForSubscription operation.
RoleDefinitionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
RoleDefinitionsDeleteResponse	Contains response data for the delete operation.
RoleDefinitionsGetByIdResponse	Contains response data for the getById operation.
RoleDefinitionsGetResponse	Contains response data for the get operation.
RoleDefinitionsListNextResponse	Contains response data for the listNext operation.
RoleDefinitionsListResponse	Contains response data for the list operation.
RoleEligibilityScheduleInstancesGetResponse	Contains response data for the get operation.
RoleEligibilityScheduleInstancesListForScopeNextResponse	Contains response data for the listForScopeNext operation.
RoleEligibilityScheduleInstancesListForScopeResponse	Contains response data for the listForScope operation.
RoleEligibilityScheduleRequestsCreateResponse	Contains response data for the create operation.
RoleEligibilityScheduleRequestsGetResponse	Contains response data for the get operation.
RoleEligibilityScheduleRequestsListForScopeNextResponse	Contains response data for the listForScopeNext operation.
RoleEligibilityScheduleRequestsListForScopeResponse	Contains response data for the listForScope operation.
RoleEligibilityScheduleRequestsValidateResponse	Contains response data for the validate operation.
RoleEligibilitySchedulesGetResponse	Contains response data for the get operation.
RoleEligibilitySchedulesListForScopeNextResponse	Contains response data for the listForScopeNext operation.
RoleEligibilitySchedulesListForScopeResponse	Contains response data for the listForScope operation.
RoleManagementPoliciesGetResponse	Contains response data for the get operation.
RoleManagementPoliciesListForScopeNextResponse	Contains response data for the listForScopeNext operation.
RoleManagementPoliciesListForScopeResponse	Contains response data for the listForScope operation.
RoleManagementPoliciesUpdateResponse	Contains response data for the update operation.
RoleManagementPolicyAssignmentsCreateResponse	Contains response data for the create operation.
RoleManagementPolicyAssignmentsGetResponse	Contains response data for the get operation.
RoleManagementPolicyAssignmentsListForScopeNextResponse	Contains response data for the listForScopeNext operation.
RoleManagementPolicyAssignmentsListForScopeResponse	Contains response data for the listForScope operation.
RoleManagementPolicyRuleType	Defines values for RoleManagementPolicyRuleType. KnownRoleManagementPolicyRuleType can be used interchangeably with RoleManagementPolicyRuleType, this enum contains the known values that the service supports. Known values supported by the service RoleManagementPolicyApprovalRule RoleManagementPolicyAuthenticationContextRule RoleManagementPolicyEnablementRule RoleManagementPolicyExpirationRule RoleManagementPolicyNotificationRule
RoleManagementPolicyRuleUnion
Status	Defines values for Status. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service Accepted PendingEvaluation Granted Denied PendingProvisioning Provisioned PendingRevocation Revoked Canceled Failed PendingApprovalProvisioning PendingApproval FailedAsResourceIsLocked PendingAdminDecision AdminApproved AdminDenied TimedOut ProvisioningStarted Invalid PendingScheduleCreation ScheduleCreated PendingExternalProvisioning
Type	Defines values for Type. KnownType can be used interchangeably with Type, this enum contains the known values that the service supports. Known values supported by the service AfterDuration AfterDateTime NoExpiration
UserType	Defines values for UserType. KnownUserType can be used interchangeably with UserType, this enum contains the known values that the service supports. Known values supported by the service User Group

Enums

KnownApprovalMode	Known values of ApprovalMode that the service accepts.
KnownAssignmentType	Known values of AssignmentType that the service accepts.
KnownEnablementRules	Known values of EnablementRules that the service accepts.
KnownMemberType	Known values of MemberType that the service accepts.
KnownNotificationDeliveryMechanism	Known values of NotificationDeliveryMechanism that the service accepts.
KnownNotificationLevel	Known values of NotificationLevel that the service accepts.
KnownPrincipalType	Known values of PrincipalType that the service accepts.
KnownRecipientType	Known values of RecipientType that the service accepts.
KnownRequestType	Known values of RequestType that the service accepts.
KnownRoleManagementPolicyRuleType	Known values of RoleManagementPolicyRuleType that the service accepts.
KnownStatus	Known values of Status that the service accepts.
KnownType	Known values of Type that the service accepts.
KnownUserType	Known values of UserType that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.