ProximityPlacementGroups interface
Interface representing a ProximityPlacementGroups.
Methods
| create |
Create or update a proximity placement group. |
| delete(string, string, Proximity |
Delete a proximity placement group. |
| get(string, string, Proximity |
Retrieves information about a proximity placement group . |
| list |
Lists all proximity placement groups in a resource group. |
| list |
Lists all proximity placement groups in a subscription. |
| update(string, string, Proximity |
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. The name is case insensitive.
- proximityPlacementGroupName
-
string
The name of the proximity placement group.
- parameters
- ProximityPlacementGroup
Parameters supplied to the Create Proximity Placement Group operation.
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. The name is case insensitive.
- proximityPlacementGroupName
-
string
The name of the proximity placement group.
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. The name is case insensitive.
- proximityPlacementGroupName
-
string
The name of the proximity placement group.
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. The name is case insensitive.
The options parameters.
Returns
listBySubscription(ProximityPlacementGroupsListBySubscriptionOptionalParams)
Lists all proximity placement groups in a subscription.
function listBySubscription(options?: ProximityPlacementGroupsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProximityPlacementGroup, ProximityPlacementGroup[], PageSettings>Parameters
The options parameters.
Returns
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. The name is case insensitive.
- proximityPlacementGroupName
-
string
The name of the proximity placement group.
- parameters
- ProximityPlacementGroupUpdate
Parameters supplied to the Update Proximity Placement Group operation.
The options parameters.
Returns
Promise<ProximityPlacementGroup>