-
Notifications
You must be signed in to change notification settings - Fork 221
/
com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.yml
230 lines (230 loc) · 19.6 KB
/
com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.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
### YamlMime:JavaType
uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner"
name: "FrontendEndpointInner"
nameWithType: "FrontendEndpointInner"
summary: "A frontend endpoint used for routing."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.SubResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.core.management.SubResource?alt=com.azure.core.management.SubResource&text=SubResource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.core.management.SubResource.id()?alt=com.azure.core.management.SubResource.id&text=id\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.SubResource.withId(java.lang.String)?alt=com.azure.core.management.SubResource.withId&text=withId\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **FrontendEndpointInner**</br> extends <xref href=\"com.azure.core.management.SubResource?alt=com.azure.core.management.SubResource&text=SubResource\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.FrontendEndpointInner()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.FrontendEndpointInner()"
name: "FrontendEndpointInner()"
nameWithType: "FrontendEndpointInner.FrontendEndpointInner()"
summary: "Creates an instance of Frontend<wbr>Endpoint<wbr>Inner class."
syntax: "public FrontendEndpointInner()"
desc: "Creates an instance of FrontendEndpointInner class."
methods:
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.customHttpsConfiguration()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.customHttpsConfiguration()"
name: "customHttpsConfiguration()"
nameWithType: "FrontendEndpointInner.customHttpsConfiguration()"
summary: "Get the custom<wbr>Https<wbr>Configuration property: The configuration specifying how to enable HTTPS."
syntax: "public CustomHttpsConfiguration customHttpsConfiguration()"
desc: "Get the customHttpsConfiguration property: The configuration specifying how to enable HTTPS."
returns:
description: "the customHttpsConfiguration value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.CustomHttpsConfiguration?alt=com.azure.resourcemanager.frontdoor.models.CustomHttpsConfiguration&text=CustomHttpsConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.customHttpsProvisioningState()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.customHttpsProvisioningState()"
name: "customHttpsProvisioningState()"
nameWithType: "FrontendEndpointInner.customHttpsProvisioningState()"
summary: "Get the custom<wbr>Https<wbr>Provisioning<wbr>State property: Provisioning status of Custom Https of the frontend<wbr>Endpoint."
syntax: "public CustomHttpsProvisioningState customHttpsProvisioningState()"
desc: "Get the customHttpsProvisioningState property: Provisioning status of Custom Https of the frontendEndpoint."
returns:
description: "the customHttpsProvisioningState value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.CustomHttpsProvisioningState?alt=com.azure.resourcemanager.frontdoor.models.CustomHttpsProvisioningState&text=CustomHttpsProvisioningState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.customHttpsProvisioningSubstate()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.customHttpsProvisioningSubstate()"
name: "customHttpsProvisioningSubstate()"
nameWithType: "FrontendEndpointInner.customHttpsProvisioningSubstate()"
summary: "Get the custom<wbr>Https<wbr>Provisioning<wbr>Substate property: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step."
syntax: "public CustomHttpsProvisioningSubstate customHttpsProvisioningSubstate()"
desc: "Get the customHttpsProvisioningSubstate property: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step."
returns:
description: "the customHttpsProvisioningSubstate value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.CustomHttpsProvisioningSubstate?alt=com.azure.resourcemanager.frontdoor.models.CustomHttpsProvisioningSubstate&text=CustomHttpsProvisioningSubstate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.hostname()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.hostname()"
name: "hostname()"
nameWithType: "FrontendEndpointInner.hostname()"
summary: "Get the hostname property: The host name of the frontend<wbr>Endpoint."
syntax: "public String hostname()"
desc: "Get the hostname property: The host name of the frontendEndpoint. Must be a domain name."
returns:
description: "the hostname value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.name()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.name()"
name: "name()"
nameWithType: "FrontendEndpointInner.name()"
summary: "Get the name property: Resource name."
syntax: "public String name()"
desc: "Get the name property: Resource name."
returns:
description: "the name value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.resourceState()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.resourceState()"
name: "resourceState()"
nameWithType: "FrontendEndpointInner.resourceState()"
summary: "Get the resource<wbr>State property: Resource status of the Front Door or Front Door Sub<wbr>Resource."
syntax: "public FrontDoorResourceState resourceState()"
desc: "Get the resourceState property: Resource status of the Front Door or Front Door SubResource.\n\nResource status."
returns:
description: "the resourceState value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoorResourceState?alt=com.azure.resourcemanager.frontdoor.models.FrontDoorResourceState&text=FrontDoorResourceState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.sessionAffinityEnabledState()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.sessionAffinityEnabledState()"
name: "sessionAffinityEnabledState()"
nameWithType: "FrontendEndpointInner.sessionAffinityEnabledState()"
summary: "Get the session<wbr>Affinity<wbr>Enabled<wbr>State property: Whether to allow session affinity on this host."
syntax: "public SessionAffinityEnabledState sessionAffinityEnabledState()"
desc: "Get the sessionAffinityEnabledState property: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'."
returns:
description: "the sessionAffinityEnabledState value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.SessionAffinityEnabledState?alt=com.azure.resourcemanager.frontdoor.models.SessionAffinityEnabledState&text=SessionAffinityEnabledState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.sessionAffinityTtlSeconds()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.sessionAffinityTtlSeconds()"
name: "sessionAffinityTtlSeconds()"
nameWithType: "FrontendEndpointInner.sessionAffinityTtlSeconds()"
summary: "Get the session<wbr>Affinity<wbr>Ttl<wbr>Seconds property: UNUSED."
syntax: "public Integer sessionAffinityTtlSeconds()"
desc: "Get the sessionAffinityTtlSeconds property: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable."
returns:
description: "the sessionAffinityTtlSeconds value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.type()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.type()"
name: "type()"
nameWithType: "FrontendEndpointInner.type()"
summary: "Get the type property: Resource type."
syntax: "public String type()"
desc: "Get the type property: Resource type."
returns:
description: "the type value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.validate()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.validate()"
name: "validate()"
nameWithType: "FrontendEndpointInner.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.webApplicationFirewallPolicyLink()"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.webApplicationFirewallPolicyLink()"
name: "webApplicationFirewallPolicyLink()"
nameWithType: "FrontendEndpointInner.webApplicationFirewallPolicyLink()"
summary: "Get the web<wbr>Application<wbr>Firewall<wbr>Policy<wbr>Link property: Defines the Web Application Firewall policy for each host (if applicable)."
syntax: "public FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink()"
desc: "Get the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for each host (if applicable)."
returns:
description: "the webApplicationFirewallPolicyLink value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink?alt=com.azure.resourcemanager.frontdoor.models.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink&text=FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withHostname(java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withHostname(String hostname)"
name: "withHostname(String hostname)"
nameWithType: "FrontendEndpointInner.withHostname(String hostname)"
summary: "Set the hostname property: The host name of the frontend<wbr>Endpoint."
parameters:
- description: "the hostname value to set."
name: "hostname"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FrontendEndpointInner withHostname(String hostname)"
desc: "Set the hostname property: The host name of the frontendEndpoint. Must be a domain name."
returns:
description: "the FrontendEndpointInner object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner?alt=com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner&text=FrontendEndpointInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withId(java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withId(String id)"
name: "withId(String id)"
nameWithType: "FrontendEndpointInner.withId(String id)"
overridden: "com.azure.core.management.SubResource.withId(java.lang.String)"
parameters:
- name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FrontendEndpointInner withId(String id)"
returns:
type: "<xref href=\"com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner?alt=com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner&text=FrontendEndpointInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withName(java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withName(String name)"
name: "withName(String name)"
nameWithType: "FrontendEndpointInner.withName(String name)"
summary: "Set the name property: Resource name."
parameters:
- description: "the name value to set."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FrontendEndpointInner withName(String name)"
desc: "Set the name property: Resource name."
returns:
description: "the FrontendEndpointInner object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner?alt=com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner&text=FrontendEndpointInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withSessionAffinityEnabledState(com.azure.resourcemanager.frontdoor.models.SessionAffinityEnabledState)"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withSessionAffinityEnabledState(SessionAffinityEnabledState sessionAffinityEnabledState)"
name: "withSessionAffinityEnabledState(SessionAffinityEnabledState sessionAffinityEnabledState)"
nameWithType: "FrontendEndpointInner.withSessionAffinityEnabledState(SessionAffinityEnabledState sessionAffinityEnabledState)"
summary: "Set the session<wbr>Affinity<wbr>Enabled<wbr>State property: Whether to allow session affinity on this host."
parameters:
- description: "the sessionAffinityEnabledState value to set."
name: "sessionAffinityEnabledState"
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.SessionAffinityEnabledState?alt=com.azure.resourcemanager.frontdoor.models.SessionAffinityEnabledState&text=SessionAffinityEnabledState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FrontendEndpointInner withSessionAffinityEnabledState(SessionAffinityEnabledState sessionAffinityEnabledState)"
desc: "Set the sessionAffinityEnabledState property: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'."
returns:
description: "the FrontendEndpointInner object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner?alt=com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner&text=FrontendEndpointInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withSessionAffinityTtlSeconds(java.lang.Integer)"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withSessionAffinityTtlSeconds(Integer sessionAffinityTtlSeconds)"
name: "withSessionAffinityTtlSeconds(Integer sessionAffinityTtlSeconds)"
nameWithType: "FrontendEndpointInner.withSessionAffinityTtlSeconds(Integer sessionAffinityTtlSeconds)"
summary: "Set the session<wbr>Affinity<wbr>Ttl<wbr>Seconds property: UNUSED."
parameters:
- description: "the sessionAffinityTtlSeconds value to set."
name: "sessionAffinityTtlSeconds"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public FrontendEndpointInner withSessionAffinityTtlSeconds(Integer sessionAffinityTtlSeconds)"
desc: "Set the sessionAffinityTtlSeconds property: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable."
returns:
description: "the FrontendEndpointInner object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner?alt=com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner&text=FrontendEndpointInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withWebApplicationFirewallPolicyLink(com.azure.resourcemanager.frontdoor.models.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink)"
fullName: "com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner.withWebApplicationFirewallPolicyLink(FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)"
name: "withWebApplicationFirewallPolicyLink(FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)"
nameWithType: "FrontendEndpointInner.withWebApplicationFirewallPolicyLink(FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)"
summary: "Set the web<wbr>Application<wbr>Firewall<wbr>Policy<wbr>Link property: Defines the Web Application Firewall policy for each host (if applicable)."
parameters:
- description: "the webApplicationFirewallPolicyLink value to set."
name: "webApplicationFirewallPolicyLink"
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink?alt=com.azure.resourcemanager.frontdoor.models.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink&text=FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FrontendEndpointInner withWebApplicationFirewallPolicyLink(FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)"
desc: "Set the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for each host (if applicable)."
returns:
description: "the FrontendEndpointInner object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner?alt=com.azure.resourcemanager.frontdoor.fluent.models.FrontendEndpointInner&text=FrontendEndpointInner\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A frontend endpoint used for routing."
metadata: {}
package: "com.azure.resourcemanager.frontdoor.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-frontdoor:1.0.0-beta.3