-
Notifications
You must be signed in to change notification settings - Fork 181
/
FrontendEndpoints.yml
217 lines (217 loc) · 8.65 KB
/
FrontendEndpoints.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
### YamlMime:TSType
name: FrontendEndpoints
uid: '@azure/arm-frontdoor.FrontendEndpoints'
package: '@azure/arm-frontdoor'
summary: Interface representing a FrontendEndpoints.
fullName: FrontendEndpoints
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginDisableHttps(string, string, string,
FrontendEndpointsDisableHttpsOptionalParams)
uid: '@azure/arm-frontdoor.FrontendEndpoints.beginDisableHttps'
package: '@azure/arm-frontdoor'
summary: Disables a frontendEndpoint for HTTPS traffic
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDisableHttps(resourceGroupName: string, frontDoorName:
string, frontendEndpointName: string, options?:
FrontendEndpointsDisableHttpsOptionalParams):
Promise<SimplePollerLike<OperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: Name of the Resource group within the Azure subscription.
- id: frontDoorName
type: string
description: Name of the Front Door which is globally unique.
- id: frontendEndpointName
type: string
description: Name of the Frontend endpoint which is unique within the Front Door.
- id: options
type: >-
<xref
uid="@azure/arm-frontdoor.FrontendEndpointsDisableHttpsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><void>, void>>
- name: >-
beginDisableHttpsAndWait(string, string, string,
FrontendEndpointsDisableHttpsOptionalParams)
uid: '@azure/arm-frontdoor.FrontendEndpoints.beginDisableHttpsAndWait'
package: '@azure/arm-frontdoor'
summary: Disables a frontendEndpoint for HTTPS traffic
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDisableHttpsAndWait(resourceGroupName: string,
frontDoorName: string, frontendEndpointName: string, options?:
FrontendEndpointsDisableHttpsOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: Name of the Resource group within the Azure subscription.
- id: frontDoorName
type: string
description: Name of the Front Door which is globally unique.
- id: frontendEndpointName
type: string
description: Name of the Frontend endpoint which is unique within the Front Door.
- id: options
type: >-
<xref
uid="@azure/arm-frontdoor.FrontendEndpointsDisableHttpsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: >-
beginEnableHttps(string, string, string, CustomHttpsConfiguration,
FrontendEndpointsEnableHttpsOptionalParams)
uid: '@azure/arm-frontdoor.FrontendEndpoints.beginEnableHttps'
package: '@azure/arm-frontdoor'
summary: Enables a frontendEndpoint for HTTPS traffic
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginEnableHttps(resourceGroupName: string, frontDoorName:
string, frontendEndpointName: string, customHttpsConfiguration:
CustomHttpsConfiguration, options?:
FrontendEndpointsEnableHttpsOptionalParams):
Promise<SimplePollerLike<OperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: Name of the Resource group within the Azure subscription.
- id: frontDoorName
type: string
description: Name of the Front Door which is globally unique.
- id: frontendEndpointName
type: string
description: Name of the Frontend endpoint which is unique within the Front Door.
- id: customHttpsConfiguration
type: <xref uid="@azure/arm-frontdoor.CustomHttpsConfiguration" />
description: The configuration specifying how to enable HTTPS
- id: options
type: >-
<xref
uid="@azure/arm-frontdoor.FrontendEndpointsEnableHttpsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><void>, void>>
- name: >-
beginEnableHttpsAndWait(string, string, string, CustomHttpsConfiguration,
FrontendEndpointsEnableHttpsOptionalParams)
uid: '@azure/arm-frontdoor.FrontendEndpoints.beginEnableHttpsAndWait'
package: '@azure/arm-frontdoor'
summary: Enables a frontendEndpoint for HTTPS traffic
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginEnableHttpsAndWait(resourceGroupName: string,
frontDoorName: string, frontendEndpointName: string,
customHttpsConfiguration: CustomHttpsConfiguration, options?:
FrontendEndpointsEnableHttpsOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: Name of the Resource group within the Azure subscription.
- id: frontDoorName
type: string
description: Name of the Front Door which is globally unique.
- id: frontendEndpointName
type: string
description: Name of the Frontend endpoint which is unique within the Front Door.
- id: customHttpsConfiguration
type: <xref uid="@azure/arm-frontdoor.CustomHttpsConfiguration" />
description: The configuration specifying how to enable HTTPS
- id: options
type: >-
<xref
uid="@azure/arm-frontdoor.FrontendEndpointsEnableHttpsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, FrontendEndpointsGetOptionalParams)
uid: '@azure/arm-frontdoor.FrontendEndpoints.get'
package: '@azure/arm-frontdoor'
summary: >-
Gets a Frontend endpoint with the specified name within the specified
Front Door.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, frontDoorName: string,
frontendEndpointName: string, options?:
FrontendEndpointsGetOptionalParams): Promise<FrontendEndpoint>
parameters:
- id: resourceGroupName
type: string
description: Name of the Resource group within the Azure subscription.
- id: frontDoorName
type: string
description: Name of the Front Door which is globally unique.
- id: frontendEndpointName
type: string
description: Name of the Frontend endpoint which is unique within the Front Door.
- id: options
type: >-
<xref uid="@azure/arm-frontdoor.FrontendEndpointsGetOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-frontdoor.FrontendEndpoint" />>
- name: >-
listByFrontDoor(string, string,
FrontendEndpointsListByFrontDoorOptionalParams)
uid: '@azure/arm-frontdoor.FrontendEndpoints.listByFrontDoor'
package: '@azure/arm-frontdoor'
summary: Lists all of the frontend endpoints within a Front Door.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByFrontDoor(resourceGroupName: string, frontDoorName:
string, options?: FrontendEndpointsListByFrontDoorOptionalParams):
PagedAsyncIterableIterator<FrontendEndpoint, FrontendEndpoint[],
PageSettings>
parameters:
- id: resourceGroupName
type: string
description: Name of the Resource group within the Azure subscription.
- id: frontDoorName
type: string
description: Name of the Front Door which is globally unique.
- id: options
type: >-
<xref
uid="@azure/arm-frontdoor.FrontendEndpointsListByFrontDoorOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-frontdoor.FrontendEndpoint" />, <xref
uid="@azure/arm-frontdoor.FrontendEndpoint" />[], <xref
uid="@azure/core-paging.PageSettings" />>