UserSessions interface
表示 UserSessions 的接口。
方法
方法详细信息
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)
断开 userSession 的连接。
function disconnect(resourceGroupName: string, hostPoolName: string, sessionHostName: string, userSessionId: string, options?: UserSessionsDisconnectOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- hostPoolName
-
string
指定资源组中的主机池的名称
- sessionHostName
-
string
指定主机池中的会话主机的名称
- userSessionId
-
string
指定会话主机中用户会话的名称
选项参数。
返回
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
选项参数。
返回
listByHostPool(string, string, UserSessionsListByHostPoolOptionalParams)
列出 userSessions。
function listByHostPool(resourceGroupName: string, hostPoolName: string, options?: UserSessionsListByHostPoolOptionalParams): PagedAsyncIterableIterator<UserSession, UserSession[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- hostPoolName
-
string
指定资源组中的主机池的名称
选项参数。
返回
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
指定会话主机中用户会话的名称
选项参数。
返回
Promise<void>