ProximityPlacementGroups interface

Package:

@azure/arm-compute

Interface representing a ProximityPlacementGroups.

Methods

createOrUpdate(string, string, ProximityPlacementGroup, ProximityPlacementGroupsCreateOrUpdateOptionalParams)	Create or update a proximity placement group.
delete(string, string, ProximityPlacementGroupsDeleteOptionalParams)	Delete a proximity placement group.
get(string, string, ProximityPlacementGroupsGetOptionalParams)	Retrieves information about a proximity placement group .
listByResourceGroup(string, ProximityPlacementGroupsListByResourceGroupOptionalParams)	Lists all proximity placement groups in a resource group.
listBySubscription(ProximityPlacementGroupsListBySubscriptionOptionalParams)	Lists all proximity placement groups in a subscription.
update(string, string, ProximityPlacementGroupUpdate, ProximityPlacementGroupsUpdateOptionalParams)	Update a proximity placement group.

Method Details

createOrUpdate(string, string, ProximityPlacementGroup, ProximityPlacementGroupsCreateOrUpdateOptionalParams)

Create or update a proximity placement group.

function createOrUpdate(resourceGroupName: string, proximityPlacementGroupName: string, parameters: ProximityPlacementGroup, options?: ProximityPlacementGroupsCreateOrUpdateOptionalParams): Promise<ProximityPlacementGroup>

Parameters

resourceGroupName

string

The name of the resource group.

proximityPlacementGroupName

string

The name of the proximity placement group.

parameters

ProximityPlacementGroup

Parameters supplied to the Create Proximity Placement Group operation.

options

ProximityPlacementGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ProximityPlacementGroup>

delete(string, string, ProximityPlacementGroupsDeleteOptionalParams)

Delete a proximity placement group.

function delete(resourceGroupName: string, proximityPlacementGroupName: string, options?: ProximityPlacementGroupsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

proximityPlacementGroupName

string

The name of the proximity placement group.

options

ProximityPlacementGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ProximityPlacementGroupsGetOptionalParams)

Retrieves information about a proximity placement group .

function get(resourceGroupName: string, proximityPlacementGroupName: string, options?: ProximityPlacementGroupsGetOptionalParams): Promise<ProximityPlacementGroup>

Parameters

resourceGroupName

string

The name of the resource group.

proximityPlacementGroupName

string

The name of the proximity placement group.

options

ProximityPlacementGroupsGetOptionalParams

The options parameters.

Returns

Promise<ProximityPlacementGroup>

listByResourceGroup(string, ProximityPlacementGroupsListByResourceGroupOptionalParams)

Lists all proximity placement groups in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: ProximityPlacementGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProximityPlacementGroup, ProximityPlacementGroup[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

ProximityPlacementGroupsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProximityPlacementGroup, ProximityPlacementGroup[], PageSettings>

listBySubscription(ProximityPlacementGroupsListBySubscriptionOptionalParams)

Lists all proximity placement groups in a subscription.

function listBySubscription(options?: ProximityPlacementGroupsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProximityPlacementGroup, ProximityPlacementGroup[], PageSettings>

Parameters

options

ProximityPlacementGroupsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProximityPlacementGroup, ProximityPlacementGroup[], PageSettings>

update(string, string, ProximityPlacementGroupUpdate, ProximityPlacementGroupsUpdateOptionalParams)

Update a proximity placement group.

function update(resourceGroupName: string, proximityPlacementGroupName: string, parameters: ProximityPlacementGroupUpdate, options?: ProximityPlacementGroupsUpdateOptionalParams): Promise<ProximityPlacementGroup>

Parameters

resourceGroupName

string

The name of the resource group.

proximityPlacementGroupName

string

The name of the proximity placement group.

parameters

ProximityPlacementGroupUpdate

Parameters supplied to the Update Proximity Placement Group operation.

options

ProximityPlacementGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<ProximityPlacementGroup>