/
com.microsoft.azure.management.network.NetworkWatcher.yml
186 lines (186 loc) · 16.6 KB
/
com.microsoft.azure.management.network.NetworkWatcher.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
### YamlMime:JavaType
uid: "com.microsoft.azure.management.network.NetworkWatcher"
fullName: "com.microsoft.azure.management.network.NetworkWatcher"
name: "NetworkWatcher"
nameWithType: "NetworkWatcher"
summary: "Entry point for Network Watcher API in Azure."
syntax: "public interface **NetworkWatcher**</br> extends <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.network.implementation.NetworkManager?alt=com.microsoft.azure.management.network.implementation.NetworkManager&text=NetworkManager\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.management.network.implementation.NetworkWatcherInner?alt=com.microsoft.azure.management.network.implementation.NetworkWatcherInner&text=NetworkWatcherInner\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Refreshable?alt=com.microsoft.azure.management.resources.fluentcore.model.Refreshable&text=Refreshable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.network.NetworkWatcher?alt=com.microsoft.azure.management.network.NetworkWatcher&text=NetworkWatcher\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Updatable?alt=com.microsoft.azure.management.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.network.NetworkWatcher.Update?alt=com.microsoft.azure.management.network.NetworkWatcher.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.network.model.UpdatableWithTags?alt=com.microsoft.azure.management.network.model.UpdatableWithTags&text=UpdatableWithTags\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.network.NetworkWatcher?alt=com.microsoft.azure.management.network.NetworkWatcher&text=NetworkWatcher\" data-throw-if-not-resolved=\"False\" />>"
methods:
- uid: "com.microsoft.azure.management.network.NetworkWatcher.availableProviders()"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.availableProviders()"
name: "availableProviders()"
nameWithType: "NetworkWatcher.availableProviders()"
summary: "Lists all available internet service providers for a specified Azure region."
modifiers:
- "abstract"
syntax: "public abstract AvailableProviders.DefinitionStages.WithExecute availableProviders()"
desc: "Lists all available internet service providers for a specified Azure region."
returns:
description: "a stage to specify parameters for internet providers list"
type: "<xref href=\"com.microsoft.azure.management.network.AvailableProviders.DefinitionStages.WithExecute?alt=com.microsoft.azure.management.network.AvailableProviders.DefinitionStages.WithExecute&text=WithExecute\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.azureReachabilityReport()"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.azureReachabilityReport()"
name: "azureReachabilityReport()"
nameWithType: "NetworkWatcher.azureReachabilityReport()"
summary: "Gets the relative latency score for internet service providers from a specified location to Azure regions."
modifiers:
- "abstract"
syntax: "public abstract AzureReachabilityReport.DefinitionStages.WithProviderLocation azureReachabilityReport()"
desc: "Gets the relative latency score for internet service providers from a specified location to Azure regions."
returns:
description: "a stage to specify parameters for internet providers list"
type: "<xref href=\"com.microsoft.azure.management.network.AzureReachabilityReport.DefinitionStages.WithProviderLocation?alt=com.microsoft.azure.management.network.AzureReachabilityReport.DefinitionStages.WithProviderLocation&text=WithProviderLocation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.checkConnectivity()"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.checkConnectivity()"
name: "checkConnectivity()"
nameWithType: "NetworkWatcher.checkConnectivity()"
summary: "Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another virtual machine or an arbitrary remote server."
modifiers:
- "abstract"
syntax: "public abstract ConnectivityCheck.DefinitionStages.ToDestination checkConnectivity()"
desc: "Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another virtual machine or an arbitrary remote server."
returns:
description: "a stage to specify parameters for connectivity check"
type: "<xref href=\"com.microsoft.azure.management.network.ConnectivityCheck.DefinitionStages.ToDestination?alt=com.microsoft.azure.management.network.ConnectivityCheck.DefinitionStages.ToDestination&text=ToDestination\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.connectionMonitors()"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.connectionMonitors()"
name: "connectionMonitors()"
nameWithType: "NetworkWatcher.connectionMonitors()"
modifiers:
- "abstract"
syntax: "public abstract ConnectionMonitors connectionMonitors()"
returns:
description: "entry point to manage connection monitors associated with network watcher"
type: "<xref href=\"com.microsoft.azure.management.network.ConnectionMonitors?alt=com.microsoft.azure.management.network.ConnectionMonitors&text=ConnectionMonitors\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.getFlowLogSettings(java.lang.String)"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.getFlowLogSettings(String nsgId)"
name: "getFlowLogSettings(String nsgId)"
nameWithType: "NetworkWatcher.getFlowLogSettings(String nsgId)"
summary: "Gets the information on the configuration of flow log."
modifiers:
- "abstract"
parameters:
- description: "the name of the target resource group to get flow log status for"
name: "nsgId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract FlowLogSettings getFlowLogSettings(String nsgId)"
desc: "Gets the information on the configuration of flow log."
returns:
description: "information on the configuration of flow log"
type: "<xref href=\"com.microsoft.azure.management.network.FlowLogSettings?alt=com.microsoft.azure.management.network.FlowLogSettings&text=FlowLogSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.getFlowLogSettingsAsync(java.lang.String)"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.getFlowLogSettingsAsync(String nsgId)"
name: "getFlowLogSettingsAsync(String nsgId)"
nameWithType: "NetworkWatcher.getFlowLogSettingsAsync(String nsgId)"
summary: "Gets the information on the configuration of flow log asynchronously."
modifiers:
- "abstract"
parameters:
- description: "the name of the target resource group to get flow log status for"
name: "nsgId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Observable<FlowLogSettings> getFlowLogSettingsAsync(String nsgId)"
desc: "Gets the information on the configuration of flow log asynchronously."
returns:
description: "information on the configuration of flow log"
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.network.FlowLogSettings?alt=com.microsoft.azure.management.network.FlowLogSettings&text=FlowLogSettings\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.getSecurityGroupView(java.lang.String)"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.getSecurityGroupView(String vmId)"
name: "getSecurityGroupView(String vmId)"
nameWithType: "NetworkWatcher.getSecurityGroupView(String vmId)"
summary: "Gets the configured and effective security group rules on the specified VM."
modifiers:
- "abstract"
parameters:
- description: "ID of the target VM"
name: "vmId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract SecurityGroupView getSecurityGroupView(String vmId)"
desc: "Gets the configured and effective security group rules on the specified VM."
returns:
description: "the configured and effective security group rules on the specified VM"
type: "<xref href=\"com.microsoft.azure.management.network.SecurityGroupView?alt=com.microsoft.azure.management.network.SecurityGroupView&text=SecurityGroupView\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.getSecurityGroupViewAsync(java.lang.String)"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.getSecurityGroupViewAsync(String vmId)"
name: "getSecurityGroupViewAsync(String vmId)"
nameWithType: "NetworkWatcher.getSecurityGroupViewAsync(String vmId)"
summary: "Gets the configured and effective security group rules on the specified VM asynchronously."
modifiers:
- "abstract"
parameters:
- description: "ID of the target VM"
name: "vmId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Observable<SecurityGroupView> getSecurityGroupViewAsync(String vmId)"
desc: "Gets the configured and effective security group rules on the specified VM asynchronously."
returns:
description: "the configured and effective security group rules on the specified VM"
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.network.SecurityGroupView?alt=com.microsoft.azure.management.network.SecurityGroupView&text=SecurityGroupView\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.nextHop()"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.nextHop()"
name: "nextHop()"
nameWithType: "NetworkWatcher.nextHop()"
summary: "First step specifying the parameters to get next hop for the VM."
modifiers:
- "abstract"
syntax: "public abstract NextHop.DefinitionStages.WithTargetResource nextHop()"
desc: "First step specifying the parameters to get next hop for the VM."
returns:
description: "a stage to specify parameters for next hop"
type: "<xref href=\"com.microsoft.azure.management.network.NextHop.DefinitionStages.WithTargetResource?alt=com.microsoft.azure.management.network.NextHop.DefinitionStages.WithTargetResource&text=WithTargetResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.packetCaptures()"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.packetCaptures()"
name: "packetCaptures()"
nameWithType: "NetworkWatcher.packetCaptures()"
modifiers:
- "abstract"
syntax: "public abstract PacketCaptures packetCaptures()"
returns:
description: "entry point to manage packet captures associated with network watcher"
type: "<xref href=\"com.microsoft.azure.management.network.PacketCaptures?alt=com.microsoft.azure.management.network.PacketCaptures&text=PacketCaptures\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.topology()"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.topology()"
name: "topology()"
nameWithType: "NetworkWatcher.topology()"
summary: "First step specifying parameters to get topology of a resource group."
modifiers:
- "abstract"
syntax: "public abstract Topology.DefinitionStages.WithTargetResourceGroup topology()"
desc: "First step specifying parameters to get topology of a resource group."
returns:
description: "current network topology by resource group"
type: "<xref href=\"com.microsoft.azure.management.network.Topology.DefinitionStages.WithTargetResourceGroup?alt=com.microsoft.azure.management.network.Topology.DefinitionStages.WithTargetResourceGroup&text=WithTargetResourceGroup\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.troubleshoot()"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.troubleshoot()"
name: "troubleshoot()"
nameWithType: "NetworkWatcher.troubleshoot()"
summary: "Initiate troubleshooting on a specified resource (virtual network gateway or virtual network gateway connection)."
modifiers:
- "abstract"
syntax: "public abstract Troubleshooting.DefinitionStages.WithTargetResource troubleshoot()"
desc: "Initiate troubleshooting on a specified resource (virtual network gateway or virtual network gateway connection)."
returns:
description: "troubleshooting result information"
type: "<xref href=\"com.microsoft.azure.management.network.Troubleshooting.DefinitionStages.WithTargetResource?alt=com.microsoft.azure.management.network.Troubleshooting.DefinitionStages.WithTargetResource&text=WithTargetResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.network.NetworkWatcher.verifyIPFlow()"
fullName: "com.microsoft.azure.management.network.NetworkWatcher.verifyIPFlow()"
name: "verifyIPFlow()"
nameWithType: "NetworkWatcher.verifyIPFlow()"
summary: "Verify IP flow from the specified VM to a location given the currently configured NSG rules."
modifiers:
- "abstract"
syntax: "public abstract VerificationIPFlow.DefinitionStages.WithTargetResource verifyIPFlow()"
desc: "Verify IP flow from the specified VM to a location given the currently configured NSG rules."
returns:
description: "a stage to specify parameters for ip flow verification"
type: "<xref href=\"com.microsoft.azure.management.network.VerificationIPFlow.DefinitionStages.WithTargetResource?alt=com.microsoft.azure.management.network.VerificationIPFlow.DefinitionStages.WithTargetResource&text=WithTargetResource\" data-throw-if-not-resolved=\"False\" />"
type: "interface"
desc: "Entry point for Network Watcher API in Azure."
implements:
- "<xref href=\"com.microsoft.azure.management.network.model.UpdatableWithTags?alt=com.microsoft.azure.management.network.model.UpdatableWithTags&text=UpdatableWithTags\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.network.NetworkWatcher?alt=com.microsoft.azure.management.network.NetworkWatcher&text=NetworkWatcher\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.network.implementation.NetworkManager?alt=com.microsoft.azure.management.network.implementation.NetworkManager&text=NetworkManager\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.management.network.implementation.NetworkWatcherInner?alt=com.microsoft.azure.management.network.implementation.NetworkWatcherInner&text=NetworkWatcherInner\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Refreshable?alt=com.microsoft.azure.management.resources.fluentcore.model.Refreshable&text=Refreshable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.network.NetworkWatcher?alt=com.microsoft.azure.management.network.NetworkWatcher&text=NetworkWatcher\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Updatable?alt=com.microsoft.azure.management.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.network.NetworkWatcher.Update?alt=com.microsoft.azure.management.network.NetworkWatcher.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.microsoft.azure.management.network"
artifact: com.microsoft.azure:azure-mgmt-network:1.41.4