Skip to content

Commit ea1aed2

Browse files
sanray-mssanray-ms
authored
[Hub Generated] Review request for Microsoft.AzureStackHCI to add version stable/2022-01-01 (#17377)
* Adds base for updating Microsoft.AzureStackHCI from version stable/2021-09-01 to version 2022-01-01 * Updates readme * Updates API version in new specs and examples * remove readonly attribute * added example file * Format the files
1 parent d830271 commit ea1aed2

21 files changed

+2939
-2
lines changed

‎specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-01-01/arcSettings.json

Lines changed: 378 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,378 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "2022-01-01",
5+
"title": "AzureStackHCI",
6+
"description": "Azure Stack HCI management service"
7+
},
8+
"host": "management.azure.com",
9+
"schemes": [
10+
"https"
11+
],
12+
"consumes": [
13+
"application/json"
14+
],
15+
"produces": [
16+
"application/json"
17+
],
18+
"security": [
19+
{
20+
"azure_auth": [
21+
"user_impersonation"
22+
]
23+
}
24+
],
25+
"securityDefinitions": {
26+
"azure_auth": {
27+
"type": "oauth2",
28+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
29+
"flow": "implicit",
30+
"description": "Azure Active Directory OAuth2 Flow",
31+
"scopes": {
32+
"user_impersonation": "impersonate your user account"
33+
}
34+
}
35+
},
36+
"paths": {
37+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings": {
38+
"get": {
39+
"operationId": "ArcSettings_ListByCluster",
40+
"description": "Get ArcSetting resources of HCI Cluster.",
41+
"parameters": [
42+
{
43+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
44+
},
45+
{
46+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
47+
},
48+
{
49+
"$ref": "#/parameters/ClusterNameParameter"
50+
},
51+
{
52+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
53+
}
54+
],
55+
"responses": {
56+
"200": {
57+
"description": "OK",
58+
"schema": {
59+
"$ref": "#/definitions/ArcSettingList"
60+
}
61+
},
62+
"default": {
63+
"description": "Error response describing why the operation failed.",
64+
"schema": {
65+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
66+
}
67+
}
68+
},
69+
"x-ms-examples": {
70+
"List ArcSetting resources by HCI Cluster": {
71+
"$ref": "./examples/ListArcSettingsByCluster.json"
72+
}
73+
},
74+
"x-ms-pageable": {
75+
"nextLinkName": "nextLink"
76+
}
77+
}
78+
},
79+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}": {
80+
"get": {
81+
"operationId": "ArcSettings_Get",
82+
"description": "Get ArcSetting resource details of HCI Cluster.",
83+
"parameters": [
84+
{
85+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
86+
},
87+
{
88+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
89+
},
90+
{
91+
"$ref": "#/parameters/ClusterNameParameter"
92+
},
93+
{
94+
"$ref": "#/parameters/ArcSettingNameParameter"
95+
},
96+
{
97+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
98+
}
99+
],
100+
"responses": {
101+
"200": {
102+
"description": "OK",
103+
"schema": {
104+
"$ref": "#/definitions/ArcSetting"
105+
}
106+
},
107+
"default": {
108+
"description": "Error response describing why the operation failed.",
109+
"schema": {
110+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
111+
}
112+
}
113+
},
114+
"x-ms-examples": {
115+
"Get ArcSetting": {
116+
"$ref": "./examples/GetArcSetting.json"
117+
}
118+
}
119+
},
120+
"put": {
121+
"operationId": "ArcSettings_Create",
122+
"description": "Create ArcSetting for HCI cluster.",
123+
"parameters": [
124+
{
125+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
126+
},
127+
{
128+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
129+
},
130+
{
131+
"$ref": "#/parameters/ClusterNameParameter"
132+
},
133+
{
134+
"$ref": "#/parameters/ArcSettingNameParameter"
135+
},
136+
{
137+
"name": "arcSetting",
138+
"in": "body",
139+
"required": true,
140+
"schema": {
141+
"$ref": "#/definitions/ArcSetting"
142+
},
143+
"description": "Parameters supplied to the Create ArcSetting resource for this HCI cluster."
144+
},
145+
{
146+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
147+
}
148+
],
149+
"responses": {
150+
"200": {
151+
"description": "OK",
152+
"schema": {
153+
"$ref": "#/definitions/ArcSetting"
154+
}
155+
},
156+
"default": {
157+
"description": "Error response describing why the operation failed.",
158+
"schema": {
159+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
160+
}
161+
}
162+
},
163+
"x-ms-examples": {
164+
"Create ArcSetting": {
165+
"$ref": "./examples/PutArcSetting.json"
166+
}
167+
}
168+
},
169+
"delete": {
170+
"operationId": "ArcSettings_Delete",
171+
"description": "Delete ArcSetting resource details of HCI Cluster.",
172+
"parameters": [
173+
{
174+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
175+
},
176+
{
177+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
178+
},
179+
{
180+
"$ref": "#/parameters/ClusterNameParameter"
181+
},
182+
{
183+
"$ref": "#/parameters/ArcSettingNameParameter"
184+
},
185+
{
186+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
187+
}
188+
],
189+
"responses": {
190+
"200": {
191+
"description": "OK"
192+
},
193+
"202": {
194+
"description": "OK"
195+
},
196+
"204": {
197+
"description": "No content"
198+
},
199+
"default": {
200+
"description": "Error response describing why the operation failed.",
201+
"schema": {
202+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
203+
}
204+
}
205+
},
206+
"x-ms-long-running-operation": true,
207+
"x-ms-long-running-operation-options": {
208+
"final-state-via": "azure-async-operation"
209+
},
210+
"x-ms-examples": {
211+
"Delete ArcSetting": {
212+
"$ref": "./examples/DeleteArcSetting.json"
213+
}
214+
}
215+
}
216+
}
217+
},
218+
"definitions": {
219+
"ArcSettingList": {
220+
"description": "List of ArcSetting proxy resources for the HCI cluster.",
221+
"type": "object",
222+
"properties": {
223+
"value": {
224+
"description": "List of ArcSetting proxy resources.",
225+
"type": "array",
226+
"items": {
227+
"$ref": "#/definitions/ArcSetting"
228+
},
229+
"readOnly": true
230+
},
231+
"nextLink": {
232+
"description": "Link to the next set of results.",
233+
"type": "string",
234+
"readOnly": true
235+
}
236+
}
237+
},
238+
"ArcSetting": {
239+
"description": "ArcSetting details.",
240+
"type": "object",
241+
"allOf": [
242+
{
243+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource"
244+
}
245+
],
246+
"properties": {
247+
"systemData": {
248+
"description": "System data of ArcSetting resource",
249+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
250+
"x-ms-client-flatten": true,
251+
"readOnly": true
252+
},
253+
"properties": {
254+
"description": "ArcSetting properties.",
255+
"$ref": "#/definitions/ArcSettingProperties",
256+
"x-ms-client-flatten": true
257+
}
258+
}
259+
},
260+
"ArcSettingProperties": {
261+
"description": "ArcSetting properties.",
262+
"type": "object",
263+
"properties": {
264+
"provisioningState": {
265+
"description": "Provisioning state of the ArcSetting proxy resource.",
266+
"type": "string",
267+
"enum": [
268+
"Succeeded",
269+
"Failed",
270+
"Canceled",
271+
"Accepted",
272+
"Provisioning"
273+
],
274+
"x-ms-enum": {
275+
"name": "ProvisioningState",
276+
"modelAsString": true
277+
},
278+
"readOnly": true
279+
},
280+
"arcInstanceResourceGroup": {
281+
"description": "The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.",
282+
"type": "string"
283+
},
284+
"aggregateState": {
285+
"description": "Aggregate state of Arc agent across the nodes in this HCI cluster.",
286+
"type": "string",
287+
"enum": [
288+
"NotSpecified",
289+
"Error",
290+
"Succeeded",
291+
"Canceled",
292+
"Failed",
293+
"Connected",
294+
"Disconnected",
295+
"Deleted",
296+
"Creating",
297+
"Updating",
298+
"Deleting",
299+
"Moving",
300+
"PartiallySucceeded",
301+
"PartiallyConnected",
302+
"InProgress"
303+
],
304+
"x-ms-enum": {
305+
"name": "ArcSettingAggregateState",
306+
"modelAsString": true
307+
},
308+
"readOnly": true
309+
},
310+
"perNodeDetails": {
311+
"description": "State of Arc agent in each of the nodes.",
312+
"type": "array",
313+
"items": {
314+
"$ref": "#/definitions/PerNodeState"
315+
},
316+
"readOnly": true
317+
}
318+
}
319+
},
320+
"PerNodeState": {
321+
"description": "Status of Arc agent for a particular node in HCI Cluster.",
322+
"type": "object",
323+
"properties": {
324+
"name": {
325+
"type": "string",
326+
"readOnly": true,
327+
"description": "Name of the Node in HCI Cluster"
328+
},
329+
"arcInstance": {
330+
"description": "Fully qualified resource ID for the Arc agent of this node.",
331+
"type": "string",
332+
"readOnly": true
333+
},
334+
"state": {
335+
"description": "State of Arc agent in this node.",
336+
"type": "string",
337+
"enum": [
338+
"NotSpecified",
339+
"Error",
340+
"Succeeded",
341+
"Canceled",
342+
"Failed",
343+
"Connected",
344+
"Disconnected",
345+
"Deleted",
346+
"Creating",
347+
"Updating",
348+
"Deleting",
349+
"Moving"
350+
],
351+
"x-ms-enum": {
352+
"name": "NodeArcState",
353+
"modelAsString": true
354+
},
355+
"readOnly": true
356+
}
357+
}
358+
}
359+
},
360+
"parameters": {
361+
"ClusterNameParameter": {
362+
"name": "clusterName",
363+
"in": "path",
364+
"required": true,
365+
"type": "string",
366+
"description": "The name of the cluster.",
367+
"x-ms-parameter-location": "method"
368+
},
369+
"ArcSettingNameParameter": {
370+
"name": "arcSettingName",
371+
"in": "path",
372+
"required": true,
373+
"type": "string",
374+
"description": "The name of the proxy resource holding details of HCI ArcSetting information.",
375+
"x-ms-parameter-location": "method"
376+
}
377+
}
378+
}

0 commit comments

Comments
 (0)