Package version:

Interface ProximityPlacementGroups

Interface representing a ProximityPlacementGroups.

interface ProximityPlacementGroups {
    createOrUpdate(resourceGroupName: string, proximityPlacementGroupName: string, parameters: ProximityPlacementGroup, options?: ProximityPlacementGroupsCreateOrUpdateOptionalParams): Promise<ProximityPlacementGroup>;
    delete(resourceGroupName: string, proximityPlacementGroupName: string, options?: ProximityPlacementGroupsDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, proximityPlacementGroupName: string, options?: ProximityPlacementGroupsGetOptionalParams): Promise<ProximityPlacementGroup>;
    listByResourceGroup(resourceGroupName: string, options?: ProximityPlacementGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProximityPlacementGroup>;
    listBySubscription(options?: ProximityPlacementGroupsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProximityPlacementGroup>;
    update(resourceGroupName: string, proximityPlacementGroupName: string, parameters: ProximityPlacementGroupUpdate, options?: ProximityPlacementGroupsUpdateOptionalParams): Promise<ProximityPlacementGroup>;
}

Methods

createOrUpdate(resourceGroupName, proximityPlacementGroupName, parameters, options?): Promise<ProximityPlacementGroup>
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.
- Optionaloptions: ProximityPlacementGroupsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<ProximityPlacementGroup>
- Defined in operationsInterfaces/proximityPlacementGroups.ts:50

get(resourceGroupName, proximityPlacementGroupName, options?): Promise<ProximityPlacementGroup>
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.
- Optionaloptions: ProximityPlacementGroupsGetOptionalParams
  The options parameters.
Returns Promise<ProximityPlacementGroup>
- Defined in operationsInterfaces/proximityPlacementGroups.ts:86

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<ProximityPlacementGroup>
Lists all proximity placement groups in a resource group.
Parameters
- resourceGroupName: string
  The name of the resource group.
- Optionaloptions: ProximityPlacementGroupsListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ProximityPlacementGroup>
- Defined in operationsInterfaces/proximityPlacementGroups.ts:39

listBySubscription(options?): PagedAsyncIterableIterator<ProximityPlacementGroup>
Lists all proximity placement groups in a subscription.
Parameters
- Optionaloptions: ProximityPlacementGroupsListBySubscriptionOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ProximityPlacementGroup>
- Defined in operationsInterfaces/proximityPlacementGroups.ts:31

update(resourceGroupName, proximityPlacementGroupName, parameters, options?): Promise<ProximityPlacementGroup>
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.
- Optionaloptions: ProximityPlacementGroupsUpdateOptionalParams
  The options parameters.
Returns Promise<ProximityPlacementGroup>
- Defined in operationsInterfaces/proximityPlacementGroups.ts:63