-
Notifications
You must be signed in to change notification settings - Fork 180
/
FlowLogs.yml
226 lines (226 loc) · 8.78 KB
/
FlowLogs.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
### YamlMime:TSType
name: FlowLogs
uid: '@azure/arm-network.FlowLogs'
package: '@azure/arm-network'
summary: Interface representing a FlowLogs.
fullName: FlowLogs
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreateOrUpdate(string, string, string, FlowLog,
FlowLogsCreateOrUpdateOptionalParams)
uid: '@azure/arm-network.FlowLogs.beginCreateOrUpdate'
package: '@azure/arm-network'
summary: Create or update a flow log for the specified network security group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdate(resourceGroupName: string,
networkWatcherName: string, flowLogName: string, parameters: FlowLog,
options?: FlowLogsCreateOrUpdateOptionalParams):
Promise<SimplePollerLike<OperationState<FlowLog>, FlowLog>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: networkWatcherName
type: string
description: The name of the network watcher.
- id: flowLogName
type: string
description: The name of the flow log.
- id: parameters
type: <xref uid="@azure/arm-network.FlowLog" />
description: Parameters that define the create or update flow log resource.
- id: options
type: >-
<xref uid="@azure/arm-network.FlowLogsCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-network.FlowLog" />>, <xref
uid="@azure/arm-network.FlowLog" />>>
- name: >-
beginCreateOrUpdateAndWait(string, string, string, FlowLog,
FlowLogsCreateOrUpdateOptionalParams)
uid: '@azure/arm-network.FlowLogs.beginCreateOrUpdateAndWait'
package: '@azure/arm-network'
summary: Create or update a flow log for the specified network security group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdateAndWait(resourceGroupName: string,
networkWatcherName: string, flowLogName: string, parameters: FlowLog,
options?: FlowLogsCreateOrUpdateOptionalParams): Promise<FlowLog>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: networkWatcherName
type: string
description: The name of the network watcher.
- id: flowLogName
type: string
description: The name of the flow log.
- id: parameters
type: <xref uid="@azure/arm-network.FlowLog" />
description: Parameters that define the create or update flow log resource.
- id: options
type: >-
<xref uid="@azure/arm-network.FlowLogsCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-network.FlowLog" />>
- name: beginDelete(string, string, string, FlowLogsDeleteOptionalParams)
uid: '@azure/arm-network.FlowLogs.beginDelete'
package: '@azure/arm-network'
summary: Deletes the specified flow log resource.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, networkWatcherName:
string, flowLogName: string, options?: FlowLogsDeleteOptionalParams):
Promise<SimplePollerLike<OperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: networkWatcherName
type: string
description: The name of the network watcher.
- id: flowLogName
type: string
description: The name of the flow log resource.
- id: options
type: <xref uid="@azure/arm-network.FlowLogsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><void>, void>>
- name: beginDeleteAndWait(string, string, string, FlowLogsDeleteOptionalParams)
uid: '@azure/arm-network.FlowLogs.beginDeleteAndWait'
package: '@azure/arm-network'
summary: Deletes the specified flow log resource.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string,
networkWatcherName: string, flowLogName: string, options?:
FlowLogsDeleteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: networkWatcherName
type: string
description: The name of the network watcher.
- id: flowLogName
type: string
description: The name of the flow log resource.
- id: options
type: <xref uid="@azure/arm-network.FlowLogsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, FlowLogsGetOptionalParams)
uid: '@azure/arm-network.FlowLogs.get'
package: '@azure/arm-network'
summary: Gets a flow log resource by name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, networkWatcherName: string,
flowLogName: string, options?: FlowLogsGetOptionalParams):
Promise<FlowLog>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: networkWatcherName
type: string
description: The name of the network watcher.
- id: flowLogName
type: string
description: The name of the flow log resource.
- id: options
type: <xref uid="@azure/arm-network.FlowLogsGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-network.FlowLog" />>
- name: list(string, string, FlowLogsListOptionalParams)
uid: '@azure/arm-network.FlowLogs.list'
package: '@azure/arm-network'
summary: Lists all flow log resources for the specified Network Watcher.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(resourceGroupName: string, networkWatcherName: string,
options?: FlowLogsListOptionalParams):
PagedAsyncIterableIterator<FlowLog, FlowLog[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group containing Network Watcher.
- id: networkWatcherName
type: string
description: The name of the Network Watcher resource.
- id: options
type: <xref uid="@azure/arm-network.FlowLogsListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-network.FlowLog" />, <xref
uid="@azure/arm-network.FlowLog" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: >-
updateTags(string, string, string, TagsObject,
FlowLogsUpdateTagsOptionalParams)
uid: '@azure/arm-network.FlowLogs.updateTags'
package: '@azure/arm-network'
summary: Update tags of the specified flow log.
remarks: ''
isDeprecated: false
syntax:
content: >-
function updateTags(resourceGroupName: string, networkWatcherName:
string, flowLogName: string, parameters: TagsObject, options?:
FlowLogsUpdateTagsOptionalParams): Promise<FlowLog>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: networkWatcherName
type: string
description: The name of the network watcher.
- id: flowLogName
type: string
description: The name of the flow log.
- id: parameters
type: <xref uid="@azure/arm-network.TagsObject" />
description: Parameters supplied to update flow log tags.
- id: options
type: <xref uid="@azure/arm-network.FlowLogsUpdateTagsOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-network.FlowLog" />>