Grant-VMConnectAccess

Grant-VMConnectAccess

Grants a user or users access to connect to a virtual machine or machines.

構文

Parameter Set: VMName
Grant-VMConnectAccess [-VMName] <String[]> [-UserName] <System.String[]> [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ComputerName <System.String[]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMId
Grant-VMConnectAccess [-VMId] <Guid[]> [-UserName] <System.String[]> [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ComputerName <System.String[]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Grant-VMConnectAccess cmdlet grants access to a user or users to connect to a virtual machine or machines. The 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.

パラメーター

-CimSession<Microsoft.Management.Infrastructure.CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。コンピューター名またはセッション オブジェクト (New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など) を入力します。既定値は、ローカル コンピューター上の現在のセッションです。

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-ComputerName<System.String[]>

Specifies one or more Hyper-v hosts which run this cmdlet. 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.

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Credential<System.Management.Automation.PSCredential[]>

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Passthru

Indicates that this cmdlet returns a Microsoft.HyperV.PowerShell.VMConnectAce object. By default, this cmdlet does not return any output.

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-UserName<System.String[]>

Specifies a user or users to whom access to connect to a virtual machine or machines is to be granted.

Aliases

UserId,Sid

必須/オプション

true

位置

2

既定値

none

パイプライン入力の受け入れ

true(ByPropertyName)

ワイルドカード文字の受け入れ

false

-VMId<Guid[]>

Specifies the unique identifier of a virtual machine to which connect access is to be granted.

Aliases

none

必須/オプション

true

位置

1

既定値

none

パイプライン入力の受け入れ

True (ByValue, ByPropertyName)

ワイルドカード文字の受け入れ

false

-VMName<String[]>

Specifies the name of a virtual machine to which connect access is to be granted.

Aliases

none

必須/オプション

true

位置

1

既定値

none

パイプライン入力の受け入れ

True (ByValue)

ワイルドカード文字の受け入れ

false

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

必須/オプション

false

位置

named

既定値

false

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-WhatIf

コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。

必須/オプション

false

位置

named

既定値

false

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

<CommonParameters>

このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

  • None by default; Microsoft.HyperV.PowerShell.VMConnectAce if –PassThru is specified.

使用例

Example 1

This command grants user Contoso\John access to connect to a virtual machine named VM1.

PS C:\> Grant-VMConnectAccess –VMName VM1 –UserName Contoso\John