Skip to content

Commit 30eb649

Browse files
finiteattractorjhendrixMSFT
finiteattractor
authored and
jhendrixMSFT
committed
Minor fixed to address documentation issues (#2009)
* added extension properties to Get & GetNode * fix indentation * fix indentation * changed description text * Adding new API version (2017-05-15-preview). No other changes made (#2) Adding new API version (2017-05-15-preview). Only three new resources added and all others reference the previous version. - Added resources: - SoftwareUpdateConfiguration - SoftwareUpdateConfigurationRun - SoftwareUpdateConfigurationMachineRun - Validations: - Autorest azure validations passed - x-ms-examples validated with no errors * Updated tag in global configuration Updated tag in global configuration to use the latest api version as per azure PR review comment * - Fixed 2 typos in URLs (#4) - Moved parameters inside operations as it was not showing properly in documentation.
1 parent 5e06f63 commit 30eb649

3 files changed

Lines changed: 152 additions & 125 deletions

File tree

‎specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfiguration.json‎

Lines changed: 73 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -41,27 +41,6 @@
4141

4242
"paths": {
4343
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations/{softwareUpdateConfigurationName}": {
44-
"parameters": [
45-
{
46-
"$ref": "./definitions.json#/parameters/subscriptionId"
47-
},
48-
{
49-
"$ref": "./definitions.json#/parameters/resourceGroupName"
50-
},
51-
{
52-
"$ref": "./definitions.json#/parameters/automationAccountName"
53-
},
54-
{
55-
"$ref": "./definitions.json#/parameters/softwareUpdateConfigurationName"
56-
},
57-
{
58-
"$ref": "./definitions.json#/parameters/apiVersion"
59-
},
60-
{
61-
"$ref": "./definitions.json#/parameters/clientRequestId"
62-
}
63-
],
64-
6544
"put": {
6645
"tags": [ "Software Update Configuration" ],
6746
"description": "Create a new software update configuration with the name given in the URI.",
@@ -73,6 +52,24 @@
7352
},
7453
"operationId": "softwareUpdateConfigurations_Create",
7554
"parameters": [
55+
{
56+
"$ref": "./definitions.json#/parameters/subscriptionId"
57+
},
58+
{
59+
"$ref": "./definitions.json#/parameters/resourceGroupName"
60+
},
61+
{
62+
"$ref": "./definitions.json#/parameters/automationAccountName"
63+
},
64+
{
65+
"$ref": "./definitions.json#/parameters/softwareUpdateConfigurationName"
66+
},
67+
{
68+
"$ref": "./definitions.json#/parameters/apiVersion"
69+
},
70+
{
71+
"$ref": "./definitions.json#/parameters/clientRequestId"
72+
},
7673
{
7774
"name": "parameters",
7875
"description": "Request body.",
@@ -119,6 +116,26 @@
119116
"Get software update configuration by name": { "$ref": "./examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json" }
120117
},
121118
"operationId": "softwareUpdateConfigurations_GetByName",
119+
"parameters": [
120+
{
121+
"$ref": "./definitions.json#/parameters/subscriptionId"
122+
},
123+
{
124+
"$ref": "./definitions.json#/parameters/resourceGroupName"
125+
},
126+
{
127+
"$ref": "./definitions.json#/parameters/automationAccountName"
128+
},
129+
{
130+
"$ref": "./definitions.json#/parameters/softwareUpdateConfigurationName"
131+
},
132+
{
133+
"$ref": "./definitions.json#/parameters/apiVersion"
134+
},
135+
{
136+
"$ref": "./definitions.json#/parameters/clientRequestId"
137+
}
138+
],
122139
"responses": {
123140
"200": {
124141
"description": "A single software update configuration.",
@@ -142,6 +159,26 @@
142159
"Delete software update configuration": { "$ref": "./examples/softwareUpdateConfiguration/deleteSoftwareUpdateConfiguration.json" }
143160
},
144161
"operationId": "softwareUpdateConfigurations_Delete",
162+
"parameters": [
163+
{
164+
"$ref": "./definitions.json#/parameters/subscriptionId"
165+
},
166+
{
167+
"$ref": "./definitions.json#/parameters/resourceGroupName"
168+
},
169+
{
170+
"$ref": "./definitions.json#/parameters/automationAccountName"
171+
},
172+
{
173+
"$ref": "./definitions.json#/parameters/softwareUpdateConfigurationName"
174+
},
175+
{
176+
"$ref": "./definitions.json#/parameters/apiVersion"
177+
},
178+
{
179+
"$ref": "./definitions.json#/parameters/clientRequestId"
180+
}
181+
],
145182
"responses": {
146183
"200": {
147184
"description": "The software update configuration has been deleted."
@@ -157,25 +194,6 @@
157194
},
158195

159196
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations": {
160-
"parameters": [
161-
{
162-
"$ref": "./definitions.json#/parameters/subscriptionId"
163-
},
164-
{
165-
"$ref": "./definitions.json#/parameters/resourceGroupName"
166-
},
167-
{
168-
"$ref": "./definitions.json#/parameters/automationAccountName"
169-
},
170-
{
171-
"$ref": "./definitions.json#/parameters/apiVersion"
172-
},
173-
{
174-
"$ref": "./definitions.json#/parameters/clientRequestId"
175-
}
176-
],
177-
178-
179197
"get": {
180198
"tags": [ "Software Update Configuration" ],
181199
"description": "Get all software update configurations for the account.",
@@ -188,6 +206,21 @@
188206
},
189207
"operationId": "softwareUpdateConfigurations_List",
190208
"parameters": [
209+
{
210+
"$ref": "./definitions.json#/parameters/subscriptionId"
211+
},
212+
{
213+
"$ref": "./definitions.json#/parameters/resourceGroupName"
214+
},
215+
{
216+
"$ref": "./definitions.json#/parameters/automationAccountName"
217+
},
218+
{
219+
"$ref": "./definitions.json#/parameters/apiVersion"
220+
},
221+
{
222+
"$ref": "./definitions.json#/parameters/clientRequestId"
223+
},
191224
{
192225
"name": "$filter",
193226
"in": "query",

‎specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json‎

Lines changed: 39 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -40,28 +40,7 @@
4040
},
4141

4242
"paths": {
43-
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationsRuns/{softwareUpdateConfigurationMachineRunId}": {
44-
"parameters": [
45-
{
46-
"$ref": "./definitions.json#/parameters/subscriptionId"
47-
},
48-
{
49-
"$ref": "./definitions.json#/parameters/resourceGroupName"
50-
},
51-
{
52-
"$ref": "./definitions.json#/parameters/automationAccountName"
53-
},
54-
{
55-
"$ref": "./definitions.json#/parameters/softwareUpdateConfigurationMachineRunId"
56-
},
57-
{
58-
"$ref": "./definitions.json#/parameters/apiVersion"
59-
},
60-
{
61-
"$ref": "./definitions.json#/parameters/clientRequestId"
62-
}
63-
],
64-
43+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns/{softwareUpdateConfigurationMachineRunId}": {
6544
"get": {
6645
"tags": [ "Software Update Configuration Machine Run" ],
6746
"description": "Get a single software update configuration machine run by Id.",
@@ -72,6 +51,26 @@
7251
"Get software update configuration machine run": { "$ref": "./examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json" }
7352
},
7453
"operationId": "softwareUpdateConfigurationMachineRuns_GetById",
54+
"parameters": [
55+
{
56+
"$ref": "./definitions.json#/parameters/subscriptionId"
57+
},
58+
{
59+
"$ref": "./definitions.json#/parameters/resourceGroupName"
60+
},
61+
{
62+
"$ref": "./definitions.json#/parameters/automationAccountName"
63+
},
64+
{
65+
"$ref": "./definitions.json#/parameters/softwareUpdateConfigurationMachineRunId"
66+
},
67+
{
68+
"$ref": "./definitions.json#/parameters/apiVersion"
69+
},
70+
{
71+
"$ref": "./definitions.json#/parameters/clientRequestId"
72+
}
73+
],
7574
"responses": {
7675
"200": {
7776
"description": "A single software update configuration machine run.",
@@ -88,24 +87,6 @@
8887

8988

9089
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns": {
91-
"parameters": [
92-
{
93-
"$ref": "./definitions.json#/parameters/subscriptionId"
94-
},
95-
{
96-
"$ref": "./definitions.json#/parameters/resourceGroupName"
97-
},
98-
{
99-
"$ref": "./definitions.json#/parameters/automationAccountName"
100-
},
101-
{
102-
"$ref": "./definitions.json#/parameters/apiVersion"
103-
},
104-
{
105-
"$ref": "./definitions.json#/parameters/clientRequestId"
106-
}
107-
],
108-
10990
"get": {
11091
"tags": [ "Software Update Configuration Machine Run" ],
11192
"description": "Return list of software update configuration machine runs",
@@ -116,6 +97,24 @@
11697
"List software update configuration machine runs": { "$ref": "./examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json" },
11798
"List software update configuration machine runs for a specific software update configuration run": { "$ref": "./examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json" }
11899
},
100+
"operationId": "softwareUpdateConfigurationMachineRuns_List",
101+
"parameters": [
102+
{
103+
"$ref": "./definitions.json#/parameters/subscriptionId"
104+
},
105+
{
106+
"$ref": "./definitions.json#/parameters/resourceGroupName"
107+
},
108+
{
109+
"$ref": "./definitions.json#/parameters/automationAccountName"
110+
},
111+
{
112+
"$ref": "./definitions.json#/parameters/apiVersion"
113+
},
114+
{
115+
"$ref": "./definitions.json#/parameters/clientRequestId"
116+
},
117+
{
119118
"parameters": [
120119
{
121120
"name": "$skip",
@@ -139,7 +138,6 @@
139138
"description": "The filter to apply on the operation. You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime', and 'properties/softwareUpdateConfiguration/name'"
140139
}
141140
],
142-
"operationId": "softwareUpdateConfigurationMachineRuns_List",
143141
"responses": {
144142
"200": {
145143
"description": "Return list of software update configuration machine runs.",

‎specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfigurationRun.json‎

Lines changed: 40 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -40,28 +40,7 @@
4040
},
4141

4242
"paths": {
43-
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationsRuns/{softwareUpdateConfigurationRunId}": {
44-
"parameters": [
45-
{
46-
"$ref": "./definitions.json#/parameters/subscriptionId"
47-
},
48-
{
49-
"$ref": "./definitions.json#/parameters/resourceGroupName"
50-
},
51-
{
52-
"$ref": "./definitions.json#/parameters/automationAccountName"
53-
},
54-
{
55-
"$ref": "./definitions.json#/parameters/softwareUpdateConfigurationRunId"
56-
},
57-
{
58-
"$ref": "./definitions.json#/parameters/apiVersion"
59-
},
60-
{
61-
"$ref": "./definitions.json#/parameters/clientRequestId"
62-
}
63-
],
64-
43+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns/{softwareUpdateConfigurationRunId}": {
6544
"get": {
6645
"tags": [ "Software Update Configuration Run" ],
6746
"description": "Get a single software update configuration Run by Id.",
@@ -72,6 +51,26 @@
7251
"Get software update configuration runs by Id": { "$ref": "./examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json" }
7352
},
7453
"operationId": "softwareUpdateConfigurationRuns_GetById",
54+
"parameters": [
55+
{
56+
"$ref": "./definitions.json#/parameters/subscriptionId"
57+
},
58+
{
59+
"$ref": "./definitions.json#/parameters/resourceGroupName"
60+
},
61+
{
62+
"$ref": "./definitions.json#/parameters/automationAccountName"
63+
},
64+
{
65+
"$ref": "./definitions.json#/parameters/softwareUpdateConfigurationRunId"
66+
},
67+
{
68+
"$ref": "./definitions.json#/parameters/apiVersion"
69+
},
70+
{
71+
"$ref": "./definitions.json#/parameters/clientRequestId"
72+
}
73+
],
7574
"responses": {
7675
"200": {
7776
"description": "A single software update configuration Run.",
@@ -85,27 +84,7 @@
8584
}
8685
}
8786
},
88-
89-
90-
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationsRuns": {
91-
"parameters": [
92-
{
93-
"$ref": "#/parameters/subscriptionId"
94-
},
95-
{
96-
"$ref": "#/parameters/resourceGroupName"
97-
},
98-
{
99-
"$ref": "#/parameters/automationAccountName"
100-
},
101-
{
102-
"$ref": "#/parameters/apiVersion"
103-
},
104-
{
105-
"$ref": "#/parameters/clientRequestId"
106-
}
107-
],
108-
87+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns": {
10988
"get": {
11089
"tags": [ "Software Update Configuration Run" ],
11190
"description": "Return list of software update configuration runs",
@@ -116,6 +95,24 @@
11695
"List software update configuration machine runs": { "$ref": "./examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json" },
11796
"List software update configuration machine run with status equal to 'Failed'": { "$ref": "./examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json" }
11897
},
98+
"operationId": "softwareUpdateConfigurationRuns_List",
99+
"parameters": [
100+
{
101+
"$ref": "#/parameters/subscriptionId"
102+
},
103+
{
104+
"$ref": "#/parameters/resourceGroupName"
105+
},
106+
{
107+
"$ref": "#/parameters/automationAccountName"
108+
},
109+
{
110+
"$ref": "#/parameters/apiVersion"
111+
},
112+
{
113+
"$ref": "#/parameters/clientRequestId"
114+
},
115+
{
119116
"parameters": [
120117
{
121118
"name": "$skip",
@@ -139,7 +136,6 @@
139136
"description": "The filter to apply on the operation. You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime', and 'properties/softwareUpdateConfiguration/name'"
140137
}
141138
],
142-
"operationId": "softwareUpdateConfigurationRuns_List",
143139
"responses": {
144140
"200": {
145141
"description": "Return list of software update configurations runs.",

0 commit comments

Comments
 (0)
⚡