ProximityPlacementGroups | @azure/arm-compute

Interface representing a ProximityPlacementGroups.

Hierarchy

ProximityPlacementGroups

Implemented by

ProximityPlacementGroupsImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/proximityPlacementGroups.ts:51
Create or update a proximity placement group.

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

delete

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

- Defined in operationsInterfaces/proximityPlacementGroups.ts:76
Delete a proximity placement group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- proximityPlacementGroupName: string
  
  The name of the proximity placement group.
- Optional options: ProximityPlacementGroupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/proximityPlacementGroups.ts:87
Retrieves information about a proximity placement group .

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- proximityPlacementGroupName: string
  
  The name of the proximity placement group.
- Optional options: ProximityPlacementGroupsGetOptionalParams
  
  The options parameters.
Returns Promise<ProximityPlacementGroupsGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ProximityPlacementGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProximityPlacementGroup>

- Defined in operationsInterfaces/proximityPlacementGroups.ts:40
Lists all proximity placement groups in a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: ProximityPlacementGroupsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ProximityPlacementGroup>

listBySubscription

listBySubscription(options?: ProximityPlacementGroupsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProximityPlacementGroup>

- Defined in operationsInterfaces/proximityPlacementGroups.ts:32
Lists all proximity placement groups in a subscription.

Parameters
- Optional options: ProximityPlacementGroupsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ProximityPlacementGroup>

update

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

- Defined in operationsInterfaces/proximityPlacementGroups.ts:64
Update a proximity placement group.

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

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

proximityPlacementGroupName: string

parameters: ProximityPlacementGroup

Optional options: ProximityPlacementGroupsCreateOrUpdateOptionalParams

Returns Promise<ProximityPlacementGroupsCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

proximityPlacementGroupName: string

Optional options: ProximityPlacementGroupsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

proximityPlacementGroupName: string

Optional options: ProximityPlacementGroupsGetOptionalParams

Returns Promise<ProximityPlacementGroupsGetResponse>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: ProximityPlacementGroupsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<ProximityPlacementGroup>

listBySubscription

Parameters

Optional options: ProximityPlacementGroupsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<ProximityPlacementGroup>

update

Parameters

resourceGroupName: string

proximityPlacementGroupName: string

parameters: ProximityPlacementGroupUpdate

Optional options: ProximityPlacementGroupsUpdateOptionalParams

Returns Promise<ProximityPlacementGroupsUpdateResponse>