DedicatedHosts | @azure/arm-compute

Interface representing a DedicatedHosts.

Hierarchy

DedicatedHosts

Implemented by

DedicatedHostsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, hostGroupName: string, hostName: string, parameters: DedicatedHost, options?: DedicatedHostsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DedicatedHostsCreateOrUpdateResponse>, DedicatedHostsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/dedicatedHosts.ts:48
Create or update a dedicated host .

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.
- Optional options: DedicatedHostsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DedicatedHostsCreateOrUpdateResponse>, DedicatedHostsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/dedicatedHosts.ts:68
Create or update a dedicated host .

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.
- Optional options: DedicatedHostsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<DedicatedHostsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, hostGroupName: string, hostName: string, options?: DedicatedHostsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/dedicatedHosts.ts:117
Delete a dedicated host.

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.
- Optional options: DedicatedHostsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/dedicatedHosts.ts:130
Delete a dedicated host.

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.
- Optional options: DedicatedHostsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, hostGroupName: string, hostName: string, parameters: DedicatedHostUpdate, options?: DedicatedHostsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DedicatedHostsUpdateResponse>, DedicatedHostsUpdateResponse>>

- Defined in operationsInterfaces/dedicatedHosts.ts:83
Update an dedicated host .

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.
- Optional options: DedicatedHostsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DedicatedHostsUpdateResponse>, DedicatedHostsUpdateResponse>>

beginUpdateAndWait

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

- Defined in operationsInterfaces/dedicatedHosts.ts:103
Update an dedicated host .

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.
- Optional options: DedicatedHostsUpdateOptionalParams
  
  The options parameters.
Returns Promise<DedicatedHostsUpdateResponse>

get

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

- Defined in operationsInterfaces/dedicatedHosts.ts:143
Retrieves information about a dedicated host.

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.
- Optional options: DedicatedHostsGetOptionalParams
  
  The options parameters.
Returns Promise<DedicatedHostsGetResponse>

listByHostGroup

listByHostGroup(resourceGroupName: string, hostGroupName: string, options?: DedicatedHostsListByHostGroupOptionalParams): PagedAsyncIterableIterator<DedicatedHost>

- Defined in operationsInterfaces/dedicatedHosts.ts:35
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hostGroupName: string
  
  The name of the dedicated host group.
- Optional options: DedicatedHostsListByHostGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DedicatedHost>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

hostGroupName: string

hostName: string

parameters: DedicatedHost

Optional options: DedicatedHostsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DedicatedHostsCreateOrUpdateResponse>, DedicatedHostsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

hostGroupName: string

hostName: string

parameters: DedicatedHost

Optional options: DedicatedHostsCreateOrUpdateOptionalParams

Returns Promise<DedicatedHostsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

hostGroupName: string

hostName: string

Optional options: DedicatedHostsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

hostGroupName: string

hostName: string

Optional options: DedicatedHostsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

hostGroupName: string

hostName: string

parameters: DedicatedHostUpdate

Optional options: DedicatedHostsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DedicatedHostsUpdateResponse>, DedicatedHostsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

hostGroupName: string

hostName: string

parameters: DedicatedHostUpdate

Optional options: DedicatedHostsUpdateOptionalParams

Returns Promise<DedicatedHostsUpdateResponse>

get

Parameters

resourceGroupName: string

hostGroupName: string

hostName: string

Optional options: DedicatedHostsGetOptionalParams

Returns Promise<DedicatedHostsGetResponse>

listByHostGroup

Parameters

resourceGroupName: string

hostGroupName: string

Optional options: DedicatedHostsListByHostGroupOptionalParams

Returns PagedAsyncIterableIterator<DedicatedHost>