@azure/arm-authorization package

Classes

Interfaces

AccessReviewActorIdentity	Details of the actor identity
AccessReviewContactedReviewer	Access Review Contacted Reviewer.
AccessReviewContactedReviewerProperties	Properties of access review contacted reviewer.
AccessReviewDecision	Access Review.
AccessReviewDecisionIdentity	Target of the decision.
AccessReviewDecisionInsight	Access Review Decision Insight.
AccessReviewDecisionInsightProperties	Details of the Insight.
AccessReviewDecisionPrincipalResourceMembership	Target of the decision.
AccessReviewDecisionProperties	Approval Step.
AccessReviewDecisionResource	Target of the decision.
AccessReviewDecisionServicePrincipalIdentity	Service Principal Decision Target
AccessReviewDecisionUserIdentity	User Decision Target
AccessReviewDecisionUserSignInInsightProperties	User Decision Target
AccessReviewDefaultSettings	Access Review Default Settings.
AccessReviewDefaultSettingsGetOptionalParams	Optional parameters.
AccessReviewDefaultSettingsOperations	Interface representing a AccessReviewDefaultSettings operations.
AccessReviewDefaultSettingsPutOptionalParams	Optional parameters.
AccessReviewHistoryDefinition	Access Review History Definition.
AccessReviewHistoryDefinitionCreateOptionalParams	Optional parameters.
AccessReviewHistoryDefinitionDeleteByIdOptionalParams	Optional parameters.
AccessReviewHistoryDefinitionInstanceGenerateDownloadUriOptionalParams	Optional parameters.
AccessReviewHistoryDefinitionInstanceOperations	Interface representing a AccessReviewHistoryDefinitionInstance operations.
AccessReviewHistoryDefinitionInstancesListOptionalParams	Optional parameters.
AccessReviewHistoryDefinitionInstancesOperations	Interface representing a AccessReviewHistoryDefinitionInstances operations.
AccessReviewHistoryDefinitionOperations	Interface representing a AccessReviewHistoryDefinition operations.
AccessReviewHistoryDefinitionProperties	Access Review History Instances.
AccessReviewHistoryDefinitionsGetByIdOptionalParams	Optional parameters.
AccessReviewHistoryDefinitionsListOptionalParams	Optional parameters.
AccessReviewHistoryDefinitionsOperations	Interface representing a AccessReviewHistoryDefinitions operations.
AccessReviewHistoryInstance	Access Review History Definition Instance.
AccessReviewHistoryInstanceProperties	Access Review History Definition Instance properties.
AccessReviewHistoryScheduleSettings	Recurrence settings of an Access Review History Definition.
AccessReviewInstance	Access Review Instance.
AccessReviewInstanceAcceptRecommendationsOptionalParams	Optional parameters.
AccessReviewInstanceApplyDecisionsOptionalParams	Optional parameters.
AccessReviewInstanceContactedReviewersListOptionalParams	Optional parameters.
AccessReviewInstanceContactedReviewersOperations	Interface representing a AccessReviewInstanceContactedReviewers operations.
AccessReviewInstanceDecisionsListOptionalParams	Optional parameters.
AccessReviewInstanceDecisionsOperations	Interface representing a AccessReviewInstanceDecisions operations.
AccessReviewInstanceMyDecisionsGetByIdOptionalParams	Optional parameters.
AccessReviewInstanceMyDecisionsListOptionalParams	Optional parameters.
AccessReviewInstanceMyDecisionsOperations	Interface representing a AccessReviewInstanceMyDecisions operations.
AccessReviewInstanceMyDecisionsPatchOptionalParams	Optional parameters.
AccessReviewInstanceOperations	Interface representing a AccessReviewInstance operations.
AccessReviewInstanceProperties	Access Review Instance properties.
AccessReviewInstanceResetDecisionsOptionalParams	Optional parameters.
AccessReviewInstanceSendRemindersOptionalParams	Optional parameters.
AccessReviewInstanceStopOptionalParams	Optional parameters.
AccessReviewInstancesAssignedForMyApprovalGetByIdOptionalParams	Optional parameters.
AccessReviewInstancesAssignedForMyApprovalListOptionalParams	Optional parameters.
AccessReviewInstancesAssignedForMyApprovalOperations	Interface representing a AccessReviewInstancesAssignedForMyApproval operations.
AccessReviewInstancesCreateOptionalParams	Optional parameters.
AccessReviewInstancesGetByIdOptionalParams	Optional parameters.
AccessReviewInstancesListOptionalParams	Optional parameters.
AccessReviewInstancesOperations	Interface representing a AccessReviewInstances operations.
AccessReviewRecurrencePattern	Recurrence Pattern of an Access Review Schedule Definition.
AccessReviewRecurrenceRange	Recurrence Range of an Access Review Schedule Definition.
AccessReviewRecurrenceSettings	Recurrence Settings of an Access Review Schedule Definition.
AccessReviewReviewer	Descriptor for what needs to be reviewed
AccessReviewScheduleDefinition	Access Review Schedule Definition.
AccessReviewScheduleDefinitionProperties	Access Review.
AccessReviewScheduleDefinitionsAssignedForMyApprovalListOptionalParams	Optional parameters.
AccessReviewScheduleDefinitionsAssignedForMyApprovalOperations	Interface representing a AccessReviewScheduleDefinitionsAssignedForMyApproval operations.
AccessReviewScheduleDefinitionsCreateOrUpdateByIdOptionalParams	Optional parameters.
AccessReviewScheduleDefinitionsDeleteByIdOptionalParams	Optional parameters.
AccessReviewScheduleDefinitionsGetByIdOptionalParams	Optional parameters.
AccessReviewScheduleDefinitionsListOptionalParams	Optional parameters.
AccessReviewScheduleDefinitionsOperations	Interface representing a AccessReviewScheduleDefinitions operations.
AccessReviewScheduleDefinitionsStopOptionalParams	Optional parameters.
AccessReviewScheduleSettings	Settings of an Access Review.
AccessReviewScope	Descriptor for what needs to be reviewed
Alert	The alert.
AlertConfiguration	Alert configuration.
AlertConfigurationProperties	Alert configuration properties.
AlertConfigurationsGetOptionalParams	Optional parameters.
AlertConfigurationsListForScopeOptionalParams	Optional parameters.
AlertConfigurationsOperations	Interface representing a AlertConfigurations operations.
AlertConfigurationsUpdateOptionalParams	Optional parameters.
AlertDefinition	Alert definition
AlertDefinitionProperties	Alert definition properties.
AlertDefinitionsGetOptionalParams	Optional parameters.
AlertDefinitionsListForScopeOptionalParams	Optional parameters.
AlertDefinitionsOperations	Interface representing a AlertDefinitions operations.
AlertIncident	Alert incident
AlertIncidentProperties	Alert incident properties
AlertIncidentsGetOptionalParams	Optional parameters.
AlertIncidentsListForScopeOptionalParams	Optional parameters.
AlertIncidentsOperations	Interface representing a AlertIncidents operations.
AlertIncidentsRemediateOptionalParams	Optional parameters.
AlertOperationGetOptionalParams	Optional parameters.
AlertOperationOperations	Interface representing a AlertOperation operations.
AlertOperationResult	Alert operation result
AlertProperties	Alert properties.
AlertsGetOptionalParams	Optional parameters.
AlertsListForScopeOptionalParams	Optional parameters.
AlertsOperations	Interface representing a Alerts operations.
AlertsRefreshAllOptionalParams	Optional parameters.
AlertsRefreshOptionalParams	Optional parameters.
AlertsUpdateOptionalParams	Optional parameters.
ApprovalSettings	The approval settings.
ApprovalStage	The approval stage.
AttributeNamespace	An attribute namespace resource.
AttributeNamespaceCreateRequest	Request body for creating an attribute namespace.
AttributeNamespacesCreateOptionalParams	Optional parameters.
AttributeNamespacesDeleteOptionalParams	Optional parameters.
AttributeNamespacesGetOptionalParams	Optional parameters.
AttributeNamespacesOperations	Interface representing a AttributeNamespaces operations.
AuthorizationManagementClientOptionalParams	Optional parameters for the client.
AzureRolesAssignedOutsidePimAlertConfigurationProperties	The Azure roles assigned outside PIM alert configuration properties.
AzureRolesAssignedOutsidePimAlertIncidentProperties	Azure roles assigned outside PIM alert incident properties.
ClassicAdministrator	Classic Administrators
ClassicAdministratorProperties	Classic Administrator properties.
ClassicAdministratorsListOptionalParams	Optional parameters.
ClassicAdministratorsOperations	Interface representing a ClassicAdministrators operations.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
DenyAssignment	Deny Assignment
DenyAssignmentPermission	Deny assignment permissions.
DenyAssignmentPrincipal	Deny assignment principal.
DenyAssignmentProperties	Deny assignment properties.
DenyAssignmentsCreateOrUpdateOptionalParams	Optional parameters.
DenyAssignmentsDeleteOptionalParams	Optional parameters.
DenyAssignmentsGetByIdOptionalParams	Optional parameters.
DenyAssignmentsGetOptionalParams	Optional parameters.
DenyAssignmentsListForResourceGroupOptionalParams	Optional parameters.
DenyAssignmentsListForResourceOptionalParams	Optional parameters.
DenyAssignmentsListForScopeOptionalParams	Optional parameters.
DenyAssignmentsListOptionalParams	Optional parameters.
DenyAssignmentsOperations	Interface representing a DenyAssignments operations.
DuplicateRoleCreatedAlertConfigurationProperties	The duplicate role created alert configuration.
DuplicateRoleCreatedAlertIncidentProperties	Duplicate role created alert incident properties.
EligibleChildResource	Eligible child resource
EligibleChildResourcesListOptionalParams	Optional parameters.
EligibleChildResourcesOperations	Interface representing a EligibleChildResources operations.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDefinition	Error description and code explaining why an operation failed.
ErrorDefinitionProperties	Error description and code explaining why an operation failed.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExpandedProperties	model interface ExpandedProperties
ExpandedPropertiesPrincipal	Details of the principal
ExpandedPropertiesRoleDefinition	Details of role definition
ExpandedPropertiesScope	Details of the resource scope
ExtensionResource	The base extension resource.
GlobalAdministratorElevateAccessOptionalParams	Optional parameters.
GlobalAdministratorOperations	Interface representing a GlobalAdministrator operations.
Operation	The definition of a Microsoft.Authorization operation.
OperationDisplay	The display information for a Microsoft.Authorization operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PIMOnlyModeSettings	The PIM Only Mode settings.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
Permission	Role definition permissions.
PermissionsListForResourceGroupOptionalParams	Optional parameters.
PermissionsListForResourceOptionalParams	Optional parameters.
PermissionsOperations	Interface representing a Permissions operations.
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.
ProviderOperationsMetadataListOptionalParams	Optional parameters.
ProviderOperationsMetadataOperations	Interface representing a ProviderOperationsMetadata operations.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RecordAllDecisionsProperties	Record All Decisions payload.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceType	Resource Type
RestorePollerOptions
RoleAssignment	Role Assignments
RoleAssignmentCreateParameters	Role assignment create parameters.
RoleAssignmentProperties	Role assignment properties.
RoleAssignmentSchedule	Role Assignment schedule
RoleAssignmentScheduleInstance	Information about current or upcoming role assignment schedule instance
RoleAssignmentScheduleInstanceProperties	Role assignment schedule properties with scope.
RoleAssignmentScheduleInstancesGetOptionalParams	Optional parameters.
RoleAssignmentScheduleInstancesListForScopeOptionalParams	Optional parameters.
RoleAssignmentScheduleInstancesOperations	Interface representing a RoleAssignmentScheduleInstances operations.
RoleAssignmentScheduleProperties	Role assignment schedule properties with scope.
RoleAssignmentScheduleRequest	Role Assignment schedule request
RoleAssignmentScheduleRequestProperties	Role assignment schedule request properties with scope.
RoleAssignmentScheduleRequestPropertiesScheduleInfo	Schedule info of the role assignment schedule
RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration	Expiration of the role assignment schedule
RoleAssignmentScheduleRequestPropertiesTicketInfo	Ticket Info of the role assignment
RoleAssignmentScheduleRequestsCancelOptionalParams	Optional parameters.
RoleAssignmentScheduleRequestsCreateOptionalParams	Optional parameters.
RoleAssignmentScheduleRequestsGetOptionalParams	Optional parameters.
RoleAssignmentScheduleRequestsListForScopeOptionalParams	Optional parameters.
RoleAssignmentScheduleRequestsOperations	Interface representing a RoleAssignmentScheduleRequests operations.
RoleAssignmentScheduleRequestsValidateOptionalParams	Optional parameters.
RoleAssignmentSchedulesGetOptionalParams	Optional parameters.
RoleAssignmentSchedulesListForScopeOptionalParams	Optional parameters.
RoleAssignmentSchedulesOperations	Interface representing a RoleAssignmentSchedules operations.
RoleAssignmentsCreateByIdOptionalParams	Optional parameters.
RoleAssignmentsCreateOptionalParams	Optional parameters.
RoleAssignmentsDeleteByIdOptionalParams	Optional parameters.
RoleAssignmentsDeleteOptionalParams	Optional parameters.
RoleAssignmentsGetByIdOptionalParams	Optional parameters.
RoleAssignmentsGetOptionalParams	Optional parameters.
RoleAssignmentsListForResourceGroupOptionalParams	Optional parameters.
RoleAssignmentsListForResourceOptionalParams	Optional parameters.
RoleAssignmentsListForScopeOptionalParams	Optional parameters.
RoleAssignmentsListForSubscriptionOptionalParams	Optional parameters.
RoleAssignmentsOperations	Interface representing a RoleAssignments operations.
RoleDefinition	Role definition.
RoleDefinitionProperties	Role definition properties.
RoleDefinitionsCreateOrUpdateOptionalParams	Optional parameters.
RoleDefinitionsDeleteOptionalParams	Optional parameters.
RoleDefinitionsGetByIdOptionalParams	Optional parameters.
RoleDefinitionsGetOptionalParams	Optional parameters.
RoleDefinitionsListOptionalParams	Optional parameters.
RoleDefinitionsOperations	Interface representing a RoleDefinitions operations.
RoleEligibilitySchedule	Role eligibility schedule
RoleEligibilityScheduleInstance	Information about current or upcoming role eligibility schedule instance
RoleEligibilityScheduleInstanceProperties	Role eligibility schedule properties with scope.
RoleEligibilityScheduleInstancesGetOptionalParams	Optional parameters.
RoleEligibilityScheduleInstancesListForScopeOptionalParams	Optional parameters.
RoleEligibilityScheduleInstancesOperations	Interface representing a RoleEligibilityScheduleInstances operations.
RoleEligibilityScheduleProperties	Role eligibility schedule properties with scope.
RoleEligibilityScheduleRequest	Role Eligibility schedule request
RoleEligibilityScheduleRequestProperties	Role eligibility schedule request properties with scope.
RoleEligibilityScheduleRequestPropertiesScheduleInfo	Schedule info of the role eligibility schedule
RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration	Expiration of the role eligibility schedule
RoleEligibilityScheduleRequestPropertiesTicketInfo	Ticket Info of the role eligibility
RoleEligibilityScheduleRequestsCancelOptionalParams	Optional parameters.
RoleEligibilityScheduleRequestsCreateOptionalParams	Optional parameters.
RoleEligibilityScheduleRequestsGetOptionalParams	Optional parameters.
RoleEligibilityScheduleRequestsListForScopeOptionalParams	Optional parameters.
RoleEligibilityScheduleRequestsOperations	Interface representing a RoleEligibilityScheduleRequests operations.
RoleEligibilityScheduleRequestsValidateOptionalParams	Optional parameters.
RoleEligibilitySchedulesGetOptionalParams	Optional parameters.
RoleEligibilitySchedulesListForScopeOptionalParams	Optional parameters.
RoleEligibilitySchedulesOperations	Interface representing a RoleEligibilitySchedules operations.
RoleManagementPoliciesDeleteOptionalParams	Optional parameters.
RoleManagementPoliciesGetOptionalParams	Optional parameters.
RoleManagementPoliciesListForScopeOptionalParams	Optional parameters.
RoleManagementPoliciesOperations	Interface representing a RoleManagementPolicies operations.
RoleManagementPoliciesUpdateOptionalParams	Optional parameters.
RoleManagementPolicy	Role management policy
RoleManagementPolicyApprovalRule	The role management policy approval rule.
RoleManagementPolicyAssignment	Role management policy
RoleManagementPolicyAssignmentProperties	Role management policy assignment properties with scope.
RoleManagementPolicyAssignmentsCreateOptionalParams	Optional parameters.
RoleManagementPolicyAssignmentsDeleteOptionalParams	Optional parameters.
RoleManagementPolicyAssignmentsGetOptionalParams	Optional parameters.
RoleManagementPolicyAssignmentsListForScopeOptionalParams	Optional parameters.
RoleManagementPolicyAssignmentsOperations	Interface representing a RoleManagementPolicyAssignments operations.
RoleManagementPolicyAuthenticationContextRule	The role management policy authentication context rule.
RoleManagementPolicyEnablementRule	The role management policy enablement rule.
RoleManagementPolicyExpirationRule	The role management policy expiration rule.
RoleManagementPolicyNotificationRule	The role management policy notification rule.
RoleManagementPolicyPimOnlyModeRule	The role management policy PIM only mode rule.
RoleManagementPolicyProperties	Role management policy properties with scope.
RoleManagementPolicyRule	The role management policy rule.
RoleManagementPolicyRuleTarget	The role management policy rule target.
ScopeAccessReviewDefaultSettingsGetOptionalParams	Optional parameters.
ScopeAccessReviewDefaultSettingsOperations	Interface representing a ScopeAccessReviewDefaultSettings operations.
ScopeAccessReviewDefaultSettingsPutOptionalParams	Optional parameters.
ScopeAccessReviewHistoryDefinitionCreateOptionalParams	Optional parameters.
ScopeAccessReviewHistoryDefinitionDeleteByIdOptionalParams	Optional parameters.
ScopeAccessReviewHistoryDefinitionInstanceGenerateDownloadUriOptionalParams	Optional parameters.
ScopeAccessReviewHistoryDefinitionInstanceOperations	Interface representing a ScopeAccessReviewHistoryDefinitionInstance operations.
ScopeAccessReviewHistoryDefinitionInstancesListOptionalParams	Optional parameters.
ScopeAccessReviewHistoryDefinitionInstancesOperations	Interface representing a ScopeAccessReviewHistoryDefinitionInstances operations.
ScopeAccessReviewHistoryDefinitionOperations	Interface representing a ScopeAccessReviewHistoryDefinition operations.
ScopeAccessReviewHistoryDefinitionsGetByIdOptionalParams	Optional parameters.
ScopeAccessReviewHistoryDefinitionsListOptionalParams	Optional parameters.
ScopeAccessReviewHistoryDefinitionsOperations	Interface representing a ScopeAccessReviewHistoryDefinitions operations.
ScopeAccessReviewInstanceApplyDecisionsOptionalParams	Optional parameters.
ScopeAccessReviewInstanceContactedReviewersListOptionalParams	Optional parameters.
ScopeAccessReviewInstanceContactedReviewersOperations	Interface representing a ScopeAccessReviewInstanceContactedReviewers operations.
ScopeAccessReviewInstanceDecisionsListOptionalParams	Optional parameters.
ScopeAccessReviewInstanceDecisionsOperations	Interface representing a ScopeAccessReviewInstanceDecisions operations.
ScopeAccessReviewInstanceOperations	Interface representing a ScopeAccessReviewInstance operations.
ScopeAccessReviewInstanceRecordAllDecisionsOptionalParams	Optional parameters.
ScopeAccessReviewInstanceResetDecisionsOptionalParams	Optional parameters.
ScopeAccessReviewInstanceSendRemindersOptionalParams	Optional parameters.
ScopeAccessReviewInstanceStopOptionalParams	Optional parameters.
ScopeAccessReviewInstancesCreateOptionalParams	Optional parameters.
ScopeAccessReviewInstancesGetByIdOptionalParams	Optional parameters.
ScopeAccessReviewInstancesListOptionalParams	Optional parameters.
ScopeAccessReviewInstancesOperations	Interface representing a ScopeAccessReviewInstances operations.
ScopeAccessReviewScheduleDefinitionsCreateOrUpdateByIdOptionalParams	Optional parameters.
ScopeAccessReviewScheduleDefinitionsDeleteByIdOptionalParams	Optional parameters.
ScopeAccessReviewScheduleDefinitionsGetByIdOptionalParams	Optional parameters.
ScopeAccessReviewScheduleDefinitionsListOptionalParams	Optional parameters.
ScopeAccessReviewScheduleDefinitionsOperations	Interface representing a ScopeAccessReviewScheduleDefinitions operations.
ScopeAccessReviewScheduleDefinitionsStopOptionalParams	Optional parameters.
SettableResource	The resource model definition for resource.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SystemData	Metadata pertaining to creation and last modification of the resource.
TenantLevelAccessReviewInstanceContactedReviewersListOptionalParams	Optional parameters.
TenantLevelAccessReviewInstanceContactedReviewersOperations	Interface representing a TenantLevelAccessReviewInstanceContactedReviewers operations.
TooManyOwnersAssignedToResourceAlertConfigurationProperties	Too many owners assigned to resource alert configuration properties.
TooManyOwnersAssignedToResourceAlertIncidentProperties	Too many owners assigned to resource alert incident properties.
TooManyPermanentOwnersAssignedToResourceAlertConfigurationProperties	Too many permanent owners assigned to resource alert configuration properties.
TooManyPermanentOwnersAssignedToResourceAlertIncidentProperties	Too many permanent owners assigned to resource alert incident properties.
UserSet	The detail of a user.
UsersOrServicePrincipalSet	The detail of a subject.

Type Aliases

AccessRecommendationType	The feature- generated recommendation shown to the reviewer. KnownAccessRecommendationType can be used interchangeably with AccessRecommendationType, this enum contains the known values that the service supports. Known values supported by the service Approve: Approve Deny: Deny NoInfoAvailable: NoInfoAvailable
AccessReviewActorIdentityType	The identity type : user/servicePrincipal KnownAccessReviewActorIdentityType can be used interchangeably with AccessReviewActorIdentityType, this enum contains the known values that the service supports. Known values supported by the service user: user servicePrincipal: servicePrincipal
AccessReviewApplyResult	The outcome of applying the decision. KnownAccessReviewApplyResult can be used interchangeably with AccessReviewApplyResult, this enum contains the known values that the service supports. Known values supported by the service New: New Applying: Applying AppliedSuccessfully: AppliedSuccessfully AppliedWithUnknownFailure: AppliedWithUnknownFailure AppliedSuccessfullyButObjectNotFound: AppliedSuccessfullyButObjectNotFound ApplyNotSupported: ApplyNotSupported
AccessReviewDecisionIdentityUnion	Alias for AccessReviewDecisionIdentityUnion
AccessReviewDecisionInsightPropertiesUnion	Alias for AccessReviewDecisionInsightPropertiesUnion
AccessReviewDecisionInsightType	The type of insight KnownAccessReviewDecisionInsightType can be used interchangeably with AccessReviewDecisionInsightType, this enum contains the known values that the service supports. Known values supported by the service userSignInInsight: userSignInInsight
AccessReviewDecisionPrincipalResourceMembershipType	Type of AccessReviewDecisionPrincipalResourceMembershipType
AccessReviewHistoryDefinitionStatus	This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error. KnownAccessReviewHistoryDefinitionStatus can be used interchangeably with AccessReviewHistoryDefinitionStatus, this enum contains the known values that the service supports. Known values supported by the service Requested: Requested InProgress: InProgress Done: Done Error: Error
AccessReviewInstanceReviewersType	This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. KnownAccessReviewInstanceReviewersType can be used interchangeably with AccessReviewInstanceReviewersType, this enum contains the known values that the service supports. Known values supported by the service Assigned: Assigned Self: Self Managers: Managers
AccessReviewInstanceStatus	This read-only field specifies the status of an access review instance. KnownAccessReviewInstanceStatus can be used interchangeably with AccessReviewInstanceStatus, this enum contains the known values that the service supports. Known values supported by the service NotStarted: NotStarted InProgress: InProgress Completed: Completed Applied: Applied Initializing: Initializing Applying: Applying Completing: Completing Scheduled: Scheduled AutoReviewing: AutoReviewing AutoReviewed: AutoReviewed Starting: Starting
AccessReviewRecurrencePatternType	The recurrence type : weekly, monthly, etc. KnownAccessReviewRecurrencePatternType can be used interchangeably with AccessReviewRecurrencePatternType, this enum contains the known values that the service supports. Known values supported by the service weekly: weekly absoluteMonthly: absoluteMonthly
AccessReviewRecurrenceRangeType	The recurrence range type. The possible values are: endDate, noEnd, numbered. KnownAccessReviewRecurrenceRangeType can be used interchangeably with AccessReviewRecurrenceRangeType, this enum contains the known values that the service supports. Known values supported by the service endDate: endDate noEnd: noEnd numbered: numbered
AccessReviewResult	Represents a reviewer's decision for a given review KnownAccessReviewResult can be used interchangeably with AccessReviewResult, this enum contains the known values that the service supports. Known values supported by the service Approve: Approve Deny: Deny NotReviewed: NotReviewed DontKnow: DontKnow NotNotified: NotNotified
AccessReviewReviewerType	The identity type : user/servicePrincipal KnownAccessReviewReviewerType can be used interchangeably with AccessReviewReviewerType, this enum contains the known values that the service supports. Known values supported by the service user: user servicePrincipal: servicePrincipal
AccessReviewScheduleDefinitionReviewersType	This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. KnownAccessReviewScheduleDefinitionReviewersType can be used interchangeably with AccessReviewScheduleDefinitionReviewersType, this enum contains the known values that the service supports. Known values supported by the service Assigned: Assigned Self: Self Managers: Managers
AccessReviewScheduleDefinitionStatus	This read-only field specifies the status of an accessReview. KnownAccessReviewScheduleDefinitionStatus can be used interchangeably with AccessReviewScheduleDefinitionStatus, this enum contains the known values that the service supports. Known values supported by the service NotStarted: NotStarted InProgress: InProgress Completed: Completed Applied: Applied Initializing: Initializing Applying: Applying Completing: Completing Scheduled: Scheduled AutoReviewing: AutoReviewing AutoReviewed: AutoReviewed Starting: Starting
AccessReviewScopeAssignmentState	The role assignment state eligible/active to review KnownAccessReviewScopeAssignmentState can be used interchangeably with AccessReviewScopeAssignmentState, this enum contains the known values that the service supports. Known values supported by the service eligible: eligible active: active
AccessReviewScopePrincipalType	The identity type user/servicePrincipal to review KnownAccessReviewScopePrincipalType can be used interchangeably with AccessReviewScopePrincipalType, this enum contains the known values that the service supports. Known values supported by the service user: user guestUser: guestUser servicePrincipal: servicePrincipal user,group: user,group redeemedGuestUser: redeemedGuestUser
AlertConfigurationPropertiesUnion	Alias for AlertConfigurationPropertiesUnion
AlertIncidentPropertiesUnion	Alias for AlertIncidentPropertiesUnion
ApprovalMode	The type of rule KnownApprovalMode can be used interchangeably with ApprovalMode, this enum contains the known values that the service supports. Known values supported by the service SingleStage: SingleStage Serial: Serial Parallel: Parallel NoApproval: NoApproval
AssignmentType	Assignment type of the role assignment schedule KnownAssignmentType can be used interchangeably with AssignmentType, this enum contains the known values that the service supports. Known values supported by the service Activated: Activated Assigned: Assigned
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DecisionResourceType	The type of resource KnownDecisionResourceType can be used interchangeably with DecisionResourceType, this enum contains the known values that the service supports. Known values supported by the service azureRole: azureRole
DecisionTargetType	The type of decision target : User/ServicePrincipal KnownDecisionTargetType can be used interchangeably with DecisionTargetType, this enum contains the known values that the service supports. Known values supported by the service user: user servicePrincipal: servicePrincipal
DefaultDecisionType	This specifies the behavior for the autoReview feature when an access review completes. KnownDefaultDecisionType can be used interchangeably with DefaultDecisionType, this enum contains the known values that the service supports. Known values supported by the service Approve: Approve Deny: Deny Recommendation: Recommendation
DenyAssignmentEffect	The effect of the deny assignment. 'enforced' blocks access, 'audit' logs without blocking. KnownDenyAssignmentEffect can be used interchangeably with DenyAssignmentEffect, this enum contains the known values that the service supports. Known values supported by the service enforced: enforced audit: audit
DenyAssignmentPrincipalType	The type of the principal such as user, group, servicePrincipal, etc.
EnablementRules	The type of enablement rule KnownEnablementRules can be used interchangeably with EnablementRules, this enum contains the known values that the service supports. Known values supported by the service MultiFactorAuthentication: MultiFactorAuthentication Justification: Justification Ticketing: Ticketing
ExcludedPrincipalTypes	Type of ExcludedPrincipalTypes
MemberType	Membership type of the role assignment schedule KnownMemberType can be used interchangeably with MemberType, this enum contains the known values that the service supports. Known values supported by the service Inherited: Inherited Direct: Direct Group: Group
NotificationDeliveryMechanism	The type of notification. KnownNotificationDeliveryMechanism can be used interchangeably with NotificationDeliveryMechanism, this enum contains the known values that the service supports. Known values supported by the service Email: Email
NotificationLevel	The notification level. KnownNotificationLevel can be used interchangeably with NotificationLevel, this enum contains the known values that the service supports. Known values supported by the service None: None Critical: Critical All: All
PIMOnlyMode	Determines whether the setting is enabled, disabled or report only. KnownPIMOnlyMode can be used interchangeably with PIMOnlyMode, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled ReportOnly: ReportOnly
PrincipalType	The principal type of the assigned principal ID. KnownPrincipalType can be used interchangeably with PrincipalType, this enum contains the known values that the service supports. Known values supported by the service User: User Group: Group ServicePrincipal: ServicePrincipal ForeignGroup: ForeignGroup Device: Device
RecipientType	The recipient type. KnownRecipientType can be used interchangeably with RecipientType, this enum contains the known values that the service supports. Known values supported by the service Requestor: Requestor Approver: Approver Admin: Admin
RecordAllDecisionsResult	The decision to make. Approvers can take action of Approve/Deny KnownRecordAllDecisionsResult can be used interchangeably with RecordAllDecisionsResult, this enum contains the known values that the service supports. Known values supported by the service Approve: Approve Deny: Deny
RequestType	The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc KnownRequestType can be used interchangeably with RequestType, this enum contains the known values that the service supports. Known values supported by the service AdminAssign: AdminAssign AdminRemove: AdminRemove AdminUpdate: AdminUpdate AdminExtend: AdminExtend AdminRenew: AdminRenew SelfActivate: SelfActivate SelfDeactivate: SelfDeactivate SelfExtend: SelfExtend SelfRenew: SelfRenew
RoleManagementPolicyRuleType	The type of rule KnownRoleManagementPolicyRuleType can be used interchangeably with RoleManagementPolicyRuleType, this enum contains the known values that the service supports. Known values supported by the service RoleManagementPolicyApprovalRule: RoleManagementPolicyApprovalRule RoleManagementPolicyAuthenticationContextRule: RoleManagementPolicyAuthenticationContextRule RoleManagementPolicyEnablementRule: RoleManagementPolicyEnablementRule RoleManagementPolicyExpirationRule: RoleManagementPolicyExpirationRule RoleManagementPolicyNotificationRule: RoleManagementPolicyNotificationRule RoleManagementPolicyPimOnlyModeRule: RoleManagementPolicyPimOnlyModeRule
RoleManagementPolicyRuleUnion	Alias for RoleManagementPolicyRuleUnion
SeverityLevel	Severity level of the alert. KnownSeverityLevel can be used interchangeably with SeverityLevel, this enum contains the known values that the service supports. Known values supported by the service Low: Low Medium: Medium High: High
Status	The status of the role assignment schedule. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service Accepted: Accepted PendingEvaluation: PendingEvaluation Granted: Granted Denied: Denied PendingProvisioning: PendingProvisioning Provisioned: Provisioned PendingRevocation: PendingRevocation Revoked: Revoked Canceled: Canceled Failed: Failed PendingApprovalProvisioning: PendingApprovalProvisioning PendingApproval: PendingApproval FailedAsResourceIsLocked: FailedAsResourceIsLocked PendingAdminDecision: PendingAdminDecision AdminApproved: AdminApproved AdminDenied: AdminDenied TimedOut: TimedOut ProvisioningStarted: ProvisioningStarted Invalid: Invalid PendingScheduleCreation: PendingScheduleCreation ScheduleCreated: ScheduleCreated PendingExternalProvisioning: PendingExternalProvisioning
Type	Type of the role assignment schedule expiration KnownType can be used interchangeably with Type, this enum contains the known values that the service supports. Known values supported by the service AfterDuration: AfterDuration AfterDateTime: AfterDateTime NoExpiration: NoExpiration
UserType	The type of user. KnownUserType can be used interchangeably with UserType, this enum contains the known values that the service supports. Known values supported by the service User: User Group: Group
UsersOrServicePrincipalSetUserType	The type of user. KnownUsersOrServicePrincipalSetUserType can be used interchangeably with UsersOrServicePrincipalSetUserType, this enum contains the known values that the service supports. Known values supported by the service User: User Group: Group ServicePrincipal: ServicePrincipal

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessRecommendationType	The feature- generated recommendation shown to the reviewer.
KnownAccessReviewActorIdentityType	The identity type : user/servicePrincipal
KnownAccessReviewApplyResult	The outcome of applying the decision.
KnownAccessReviewDecisionInsightType	The type of insight
KnownAccessReviewDecisionPrincipalResourceMembershipType	Known values of AccessReviewDecisionPrincipalResourceMembershipType that the service accepts.
KnownAccessReviewHistoryDefinitionStatus	This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
KnownAccessReviewInstanceReviewersType	This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review.
KnownAccessReviewInstanceStatus	This read-only field specifies the status of an access review instance.
KnownAccessReviewRecurrencePatternType	The recurrence type : weekly, monthly, etc.
KnownAccessReviewRecurrenceRangeType	The recurrence range type. The possible values are: endDate, noEnd, numbered.
KnownAccessReviewResult	Represents a reviewer's decision for a given review
KnownAccessReviewReviewerType	The identity type : user/servicePrincipal
KnownAccessReviewScheduleDefinitionReviewersType	This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review.
KnownAccessReviewScheduleDefinitionStatus	This read-only field specifies the status of an accessReview.
KnownAccessReviewScopeAssignmentState	The role assignment state eligible/active to review
KnownAccessReviewScopePrincipalType	The identity type user/servicePrincipal to review
KnownApprovalMode	The type of rule
KnownAssignmentType	Assignment type of the role assignment schedule
KnownCreatedByType	The kind of entity that created the resource.
KnownDecisionResourceType	The type of resource
KnownDecisionTargetType	The type of decision target : User/ServicePrincipal
KnownDefaultDecisionType	This specifies the behavior for the autoReview feature when an access review completes.
KnownDenyAssignmentEffect	The effect of the deny assignment. 'enforced' blocks access, 'audit' logs without blocking.
KnownEnablementRules	The type of enablement rule
KnownExcludedPrincipalTypes	Known values of ExcludedPrincipalTypes that the service accepts.
KnownMemberType	Membership type of the role assignment schedule
KnownNotificationDeliveryMechanism	The type of notification.
KnownNotificationLevel	The notification level.
KnownPIMOnlyMode	Determines whether the setting is enabled, disabled or report only.
KnownPrincipalType	The principal type of the assigned principal ID.
KnownRecipientType	The recipient type.
KnownRecordAllDecisionsResult	The decision to make. Approvers can take action of Approve/Deny
KnownRequestType	The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc
KnownRoleManagementPolicyRuleType	The type of rule
KnownSeverityLevel	Severity level of the alert.
KnownStatus	The status of the role assignment schedule.
KnownType	Type of the role assignment schedule expiration
KnownUserType	The type of user.
KnownUsersOrServicePrincipalSetUserType	The type of user.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(AuthorizationManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

restorePoller<TResponse, TResult>(AuthorizationManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AuthorizationManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: AuthorizationManagementClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

Feedback

Was this page helpful?

@azure/arm-authorization package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(AuthorizationManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type

Feedback