-
Notifications
You must be signed in to change notification settings - Fork 244
/
azure.mgmt.compute.v2020_12_01.operations.ProximityPlacementGroupsOperations.yml
165 lines (160 loc) · 6.72 KB
/
azure.mgmt.compute.v2020_12_01.operations.ProximityPlacementGroupsOperations.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
### YamlMime:PythonClass
uid: azure.mgmt.compute.v2020_12_01.operations.ProximityPlacementGroupsOperations
name: ProximityPlacementGroupsOperations
fullName: azure.mgmt.compute.v2020_12_01.operations.ProximityPlacementGroupsOperations
module: azure.mgmt.compute.v2020_12_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.v2020_12_01.ComputeManagementClient>'s\n\
>\n> <xref:proximity_placement_groups> attribute.\n>"
constructor:
syntax: ProximityPlacementGroupsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2020_12_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.v2020_12_01.models.ProximityPlacementGroup>
- <xref:typing.IO>[<xref:bytes>]
return:
description: ProximityPlacementGroup or the result of cls(response)
types:
- <xref:azure.mgmt.compute.v2020_12_01.models.ProximityPlacementGroup>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_12_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.v2020_12_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.v2020_12_01.models.ProximityPlacementGroup>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_12_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.v2020_12_01.models.ProximityPlacementGroup>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_12_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.v2020_12_01.models.ProximityPlacementGroup>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_12_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.v2020_12_01.models.ProximityPlacementGroupUpdate>
- <xref:typing.IO>[<xref:bytes>]
return:
description: ProximityPlacementGroup or the result of cls(response)
types:
- <xref:azure.mgmt.compute.v2020_12_01.models.ProximityPlacementGroup>
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2020_12_01.operations.ProximityPlacementGroupsOperations.models
name: models
signature: models = <module 'azure.mgmt.compute.v2020_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2020_12_01\\models\\__init__.py'>