HostPools interface
Interface representing a HostPools.
Methods
| create |
Create or update a host pool. |
| delete(string, string, Host |
Remove a host pool. |
| get(string, string, Host |
Get a host pool. |
| list(Host |
List hostPools in subscription. |
| list |
List hostPools. |
| retrieve |
Registration token of the host pool. |
| update(string, string, Host |
Update a host pool. |
Method Details
createOrUpdate(string, string, HostPool, HostPoolsCreateOrUpdateOptionalParams)
Create or update a host pool.
function createOrUpdate(resourceGroupName: string, hostPoolName: string, hostPool: HostPool, options?: HostPoolsCreateOrUpdateOptionalParams): Promise<HostPool>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
- hostPool
- HostPool
Object containing HostPool definitions.
The options parameters.
Returns
Promise<HostPool>
delete(string, string, HostPoolsDeleteOptionalParams)
Remove a host pool.
function delete(resourceGroupName: string, hostPoolName: string, options?: HostPoolsDeleteOptionalParams): 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
- options
- HostPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, HostPoolsGetOptionalParams)
Get a host pool.
function get(resourceGroupName: string, hostPoolName: string, options?: HostPoolsGetOptionalParams): Promise<HostPool>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
- HostPoolsGetOptionalParams
The options parameters.
Returns
Promise<HostPool>
list(HostPoolsListOptionalParams)
List hostPools in subscription.
function list(options?: HostPoolsListOptionalParams): PagedAsyncIterableIterator<HostPool, HostPool[], PageSettings>Parameters
- options
- HostPoolsListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, HostPoolsListByResourceGroupOptionalParams)
List hostPools.
function listByResourceGroup(resourceGroupName: string, options?: HostPoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<HostPool, HostPool[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
retrieveRegistrationToken(string, string, HostPoolsRetrieveRegistrationTokenOptionalParams)
Registration token of the host pool.
function retrieveRegistrationToken(resourceGroupName: string, hostPoolName: string, options?: HostPoolsRetrieveRegistrationTokenOptionalParams): Promise<RegistrationInfo>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
The options parameters.
Returns
Promise<RegistrationInfo>
update(string, string, HostPoolsUpdateOptionalParams)
Update a host pool.
function update(resourceGroupName: string, hostPoolName: string, options?: HostPoolsUpdateOptionalParams): Promise<HostPool>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
- HostPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<HostPool>