UserSessions interface

套件:

@azure/arm-desktopvirtualization

代表 UserSessions 的介面。

方法

delete(string, string, string, string, UserSessionsDeleteOptionalParams)	拿掉userSession。
disconnect(string, string, string, string, UserSessionsDisconnectOptionalParams)	中斷用戶連線。
get(string, string, string, string, UserSessionsGetOptionalParams)	取得userSession。
list(string, string, string, UserSessionsListOptionalParams)	列出userSessions。
listByHostPool(string, string, UserSessionsListByHostPoolOptionalParams)	列出userSessions。
sendMessage(string, string, string, string, UserSessionsSendMessageOptionalParams)	傳送訊息給使用者。

方法詳細資料

delete(string, string, string, string, UserSessionsDeleteOptionalParams)

拿掉userSession。

function delete(resourceGroupName: string, hostPoolName: string, sessionHostName: string, userSessionId: string, options?: UserSessionsDeleteOptionalParams): Promise<void>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

hostPoolName

string

指定資源群組內的主機集區名稱

sessionHostName

string

指定主機集區內的工作階段主機名稱

userSessionId

string

指定工作階段主機內使用者工作階段的名稱

options

UserSessionsDeleteOptionalParams

選項參數。

傳回

Promise<void>

disconnect(string, string, string, string, UserSessionsDisconnectOptionalParams)

中斷用戶連線。

function disconnect(resourceGroupName: string, hostPoolName: string, sessionHostName: string, userSessionId: string, options?: UserSessionsDisconnectOptionalParams): Promise<void>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

hostPoolName

string

指定資源群組內的主機集區名稱

sessionHostName

string

指定主機集區內的工作階段主機名稱

userSessionId

string

指定工作階段主機內使用者工作階段的名稱

options

UserSessionsDisconnectOptionalParams

選項參數。

傳回

Promise<void>

get(string, string, string, string, UserSessionsGetOptionalParams)

取得userSession。

function get(resourceGroupName: string, hostPoolName: string, sessionHostName: string, userSessionId: string, options?: UserSessionsGetOptionalParams): Promise<UserSession>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

hostPoolName

string

指定資源群組內的主機集區名稱

sessionHostName

string

指定主機集區內的工作階段主機名稱

userSessionId

string

指定工作階段主機內使用者工作階段的名稱

options

UserSessionsGetOptionalParams

選項參數。

傳回

Promise<UserSession>

list(string, string, string, UserSessionsListOptionalParams)

列出userSessions。

function list(resourceGroupName: string, hostPoolName: string, sessionHostName: string, options?: UserSessionsListOptionalParams): PagedAsyncIterableIterator<UserSession, UserSession[], PageSettings>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

hostPoolName

string

指定資源群組內的主機集區名稱

sessionHostName

string

指定主機集區內的工作階段主機名稱

options

UserSessionsListOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<UserSession, UserSession[], PageSettings>

listByHostPool(string, string, UserSessionsListByHostPoolOptionalParams)

列出userSessions。

function listByHostPool(resourceGroupName: string, hostPoolName: string, options?: UserSessionsListByHostPoolOptionalParams): PagedAsyncIterableIterator<UserSession, UserSession[], PageSettings>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

hostPoolName

string

指定資源群組內的主機集區名稱

options

UserSessionsListByHostPoolOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<UserSession, UserSession[], PageSettings>

sendMessage(string, string, string, string, UserSessionsSendMessageOptionalParams)

傳送訊息給使用者。

function sendMessage(resourceGroupName: string, hostPoolName: string, sessionHostName: string, userSessionId: string, options?: UserSessionsSendMessageOptionalParams): Promise<void>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

hostPoolName

string

指定資源群組內的主機集區名稱

sessionHostName

string

指定主機集區內的工作階段主機名稱

userSessionId

string

指定工作階段主機內使用者工作階段的名稱

options

UserSessionsSendMessageOptionalParams

選項參數。

傳回

Promise<void>