Edit

Share via

Clear-AzureRemoteAppVmStaleAdObject

  • Reference
Module:
Azure

Removes objects in Microsoft Entra ID that are associated with Azure RemoteApp virtual machines that no longer exist.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Clear-AzureRemoteAppVmStaleAdObject
     -CollectionName <String>
     [-Credential <PSCredential>]
     [-Profile <AzureSMProfile>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Clear-AzureRemoteAppVmStaleAdObject cmdlet removes objects in Microsoft Entra ID that are associated with Azure RemoteApp virtual machines that no longer exist. You must use credentials that have rights to remove Microsoft Entra objects. If you specify the Verbose common parameter, this cmdlet displays the name of each object that it deletes.

Examples

Example 1: Clear stale objects for a collection

PS C:\> $AdminCredentials = Get-Credential
PS C:\> Clear-AzureRemoteAppVmStaleAdObject -CollectionName "Contoso" -Credential $AdminCredentials

The first command prompts you for a user name and password by using Get-Credential. The command stores the results in the $AdminCredentials variable.

The second command clears the stale objects for the collection named Contoso. The command uses the credentials stored in $AdminCredentials variable. In order for the command to succeed, those credentials must have appropriate rights.

Parameters

-CollectionName

Specifies the name of the Azure RemoteApp collection.

Type:String
Aliases:Name
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies a credential that has rights to perform this action. To obtain a PSCredential object, use the Get-Credential cmdlet. If you do not specify this parameter, this cmdlet uses the current user credentials.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
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:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False