azure.mgmt.compute.v2022_11_01.operations.ProximityPlacementGroupsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2022_11_01.operations.ProximityPlacementGroupsOperations
name: ProximityPlacementGroupsOperations
fullName: azure.mgmt.compute.v2022_11_01.operations.ProximityPlacementGroupsOperations
module: azure.mgmt.compute.v2022_11_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.compute.v2022_11_01.ComputeManagementClient>'s\n\
  >\n> <xref:proximity_placement_groups> attribute.\n>"
constructor:
  syntax: ProximityPlacementGroupsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2022_11_01.operations.ProximityPlacementGroupsOperations.create_or_update
  name: create_or_update
  summary: Create or update a proximity placement group.
  signature: '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: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: proximity_placement_group_name
    description: The name of the proximity placement group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the Create Proximity Placement Group operation.
      Is

      either a ProximityPlacementGroup type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2022_11_01.models.ProximityPlacementGroup>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: ProximityPlacementGroup or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2022_11_01.models.ProximityPlacementGroup>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_11_01.operations.ProximityPlacementGroupsOperations.delete
  name: delete
  summary: Delete a proximity placement group.
  signature: 'delete(resource_group_name: str, proximity_placement_group_name: str,
    **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: proximity_placement_group_name
    description: The name of the proximity placement group. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_11_01.operations.ProximityPlacementGroupsOperations.get
  name: get
  summary: Retrieves information about a proximity placement group .
  signature: 'get(resource_group_name: str, proximity_placement_group_name: str, *,
    include_colocation_status: str | None = None, **kwargs: Any) -> ProximityPlacementGroup'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: proximity_placement_group_name
    description: The name of the proximity placement group. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: include_colocation_status
    description: 'includeColocationStatus=true enables fetching the

      colocation status of all the resources in the proximity placement group. Default
      value is None.'
    types:
    - <xref:str>
  return:
    description: ProximityPlacementGroup or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2022_11_01.models.ProximityPlacementGroup>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_11_01.operations.ProximityPlacementGroupsOperations.list_by_resource_group
  name: list_by_resource_group
  summary: Lists all proximity placement groups in a resource group.
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[ProximityPlacementGroup]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: 'An iterator like instance of either ProximityPlacementGroup or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2022_11_01.models.ProximityPlacementGroup>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_11_01.operations.ProximityPlacementGroupsOperations.list_by_subscription
  name: list_by_subscription
  summary: Lists all proximity placement groups in a subscription.
  signature: 'list_by_subscription(**kwargs: Any) -> Iterable[ProximityPlacementGroup]'
  return:
    description: 'An iterator like instance of either ProximityPlacementGroup or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2022_11_01.models.ProximityPlacementGroup>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_11_01.operations.ProximityPlacementGroupsOperations.update
  name: update
  summary: Update a proximity placement group.
  signature: 'update(resource_group_name: str, proximity_placement_group_name: str,
    parameters: _models.ProximityPlacementGroupUpdate, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.ProximityPlacementGroup'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: proximity_placement_group_name
    description: The name of the proximity placement group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the Update Proximity Placement Group operation.
      Is

      either a ProximityPlacementGroupUpdate type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2022_11_01.models.ProximityPlacementGroupUpdate>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: ProximityPlacementGroup or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2022_11_01.models.ProximityPlacementGroup>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2022_11_01.operations.ProximityPlacementGroupsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.compute.v2022_11_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2022_11_01\\models\\__init__.py'>