/
com.azure.resourcemanager.network.fluent.models.ProbeInner.yml
268 lines (268 loc) · 20.7 KB
/
com.azure.resourcemanager.network.fluent.models.ProbeInner.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
### YamlMime:JavaType
uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner"
name: "ProbeInner"
nameWithType: "ProbeInner"
summary: "A load balancer probe."
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 **ProbeInner**</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.network.fluent.models.ProbeInner.ProbeInner()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.ProbeInner()"
name: "ProbeInner()"
nameWithType: "ProbeInner.ProbeInner()"
summary: "Creates an instance of Probe<wbr>Inner class."
syntax: "public ProbeInner()"
desc: "Creates an instance of ProbeInner class."
methods:
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.etag()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.etag()"
name: "etag()"
nameWithType: "ProbeInner.etag()"
summary: "Get the etag property: A unique read-only string that changes whenever the resource is updated."
syntax: "public String etag()"
desc: "Get the etag property: A unique read-only string that changes whenever the resource is updated."
returns:
description: "the etag value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.intervalInSeconds()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.intervalInSeconds()"
name: "intervalInSeconds()"
nameWithType: "ProbeInner.intervalInSeconds()"
summary: "Get the interval<wbr>InSeconds property: The interval, in seconds, for how frequently to probe the endpoint for health status."
syntax: "public Integer intervalInSeconds()"
desc: "Get the intervalInSeconds property: The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5."
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.network.fluent.models.ProbeInner.loadBalancingRules()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.loadBalancingRules()"
name: "loadBalancingRules()"
nameWithType: "ProbeInner.loadBalancingRules()"
summary: "Get the load<wbr>Balancing<wbr>Rules property: The load balancer rules that use this probe."
syntax: "public List<SubResource> loadBalancingRules()"
desc: "Get the loadBalancingRules property: The load balancer rules that use this probe."
returns:
description: "the loadBalancingRules value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.core.management.SubResource?alt=com.azure.core.management.SubResource&text=SubResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.name()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.name()"
name: "name()"
nameWithType: "ProbeInner.name()"
summary: "Get the name property: The name of the resource that is unique within the set of probes used by the load balancer."
syntax: "public String name()"
desc: "Get the name property: The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource."
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.network.fluent.models.ProbeInner.numberOfProbes()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.numberOfProbes()"
name: "numberOfProbes()"
nameWithType: "ProbeInner.numberOfProbes()"
summary: "Get the number<wbr>OfProbes property: The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint."
syntax: "public Integer numberOfProbes()"
desc: "Get the numberOfProbes property: The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure."
returns:
description: "the numberOfProbes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.port()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.port()"
name: "port()"
nameWithType: "ProbeInner.port()"
summary: "Get the port property: The port for communicating the probe."
syntax: "public Integer port()"
desc: "Get the port property: The port for communicating the probe. Possible values range from 1 to 65535, inclusive."
returns:
description: "the port value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.probeThreshold()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.probeThreshold()"
name: "probeThreshold()"
nameWithType: "ProbeInner.probeThreshold()"
summary: "Get the probe<wbr>Threshold property: The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint."
syntax: "public Integer probeThreshold()"
desc: "Get the probeThreshold property: The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation."
returns:
description: "the probeThreshold value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.protocol()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.protocol()"
name: "protocol()"
nameWithType: "ProbeInner.protocol()"
summary: "Get the protocol property: The protocol of the end point."
syntax: "public ProbeProtocol protocol()"
desc: "Get the protocol property: The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful."
returns:
description: "the protocol value."
type: "<xref href=\"com.azure.resourcemanager.network.models.ProbeProtocol?alt=com.azure.resourcemanager.network.models.ProbeProtocol&text=ProbeProtocol\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.provisioningState()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.provisioningState()"
name: "provisioningState()"
nameWithType: "ProbeInner.provisioningState()"
summary: "Get the provisioning<wbr>State property: The provisioning state of the probe resource."
syntax: "public ProvisioningState provisioningState()"
desc: "Get the provisioningState property: The provisioning state of the probe resource."
returns:
description: "the provisioningState value."
type: "<xref href=\"com.azure.resourcemanager.network.models.ProvisioningState?alt=com.azure.resourcemanager.network.models.ProvisioningState&text=ProvisioningState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.requestPath()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.requestPath()"
name: "requestPath()"
nameWithType: "ProbeInner.requestPath()"
summary: "Get the request<wbr>Path property: The URI used for requesting health status from the VM."
syntax: "public String requestPath()"
desc: "Get the requestPath property: The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value."
returns:
description: "the requestPath value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.type()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.type()"
name: "type()"
nameWithType: "ProbeInner.type()"
summary: "Get the type property: Type of the resource."
syntax: "public String type()"
desc: "Get the type property: Type of the resource."
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.network.fluent.models.ProbeInner.validate()"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.validate()"
name: "validate()"
nameWithType: "ProbeInner.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withId(java.lang.String)"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withId(String id)"
name: "withId(String id)"
nameWithType: "ProbeInner.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 ProbeInner withId(String id)"
returns:
type: "<xref href=\"com.azure.resourcemanager.network.fluent.models.ProbeInner?alt=com.azure.resourcemanager.network.fluent.models.ProbeInner&text=ProbeInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withIntervalInSeconds(java.lang.Integer)"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withIntervalInSeconds(Integer intervalInSeconds)"
name: "withIntervalInSeconds(Integer intervalInSeconds)"
nameWithType: "ProbeInner.withIntervalInSeconds(Integer intervalInSeconds)"
summary: "Set the interval<wbr>InSeconds property: The interval, in seconds, for how frequently to probe the endpoint for health status."
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 ProbeInner withIntervalInSeconds(Integer intervalInSeconds)"
desc: "Set the intervalInSeconds property: The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5."
returns:
description: "the ProbeInner object itself."
type: "<xref href=\"com.azure.resourcemanager.network.fluent.models.ProbeInner?alt=com.azure.resourcemanager.network.fluent.models.ProbeInner&text=ProbeInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withName(java.lang.String)"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withName(String name)"
name: "withName(String name)"
nameWithType: "ProbeInner.withName(String name)"
summary: "Set the name property: The name of the resource that is unique within the set of probes used by the load balancer."
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 ProbeInner withName(String name)"
desc: "Set the name property: The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource."
returns:
description: "the ProbeInner object itself."
type: "<xref href=\"com.azure.resourcemanager.network.fluent.models.ProbeInner?alt=com.azure.resourcemanager.network.fluent.models.ProbeInner&text=ProbeInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withNumberOfProbes(java.lang.Integer)"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withNumberOfProbes(Integer numberOfProbes)"
name: "withNumberOfProbes(Integer numberOfProbes)"
nameWithType: "ProbeInner.withNumberOfProbes(Integer numberOfProbes)"
summary: "Set the number<wbr>OfProbes property: The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint."
parameters:
- description: "the numberOfProbes value to set."
name: "numberOfProbes"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ProbeInner withNumberOfProbes(Integer numberOfProbes)"
desc: "Set the numberOfProbes property: The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure."
returns:
description: "the ProbeInner object itself."
type: "<xref href=\"com.azure.resourcemanager.network.fluent.models.ProbeInner?alt=com.azure.resourcemanager.network.fluent.models.ProbeInner&text=ProbeInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withPort(java.lang.Integer)"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withPort(Integer port)"
name: "withPort(Integer port)"
nameWithType: "ProbeInner.withPort(Integer port)"
summary: "Set the port property: The port for communicating the probe."
parameters:
- description: "the port value to set."
name: "port"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ProbeInner withPort(Integer port)"
desc: "Set the port property: The port for communicating the probe. Possible values range from 1 to 65535, inclusive."
returns:
description: "the ProbeInner object itself."
type: "<xref href=\"com.azure.resourcemanager.network.fluent.models.ProbeInner?alt=com.azure.resourcemanager.network.fluent.models.ProbeInner&text=ProbeInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withProbeThreshold(java.lang.Integer)"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withProbeThreshold(Integer probeThreshold)"
name: "withProbeThreshold(Integer probeThreshold)"
nameWithType: "ProbeInner.withProbeThreshold(Integer probeThreshold)"
summary: "Set the probe<wbr>Threshold property: The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint."
parameters:
- description: "the probeThreshold value to set."
name: "probeThreshold"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ProbeInner withProbeThreshold(Integer probeThreshold)"
desc: "Set the probeThreshold property: The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation."
returns:
description: "the ProbeInner object itself."
type: "<xref href=\"com.azure.resourcemanager.network.fluent.models.ProbeInner?alt=com.azure.resourcemanager.network.fluent.models.ProbeInner&text=ProbeInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withProtocol(com.azure.resourcemanager.network.models.ProbeProtocol)"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withProtocol(ProbeProtocol protocol)"
name: "withProtocol(ProbeProtocol protocol)"
nameWithType: "ProbeInner.withProtocol(ProbeProtocol protocol)"
summary: "Set the protocol property: The protocol of the end point."
parameters:
- description: "the protocol value to set."
name: "protocol"
type: "<xref href=\"com.azure.resourcemanager.network.models.ProbeProtocol?alt=com.azure.resourcemanager.network.models.ProbeProtocol&text=ProbeProtocol\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ProbeInner withProtocol(ProbeProtocol protocol)"
desc: "Set the protocol property: The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful."
returns:
description: "the ProbeInner object itself."
type: "<xref href=\"com.azure.resourcemanager.network.fluent.models.ProbeInner?alt=com.azure.resourcemanager.network.fluent.models.ProbeInner&text=ProbeInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withRequestPath(java.lang.String)"
fullName: "com.azure.resourcemanager.network.fluent.models.ProbeInner.withRequestPath(String requestPath)"
name: "withRequestPath(String requestPath)"
nameWithType: "ProbeInner.withRequestPath(String requestPath)"
summary: "Set the request<wbr>Path property: The URI used for requesting health status from the VM."
parameters:
- description: "the requestPath value to set."
name: "requestPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ProbeInner withRequestPath(String requestPath)"
desc: "Set the requestPath property: The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value."
returns:
description: "the ProbeInner object itself."
type: "<xref href=\"com.azure.resourcemanager.network.fluent.models.ProbeInner?alt=com.azure.resourcemanager.network.fluent.models.ProbeInner&text=ProbeInner\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A load balancer probe."
metadata: {}
package: "com.azure.resourcemanager.network.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-network:2.39.0