HostPools interface
代表 HostPools 的介面。
方法
方法詳細資料
createOrUpdate(string, string, HostPool, HostPoolsCreateOrUpdateOptionalParams)
建立或更新主機集區。
function createOrUpdate(resourceGroupName: string, hostPoolName: string, hostPool: HostPool, options?: HostPoolsCreateOrUpdateOptionalParams): Promise<HostPool>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- hostPoolName
-
string
指定資源群組內的主機集區名稱
- hostPool
- HostPool
包含 HostPool 定義的物件。
選項參數。
傳回
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
選項參數。
傳回
listByResourceGroup(string, HostPoolsListByResourceGroupOptionalParams)
列出 hostPools。
function listByResourceGroup(resourceGroupName: string, options?: HostPoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<HostPool, HostPool[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
選項參數。
傳回
listRegistrationTokens(string, string, HostPoolsListRegistrationTokensOptionalParams)
列出與 HostPool 相關聯的 RegistrationTokens 作業
function listRegistrationTokens(resourceGroupName: string, hostPoolName: string, options?: HostPoolsListRegistrationTokensOptionalParams): Promise<RegistrationTokenList>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- hostPoolName
-
string
指定資源群組內的主機集區名稱
選項參數。
傳回
Promise<RegistrationTokenList>
retrieveRegistrationToken(string, string, HostPoolsRetrieveRegistrationTokenOptionalParams)
主機集區的註冊令牌。
function retrieveRegistrationToken(resourceGroupName: string, hostPoolName: string, options?: HostPoolsRetrieveRegistrationTokenOptionalParams): Promise<RegistrationInfo>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- hostPoolName
-
string
指定資源群組內的主機集區名稱
選項參數。
傳回
Promise<RegistrationInfo>
update(string, string, HostPoolsUpdateOptionalParams)
更新主機集區。
function update(resourceGroupName: string, hostPoolName: string, options?: HostPoolsUpdateOptionalParams): Promise<HostPool>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- hostPoolName
-
string
指定資源群組內的主機集區名稱
- options
- HostPoolsUpdateOptionalParams
選項參數。
傳回
Promise<HostPool>