HostPools interface
HostPools を表すインターフェイス。
メソッド
| create |
ホスト プールを作成または更新します。 |
| delete(string, string, Host |
ホスト プールを削除します。 |
| get(string, string, Host |
ホスト プールを取得します。 |
| list(Host |
サブスクリプション内の hostPools を一覧表示します。 |
| list |
hostPools を一覧表示します。 |
| list |
HostPool に関連付けられている RegistrationTokens を一覧表示する操作 |
| retrieve |
ホスト プールの登録トークン。 |
| update(string, string, Host |
ホスト プールを更新します。 |
メソッドの詳細
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>