-
Notifications
You must be signed in to change notification settings - Fork 180
/
SystemTopics.yml
267 lines (267 loc) · 10.9 KB
/
SystemTopics.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
### YamlMime:TSType
name: SystemTopics
uid: '@azure/arm-eventgrid.SystemTopics'
package: '@azure/arm-eventgrid'
summary: Interface representing a SystemTopics.
fullName: SystemTopics
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreateOrUpdate(string, string, SystemTopic,
SystemTopicsCreateOrUpdateOptionalParams)
uid: '@azure/arm-eventgrid.SystemTopics.beginCreateOrUpdate'
package: '@azure/arm-eventgrid'
summary: Asynchronously creates a new system topic with the specified parameters.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdate(resourceGroupName: string, systemTopicName:
string, systemTopicInfo: SystemTopic, options?:
SystemTopicsCreateOrUpdateOptionalParams):
Promise<PollerLike<PollOperationState<SystemTopic>, SystemTopic>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the user's subscription.
- id: systemTopicName
type: string
description: Name of the system topic.
- id: systemTopicInfo
type: <xref uid="@azure/arm-eventgrid.SystemTopic" />
description: System Topic information.
- id: options
type: >-
<xref
uid="@azure/arm-eventgrid.SystemTopicsCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><<xref
uid="@azure/arm-eventgrid.SystemTopic" />>, <xref
uid="@azure/arm-eventgrid.SystemTopic" />>>
- name: >-
beginCreateOrUpdateAndWait(string, string, SystemTopic,
SystemTopicsCreateOrUpdateOptionalParams)
uid: '@azure/arm-eventgrid.SystemTopics.beginCreateOrUpdateAndWait'
package: '@azure/arm-eventgrid'
summary: Asynchronously creates a new system topic with the specified parameters.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdateAndWait(resourceGroupName: string,
systemTopicName: string, systemTopicInfo: SystemTopic, options?:
SystemTopicsCreateOrUpdateOptionalParams): Promise<SystemTopic>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the user's subscription.
- id: systemTopicName
type: string
description: Name of the system topic.
- id: systemTopicInfo
type: <xref uid="@azure/arm-eventgrid.SystemTopic" />
description: System Topic information.
- id: options
type: >-
<xref
uid="@azure/arm-eventgrid.SystemTopicsCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventgrid.SystemTopic" />>
- name: beginDelete(string, string, SystemTopicsDeleteOptionalParams)
uid: '@azure/arm-eventgrid.SystemTopics.beginDelete'
package: '@azure/arm-eventgrid'
summary: Delete existing system topic.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, systemTopicName: string,
options?: SystemTopicsDeleteOptionalParams):
Promise<PollerLike<PollOperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the user's subscription.
- id: systemTopicName
type: string
description: Name of the system topic.
- id: options
type: <xref uid="@azure/arm-eventgrid.SystemTopicsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><void>, void>>
- name: beginDeleteAndWait(string, string, SystemTopicsDeleteOptionalParams)
uid: '@azure/arm-eventgrid.SystemTopics.beginDeleteAndWait'
package: '@azure/arm-eventgrid'
summary: Delete existing system topic.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string, systemTopicName:
string, options?: SystemTopicsDeleteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the user's subscription.
- id: systemTopicName
type: string
description: Name of the system topic.
- id: options
type: <xref uid="@azure/arm-eventgrid.SystemTopicsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: >-
beginUpdate(string, string, SystemTopicUpdateParameters,
SystemTopicsUpdateOptionalParams)
uid: '@azure/arm-eventgrid.SystemTopics.beginUpdate'
package: '@azure/arm-eventgrid'
summary: Asynchronously updates a system topic with the specified parameters.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdate(resourceGroupName: string, systemTopicName: string,
systemTopicUpdateParameters: SystemTopicUpdateParameters, options?:
SystemTopicsUpdateOptionalParams):
Promise<PollerLike<PollOperationState<SystemTopic>, SystemTopic>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the user's subscription.
- id: systemTopicName
type: string
description: Name of the system topic.
- id: systemTopicUpdateParameters
type: <xref uid="@azure/arm-eventgrid.SystemTopicUpdateParameters" />
description: SystemTopic update information.
- id: options
type: <xref uid="@azure/arm-eventgrid.SystemTopicsUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><<xref
uid="@azure/arm-eventgrid.SystemTopic" />>, <xref
uid="@azure/arm-eventgrid.SystemTopic" />>>
- name: >-
beginUpdateAndWait(string, string, SystemTopicUpdateParameters,
SystemTopicsUpdateOptionalParams)
uid: '@azure/arm-eventgrid.SystemTopics.beginUpdateAndWait'
package: '@azure/arm-eventgrid'
summary: Asynchronously updates a system topic with the specified parameters.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdateAndWait(resourceGroupName: string, systemTopicName:
string, systemTopicUpdateParameters: SystemTopicUpdateParameters,
options?: SystemTopicsUpdateOptionalParams): Promise<SystemTopic>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the user's subscription.
- id: systemTopicName
type: string
description: Name of the system topic.
- id: systemTopicUpdateParameters
type: <xref uid="@azure/arm-eventgrid.SystemTopicUpdateParameters" />
description: SystemTopic update information.
- id: options
type: <xref uid="@azure/arm-eventgrid.SystemTopicsUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventgrid.SystemTopic" />>
- name: get(string, string, SystemTopicsGetOptionalParams)
uid: '@azure/arm-eventgrid.SystemTopics.get'
package: '@azure/arm-eventgrid'
summary: Get properties of a system topic.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, systemTopicName: string,
options?: SystemTopicsGetOptionalParams): Promise<SystemTopic>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the user's subscription.
- id: systemTopicName
type: string
description: Name of the system topic.
- id: options
type: <xref uid="@azure/arm-eventgrid.SystemTopicsGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-eventgrid.SystemTopic" />>
- name: listByResourceGroup(string, SystemTopicsListByResourceGroupOptionalParams)
uid: '@azure/arm-eventgrid.SystemTopics.listByResourceGroup'
package: '@azure/arm-eventgrid'
summary: List all the system topics under a resource group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByResourceGroup(resourceGroupName: string, options?:
SystemTopicsListByResourceGroupOptionalParams):
PagedAsyncIterableIterator<SystemTopic, SystemTopic[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the user's subscription.
- id: options
type: >-
<xref
uid="@azure/arm-eventgrid.SystemTopicsListByResourceGroupOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-eventgrid.SystemTopic" />, <xref
uid="@azure/arm-eventgrid.SystemTopic" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: listBySubscription(SystemTopicsListBySubscriptionOptionalParams)
uid: '@azure/arm-eventgrid.SystemTopics.listBySubscription'
package: '@azure/arm-eventgrid'
summary: List all the system topics under an Azure subscription.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listBySubscription(options?:
SystemTopicsListBySubscriptionOptionalParams):
PagedAsyncIterableIterator<SystemTopic, SystemTopic[], PageSettings>
parameters:
- id: options
type: >-
<xref
uid="@azure/arm-eventgrid.SystemTopicsListBySubscriptionOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-eventgrid.SystemTopic" />, <xref
uid="@azure/arm-eventgrid.SystemTopic" />[], <xref
uid="@azure/core-paging.PageSettings" />>