-
Notifications
You must be signed in to change notification settings - Fork 180
/
Endpoints.yml
275 lines (275 loc) · 10 KB
/
Endpoints.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
266
267
268
269
270
271
272
273
274
275
### YamlMime:TSType
name: Endpoints
uid: '@azure/arm-hybridconnectivity.Endpoints'
package: '@azure/arm-hybridconnectivity'
summary: Interface representing a Endpoints.
fullName: Endpoints
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
createOrUpdate(string, string, EndpointResource,
EndpointsCreateOrUpdateOptionalParams)
uid: '@azure/arm-hybridconnectivity.Endpoints.createOrUpdate'
package: '@azure/arm-hybridconnectivity'
summary: Create or update the endpoint to the target resource.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdate(resourceUri: string, endpointName: string,
endpointResource: EndpointResource, options?:
EndpointsCreateOrUpdateOptionalParams): Promise<EndpointResource>
parameters:
- id: resourceUri
type: string
description: >-
The fully qualified Azure Resource manager identifier of the
resource to be
connected.
- id: endpointName
type: string
description: The endpoint name.
- id: endpointResource
type: <xref uid="@azure/arm-hybridconnectivity.EndpointResource" />
description: Endpoint details
- id: options
type: >-
<xref
uid="@azure/arm-hybridconnectivity.EndpointsCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-hybridconnectivity.EndpointResource"
/>>
- name: delete(string, string, EndpointsDeleteOptionalParams)
uid: '@azure/arm-hybridconnectivity.Endpoints.delete'
package: '@azure/arm-hybridconnectivity'
summary: Deletes the endpoint access to the target resource.
remarks: ''
isDeprecated: false
syntax:
content: >-
function delete(resourceUri: string, endpointName: string, options?:
EndpointsDeleteOptionalParams): Promise<void>
parameters:
- id: resourceUri
type: string
description: >-
The fully qualified Azure Resource manager identifier of the
resource to be
connected.
- id: endpointName
type: string
description: The endpoint name.
- id: options
type: >-
<xref
uid="@azure/arm-hybridconnectivity.EndpointsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, EndpointsGetOptionalParams)
uid: '@azure/arm-hybridconnectivity.Endpoints.get'
package: '@azure/arm-hybridconnectivity'
summary: Gets the endpoint to the resource.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceUri: string, endpointName: string, options?:
EndpointsGetOptionalParams): Promise<EndpointResource>
parameters:
- id: resourceUri
type: string
description: >-
The fully qualified Azure Resource manager identifier of the
resource to be
connected.
- id: endpointName
type: string
description: The endpoint name.
- id: options
type: >-
<xref uid="@azure/arm-hybridconnectivity.EndpointsGetOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-hybridconnectivity.EndpointResource"
/>>
- name: list(string, EndpointsListOptionalParams)
uid: '@azure/arm-hybridconnectivity.Endpoints.list'
package: '@azure/arm-hybridconnectivity'
summary: List of endpoints to the target resource.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(resourceUri: string, options?:
EndpointsListOptionalParams):
PagedAsyncIterableIterator<EndpointResource, EndpointResource[],
PageSettings>
parameters:
- id: resourceUri
type: string
description: >-
The fully qualified Azure Resource manager identifier of the
resource to be
connected.
- id: options
type: >-
<xref
uid="@azure/arm-hybridconnectivity.EndpointsListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-hybridconnectivity.EndpointResource" />, <xref
uid="@azure/arm-hybridconnectivity.EndpointResource" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: listCredentials(string, string, EndpointsListCredentialsOptionalParams)
uid: '@azure/arm-hybridconnectivity.Endpoints.listCredentials'
package: '@azure/arm-hybridconnectivity'
summary: Gets the endpoint access credentials to the resource.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listCredentials(resourceUri: string, endpointName: string,
options?: EndpointsListCredentialsOptionalParams):
Promise<EndpointAccessResource>
parameters:
- id: resourceUri
type: string
description: >-
The fully qualified Azure Resource manager identifier of the
resource to be
connected.
- id: endpointName
type: string
description: The endpoint name.
- id: options
type: >-
<xref
uid="@azure/arm-hybridconnectivity.EndpointsListCredentialsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-hybridconnectivity.EndpointAccessResource" />>
- name: >-
listIngressGatewayCredentials(string, string,
EndpointsListIngressGatewayCredentialsOptionalParams)
uid: '@azure/arm-hybridconnectivity.Endpoints.listIngressGatewayCredentials'
package: '@azure/arm-hybridconnectivity'
summary: Gets the ingress gateway endpoint credentials
remarks: ''
isDeprecated: false
syntax:
content: >-
function listIngressGatewayCredentials(resourceUri: string,
endpointName: string, options?:
EndpointsListIngressGatewayCredentialsOptionalParams):
Promise<IngressGatewayResource>
parameters:
- id: resourceUri
type: string
description: >-
The fully qualified Azure Resource manager identifier of the
resource to be
connected.
- id: endpointName
type: string
description: The endpoint name.
- id: options
type: >-
<xref
uid="@azure/arm-hybridconnectivity.EndpointsListIngressGatewayCredentialsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-hybridconnectivity.IngressGatewayResource" />>
- name: >-
listManagedProxyDetails(string, string, ManagedProxyRequest,
EndpointsListManagedProxyDetailsOptionalParams)
uid: '@azure/arm-hybridconnectivity.Endpoints.listManagedProxyDetails'
package: '@azure/arm-hybridconnectivity'
summary: Fetches the managed proxy details
remarks: ''
isDeprecated: false
syntax:
content: >-
function listManagedProxyDetails(resourceUri: string, endpointName:
string, managedProxyRequest: ManagedProxyRequest, options?:
EndpointsListManagedProxyDetailsOptionalParams):
Promise<ManagedProxyResource>
parameters:
- id: resourceUri
type: string
description: >-
The fully qualified Azure Resource manager identifier of the
resource to be
connected.
- id: endpointName
type: string
description: The endpoint name.
- id: managedProxyRequest
type: <xref uid="@azure/arm-hybridconnectivity.ManagedProxyRequest" />
description: Object of type ManagedProxyRequest
- id: options
type: >-
<xref
uid="@azure/arm-hybridconnectivity.EndpointsListManagedProxyDetailsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-hybridconnectivity.ManagedProxyResource" />>
- name: update(string, string, EndpointResource, EndpointsUpdateOptionalParams)
uid: '@azure/arm-hybridconnectivity.Endpoints.update'
package: '@azure/arm-hybridconnectivity'
summary: Update the endpoint to the target resource.
remarks: ''
isDeprecated: false
syntax:
content: >-
function update(resourceUri: string, endpointName: string,
endpointResource: EndpointResource, options?:
EndpointsUpdateOptionalParams): Promise<EndpointResource>
parameters:
- id: resourceUri
type: string
description: >-
The fully qualified Azure Resource manager identifier of the
resource to be
connected.
- id: endpointName
type: string
description: The endpoint name.
- id: endpointResource
type: <xref uid="@azure/arm-hybridconnectivity.EndpointResource" />
description: Endpoint details
- id: options
type: >-
<xref
uid="@azure/arm-hybridconnectivity.EndpointsUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-hybridconnectivity.EndpointResource"
/>>