-
Notifications
You must be signed in to change notification settings - Fork 180
/
Probe.yml
163 lines (162 loc) · 5.54 KB
/
Probe.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
### YamlMime:TSType
name: Probe
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: A load balancer probe.
fullName: Probe
remarks: ''
isDeprecated: false
type: interface
properties:
- name: etag
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe.etag'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: A unique read-only string that changes whenever the resource is updated.
fullName: etag
remarks: ''
isDeprecated: false
syntax:
content: 'etag?: string'
return:
description: ''
type: string
- name: intervalInSeconds
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe.intervalInSeconds'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: >-
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.
fullName: intervalInSeconds
remarks: ''
isDeprecated: false
syntax:
content: 'intervalInSeconds?: number'
return:
description: ''
type: number
- name: loadBalancingRules
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe.loadBalancingRules'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: >-
The load balancer rules that use this probe.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: loadBalancingRules
remarks: ''
isDeprecated: false
syntax:
content: 'loadBalancingRules?: SubResource[]'
return:
description: ''
type: >-
<xref uid="@azure/arm-network-profile-2020-09-01-hybrid.SubResource"
/>[]
- name: name
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe.name'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: >-
Gets name of the resource that is unique within a resource group. This
name can be used to access the resource.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
- name: numberOfProbes
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe.numberOfProbes'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: >-
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.
fullName: numberOfProbes
remarks: ''
isDeprecated: false
syntax:
content: 'numberOfProbes?: number'
return:
description: ''
type: number
- name: port
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe.port'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: >-
The port for communicating the probe. Possible values range from 1 to
65535, inclusive.
fullName: port
remarks: ''
isDeprecated: false
syntax:
content: 'port?: number'
return:
description: ''
type: number
- name: protocol
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe.protocol'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: >-
The protocol of the end point. Possible values are: 'Http', 'Tcp', or
'Https'. 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.
fullName: protocol
remarks: ''
isDeprecated: false
syntax:
content: 'protocol?: string'
return:
description: ''
type: string
- name: provisioningState
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe.provisioningState'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: >-
Gets the provisioning state of the public IP resource. Possible values
are: 'Updating', 'Deleting', and 'Failed'.
fullName: provisioningState
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningState?: string'
return:
description: ''
type: string
- name: requestPath
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe.requestPath'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: >-
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.
fullName: requestPath
remarks: ''
isDeprecated: false
syntax:
content: 'requestPath?: string'
return:
description: ''
type: string
inheritedProperties:
- name: id
uid: '@azure/arm-network-profile-2020-09-01-hybrid.Probe.id'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: Resource ID.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[SubResource.id](xref:@azure/arm-network-profile-2020-09-01-hybrid.SubResource.id)
extends: <xref uid="@azure/arm-network-profile-2020-09-01-hybrid.SubResource" />