-
Notifications
You must be signed in to change notification settings - Fork 246
/
azure.mgmt.compute.v2019_12_01.operations.GalleryImagesOperations.yml
200 lines (187 loc) · 7.17 KB
/
azure.mgmt.compute.v2019_12_01.operations.GalleryImagesOperations.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
### YamlMime:PythonClass
uid: azure.mgmt.compute.v2019_12_01.operations.GalleryImagesOperations
name: GalleryImagesOperations
fullName: azure.mgmt.compute.v2019_12_01.operations.GalleryImagesOperations
module: azure.mgmt.compute.v2019_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.v2019_12_01.ComputeManagementClient>'s\n\
>\n> <xref:gallery_images> attribute.\n>"
constructor:
syntax: GalleryImagesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2019_12_01.operations.GalleryImagesOperations.begin_create_or_update
name: begin_create_or_update
summary: Create or update a gallery Image Definition.
signature: 'begin_create_or_update(resource_group_name: str, gallery_name: str,
gallery_image_name: str, gallery_image: _models.GalleryImage, *, content_type:
str = ''application/json'', **kwargs: Any) -> LROPoller[_models.GalleryImage]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: gallery_name
description: 'The name of the Shared Image Gallery in which the Image Definition
is to
be created. Required.'
isRequired: true
types:
- <xref:str>
- name: gallery_image_name
description: 'The name of the gallery Image Definition to be created or updated.
The allowed characters are alphabets and numbers with dots, dashes, and periods
allowed in the
middle. The maximum length is 80 characters. Required.'
isRequired: true
types:
- <xref:str>
- name: gallery_image
description: 'Parameters supplied to the create or update gallery image operation.
Is
either a GalleryImage type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2019_12_01.models.GalleryImage>
- <xref:typing.IO>[<xref:bytes>]
return:
description: 'An instance of LROPoller that returns either GalleryImage or the
result of
cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2019_12_01.models.GalleryImage>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2019_12_01.operations.GalleryImagesOperations.begin_delete
name: begin_delete
summary: Delete a gallery image.
signature: 'begin_delete(resource_group_name: str, gallery_name: str, gallery_image_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: gallery_name
description: 'The name of the Shared Image Gallery in which the Image Definition
is to
be deleted. Required.'
isRequired: true
types:
- <xref:str>
- name: gallery_image_name
description: The name of the gallery Image Definition to be deleted. 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_12_01.operations.GalleryImagesOperations.begin_update
name: begin_update
summary: Update a gallery Image Definition.
signature: 'begin_update(resource_group_name: str, gallery_name: str, gallery_image_name:
str, gallery_image: _models.GalleryImageUpdate, *, content_type: str = ''application/json'',
**kwargs: Any) -> LROPoller[_models.GalleryImage]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: gallery_name
description: 'The name of the Shared Image Gallery in which the Image Definition
is to
be updated. Required.'
isRequired: true
types:
- <xref:str>
- name: gallery_image_name
description: 'The name of the gallery Image Definition to be updated. The allowed
characters are alphabets and numbers with dots, dashes, and periods allowed
in the middle. The
maximum length is 80 characters. Required.'
isRequired: true
types:
- <xref:str>
- name: gallery_image
description: 'Parameters supplied to the update gallery image operation. Is either
a
GalleryImageUpdate type or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.compute.v2019_12_01.models.GalleryImageUpdate>
- <xref:typing.IO>[<xref:bytes>]
return:
description: 'An instance of LROPoller that returns either GalleryImage or the
result of
cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2019_12_01.models.GalleryImage>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2019_12_01.operations.GalleryImagesOperations.get
name: get
summary: Retrieves information about a gallery Image Definition.
signature: 'get(resource_group_name: str, gallery_name: str, gallery_image_name:
str, **kwargs: Any) -> GalleryImage'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: gallery_name
description: 'The name of the Shared Image Gallery from which the Image Definitions
are
to be retrieved. Required.'
isRequired: true
types:
- <xref:str>
- name: gallery_image_name
description: The name of the gallery Image Definition to be retrieved. Required.
isRequired: true
types:
- <xref:str>
return:
description: GalleryImage or the result of cls(response)
types:
- <xref:azure.mgmt.compute.v2019_12_01.models.GalleryImage>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2019_12_01.operations.GalleryImagesOperations.list_by_gallery
name: list_by_gallery
summary: List gallery Image Definitions in a gallery.
signature: 'list_by_gallery(resource_group_name: str, gallery_name: str, **kwargs:
Any) -> Iterable[GalleryImage]'
parameters:
- name: resource_group_name
description: The name of the resource group. Required.
isRequired: true
types:
- <xref:str>
- name: gallery_name
description: 'The name of the Shared Image Gallery from which Image Definitions
are to
be listed. Required.'
isRequired: true
types:
- <xref:str>
return:
description: An iterator like instance of either GalleryImage or the result of
cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2019_12_01.models.GalleryImage>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2019_12_01.operations.GalleryImagesOperations.models
name: models
signature: models = <module 'azure.mgmt.compute.v2019_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2019_12_01\\models\\__init__.py'>