ProximityPlacementGroupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:proximity_placement_groups> attribute.

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. The name is case insensitive. Required.
proximity_placement_group_name Required	str The name of the proximity placement group. Required.
parameters Required	ProximityPlacementGroup or <xref:JSON> or IO[bytes] Parameters supplied to the Create Proximity Placement Group operation. Is one of the following types: ProximityPlacementGroup, JSON, IO[bytes] Required.

Returns

Type	Description
ProximityPlacementGroup	ProximityPlacementGroup. The ProximityPlacementGroup is compatible with MutableMapping

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. The name is case insensitive. Required.
proximity_placement_group_name Required	str The name of the proximity placement group. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

Retrieves information about a proximity placement group .

get(resource_group_name: str, proximity_placement_group_name: str, *, include_colocation_status: str | None = None, **kwargs: Any) -> ProximityPlacementGroup

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
proximity_placement_group_name Required	str The name of the proximity placement group. Required.

Keyword-Only Parameters

Name	Description
include_colocation_status	str includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group. Default value is None. Default value: None

Returns

Type	Description
ProximityPlacementGroup	ProximityPlacementGroup. The ProximityPlacementGroup is compatible with MutableMapping

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) -> ItemPaged[ProximityPlacementGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[ProximityPlacementGroup]	An iterator like instance of ProximityPlacementGroup

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Lists all proximity placement groups in a subscription.

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

Returns

Type	Description
ItemPaged[ProximityPlacementGroup]	An iterator like instance of ProximityPlacementGroup

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. The name is case insensitive. Required.
proximity_placement_group_name Required	str The name of the proximity placement group. Required.
parameters Required	ProximityPlacementGroupUpdate or <xref:JSON> or IO[bytes] Parameters supplied to the Update Proximity Placement Group operation. Is one of the following types: ProximityPlacementGroupUpdate, JSON, IO[bytes] Required.

Returns

Type	Description
ProximityPlacementGroup	ProximityPlacementGroup. The ProximityPlacementGroup is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Commenti e suggerimenti

Questa pagina è stata utile?