-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations.yml
193 lines (192 loc) · 6.9 KB
/
azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations.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
### YamlMime:PythonClass
uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations
name: VirtualMachineImagesOperations
fullName: azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations
module: azure.mgmt.compute.v2022_08_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_08_01.ComputeManagementClient>'s\n\
>\n> <xref:virtual_machine_images> attribute.\n>"
constructor:
syntax: VirtualMachineImagesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations.get
name: get
summary: Gets a virtual machine image.
signature: 'get(location: str, publisher_name: str, offer: str, skus: str, version:
str, **kwargs: Any) -> VirtualMachineImage'
parameters:
- name: location
description: The name of a supported Azure region. Required.
isRequired: true
types:
- <xref:str>
- name: publisher_name
description: A valid image publisher. Required.
isRequired: true
types:
- <xref:str>
- name: offer
description: A valid image publisher offer. Required.
isRequired: true
types:
- <xref:str>
- name: skus
description: A valid image SKU. Required.
isRequired: true
types:
- <xref:str>
- name: version
description: A valid image SKU version. Required.
isRequired: true
types:
- <xref:str>
return:
description: VirtualMachineImage or the result of cls(response)
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineImage>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations.list
name: list
summary: 'Gets a list of all virtual machine image versions for the specified location,
publisher, offer,
and SKU.'
signature: 'list(location: str, publisher_name: str, offer: str, skus: str, *, expand:
str | None = None, top: int | None = None, orderby: str | None = None, **kwargs:
Any) -> List[VirtualMachineImageResource]'
parameters:
- name: location
description: The name of a supported Azure region. Required.
isRequired: true
types:
- <xref:str>
- name: publisher_name
description: A valid image publisher. Required.
isRequired: true
types:
- <xref:str>
- name: offer
description: A valid image publisher offer. Required.
isRequired: true
types:
- <xref:str>
- name: skus
description: A valid image SKU. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: expand
description: The expand expression to apply on the operation. Default value is
None.
types:
- <xref:str>
- name: top
description: Default value is None.
types:
- <xref:int>
- name: orderby
description: Default value is None.
types:
- <xref:str>
return:
description: list of VirtualMachineImageResource or the result of cls(response)
types:
- <xref:list>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineImageResource>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations.list_by_edge_zone
name: list_by_edge_zone
summary: Gets a list of all virtual machine image versions for the specified edge
zone.
signature: 'list_by_edge_zone(location: str, edge_zone: str, **kwargs: Any) -> VmImagesInEdgeZoneListResult'
parameters:
- name: location
description: The name of a supported Azure region. Required.
isRequired: true
types:
- <xref:str>
- name: edge_zone
description: The name of the edge zone. Required.
isRequired: true
types:
- <xref:str>
return:
description: VmImagesInEdgeZoneListResult or the result of cls(response)
types:
- <xref:azure.mgmt.compute.v2022_08_01.models.VmImagesInEdgeZoneListResult>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations.list_offers
name: list_offers
summary: Gets a list of virtual machine image offers for the specified location
and publisher.
signature: 'list_offers(location: str, publisher_name: str, **kwargs: Any) -> List[VirtualMachineImageResource]'
parameters:
- name: location
description: The name of a supported Azure region. Required.
isRequired: true
types:
- <xref:str>
- name: publisher_name
description: A valid image publisher. Required.
isRequired: true
types:
- <xref:str>
return:
description: list of VirtualMachineImageResource or the result of cls(response)
types:
- <xref:list>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineImageResource>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations.list_publishers
name: list_publishers
summary: Gets a list of virtual machine image publishers for the specified Azure
location.
signature: 'list_publishers(location: str, **kwargs: Any) -> List[VirtualMachineImageResource]'
parameters:
- name: location
description: The name of a supported Azure region. Required.
isRequired: true
types:
- <xref:str>
return:
description: list of VirtualMachineImageResource or the result of cls(response)
types:
- <xref:list>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineImageResource>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations.list_skus
name: list_skus
summary: Gets a list of virtual machine image SKUs for the specified location, publisher,
and offer.
signature: 'list_skus(location: str, publisher_name: str, offer: str, **kwargs:
Any) -> List[VirtualMachineImageResource]'
parameters:
- name: location
description: The name of a supported Azure region. Required.
isRequired: true
types:
- <xref:str>
- name: publisher_name
description: A valid image publisher. Required.
isRequired: true
types:
- <xref:str>
- name: offer
description: A valid image publisher offer. Required.
isRequired: true
types:
- <xref:str>
return:
description: list of VirtualMachineImageResource or the result of cls(response)
types:
- <xref:list>[<xref:azure.mgmt.compute.v2022_08_01.models.VirtualMachineImageResource>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2022_08_01.operations.VirtualMachineImagesOperations.models
name: models
signature: models = <module 'azure.mgmt.compute.v2022_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2022_08_01\\models\\__init__.py'>