Skip to content

Commit e6344a9

Browse files
msabansaltjprescott
authored andcommitted
Added documentation for patch api call used to update tags (#7044)
* Added documentation for patch api call used to update tags * Fixing missing }
1 parent 1dd4c34 commit e6344a9

File tree

2 files changed

+150
-0
lines changed

2 files changed

+150
-0
lines changed

specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/bastionHost.json

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,70 @@
186186
"x-ms-long-running-operation-options": {
187187
"final-state-via": "azure-async-operation"
188188
}
189+
},
190+
"patch": {
191+
"tags": [
192+
"BastionHosts"
193+
],
194+
"operationId": "BastionHosts_UpdateTags",
195+
"x-ms-examples": {
196+
"BastionHostUpdate": {
197+
"$ref": "./examples/BastionHostUpdateTags.json"
198+
}
199+
},
200+
"description": "Updates bastion host tags.",
201+
"parameters": [
202+
{
203+
"$ref": "./network.json#/parameters/SubscriptionIdParameter"
204+
},
205+
{
206+
"name": "resourceGroupName",
207+
"in": "path",
208+
"required": true,
209+
"type": "string",
210+
"description": "The resource group name of the BastionHost."
211+
},
212+
{
213+
"name": "bastionHostName",
214+
"in": "path",
215+
"required": true,
216+
"type": "string",
217+
"description": "The name of the bastionHost."
218+
},
219+
{
220+
"$ref": "./network.json#/parameters/ApiVersionParameter"
221+
},
222+
{
223+
"name": "bastionHostParameters",
224+
"in": "body",
225+
"required": true,
226+
"schema": {
227+
"$ref": "./network.json#/definitions/TagsObject"
228+
},
229+
"description": "Parameters supplied to update a bastion host tags."
230+
}
231+
],
232+
"responses": {
233+
"200": {
234+
"description": "Request successful. Returns the details of the updated bastion host.",
235+
"schema": {
236+
"$ref": "#/definitions/BastionHost"
237+
}
238+
},
239+
"201": {
240+
"description": "Request received successfully. Returns the details of the updated bastion host.",
241+
"schema": {
242+
"$ref": "#/definitions/BastionHost"
243+
}
244+
},
245+
"default": {
246+
"description": "Error.",
247+
"schema": {
248+
"$ref": "./network.json#/definitions/Error"
249+
}
250+
}
251+
},
252+
"x-ms-long-running-operation": true
189253
}
190254
},
191255
"/subscriptions/{subscriptionId}/providers/Microsoft.Network/bastionHosts": {
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
{
2+
"parameters": {
3+
"api-version": "2019-06-01",
4+
"subscriptionId": "subid",
5+
"resourceGroupName": "rg1",
6+
"bastionHostName": "bastionhosttenant'",
7+
"bastionHostParameters": {
8+
"tags": {
9+
"tag1": "value1",
10+
"tag2": "value2"
11+
}
12+
}
13+
},
14+
"responses": {
15+
"200": {
16+
"body": {
17+
"name": "bastionhost'",
18+
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'",
19+
"type": "Microsoft.Network/bastionHosts",
20+
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
21+
"location": "West US",
22+
"tags": {
23+
"tag1": "value1",
24+
"tag2": "value2"
25+
},
26+
"properties": {
27+
"provisioningState": "Succeeded",
28+
"dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com",
29+
"ipConfigurations": [
30+
{
31+
"name": "bastionHostIpConfiguration",
32+
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration",
33+
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
34+
"type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations",
35+
"properties": {
36+
"provisioningState": "Succeeded",
37+
"privateIPAllocationMethod": "Dynamic",
38+
"subnet": {
39+
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"
40+
},
41+
"publicIPAddress": {
42+
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"
43+
}
44+
}
45+
}
46+
]
47+
}
48+
}
49+
},
50+
"201": {
51+
"body": {
52+
"name": "bastionhost'",
53+
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'",
54+
"type": "Microsoft.Network/bastionHosts",
55+
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
56+
"location": "West US",
57+
"tags": {
58+
"tag1": "value1",
59+
"tag2": "value2"
60+
},
61+
"properties": {
62+
"provisioningState": "Succeeded",
63+
"dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com",
64+
"ipConfigurations": [
65+
{
66+
"name": "bastionHostIpConfiguration",
67+
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration",
68+
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
69+
"type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations",
70+
"properties": {
71+
"provisioningState": "Succeeded",
72+
"privateIPAllocationMethod": "Dynamic",
73+
"subnet": {
74+
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"
75+
},
76+
"publicIPAddress": {
77+
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"
78+
}
79+
}
80+
}
81+
]
82+
}
83+
}
84+
}
85+
}
86+
}

0 commit comments

Comments
 (0)