azure-native.authorization.getRoleManagementPolicyAssignment

Role management policy API Version: 2020-10-01.

Using getRoleManagementPolicyAssignment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRoleManagementPolicyAssignment(args: GetRoleManagementPolicyAssignmentArgs, opts?: InvokeOptions): Promise<GetRoleManagementPolicyAssignmentResult>
function getRoleManagementPolicyAssignmentOutput(args: GetRoleManagementPolicyAssignmentOutputArgs, opts?: InvokeOptions): Output<GetRoleManagementPolicyAssignmentResult>
def get_role_management_policy_assignment(role_management_policy_assignment_name: Optional[str] = None,
                                          scope: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetRoleManagementPolicyAssignmentResult
def get_role_management_policy_assignment_output(role_management_policy_assignment_name: Optional[pulumi.Input[str]] = None,
                                          scope: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetRoleManagementPolicyAssignmentResult]
func LookupRoleManagementPolicyAssignment(ctx *Context, args *LookupRoleManagementPolicyAssignmentArgs, opts ...InvokeOption) (*LookupRoleManagementPolicyAssignmentResult, error)
func LookupRoleManagementPolicyAssignmentOutput(ctx *Context, args *LookupRoleManagementPolicyAssignmentOutputArgs, opts ...InvokeOption) LookupRoleManagementPolicyAssignmentResultOutput

> Note: This function is named LookupRoleManagementPolicyAssignment in the Go SDK.

public static class GetRoleManagementPolicyAssignment 
{
    public static Task<GetRoleManagementPolicyAssignmentResult> InvokeAsync(GetRoleManagementPolicyAssignmentArgs args, InvokeOptions? opts = null)
    public static Output<GetRoleManagementPolicyAssignmentResult> Invoke(GetRoleManagementPolicyAssignmentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetRoleManagementPolicyAssignmentResult> getRoleManagementPolicyAssignment(GetRoleManagementPolicyAssignmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:authorization:getRoleManagementPolicyAssignment
  arguments:
    # arguments dictionary

The following arguments are supported:

RoleManagementPolicyAssignmentName string

The name of format {guid_guid} the role management policy assignment to get.

Scope string

The scope of the role management policy.

RoleManagementPolicyAssignmentName string

The name of format {guid_guid} the role management policy assignment to get.

Scope string

The scope of the role management policy.

roleManagementPolicyAssignmentName String

The name of format {guid_guid} the role management policy assignment to get.

scope String

The scope of the role management policy.

roleManagementPolicyAssignmentName string

The name of format {guid_guid} the role management policy assignment to get.

scope string

The scope of the role management policy.

role_management_policy_assignment_name str

The name of format {guid_guid} the role management policy assignment to get.

scope str

The scope of the role management policy.

roleManagementPolicyAssignmentName String

The name of format {guid_guid} the role management policy assignment to get.

scope String

The scope of the role management policy.

getRoleManagementPolicyAssignment Result

The following output properties are available:

EffectiveRules List<object>

The readonly computed rule applied to the policy.

Id string

The role management policy Id.

Name string

The role management policy name.

PolicyAssignmentProperties Pulumi.AzureNative.Authorization.Outputs.PolicyAssignmentPropertiesResponse

Additional properties of scope, role definition and policy

Type string

The role management policy type.

PolicyId string

The policy id role management policy assignment.

RoleDefinitionId string

The role definition of management policy assignment.

Scope string

The role management policy scope.

EffectiveRules []interface{}

The readonly computed rule applied to the policy.

Id string

The role management policy Id.

Name string

The role management policy name.

PolicyAssignmentProperties PolicyAssignmentPropertiesResponse

Additional properties of scope, role definition and policy

Type string

The role management policy type.

PolicyId string

The policy id role management policy assignment.

RoleDefinitionId string

The role definition of management policy assignment.

Scope string

The role management policy scope.

effectiveRules List<Object>

The readonly computed rule applied to the policy.

id String

The role management policy Id.

name String

The role management policy name.

policyAssignmentProperties PolicyAssignmentPropertiesResponse

Additional properties of scope, role definition and policy

type String

The role management policy type.

policyId String

The policy id role management policy assignment.

roleDefinitionId String

The role definition of management policy assignment.

scope String

The role management policy scope.

effectiveRules (RoleManagementPolicyApprovalRuleResponse | RoleManagementPolicyAuthenticationContextRuleResponse | RoleManagementPolicyEnablementRuleResponse | RoleManagementPolicyExpirationRuleResponse | RoleManagementPolicyNotificationRuleResponse)[]

The readonly computed rule applied to the policy.

id string

The role management policy Id.

name string

The role management policy name.

policyAssignmentProperties PolicyAssignmentPropertiesResponse

Additional properties of scope, role definition and policy

type string

The role management policy type.

policyId string

The policy id role management policy assignment.

roleDefinitionId string

The role definition of management policy assignment.

scope string

The role management policy scope.

effective_rules Sequence[Any]

The readonly computed rule applied to the policy.

id str

The role management policy Id.

name str

The role management policy name.

policy_assignment_properties PolicyAssignmentPropertiesResponse

Additional properties of scope, role definition and policy

type str

The role management policy type.

policy_id str

The policy id role management policy assignment.

role_definition_id str

The role definition of management policy assignment.

scope str

The role management policy scope.

effectiveRules List<Property Map | Property Map | Property Map | Property Map | Property Map>

The readonly computed rule applied to the policy.

id String

The role management policy Id.

name String

The role management policy name.

policyAssignmentProperties Property Map

Additional properties of scope, role definition and policy

type String

The role management policy type.

policyId String

The policy id role management policy assignment.

roleDefinitionId String

The role definition of management policy assignment.

scope String

The role management policy scope.

Supporting Types

ApprovalSettingsResponse

ApprovalMode string

The type of rule

ApprovalStages List<Pulumi.AzureNative.Authorization.Inputs.ApprovalStageResponse>

The approval stages of the request.

IsApprovalRequired bool

Determines whether approval is required or not.

IsApprovalRequiredForExtension bool

Determines whether approval is required for assignment extension.

IsRequestorJustificationRequired bool

Determine whether requestor justification is required.

ApprovalMode string

The type of rule

ApprovalStages []ApprovalStageResponse

The approval stages of the request.

IsApprovalRequired bool

Determines whether approval is required or not.

IsApprovalRequiredForExtension bool

Determines whether approval is required for assignment extension.

IsRequestorJustificationRequired bool

Determine whether requestor justification is required.

approvalMode String

The type of rule

approvalStages List<ApprovalStageResponse>

The approval stages of the request.

isApprovalRequired Boolean

Determines whether approval is required or not.

isApprovalRequiredForExtension Boolean

Determines whether approval is required for assignment extension.

isRequestorJustificationRequired Boolean

Determine whether requestor justification is required.

approvalMode string

The type of rule

approvalStages ApprovalStageResponse[]

The approval stages of the request.

isApprovalRequired boolean

Determines whether approval is required or not.

isApprovalRequiredForExtension boolean

Determines whether approval is required for assignment extension.

isRequestorJustificationRequired boolean

Determine whether requestor justification is required.

approval_mode str

The type of rule

approval_stages Sequence[ApprovalStageResponse]

The approval stages of the request.

is_approval_required bool

Determines whether approval is required or not.

is_approval_required_for_extension bool

Determines whether approval is required for assignment extension.

is_requestor_justification_required bool

Determine whether requestor justification is required.

approvalMode String

The type of rule

approvalStages List<Property Map>

The approval stages of the request.

isApprovalRequired Boolean

Determines whether approval is required or not.

isApprovalRequiredForExtension Boolean

Determines whether approval is required for assignment extension.

isRequestorJustificationRequired Boolean

Determine whether requestor justification is required.

ApprovalStageResponse

ApprovalStageTimeOutInDays int

The time in days when approval request would be timed out

EscalationApprovers List<Pulumi.AzureNative.Authorization.Inputs.UserSetResponse>

The escalation approver of the request.

EscalationTimeInMinutes int

The time in minutes when the approval request would be escalated if the primary approver does not approve

IsApproverJustificationRequired bool

Determines whether approver need to provide justification for his decision.

IsEscalationEnabled bool

The value determine whether escalation feature is enabled.

PrimaryApprovers List<Pulumi.AzureNative.Authorization.Inputs.UserSetResponse>

The primary approver of the request.

ApprovalStageTimeOutInDays int

The time in days when approval request would be timed out

EscalationApprovers []UserSetResponse

The escalation approver of the request.

EscalationTimeInMinutes int

The time in minutes when the approval request would be escalated if the primary approver does not approve

IsApproverJustificationRequired bool

Determines whether approver need to provide justification for his decision.

IsEscalationEnabled bool

The value determine whether escalation feature is enabled.

PrimaryApprovers []UserSetResponse

The primary approver of the request.

approvalStageTimeOutInDays Integer

The time in days when approval request would be timed out

escalationApprovers List<UserSetResponse>

The escalation approver of the request.

escalationTimeInMinutes Integer

The time in minutes when the approval request would be escalated if the primary approver does not approve

isApproverJustificationRequired Boolean

Determines whether approver need to provide justification for his decision.

isEscalationEnabled Boolean

The value determine whether escalation feature is enabled.

primaryApprovers List<UserSetResponse>

The primary approver of the request.

approvalStageTimeOutInDays number

The time in days when approval request would be timed out

escalationApprovers UserSetResponse[]

The escalation approver of the request.

escalationTimeInMinutes number

The time in minutes when the approval request would be escalated if the primary approver does not approve

isApproverJustificationRequired boolean

Determines whether approver need to provide justification for his decision.

isEscalationEnabled boolean

The value determine whether escalation feature is enabled.

primaryApprovers UserSetResponse[]

The primary approver of the request.

approval_stage_time_out_in_days int

The time in days when approval request would be timed out

escalation_approvers Sequence[UserSetResponse]

The escalation approver of the request.

escalation_time_in_minutes int

The time in minutes when the approval request would be escalated if the primary approver does not approve

is_approver_justification_required bool

Determines whether approver need to provide justification for his decision.

is_escalation_enabled bool

The value determine whether escalation feature is enabled.

primary_approvers Sequence[UserSetResponse]

The primary approver of the request.

approvalStageTimeOutInDays Number

The time in days when approval request would be timed out

escalationApprovers List<Property Map>

The escalation approver of the request.

escalationTimeInMinutes Number

The time in minutes when the approval request would be escalated if the primary approver does not approve

isApproverJustificationRequired Boolean

Determines whether approver need to provide justification for his decision.

isEscalationEnabled Boolean

The value determine whether escalation feature is enabled.

primaryApprovers List<Property Map>

The primary approver of the request.

PolicyAssignmentPropertiesResponse

policy Property Map

Details of the policy

roleDefinition Property Map

Details of role definition

scope Property Map

Details of the resource scope

PolicyAssignmentPropertiesResponsePolicy

LastModifiedBy Pulumi.AzureNative.Authorization.Inputs.PrincipalResponse

The name of the entity last modified it

Id string

Id of the policy

LastModifiedDateTime string

The last modified date time.

LastModifiedBy PrincipalResponse

The name of the entity last modified it

Id string

Id of the policy

LastModifiedDateTime string

The last modified date time.

lastModifiedBy PrincipalResponse

The name of the entity last modified it

id String

Id of the policy

lastModifiedDateTime String

The last modified date time.

lastModifiedBy PrincipalResponse

The name of the entity last modified it

id string

Id of the policy

lastModifiedDateTime string

The last modified date time.

last_modified_by PrincipalResponse

The name of the entity last modified it

id str

Id of the policy

last_modified_date_time str

The last modified date time.

lastModifiedBy Property Map

The name of the entity last modified it

id String

Id of the policy

lastModifiedDateTime String

The last modified date time.

PolicyAssignmentPropertiesResponseRoleDefinition

DisplayName string

Display name of the role definition

Id string

Id of the role definition

Type string

Type of the role definition

DisplayName string

Display name of the role definition

Id string

Id of the role definition

Type string

Type of the role definition

displayName String

Display name of the role definition

id String

Id of the role definition

type String

Type of the role definition

displayName string

Display name of the role definition

id string

Id of the role definition

type string

Type of the role definition

display_name str

Display name of the role definition

id str

Id of the role definition

type str

Type of the role definition

displayName String

Display name of the role definition

id String

Id of the role definition

type String

Type of the role definition

PolicyAssignmentPropertiesResponseScope

DisplayName string

Display name of the resource

Id string

Scope id of the resource

Type string

Type of the resource

DisplayName string

Display name of the resource

Id string

Scope id of the resource

Type string

Type of the resource

displayName String

Display name of the resource

id String

Scope id of the resource

type String

Type of the resource

displayName string

Display name of the resource

id string

Scope id of the resource

type string

Type of the resource

display_name str

Display name of the resource

id str

Scope id of the resource

type str

Type of the resource

displayName String

Display name of the resource

id String

Scope id of the resource

type String

Type of the resource

PrincipalResponse

DisplayName string

The name of the principal made changes

Email string

Email of principal

Id string

The id of the principal made changes

Type string

Type of principal such as user , group etc

DisplayName string

The name of the principal made changes

Email string

Email of principal

Id string

The id of the principal made changes

Type string

Type of principal such as user , group etc

displayName String

The name of the principal made changes

email String

Email of principal

id String

The id of the principal made changes

type String

Type of principal such as user , group etc

displayName string

The name of the principal made changes

email string

Email of principal

id string

The id of the principal made changes

type string

Type of principal such as user , group etc

display_name str

The name of the principal made changes

email str

Email of principal

id str

The id of the principal made changes

type str

Type of principal such as user , group etc

displayName String

The name of the principal made changes

email String

Email of principal

id String

The id of the principal made changes

type String

Type of principal such as user , group etc

RoleManagementPolicyApprovalRuleResponse

Id string

The id of the rule.

Setting ApprovalSettingsResponse

The approval setting

Target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id String

The id of the rule.

setting ApprovalSettingsResponse

The approval setting

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id string

The id of the rule.

setting ApprovalSettingsResponse

The approval setting

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id str

The id of the rule.

setting ApprovalSettingsResponse

The approval setting

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id String

The id of the rule.

setting Property Map

The approval setting

target Property Map

The target of the current rule.

RoleManagementPolicyAuthenticationContextRuleResponse

ClaimValue string

The claim value.

Id string

The id of the rule.

IsEnabled bool

The value indicating if rule is enabled.

Target Pulumi.AzureNative.Authorization.Inputs.RoleManagementPolicyRuleTargetResponse

The target of the current rule.

ClaimValue string

The claim value.

Id string

The id of the rule.

IsEnabled bool

The value indicating if rule is enabled.

Target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

claimValue String

The claim value.

id String

The id of the rule.

isEnabled Boolean

The value indicating if rule is enabled.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

claimValue string

The claim value.

id string

The id of the rule.

isEnabled boolean

The value indicating if rule is enabled.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

claim_value str

The claim value.

id str

The id of the rule.

is_enabled bool

The value indicating if rule is enabled.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

claimValue String

The claim value.

id String

The id of the rule.

isEnabled Boolean

The value indicating if rule is enabled.

target Property Map

The target of the current rule.

RoleManagementPolicyEnablementRuleResponse

EnabledRules List<string>

The list of enabled rules.

Id string

The id of the rule.

Target Pulumi.AzureNative.Authorization.Inputs.RoleManagementPolicyRuleTargetResponse

The target of the current rule.

EnabledRules []string

The list of enabled rules.

Id string

The id of the rule.

Target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

enabledRules List<String>

The list of enabled rules.

id String

The id of the rule.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

enabledRules string[]

The list of enabled rules.

id string

The id of the rule.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

enabled_rules Sequence[str]

The list of enabled rules.

id str

The id of the rule.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

enabledRules List<String>

The list of enabled rules.

id String

The id of the rule.

target Property Map

The target of the current rule.

RoleManagementPolicyExpirationRuleResponse

Id string

The id of the rule.

IsExpirationRequired bool

The value indicating whether expiration is required.

MaximumDuration string

The maximum duration of expiration in timespan.

Target Pulumi.AzureNative.Authorization.Inputs.RoleManagementPolicyRuleTargetResponse

The target of the current rule.

Id string

The id of the rule.

IsExpirationRequired bool

The value indicating whether expiration is required.

MaximumDuration string

The maximum duration of expiration in timespan.

Target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id String

The id of the rule.

isExpirationRequired Boolean

The value indicating whether expiration is required.

maximumDuration String

The maximum duration of expiration in timespan.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id string

The id of the rule.

isExpirationRequired boolean

The value indicating whether expiration is required.

maximumDuration string

The maximum duration of expiration in timespan.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id str

The id of the rule.

is_expiration_required bool

The value indicating whether expiration is required.

maximum_duration str

The maximum duration of expiration in timespan.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id String

The id of the rule.

isExpirationRequired Boolean

The value indicating whether expiration is required.

maximumDuration String

The maximum duration of expiration in timespan.

target Property Map

The target of the current rule.

RoleManagementPolicyNotificationRuleResponse

Id string

The id of the rule.

IsDefaultRecipientsEnabled bool

Determines if the notification will be sent to the recipient type specified in the policy rule.

NotificationLevel string

The notification level.

NotificationRecipients List<string>

The list of notification recipients.

NotificationType string

The type of notification.

RecipientType string

The recipient type.

Target Pulumi.AzureNative.Authorization.Inputs.RoleManagementPolicyRuleTargetResponse

The target of the current rule.

Id string

The id of the rule.

IsDefaultRecipientsEnabled bool

Determines if the notification will be sent to the recipient type specified in the policy rule.

NotificationLevel string

The notification level.

NotificationRecipients []string

The list of notification recipients.

NotificationType string

The type of notification.

RecipientType string

The recipient type.

Target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id String

The id of the rule.

isDefaultRecipientsEnabled Boolean

Determines if the notification will be sent to the recipient type specified in the policy rule.

notificationLevel String

The notification level.

notificationRecipients List<String>

The list of notification recipients.

notificationType String

The type of notification.

recipientType String

The recipient type.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id string

The id of the rule.

isDefaultRecipientsEnabled boolean

Determines if the notification will be sent to the recipient type specified in the policy rule.

notificationLevel string

The notification level.

notificationRecipients string[]

The list of notification recipients.

notificationType string

The type of notification.

recipientType string

The recipient type.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id str

The id of the rule.

is_default_recipients_enabled bool

Determines if the notification will be sent to the recipient type specified in the policy rule.

notification_level str

The notification level.

notification_recipients Sequence[str]

The list of notification recipients.

notification_type str

The type of notification.

recipient_type str

The recipient type.

target RoleManagementPolicyRuleTargetResponse

The target of the current rule.

id String

The id of the rule.

isDefaultRecipientsEnabled Boolean

Determines if the notification will be sent to the recipient type specified in the policy rule.

notificationLevel String

The notification level.

notificationRecipients List<String>

The list of notification recipients.

notificationType String

The type of notification.

recipientType String

The recipient type.

target Property Map

The target of the current rule.

RoleManagementPolicyRuleTargetResponse

Caller string

The caller of the setting.

EnforcedSettings List<string>

The list of enforced settings.

InheritableSettings List<string>

The list of inheritable settings.

Level string

The assignment level to which rule is applied.

Operations List<string>

The type of operation.

TargetObjects List<string>

The list of target objects.

Caller string

The caller of the setting.

EnforcedSettings []string

The list of enforced settings.

InheritableSettings []string

The list of inheritable settings.

Level string

The assignment level to which rule is applied.

Operations []string

The type of operation.

TargetObjects []string

The list of target objects.

caller String

The caller of the setting.

enforcedSettings List<String>

The list of enforced settings.

inheritableSettings List<String>

The list of inheritable settings.

level String

The assignment level to which rule is applied.

operations List<String>

The type of operation.

targetObjects List<String>

The list of target objects.

caller string

The caller of the setting.

enforcedSettings string[]

The list of enforced settings.

inheritableSettings string[]

The list of inheritable settings.

level string

The assignment level to which rule is applied.

operations string[]

The type of operation.

targetObjects string[]

The list of target objects.

caller str

The caller of the setting.

enforced_settings Sequence[str]

The list of enforced settings.

inheritable_settings Sequence[str]

The list of inheritable settings.

level str

The assignment level to which rule is applied.

operations Sequence[str]

The type of operation.

target_objects Sequence[str]

The list of target objects.

caller String

The caller of the setting.

enforcedSettings List<String>

The list of enforced settings.

inheritableSettings List<String>

The list of inheritable settings.

level String

The assignment level to which rule is applied.

operations List<String>

The type of operation.

targetObjects List<String>

The list of target objects.

UserSetResponse

Description string

The description of the user.

Id string

The object id of the user.

IsBackup bool

The value indicating whether the user is a backup fallback approver

UserType string

The type of user.

Description string

The description of the user.

Id string

The object id of the user.

IsBackup bool

The value indicating whether the user is a backup fallback approver

UserType string

The type of user.

description String

The description of the user.

id String

The object id of the user.

isBackup Boolean

The value indicating whether the user is a backup fallback approver

userType String

The type of user.

description string

The description of the user.

id string

The object id of the user.

isBackup boolean

The value indicating whether the user is a backup fallback approver

userType string

The type of user.

description str

The description of the user.

id str

The object id of the user.

is_backup bool

The value indicating whether the user is a backup fallback approver

user_type str

The type of user.

description String

The description of the user.

id String

The object id of the user.

isBackup Boolean

The value indicating whether the user is a backup fallback approver

userType String

The type of user.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0