-
Notifications
You must be signed in to change notification settings - Fork 180
/
Images.yml
188 lines (188 loc) · 7.21 KB
/
Images.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
### YamlMime:TSType
name: Images
uid: '@azure/arm-sphere.Images'
package: '@azure/arm-sphere'
summary: Interface representing a Images.
fullName: Images
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreateOrUpdate(string, string, string, Image_2,
ImagesCreateOrUpdateOptionalParams)
uid: '@azure/arm-sphere.Images.beginCreateOrUpdate'
package: '@azure/arm-sphere'
summary: Create a Image
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdate(resourceGroupName: string, catalogName:
string, imageName: string, resource: Image_2, options?:
ImagesCreateOrUpdateOptionalParams):
Promise<SimplePollerLike<OperationState<Image_2>, Image_2>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: catalogName
type: string
description: Name of catalog
- id: imageName
type: string
description: Image name. Use an image GUID for GA versions of the API.
- id: resource
type: <xref uid="@azure/arm-sphere.Image" />
description: Resource create parameters.
- id: options
type: <xref uid="@azure/arm-sphere.ImagesCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-sphere.Image" />>, <xref
uid="@azure/arm-sphere.Image" />>>
- name: >-
beginCreateOrUpdateAndWait(string, string, string, Image_2,
ImagesCreateOrUpdateOptionalParams)
uid: '@azure/arm-sphere.Images.beginCreateOrUpdateAndWait'
package: '@azure/arm-sphere'
summary: Create a Image
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdateAndWait(resourceGroupName: string,
catalogName: string, imageName: string, resource: Image_2, options?:
ImagesCreateOrUpdateOptionalParams): Promise<Image_2>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: catalogName
type: string
description: Name of catalog
- id: imageName
type: string
description: Image name. Use an image GUID for GA versions of the API.
- id: resource
type: <xref uid="@azure/arm-sphere.Image" />
description: Resource create parameters.
- id: options
type: <xref uid="@azure/arm-sphere.ImagesCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-sphere.Image" />>
- name: beginDelete(string, string, string, ImagesDeleteOptionalParams)
uid: '@azure/arm-sphere.Images.beginDelete'
package: '@azure/arm-sphere'
summary: Delete a Image
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, catalogName: string,
imageName: string, options?: ImagesDeleteOptionalParams):
Promise<SimplePollerLike<OperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: catalogName
type: string
description: Name of catalog
- id: imageName
type: string
description: Image name. Use an image GUID for GA versions of the API.
- id: options
type: <xref uid="@azure/arm-sphere.ImagesDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><void>, void>>
- name: beginDeleteAndWait(string, string, string, ImagesDeleteOptionalParams)
uid: '@azure/arm-sphere.Images.beginDeleteAndWait'
package: '@azure/arm-sphere'
summary: Delete a Image
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string, catalogName:
string, imageName: string, options?: ImagesDeleteOptionalParams):
Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: catalogName
type: string
description: Name of catalog
- id: imageName
type: string
description: Image name. Use an image GUID for GA versions of the API.
- id: options
type: <xref uid="@azure/arm-sphere.ImagesDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, ImagesGetOptionalParams)
uid: '@azure/arm-sphere.Images.get'
package: '@azure/arm-sphere'
summary: Get a Image
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, catalogName: string, imageName:
string, options?: ImagesGetOptionalParams): Promise<Image_2>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: catalogName
type: string
description: Name of catalog
- id: imageName
type: string
description: Image name. Use an image GUID for GA versions of the API.
- id: options
type: <xref uid="@azure/arm-sphere.ImagesGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-sphere.Image" />>
- name: listByCatalog(string, string, ImagesListByCatalogOptionalParams)
uid: '@azure/arm-sphere.Images.listByCatalog'
package: '@azure/arm-sphere'
summary: List Image resources by Catalog
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByCatalog(resourceGroupName: string, catalogName: string,
options?: ImagesListByCatalogOptionalParams):
PagedAsyncIterableIterator<Image_2, Image_2[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: catalogName
type: string
description: Name of catalog
- id: options
type: <xref uid="@azure/arm-sphere.ImagesListByCatalogOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-sphere.Image" />, <xref uid="@azure/arm-sphere.Image"
/>[], <xref uid="@azure/core-paging.PageSettings" />>