-
Notifications
You must be signed in to change notification settings - Fork 180
/
BastionHosts.yml
265 lines (265 loc) · 10.4 KB
/
BastionHosts.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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
### YamlMime:TSType
name: BastionHosts
uid: '@azure/arm-network.BastionHosts'
package: '@azure/arm-network'
summary: Interface representing a BastionHosts.
fullName: BastionHosts
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreateOrUpdate(string, string, BastionHost,
BastionHostsCreateOrUpdateOptionalParams)
uid: '@azure/arm-network.BastionHosts.beginCreateOrUpdate'
package: '@azure/arm-network'
summary: Creates or updates the specified Bastion Host.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdate(resourceGroupName: string, bastionHostName:
string, parameters: BastionHost, options?:
BastionHostsCreateOrUpdateOptionalParams):
Promise<SimplePollerLike<OperationState<BastionHost>, BastionHost>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: bastionHostName
type: string
description: The name of the Bastion Host.
- id: parameters
type: <xref uid="@azure/arm-network.BastionHost" />
description: Parameters supplied to the create or update Bastion Host operation.
- id: options
type: >-
<xref
uid="@azure/arm-network.BastionHostsCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-network.BastionHost" />>, <xref
uid="@azure/arm-network.BastionHost" />>>
- name: >-
beginCreateOrUpdateAndWait(string, string, BastionHost,
BastionHostsCreateOrUpdateOptionalParams)
uid: '@azure/arm-network.BastionHosts.beginCreateOrUpdateAndWait'
package: '@azure/arm-network'
summary: Creates or updates the specified Bastion Host.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdateAndWait(resourceGroupName: string,
bastionHostName: string, parameters: BastionHost, options?:
BastionHostsCreateOrUpdateOptionalParams): Promise<BastionHost>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: bastionHostName
type: string
description: The name of the Bastion Host.
- id: parameters
type: <xref uid="@azure/arm-network.BastionHost" />
description: Parameters supplied to the create or update Bastion Host operation.
- id: options
type: >-
<xref
uid="@azure/arm-network.BastionHostsCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-network.BastionHost" />>
- name: beginDelete(string, string, BastionHostsDeleteOptionalParams)
uid: '@azure/arm-network.BastionHosts.beginDelete'
package: '@azure/arm-network'
summary: Deletes the specified Bastion Host.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, bastionHostName: string,
options?: BastionHostsDeleteOptionalParams):
Promise<SimplePollerLike<OperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: bastionHostName
type: string
description: The name of the Bastion Host.
- id: options
type: <xref uid="@azure/arm-network.BastionHostsDeleteOptionalParams" />
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, BastionHostsDeleteOptionalParams)
uid: '@azure/arm-network.BastionHosts.beginDeleteAndWait'
package: '@azure/arm-network'
summary: Deletes the specified Bastion Host.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string, bastionHostName:
string, options?: BastionHostsDeleteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: bastionHostName
type: string
description: The name of the Bastion Host.
- id: options
type: <xref uid="@azure/arm-network.BastionHostsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: >-
beginUpdateTags(string, string, TagsObject,
BastionHostsUpdateTagsOptionalParams)
uid: '@azure/arm-network.BastionHosts.beginUpdateTags'
package: '@azure/arm-network'
summary: Updates Tags for BastionHost resource
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdateTags(resourceGroupName: string, bastionHostName:
string, parameters: TagsObject, options?:
BastionHostsUpdateTagsOptionalParams):
Promise<SimplePollerLike<OperationState<BastionHost>, BastionHost>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: bastionHostName
type: string
description: The name of the Bastion Host.
- id: parameters
type: <xref uid="@azure/arm-network.TagsObject" />
description: Parameters supplied to update BastionHost tags.
- id: options
type: >-
<xref uid="@azure/arm-network.BastionHostsUpdateTagsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-network.BastionHost" />>, <xref
uid="@azure/arm-network.BastionHost" />>>
- name: >-
beginUpdateTagsAndWait(string, string, TagsObject,
BastionHostsUpdateTagsOptionalParams)
uid: '@azure/arm-network.BastionHosts.beginUpdateTagsAndWait'
package: '@azure/arm-network'
summary: Updates Tags for BastionHost resource
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdateTagsAndWait(resourceGroupName: string,
bastionHostName: string, parameters: TagsObject, options?:
BastionHostsUpdateTagsOptionalParams): Promise<BastionHost>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: bastionHostName
type: string
description: The name of the Bastion Host.
- id: parameters
type: <xref uid="@azure/arm-network.TagsObject" />
description: Parameters supplied to update BastionHost tags.
- id: options
type: >-
<xref uid="@azure/arm-network.BastionHostsUpdateTagsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-network.BastionHost" />>
- name: get(string, string, BastionHostsGetOptionalParams)
uid: '@azure/arm-network.BastionHosts.get'
package: '@azure/arm-network'
summary: Gets the specified Bastion Host.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, bastionHostName: string,
options?: BastionHostsGetOptionalParams): Promise<BastionHost>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: bastionHostName
type: string
description: The name of the Bastion Host.
- id: options
type: <xref uid="@azure/arm-network.BastionHostsGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-network.BastionHost" />>
- name: list(BastionHostsListOptionalParams)
uid: '@azure/arm-network.BastionHosts.list'
package: '@azure/arm-network'
summary: Lists all Bastion Hosts in a subscription.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(options?: BastionHostsListOptionalParams):
PagedAsyncIterableIterator<BastionHost, BastionHost[], PageSettings>
parameters:
- id: options
type: <xref uid="@azure/arm-network.BastionHostsListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-network.BastionHost" />, <xref
uid="@azure/arm-network.BastionHost" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: listByResourceGroup(string, BastionHostsListByResourceGroupOptionalParams)
uid: '@azure/arm-network.BastionHosts.listByResourceGroup'
package: '@azure/arm-network'
summary: Lists all Bastion Hosts in a resource group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByResourceGroup(resourceGroupName: string, options?:
BastionHostsListByResourceGroupOptionalParams):
PagedAsyncIterableIterator<BastionHost, BastionHost[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: options
type: >-
<xref
uid="@azure/arm-network.BastionHostsListByResourceGroupOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-network.BastionHost" />, <xref
uid="@azure/arm-network.BastionHost" />[], <xref
uid="@azure/core-paging.PageSettings" />>