-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.yml
224 lines (224 loc) · 17.4 KB
/
com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.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
### YamlMime:JavaType
uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel"
name: "HealthProbeSettingsModel"
nameWithType: "HealthProbeSettingsModel"
summary: "Load balancing settings for a backend pool."
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 **HealthProbeSettingsModel**</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.models.HealthProbeSettingsModel.HealthProbeSettingsModel()"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.HealthProbeSettingsModel()"
name: "HealthProbeSettingsModel()"
nameWithType: "HealthProbeSettingsModel.HealthProbeSettingsModel()"
summary: "Creates an instance of Health<wbr>Probe<wbr>Settings<wbr>Model class."
syntax: "public HealthProbeSettingsModel()"
desc: "Creates an instance of HealthProbeSettingsModel class."
methods:
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.enabledState()"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.enabledState()"
name: "enabledState()"
nameWithType: "HealthProbeSettingsModel.enabledState()"
summary: "Get the enabled<wbr>State property: Whether to enable health probes to be made against backends defined under backend<wbr>Pools."
syntax: "public HealthProbeEnabled enabledState()"
desc: "Get the enabledState property: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool."
returns:
description: "the enabledState value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.HealthProbeEnabled?alt=com.azure.resourcemanager.frontdoor.models.HealthProbeEnabled&text=HealthProbeEnabled\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.healthProbeMethod()"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.healthProbeMethod()"
name: "healthProbeMethod()"
nameWithType: "HealthProbeSettingsModel.healthProbeMethod()"
summary: "Get the health<wbr>Probe<wbr>Method property: Configures which HTTP method to use to probe the backends defined under backend<wbr>Pools."
syntax: "public FrontDoorHealthProbeMethod healthProbeMethod()"
desc: "Get the healthProbeMethod property: Configures which HTTP method to use to probe the backends defined under backendPools."
returns:
description: "the healthProbeMethod value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoorHealthProbeMethod?alt=com.azure.resourcemanager.frontdoor.models.FrontDoorHealthProbeMethod&text=FrontDoorHealthProbeMethod\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.intervalInSeconds()"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.intervalInSeconds()"
name: "intervalInSeconds()"
nameWithType: "HealthProbeSettingsModel.intervalInSeconds()"
summary: "Get the interval<wbr>InSeconds property: The number of seconds between health probes."
syntax: "public Integer intervalInSeconds()"
desc: "Get the intervalInSeconds property: The number of seconds between health probes."
returns:
description: "the intervalInSeconds value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.name()"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.name()"
name: "name()"
nameWithType: "HealthProbeSettingsModel.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.models.HealthProbeSettingsModel.path()"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.path()"
name: "path()"
nameWithType: "HealthProbeSettingsModel.path()"
summary: "Get the path property: The path to use for the health probe."
syntax: "public String path()"
desc: "Get the path property: The path to use for the health probe. Default is /."
returns:
description: "the path value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.protocol()"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.protocol()"
name: "protocol()"
nameWithType: "HealthProbeSettingsModel.protocol()"
summary: "Get the protocol property: Protocol scheme to use for this probe."
syntax: "public FrontDoorProtocol protocol()"
desc: "Get the protocol property: Protocol scheme to use for this probe."
returns:
description: "the protocol value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoorProtocol?alt=com.azure.resourcemanager.frontdoor.models.FrontDoorProtocol&text=FrontDoorProtocol\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.resourceState()"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.resourceState()"
name: "resourceState()"
nameWithType: "HealthProbeSettingsModel.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.models.HealthProbeSettingsModel.type()"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.type()"
name: "type()"
nameWithType: "HealthProbeSettingsModel.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.models.HealthProbeSettingsModel.validate()"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.validate()"
name: "validate()"
nameWithType: "HealthProbeSettingsModel.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withEnabledState(com.azure.resourcemanager.frontdoor.models.HealthProbeEnabled)"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withEnabledState(HealthProbeEnabled enabledState)"
name: "withEnabledState(HealthProbeEnabled enabledState)"
nameWithType: "HealthProbeSettingsModel.withEnabledState(HealthProbeEnabled enabledState)"
summary: "Set the enabled<wbr>State property: Whether to enable health probes to be made against backends defined under backend<wbr>Pools."
parameters:
- description: "the enabledState value to set."
name: "enabledState"
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.HealthProbeEnabled?alt=com.azure.resourcemanager.frontdoor.models.HealthProbeEnabled&text=HealthProbeEnabled\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HealthProbeSettingsModel withEnabledState(HealthProbeEnabled enabledState)"
desc: "Set the enabledState property: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool."
returns:
description: "the HealthProbeSettingsModel object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel?alt=com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel&text=HealthProbeSettingsModel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withHealthProbeMethod(com.azure.resourcemanager.frontdoor.models.FrontDoorHealthProbeMethod)"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withHealthProbeMethod(FrontDoorHealthProbeMethod healthProbeMethod)"
name: "withHealthProbeMethod(FrontDoorHealthProbeMethod healthProbeMethod)"
nameWithType: "HealthProbeSettingsModel.withHealthProbeMethod(FrontDoorHealthProbeMethod healthProbeMethod)"
summary: "Set the health<wbr>Probe<wbr>Method property: Configures which HTTP method to use to probe the backends defined under backend<wbr>Pools."
parameters:
- description: "the healthProbeMethod value to set."
name: "healthProbeMethod"
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoorHealthProbeMethod?alt=com.azure.resourcemanager.frontdoor.models.FrontDoorHealthProbeMethod&text=FrontDoorHealthProbeMethod\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HealthProbeSettingsModel withHealthProbeMethod(FrontDoorHealthProbeMethod healthProbeMethod)"
desc: "Set the healthProbeMethod property: Configures which HTTP method to use to probe the backends defined under backendPools."
returns:
description: "the HealthProbeSettingsModel object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel?alt=com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel&text=HealthProbeSettingsModel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withId(java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withId(String id)"
name: "withId(String id)"
nameWithType: "HealthProbeSettingsModel.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 HealthProbeSettingsModel withId(String id)"
returns:
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel?alt=com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel&text=HealthProbeSettingsModel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withIntervalInSeconds(java.lang.Integer)"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withIntervalInSeconds(Integer intervalInSeconds)"
name: "withIntervalInSeconds(Integer intervalInSeconds)"
nameWithType: "HealthProbeSettingsModel.withIntervalInSeconds(Integer intervalInSeconds)"
summary: "Set the interval<wbr>InSeconds property: The number of seconds between health probes."
parameters:
- description: "the intervalInSeconds value to set."
name: "intervalInSeconds"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public HealthProbeSettingsModel withIntervalInSeconds(Integer intervalInSeconds)"
desc: "Set the intervalInSeconds property: The number of seconds between health probes."
returns:
description: "the HealthProbeSettingsModel object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel?alt=com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel&text=HealthProbeSettingsModel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withName(java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withName(String name)"
name: "withName(String name)"
nameWithType: "HealthProbeSettingsModel.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 HealthProbeSettingsModel withName(String name)"
desc: "Set the name property: Resource name."
returns:
description: "the HealthProbeSettingsModel object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel?alt=com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel&text=HealthProbeSettingsModel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withPath(java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withPath(String path)"
name: "withPath(String path)"
nameWithType: "HealthProbeSettingsModel.withPath(String path)"
summary: "Set the path property: The path to use for the health probe."
parameters:
- description: "the path value to set."
name: "path"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public HealthProbeSettingsModel withPath(String path)"
desc: "Set the path property: The path to use for the health probe. Default is /."
returns:
description: "the HealthProbeSettingsModel object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel?alt=com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel&text=HealthProbeSettingsModel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withProtocol(com.azure.resourcemanager.frontdoor.models.FrontDoorProtocol)"
fullName: "com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel.withProtocol(FrontDoorProtocol protocol)"
name: "withProtocol(FrontDoorProtocol protocol)"
nameWithType: "HealthProbeSettingsModel.withProtocol(FrontDoorProtocol protocol)"
summary: "Set the protocol property: Protocol scheme to use for this probe."
parameters:
- description: "the protocol value to set."
name: "protocol"
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoorProtocol?alt=com.azure.resourcemanager.frontdoor.models.FrontDoorProtocol&text=FrontDoorProtocol\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HealthProbeSettingsModel withProtocol(FrontDoorProtocol protocol)"
desc: "Set the protocol property: Protocol scheme to use for this probe."
returns:
description: "the HealthProbeSettingsModel object itself."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel?alt=com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel&text=HealthProbeSettingsModel\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Load balancing settings for a backend pool."
metadata: {}
package: "com.azure.resourcemanager.frontdoor.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-frontdoor:1.0.0-beta.3