-
Notifications
You must be signed in to change notification settings - Fork 180
/
Automations.yml
199 lines (195 loc) · 7.46 KB
/
Automations.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
### YamlMime:TSType
name: Automations
uid: '@azure/arm-security.Automations'
package: '@azure/arm-security'
summary: Interface representing a Automations.
fullName: Automations
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
createOrUpdate(string, string, Automation,
AutomationsCreateOrUpdateOptionalParams)
uid: '@azure/arm-security.Automations.createOrUpdate'
package: '@azure/arm-security'
summary: >-
Creates or updates a security automation. If a security automation is
already created and a
subsequent request is issued for the same automation id, then it will be
updated.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdate(resourceGroupName: string, automationName:
string, automation: Automation, options?:
AutomationsCreateOrUpdateOptionalParams): Promise<Automation>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group within the user's subscription. The
name is
case insensitive.
- id: automationName
type: string
description: The security automation name.
- id: automation
type: <xref uid="@azure/arm-security.Automation" />
description: The security automation resource
- id: options
type: >-
<xref
uid="@azure/arm-security.AutomationsCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-security.Automation" />>
- name: delete(string, string, AutomationsDeleteOptionalParams)
uid: '@azure/arm-security.Automations.delete'
package: '@azure/arm-security'
summary: Deletes a security automation.
remarks: ''
isDeprecated: false
syntax:
content: >-
function delete(resourceGroupName: string, automationName: string,
options?: AutomationsDeleteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group within the user's subscription. The
name is
case insensitive.
- id: automationName
type: string
description: The security automation name.
- id: options
type: <xref uid="@azure/arm-security.AutomationsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, AutomationsGetOptionalParams)
uid: '@azure/arm-security.Automations.get'
package: '@azure/arm-security'
summary: Retrieves information about the model of a security automation.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, automationName: string,
options?: AutomationsGetOptionalParams): Promise<Automation>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group within the user's subscription. The
name is
case insensitive.
- id: automationName
type: string
description: The security automation name.
- id: options
type: <xref uid="@azure/arm-security.AutomationsGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-security.Automation" />>
- name: list(AutomationsListOptionalParams)
uid: '@azure/arm-security.Automations.list'
package: '@azure/arm-security'
summary: >-
Lists all the security automations in the specified subscription. Use the
'nextLink' property in the
response to get the next page of security automations for the specified
subscription.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(options?: AutomationsListOptionalParams):
PagedAsyncIterableIterator<Automation, Automation[], PageSettings>
parameters:
- id: options
type: <xref uid="@azure/arm-security.AutomationsListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-security.Automation" />, <xref
uid="@azure/arm-security.Automation" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: listByResourceGroup(string, AutomationsListByResourceGroupOptionalParams)
uid: '@azure/arm-security.Automations.listByResourceGroup'
package: '@azure/arm-security'
summary: >-
Lists all the security automations in the specified resource group. Use
the 'nextLink' property in
the response to get the next page of security automations for the
specified resource group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByResourceGroup(resourceGroupName: string, options?:
AutomationsListByResourceGroupOptionalParams):
PagedAsyncIterableIterator<Automation, Automation[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group within the user's subscription. The
name is
case insensitive.
- id: options
type: >-
<xref
uid="@azure/arm-security.AutomationsListByResourceGroupOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-security.Automation" />, <xref
uid="@azure/arm-security.Automation" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: validate(string, string, Automation, AutomationsValidateOptionalParams)
uid: '@azure/arm-security.Automations.validate'
package: '@azure/arm-security'
summary: >-
Validates the security automation model before create or update. Any
validation errors are returned
to the client.
remarks: ''
isDeprecated: false
syntax:
content: >-
function validate(resourceGroupName: string, automationName: string,
automation: Automation, options?: AutomationsValidateOptionalParams):
Promise<AutomationValidationStatus>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group within the user's subscription. The
name is
case insensitive.
- id: automationName
type: string
description: The security automation name.
- id: automation
type: <xref uid="@azure/arm-security.Automation" />
description: The security automation resource
- id: options
type: <xref uid="@azure/arm-security.AutomationsValidateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-security.AutomationValidationStatus"
/>>