UserSessions interface
UserSessions を表すインターフェイス。
メソッド
| delete(string, string, string, string, User |
userSession を削除します。 |
| disconnect(string, string, string, string, User |
userSession を切断します。 |
| get(string, string, string, string, User |
userSession を取得します。 |
| list(string, string, string, User |
userSessions を一覧表示します。 |
| list |
userSessions を一覧表示します。 |
| send |
ユーザーにメッセージを送信します。 |
メソッドの詳細
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>