Remove-MgBetaDirectoryRoleMemberByRef
Remove a member from a directoryRole. You can use both the object ID and template ID of the directoryRole with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see Role template IDs.
Note
To view the v1.0 release of this cmdlet, view Remove-MgDirectoryRoleMemberDirectoryObjectByRef
Syntax
Remove-MgBetaDirectoryRoleMemberByRef
-DirectoryObjectId <String>
-DirectoryRoleId <String>
[-IfMatch <String>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-MgBetaDirectoryRoleMemberByRef
-InputObject <IIdentityDirectoryManagementIdentity>
[-IfMatch <String>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Remove a member from a directoryRole. You can use both the object ID and template ID of the directoryRole with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see Role template IDs.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | RoleManagement.ReadWrite.Directory | Not available. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | RoleManagement.ReadWrite.Directory | Not available. |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
Remove-MgBetaDirectoryRoleMemberByRef -DirectoryRoleId $directoryRoleId -DirectoryObjectId $directoryObjectIdThis example shows how to use the Remove-MgBetaDirectoryRoleMemberByRef Cmdlet.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectoryObjectId
The unique identifier of directoryObject
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectoryRoleId
The unique identifier of directoryRole
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IfMatch
ETag
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IIdentityDirectoryManagementIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Returns true when the command succeeds
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity
System.Collections.IDictionary
Outputs
System.Boolean
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter
[AdministrativeUnitId <String>]: The unique identifier of administrativeUnit[AllowedValueId <String>]: The unique identifier of allowedValue[AttributeSetId <String>]: The unique identifier of attributeSet[CertificateAuthorityAsEntityId <String>]: The unique identifier of certificateAuthorityAsEntity[CertificateBasedApplicationConfigurationId <String>]: The unique identifier of certificateBasedApplicationConfiguration[CommandId <String>]: The unique identifier of command[CommerceSubscriptionId <String>]: Alternate key of companySubscription[CompanySubscriptionId <String>]: The unique identifier of companySubscription[ContractId <String>]: The unique identifier of contract[CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition[DeviceId <String>]: The unique identifier of device[DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo[DirectoryObjectId <String>]: The unique identifier of directoryObject[DirectoryRoleId <String>]: The unique identifier of directoryRole[DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate[DirectorySettingId <String>]: The unique identifier of directorySetting[DirectorySettingTemplateId <String>]: The unique identifier of directorySettingTemplate[DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord[DomainId <String>]: The unique identifier of domain[ExtensionId <String>]: The unique identifier of extension[ExternalUserProfileId <String>]: The unique identifier of externalUserProfile[FeatureRolloutPolicyId <String>]: The unique identifier of featureRolloutPolicy[IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase[ImpactedResourceId <String>]: The unique identifier of impactedResource[InboundSharedUserProfileUserId <String>]: The unique identifier of inboundSharedUserProfile[InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation[ManagedTenantAlertId <String>]: The unique identifier of managedTenantAlert[ManagementActionId <String>]: The unique identifier of managementAction[OcpSubscriptionId <String>]: Alternate key of companySubscription[OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization[OrgContactId <String>]: The unique identifier of orgContact[OrganizationId <String>]: The unique identifier of organization[OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization[OutboundSharedUserProfileUserId <String>]: The unique identifier of outboundSharedUserProfile[PendingExternalUserProfileId <String>]: The unique identifier of pendingExternalUserProfile[ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty[RecommendationId <String>]: The unique identifier of recommendation[RoleTemplateId <String>]: Alternate key of directoryRole[ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership[SharedEmailDomainId <String>]: The unique identifier of sharedEmailDomain[SharedEmailDomainInvitationId <String>]: The unique identifier of sharedEmailDomainInvitation[SubscribedSkuId <String>]: The unique identifier of subscribedSku[TenantId <String>]: The unique identifier of tenant[TenantReferenceTenantId <String>]: The unique identifier of tenantReference[TenantTagId <String>]: The unique identifier of tenantTag[UsageRightId <String>]: The unique identifier of usageRight[UserId <String>]: The unique identifier of user