你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

HostPools interface

包:

@azure/arm-desktopvirtualization

表示 HostPools 的接口。

方法

createOrUpdate(string, string, HostPool, HostPoolsCreateOrUpdateOptionalParams)	创建或更新主机池。
delete(string, string, HostPoolsDeleteOptionalParams)	删除主机池。
get(string, string, HostPoolsGetOptionalParams)	获取主机池。
list(HostPoolsListOptionalParams)	列出订阅中的 hostPools。
listByResourceGroup(string, HostPoolsListByResourceGroupOptionalParams)	列出 hostPools。
listRegistrationTokens(string, string, HostPoolsListRegistrationTokensOptionalParams)	列出与 HostPool 关联的 RegistrationTokens 的操作
retrieveRegistrationToken(string, string, HostPoolsRetrieveRegistrationTokenOptionalParams)	主机池的注册令牌。
update(string, string, HostPoolsUpdateOptionalParams)	更新主机池。

方法详细信息

createOrUpdate(string, string, HostPool, HostPoolsCreateOrUpdateOptionalParams)

创建或更新主机池。

function createOrUpdate(resourceGroupName: string, hostPoolName: string, hostPool: HostPool, options?: HostPoolsCreateOrUpdateOptionalParams): Promise<HostPool>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

hostPoolName

string

指定资源组中的主机池的名称

hostPool

HostPool

包含 HostPool 定义的对象。

options

HostPoolsCreateOrUpdateOptionalParams

选项参数。

返回

Promise<HostPool>

delete(string, string, HostPoolsDeleteOptionalParams)

删除主机池。

function delete(resourceGroupName: string, hostPoolName: string, options?: HostPoolsDeleteOptionalParams): Promise<void>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

hostPoolName

string

指定资源组中的主机池的名称

options

HostPoolsDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, HostPoolsGetOptionalParams)

获取主机池。

function get(resourceGroupName: string, hostPoolName: string, options?: HostPoolsGetOptionalParams): Promise<HostPool>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

hostPoolName

string

指定资源组中的主机池的名称

options

HostPoolsGetOptionalParams

选项参数。

返回

Promise<HostPool>

list(HostPoolsListOptionalParams)

列出订阅中的 hostPools。

function list(options?: HostPoolsListOptionalParams): PagedAsyncIterableIterator<HostPool, HostPool[], PageSettings>

参数

options

HostPoolsListOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<HostPool, HostPool[], PageSettings>

listByResourceGroup(string, HostPoolsListByResourceGroupOptionalParams)

列出 hostPools。

function listByResourceGroup(resourceGroupName: string, options?: HostPoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<HostPool, HostPool[], PageSettings>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

options

HostPoolsListByResourceGroupOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<HostPool, HostPool[], PageSettings>

listRegistrationTokens(string, string, HostPoolsListRegistrationTokensOptionalParams)

列出与 HostPool 关联的 RegistrationTokens 的操作

function listRegistrationTokens(resourceGroupName: string, hostPoolName: string, options?: HostPoolsListRegistrationTokensOptionalParams): Promise<RegistrationTokenList>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

hostPoolName

string

指定资源组中的主机池的名称

options

HostPoolsListRegistrationTokensOptionalParams

选项参数。

返回

Promise<RegistrationTokenList>

retrieveRegistrationToken(string, string, HostPoolsRetrieveRegistrationTokenOptionalParams)

主机池的注册令牌。

function retrieveRegistrationToken(resourceGroupName: string, hostPoolName: string, options?: HostPoolsRetrieveRegistrationTokenOptionalParams): Promise<RegistrationInfo>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

hostPoolName

string

指定资源组中的主机池的名称

options

HostPoolsRetrieveRegistrationTokenOptionalParams

选项参数。

返回

Promise<RegistrationInfo>

update(string, string, HostPoolsUpdateOptionalParams)

更新主机池。

function update(resourceGroupName: string, hostPoolName: string, options?: HostPoolsUpdateOptionalParams): Promise<HostPool>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

hostPoolName

string

指定资源组中的主机池的名称

options

HostPoolsUpdateOptionalParams

选项参数。

返回

Promise<HostPool>