ProximityPlacementGroupsOperations Class

ProximityPlacementGroupsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
ProximityPlacementGroupsOperations

Constructor

ProximityPlacementGroupsOperations(client, config, serializer, deserializer) -> None

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.compute.v2019_12_01.models._models_py3.ProximityPlacementGroup, **kwargs: typing.Any) -> azure.mgmt.compute.v2019_12_01.models._models_py3.ProximityPlacementGroup

Parameters

resource_group_name
str
Required

The name of the resource group.

proximity_placement_group_name
str
Required

The name of the proximity placement group.

parameters
ProximityPlacementGroup
Required

Parameters supplied to the Create Proximity Placement Group operation.

cls
callable

A custom type or function that will be passed the direct response

Returns

ProximityPlacementGroup, or the result of cls(response)

Return type

delete

Delete a proximity placement group.

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

Parameters

resource_group_name
str
Required

The name of the resource group.

proximity_placement_group_name
str
Required

The name of the proximity placement group.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

get

Retrieves information about a proximity placement group .

get(resource_group_name: str, proximity_placement_group_name: str, include_colocation_status: typing.Union[str, NoneType] = None, **kwargs: typing.Any) -> azure.mgmt.compute.v2019_12_01.models._models_py3.ProximityPlacementGroup

Parameters

resource_group_name
str
Required

The name of the resource group.

proximity_placement_group_name
str
Required

The name of the proximity placement group.

include_colocation_status
str
default value: None

includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.

cls
callable

A custom type or function that will be passed the direct response

Returns

ProximityPlacementGroup, or the result of cls(response)

Return type

list_by_resource_group

Lists all proximity placement groups in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.ProximityPlacementGroupListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

list_by_subscription

Lists all proximity placement groups in a subscription.

list_by_subscription(**kwargs: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.ProximityPlacementGroupListResult')]

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

update

Update a proximity placement group.

update(resource_group_name: str, proximity_placement_group_name: str, parameters: azure.mgmt.compute.v2019_12_01.models._models_py3.ProximityPlacementGroupUpdate, **kwargs: typing.Any) -> azure.mgmt.compute.v2019_12_01.models._models_py3.ProximityPlacementGroup

Parameters

resource_group_name
str
Required

The name of the resource group.

proximity_placement_group_name
str
Required

The name of the proximity placement group.

parameters
ProximityPlacementGroupUpdate
Required

Parameters supplied to the Update Proximity Placement Group operation.

cls
callable

A custom type or function that will be passed the direct response

Returns

ProximityPlacementGroup, or the result of cls(response)

Return type

Attributes

models

models = <module 'azure.mgmt.compute.v2019_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\compute\\v2019_12_01\\models\\__init__.py'>