DedicatedHostsImpl | @azure/arm-compute

Class containing DedicatedHosts operations.

Hierarchy

DedicatedHostsImpl

Implements

DedicatedHosts

Index

Constructors

constructor

Methods

Constructors

constructor

new DedicatedHostsImpl(client: ComputeManagementClientContext): DedicatedHostsImpl

- Defined in operations/dedicatedHosts.ts:37
Initialize a new instance of the class DedicatedHosts class.

Parameters
- client: ComputeManagementClientContext
  
  Reference to the service client
Returns DedicatedHostsImpl

Methods

beginCreateOrUpdate

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

Implementation of DedicatedHosts.beginCreateOrUpdate
- Defined in operations/dedicatedHosts.ts:127
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>

Implementation of DedicatedHosts.beginCreateOrUpdateAndWait
- Defined in operations/dedicatedHosts.ts:197
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>>

Implementation of DedicatedHosts.beginDelete
- Defined in operations/dedicatedHosts.ts:316
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>

Implementation of DedicatedHosts.beginDeleteAndWait
- Defined in operations/dedicatedHosts.ts:379
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>>

Implementation of DedicatedHosts.beginUpdate
- Defined in operations/dedicatedHosts.ts:222
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>

Implementation of DedicatedHosts.beginUpdateAndWait
- Defined in operations/dedicatedHosts.ts:292
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>

Implementation of DedicatedHosts.get
- Defined in operations/dedicatedHosts.ts:401
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>

Implementation of DedicatedHosts.listByHostGroup
- Defined in operations/dedicatedHosts.ts:54
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

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ComputeManagementClientContext

Returns DedicatedHostsImpl

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>