Share via

ProximityPlacementGroupsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ComputeManagementClient's

<xref:proximity_placement_groups> attribute.

Inheritance
builtins.object
ProximityPlacementGroupsOperations

Constructor

ProximityPlacementGroupsOperations(*args, **kwargs)

Methods

create_or_update

Create or update a proximity placement group.
delete

Delete a proximity placement group.
get

Retrieves information about a proximity placement group .
list_by_resource_group

Lists all proximity placement groups in a resource group.
list_by_subscription

Lists all proximity placement groups in a subscription.
update

Update a proximity placement group.

create_or_update

Create or update a proximity placement group.

create_or_update(resource_group_name: str, proximity_placement_group_name: str, parameters: _models.ProximityPlacementGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ProximityPlacementGroup

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
proximity_placement_group_name
Required
str

The name of the proximity placement group. Required.
parameters
Required
ProximityPlacementGroup or IO[bytes]

Parameters supplied to the Create Proximity Placement Group operation. Is either a ProximityPlacementGroup type or a IO[bytes] type. Required.

Returns

Type Description
ProximityPlacementGroup

ProximityPlacementGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Delete a proximity placement group.

delete(resource_group_name: str, proximity_placement_group_name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
proximity_placement_group_name
Required
str

The name of the proximity placement group. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Retrieves information about a proximity placement group .

get(resource_group_name: str, proximity_placement_group_name: str, **kwargs: Any) -> ProximityPlacementGroup

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
proximity_placement_group_name
Required
str

The name of the proximity placement group. Required.

Returns

Type Description
ProximityPlacementGroup

ProximityPlacementGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Lists all proximity placement groups in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[ProximityPlacementGroup]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description
ItemPaged[ProximityPlacementGroup]

An iterator like instance of either ProximityPlacementGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_subscription

Lists all proximity placement groups in a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[ProximityPlacementGroup]

Returns

Type Description
ItemPaged[ProximityPlacementGroup]

An iterator like instance of either ProximityPlacementGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update

Update a proximity placement group.

update(resource_group_name: str, proximity_placement_group_name: str, parameters: _models.ProximityPlacementGroupUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ProximityPlacementGroup

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
proximity_placement_group_name
Required
str

The name of the proximity placement group. Required.
parameters
Required
ProximityPlacementGroupUpdate or IO[bytes]

Parameters supplied to the Update Proximity Placement Group operation. Is either a ProximityPlacementGroupUpdate type or a IO[bytes] type. Required.

Returns

Type Description
ProximityPlacementGroup

ProximityPlacementGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.compute.v2018_10_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2018_10_01\\models\\__init__.py'>