Revoke-VMConnectAccess
Revokes access for one or more users to connect to a one or more virtual machines.
Syntax
Revoke-VMConnectAccess
[-VMName] <String[]>
[-UserName] <String[]>
[-Passthru]
[-ComputerName <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Revoke-VMConnectAccess
[-VMId] <Guid[]>
[-UserName] <String[]>
[-Passthru]
[-ComputerName <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Revoke-VMConnectAccess cmdlet revokes access for one or more users to connect to one or more virtual machines. This cmdlet is intended for use in providing other applications with the appropriate permissions required to initiate a session with Virtual Machine Connection. Examples of such applications are Virtual Machine Manager.
Examples
Example 1
PS C:\>Revoke-VMConnectAccess -VMName VM1 -UserName Contoso\John
This command revokes the access of user Contoso\John to connect to virtual machine VM1.
Parameters
-ComputerName
Specifies one or more virtual machine hosts on which access to connect to a virtual machine or machines is to be revoked. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly.
Type: | String[] |
Position: | Named |
Default value: | . |
Required: | False |
Accept pipeline input: | False |
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 |
-Passthru
Specifies that a VMConnectAce is to be passed through to the pipeline for each revocation of access.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserName
Specifies the user or users to whom access to connect to a virtual machine or machines is to be revoked, in one of the following forms.
Local User Account: john ComputerName\john
Domain User Account: CONTOSO\john Contoso.com\john
User Principal Name (UPN): john@contoso.com
Security Identifier: S-1-5-21-3165297888-301567370-576410423-1103
Type: | String[] |
Aliases: | UserId, Sid |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VMId
Specifies the unique identifier of a virtual machine or machines to which connect access is to be revoked.
Type: | Guid[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VMName
Specifies the name or names of the virtual machine or machines to which access is being revoked.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
Outputs
None by default; Microsoft.HyperV.PowerShell.VMConnectAce if -PassThru is specified.