DedicatedHosts interface

Package:

@azure/arm-compute

Interface representing a DedicatedHosts.

Methods

beginCreateOrUpdate(string, string, string, DedicatedHost, DedicatedHostsCreateOrUpdateOptionalParams)	Create or update a dedicated host .
beginCreateOrUpdateAndWait(string, string, string, DedicatedHost, DedicatedHostsCreateOrUpdateOptionalParams)	Create or update a dedicated host .
beginDelete(string, string, string, DedicatedHostsDeleteOptionalParams)	Delete a dedicated host.
beginDeleteAndWait(string, string, string, DedicatedHostsDeleteOptionalParams)	Delete a dedicated host.
beginRedeploy(string, string, string, DedicatedHostsRedeployOptionalParams)	Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.
beginRedeployAndWait(string, string, string, DedicatedHostsRedeployOptionalParams)	Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.
beginRestart(string, string, string, DedicatedHostsRestartOptionalParams)	Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.
beginRestartAndWait(string, string, string, DedicatedHostsRestartOptionalParams)	Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.
beginUpdate(string, string, string, DedicatedHostUpdate, DedicatedHostsUpdateOptionalParams)	Update a dedicated host .
beginUpdateAndWait(string, string, string, DedicatedHostUpdate, DedicatedHostsUpdateOptionalParams)	Update a dedicated host .
get(string, string, string, DedicatedHostsGetOptionalParams)	Retrieves information about a dedicated host.
listAvailableSizes(string, string, string, DedicatedHostsListAvailableSizesOptionalParams)	Lists all available dedicated host sizes to which the specified dedicated host can be resized. NOTE: The dedicated host sizes provided can be used to only scale up the existing dedicated host.
listByHostGroup(string, string, DedicatedHostsListByHostGroupOptionalParams)	Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.

Method Details

beginCreateOrUpdate(string, string, string, DedicatedHost, DedicatedHostsCreateOrUpdateOptionalParams)

Create or update a dedicated host .

function beginCreateOrUpdate(resourceGroupName: string, hostGroupName: string, hostName: string, parameters: DedicatedHost, options?: DedicatedHostsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DedicatedHost>, DedicatedHost>>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host .

parameters

DedicatedHost

Parameters supplied to the Create Dedicated Host.

options

DedicatedHostsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<DedicatedHost>, DedicatedHost>>

beginCreateOrUpdateAndWait(string, string, string, DedicatedHost, DedicatedHostsCreateOrUpdateOptionalParams)

Create or update a dedicated host .

function beginCreateOrUpdateAndWait(resourceGroupName: string, hostGroupName: string, hostName: string, parameters: DedicatedHost, options?: DedicatedHostsCreateOrUpdateOptionalParams): Promise<DedicatedHost>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host .

parameters

DedicatedHost

Parameters supplied to the Create Dedicated Host.

options

DedicatedHostsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DedicatedHost>

beginDelete(string, string, string, DedicatedHostsDeleteOptionalParams)

Delete a dedicated host.

function beginDelete(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options

DedicatedHostsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, DedicatedHostsDeleteOptionalParams)

Delete a dedicated host.

function beginDeleteAndWait(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options

DedicatedHostsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRedeploy(string, string, string, DedicatedHostsRedeployOptionalParams)

Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.

function beginRedeploy(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsRedeployOptionalParams): Promise<SimplePollerLike<OperationState<DedicatedHostsRedeployHeaders>, DedicatedHostsRedeployHeaders>>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options

DedicatedHostsRedeployOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<DedicatedHostsRedeployHeaders>, DedicatedHostsRedeployHeaders>>

beginRedeployAndWait(string, string, string, DedicatedHostsRedeployOptionalParams)

Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.

function beginRedeployAndWait(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsRedeployOptionalParams): Promise<DedicatedHostsRedeployHeaders>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options

DedicatedHostsRedeployOptionalParams

The options parameters.

Returns

Promise<DedicatedHostsRedeployHeaders>

beginRestart(string, string, string, DedicatedHostsRestartOptionalParams)

Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.

function beginRestart(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options

DedicatedHostsRestartOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait(string, string, string, DedicatedHostsRestartOptionalParams)

Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.

function beginRestartAndWait(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsRestartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options

DedicatedHostsRestartOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, DedicatedHostUpdate, DedicatedHostsUpdateOptionalParams)

Update a dedicated host .

function beginUpdate(resourceGroupName: string, hostGroupName: string, hostName: string, parameters: DedicatedHostUpdate, options?: DedicatedHostsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DedicatedHost>, DedicatedHost>>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host .

parameters

DedicatedHostUpdate

Parameters supplied to the Update Dedicated Host operation.

options

DedicatedHostsUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<DedicatedHost>, DedicatedHost>>

beginUpdateAndWait(string, string, string, DedicatedHostUpdate, DedicatedHostsUpdateOptionalParams)

Update a dedicated host .

function beginUpdateAndWait(resourceGroupName: string, hostGroupName: string, hostName: string, parameters: DedicatedHostUpdate, options?: DedicatedHostsUpdateOptionalParams): Promise<DedicatedHost>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host .

parameters

DedicatedHostUpdate

Parameters supplied to the Update Dedicated Host operation.

options

DedicatedHostsUpdateOptionalParams

The options parameters.

Returns

Promise<DedicatedHost>

get(string, string, string, DedicatedHostsGetOptionalParams)

Retrieves information about a dedicated host.

function get(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsGetOptionalParams): Promise<DedicatedHost>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options

DedicatedHostsGetOptionalParams

The options parameters.

Returns

Promise<DedicatedHost>

listAvailableSizes(string, string, string, DedicatedHostsListAvailableSizesOptionalParams)

Lists all available dedicated host sizes to which the specified dedicated host can be resized. NOTE: The dedicated host sizes provided can be used to only scale up the existing dedicated host.

function listAvailableSizes(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsListAvailableSizesOptionalParams): PagedAsyncIterableIterator<string, string[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

hostName

string

The name of the dedicated host.

options

DedicatedHostsListAvailableSizesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<string, string[], PageSettings>

listByHostGroup(string, string, DedicatedHostsListByHostGroupOptionalParams)

Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.

function listByHostGroup(resourceGroupName: string, hostGroupName: string, options?: DedicatedHostsListByHostGroupOptionalParams): PagedAsyncIterableIterator<DedicatedHost, DedicatedHost[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

hostGroupName

string

The name of the dedicated host group.

options

DedicatedHostsListByHostGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DedicatedHost, DedicatedHost[], PageSettings>