SessionHosts interface
Interface representing a SessionHosts.
Methods
| delete(string, string, string, Session |
Remove a SessionHost. |
| get(string, string, string, Session |
Get a session host. |
| list(string, string, Session |
List sessionHosts. |
| update(string, string, string, Session |
Update a session host. |
Method Details
delete(string, string, string, SessionHostsDeleteOptionalParams)
Remove a SessionHost.
function delete(resourceGroupName: string, hostPoolName: string, sessionHostName: string, options?: SessionHostsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- hostPoolName
-
string
The name of the host pool within the specified resource group
- sessionHostName
-
string
The name of the session host within the specified host pool
- options
- SessionHostsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, SessionHostsGetOptionalParams)
Get a session host.
function get(resourceGroupName: string, hostPoolName: string, sessionHostName: string, options?: SessionHostsGetOptionalParams): Promise<SessionHost>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- hostPoolName
-
string
The name of the host pool within the specified resource group
- sessionHostName
-
string
The name of the session host within the specified host pool
- options
- SessionHostsGetOptionalParams
The options parameters.
Returns
Promise<SessionHost>
list(string, string, SessionHostsListOptionalParams)
List sessionHosts.
function list(resourceGroupName: string, hostPoolName: string, options?: SessionHostsListOptionalParams): PagedAsyncIterableIterator<SessionHost, SessionHost[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- hostPoolName
-
string
The name of the host pool within the specified resource group
- options
- SessionHostsListOptionalParams
The options parameters.
Returns
update(string, string, string, SessionHostsUpdateOptionalParams)
Update a session host.
function update(resourceGroupName: string, hostPoolName: string, sessionHostName: string, options?: SessionHostsUpdateOptionalParams): Promise<SessionHost>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- hostPoolName
-
string
The name of the host pool within the specified resource group
- sessionHostName
-
string
The name of the session host within the specified host pool
- options
- SessionHostsUpdateOptionalParams
The options parameters.
Returns
Promise<SessionHost>