-
Notifications
You must be signed in to change notification settings - Fork 244
/
azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations.yml
245 lines (230 loc) · 9.12 KB
/
azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations.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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
### YamlMime:PythonClass
uid: azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations
name: SnapshotsOperations
fullName: azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations
module: azure.mgmt.compute.v2019_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.v2019_03_01.ComputeManagementClient>'s\n\
>\n> <xref:snapshots> attribute.\n>"
constructor:
syntax: SnapshotsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations.begin_create_or_update
name: begin_create_or_update
summary: Creates or updates a snapshot.
signature: 'begin_create_or_update(resource_group_name: str, snapshot_name: str,
snapshot: _models.Snapshot, *, content_type: str = ''application/json'', **kwargs:
Any) -> LROPoller[_models.Snapshot]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: snapshot_name
description: 'The name of the snapshot that is being created. The name can''t
be changed
after the snapshot is created. Supported characters for the name are a-z, A-Z,
0-9 and _. The
max name length is 80 characters. Required.'
isRequired: true
types:
- <xref:str>
- name: snapshot
description: 'Snapshot object supplied in the body of the Put disk operation.
Is either a
Snapshot type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2019_03_01.models.Snapshot>
- <xref:typing.IO>[<xref:bytes>]
return:
description: An instance of LROPoller that returns either Snapshot or the result
of cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2019_03_01.models.Snapshot>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations.begin_delete
name: begin_delete
summary: Deletes a snapshot.
signature: 'begin_delete(resource_group_name: str, snapshot_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: snapshot_name
description: 'The name of the snapshot that is being created. The name can''t
be changed
after the snapshot is created. Supported characters for the name are a-z, A-Z,
0-9 and _. The
max name length is 80 characters. 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.v2019_03_01.operations.SnapshotsOperations.begin_grant_access
name: begin_grant_access
summary: Grants access to a snapshot.
signature: 'begin_grant_access(resource_group_name: str, snapshot_name: str, grant_access_data:
_models.GrantAccessData, *, content_type: str = ''application/json'', **kwargs:
Any) -> LROPoller[_models.AccessUri]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: snapshot_name
description: 'The name of the snapshot that is being created. The name can''t
be changed
after the snapshot is created. Supported characters for the name are a-z, A-Z,
0-9 and _. The
max name length is 80 characters. Required.'
isRequired: true
types:
- <xref:str>
- name: grant_access_data
description: 'Access data object supplied in the body of the get snapshot access
operation. Is either a GrantAccessData type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2019_03_01.models.GrantAccessData>
- <xref:typing.IO>[<xref:bytes>]
return:
description: An instance of LROPoller that returns either AccessUri or the result
of cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2019_03_01.models.AccessUri>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations.begin_revoke_access
name: begin_revoke_access
summary: Revokes access to a snapshot.
signature: 'begin_revoke_access(resource_group_name: str, snapshot_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: snapshot_name
description: 'The name of the snapshot that is being created. The name can''t
be changed
after the snapshot is created. Supported characters for the name are a-z, A-Z,
0-9 and _. The
max name length is 80 characters. 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.v2019_03_01.operations.SnapshotsOperations.begin_update
name: begin_update
summary: Updates (patches) a snapshot.
signature: 'begin_update(resource_group_name: str, snapshot_name: str, snapshot:
_models.SnapshotUpdate, *, content_type: str = ''application/json'', **kwargs:
Any) -> LROPoller[_models.Snapshot]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: snapshot_name
description: 'The name of the snapshot that is being created. The name can''t
be changed
after the snapshot is created. Supported characters for the name are a-z, A-Z,
0-9 and _. The
max name length is 80 characters. Required.'
isRequired: true
types:
- <xref:str>
- name: snapshot
description: 'Snapshot object supplied in the body of the Patch snapshot operation.
Is
either a SnapshotUpdate type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2019_03_01.models.SnapshotUpdate>
- <xref:typing.IO>[<xref:bytes>]
return:
description: An instance of LROPoller that returns either Snapshot or the result
of cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2019_03_01.models.Snapshot>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations.get
name: get
summary: Gets information about a snapshot.
signature: 'get(resource_group_name: str, snapshot_name: str, **kwargs: Any) ->
Snapshot'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: snapshot_name
description: 'The name of the snapshot that is being created. The name can''t
be changed
after the snapshot is created. Supported characters for the name are a-z, A-Z,
0-9 and _. The
max name length is 80 characters. Required.'
isRequired: true
types:
- <xref:str>
return:
description: Snapshot or the result of cls(response)
types:
- <xref:azure.mgmt.compute.v2019_03_01.models.Snapshot>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations.list
name: list
summary: Lists snapshots under a subscription.
signature: 'list(**kwargs: Any) -> Iterable[Snapshot]'
return:
description: An iterator like instance of either Snapshot or the result of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2019_03_01.models.Snapshot>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations.list_by_resource_group
name: list_by_resource_group
summary: Lists snapshots under a resource group.
signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[Snapshot]'
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 Snapshot or the result of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2019_03_01.models.Snapshot>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2019_03_01.operations.SnapshotsOperations.models
name: models
signature: models = <module 'azure.mgmt.compute.v2019_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2019_03_01\\models\\__init__.py'>