-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.mgmt.compute.v2023_03_01.operations.CapacityReservationsOperations.yml
205 lines (194 loc) · 8.15 KB
/
azure.mgmt.compute.v2023_03_01.operations.CapacityReservationsOperations.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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_03_01.operations.CapacityReservationsOperations
name: CapacityReservationsOperations
fullName: azure.mgmt.compute.v2023_03_01.operations.CapacityReservationsOperations
module: azure.mgmt.compute.v2023_03_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.v2023_03_01.ComputeManagementClient>'s\n\
>\n> <xref:capacity_reservations> attribute.\n>"
constructor:
syntax: CapacityReservationsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2023_03_01.operations.CapacityReservationsOperations.begin_create_or_update
name: begin_create_or_update
summary: 'The operation to create or update a capacity reservation. Please note
some properties can be
set only during capacity reservation creation. Please refer to
[https://aka.ms/CapacityReservation](https://aka.ms/CapacityReservation) for more
details.'
signature: 'begin_create_or_update(resource_group_name: str, capacity_reservation_group_name:
str, capacity_reservation_name: str, parameters: _models.CapacityReservation,
*, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.CapacityReservation]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: capacity_reservation_group_name
description: The name of the capacity reservation group. Required.
isRequired: true
types:
- <xref:str>
- name: capacity_reservation_name
description: The name of the capacity reservation. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters supplied to the Create capacity reservation. Is either
a
CapacityReservation type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.CapacityReservation>
- <xref:typing.IO>[<xref:bytes>]
return:
description: 'An instance of LROPoller that returns either CapacityReservation
or the result of
cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2023_03_01.models.CapacityReservation>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_03_01.operations.CapacityReservationsOperations.begin_delete
name: begin_delete
summary: 'The operation to delete a capacity reservation. This operation is allowed
only when all the
associated resources are disassociated from the capacity reservation. Please refer
to
[https://aka.ms/CapacityReservation](https://aka.ms/CapacityReservation) for more
details.'
signature: 'begin_delete(resource_group_name: str, capacity_reservation_group_name:
str, capacity_reservation_name: str, **kwargs: Any) -> LROPoller[None]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: capacity_reservation_group_name
description: The name of the capacity reservation group. Required.
isRequired: true
types:
- <xref:str>
- name: capacity_reservation_name
description: The name of the capacity reservation. Required.
isRequired: true
types:
- <xref:str>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_03_01.operations.CapacityReservationsOperations.begin_update
name: begin_update
summary: The operation to update a capacity reservation.
signature: 'begin_update(resource_group_name: str, capacity_reservation_group_name:
str, capacity_reservation_name: str, parameters: _models.CapacityReservationUpdate,
*, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.CapacityReservation]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: capacity_reservation_group_name
description: The name of the capacity reservation group. Required.
isRequired: true
types:
- <xref:str>
- name: capacity_reservation_name
description: The name of the capacity reservation. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters supplied to the Update capacity reservation operation.
Is either
a CapacityReservationUpdate type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.CapacityReservationUpdate>
- <xref:typing.IO>[<xref:bytes>]
return:
description: 'An instance of LROPoller that returns either CapacityReservation
or the result of
cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2023_03_01.models.CapacityReservation>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_03_01.operations.CapacityReservationsOperations.get
name: get
summary: The operation that retrieves information about the capacity reservation.
signature: 'get(resource_group_name: str, capacity_reservation_group_name: str,
capacity_reservation_name: str, *, expand: str | CapacityReservationInstanceViewTypes
| None = None, **kwargs: Any) -> CapacityReservation'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: capacity_reservation_group_name
description: The name of the capacity reservation group. Required.
isRequired: true
types:
- <xref:str>
- name: capacity_reservation_name
description: The name of the capacity reservation. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: expand
description: 'The expand expression to apply on the operation. ''InstanceView''
retrieves a
snapshot of the runtime properties of the capacity reservation that is managed
by the platform
and can change outside of control plane operations. "instanceView" Default value
is None.'
types:
- <xref:str>
- <xref:azure.mgmt.compute.v2023_03_01.models.CapacityReservationInstanceViewTypes>
return:
description: CapacityReservation or the result of cls(response)
types:
- <xref:azure.mgmt.compute.v2023_03_01.models.CapacityReservation>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_03_01.operations.CapacityReservationsOperations.list_by_capacity_reservation_group
name: list_by_capacity_reservation_group
summary: 'Lists all of the capacity reservations in the specified capacity reservation
group. Use the
nextLink property in the response to get the next page of capacity reservations.'
signature: 'list_by_capacity_reservation_group(resource_group_name: str, capacity_reservation_group_name:
str, **kwargs: Any) -> Iterable[CapacityReservation]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: capacity_reservation_group_name
description: The name of the capacity reservation group. Required.
isRequired: true
types:
- <xref:str>
return:
description: An iterator like instance of either CapacityReservation or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2023_03_01.models.CapacityReservation>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2023_03_01.operations.CapacityReservationsOperations.models
name: models
signature: models = <module 'azure.mgmt.compute.v2023_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2023_03_01\\models\\__init__.py'>