-
Notifications
You must be signed in to change notification settings - Fork 258
/
com.azure.resourcemanager.resources.models.GenericResources.yml
453 lines (453 loc) · 40 KB
/
com.azure.resourcemanager.resources.models.GenericResources.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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
### YamlMime:JavaType
uid: "com.azure.resourcemanager.resources.models.GenericResources"
fullName: "com.azure.resourcemanager.resources.models.GenericResources"
name: "GenericResources"
nameWithType: "GenericResources"
summary: "Entry point to generic resources management API."
syntax: "public interface **GenericResources**</br> extends <xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsListing?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsListing&text=SupportsListing\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup&text=SupportsListingByResourceGroup\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingInResourceGroupByTag?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingInResourceGroupByTag&text=SupportsListingInResourceGroupByTag\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById&text=SupportsGettingById\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating&text=SupportsCreating\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource.DefinitionStages.Blank?alt=com.azure.resourcemanager.resources.models.GenericResource.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById&text=SupportsDeletingById\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager&text=HasManager\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.ResourceManager?alt=com.azure.resourcemanager.resources.ResourceManager&text=ResourceManager\" data-throw-if-not-resolved=\"False\" />>"
methods:
- uid: "com.azure.resourcemanager.resources.models.GenericResources.beginDeleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.beginDeleteById(String id)"
name: "beginDeleteById(String id)"
nameWithType: "GenericResources.beginDeleteById(String id)"
summary: "Begins deleting a resource from Azure, identifying it by its resource ID."
modifiers:
- "abstract"
parameters:
- description: "the resource ID of the resource to delete"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Accepted<Void> beginDeleteById(String id)"
desc: "Begins deleting a resource from Azure, identifying it by its resource ID. For consistency across service versions, please use <xref uid=\"com.azure.resourcemanager.resources.models.GenericResources.beginDeleteById(java.lang.String,java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#beginDeleteById(String, String)\"></xref> instead."
returns:
description: "the accepted deleting operation"
type: "<xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Accepted?alt=com.azure.resourcemanager.resources.fluentcore.model.Accepted&text=Accepted\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.beginDeleteById(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.beginDeleteById(String id, String apiVersion)"
name: "beginDeleteById(String id, String apiVersion)"
nameWithType: "GenericResources.beginDeleteById(String id, String apiVersion)"
summary: "Begins deleting a resource from Azure, identifying it by its resource ID."
modifiers:
- "abstract"
parameters:
- description: "the resource ID of the resource to delete"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the API version"
name: "apiVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Accepted<Void> beginDeleteById(String id, String apiVersion)"
desc: "Begins deleting a resource from Azure, identifying it by its resource ID."
returns:
description: "the accepted deleting operation"
type: "<xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Accepted?alt=com.azure.resourcemanager.resources.fluentcore.model.Accepted&text=Accepted\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.checkExistence(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.checkExistence(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
name: "checkExistence(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
nameWithType: "GenericResources.checkExistence(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
summary: "Checks if a resource exists in a resource group."
modifiers:
- "abstract"
parameters:
- description: "the resource group's name"
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the resource provider's namespace"
name: "resourceProviderNamespace"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the parent's resource path"
name: "parentResourcePath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the type of the resource"
name: "resourceType"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the name of the resource"
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the API version"
name: "apiVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract boolean checkExistence(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
desc: "Checks if a resource exists in a resource group."
returns:
description: "true if the resource exists; false otherwise"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.checkExistenceById(java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.checkExistenceById(String id)"
name: "checkExistenceById(String id)"
nameWithType: "GenericResources.checkExistenceById(String id)"
summary: "Checks if a resource exists."
modifiers:
- "abstract"
parameters:
- description: "the ID of the resource."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract boolean checkExistenceById(String id)"
desc: "Checks if a resource exists. For consistency across service versions, please use <xref uid=\"com.azure.resourcemanager.resources.models.GenericResources.checkExistenceById(java.lang.String,java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#checkExistenceById(String, String)\"></xref> instead."
returns:
description: "true if the resource exists; false otherwise"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.checkExistenceById(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.checkExistenceById(String id, String apiVersion)"
name: "checkExistenceById(String id, String apiVersion)"
nameWithType: "GenericResources.checkExistenceById(String id, String apiVersion)"
summary: "Checks if a resource exists."
modifiers:
- "abstract"
parameters:
- description: "the ID of the resource."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the API version"
name: "apiVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract boolean checkExistenceById(String id, String apiVersion)"
desc: "Checks if a resource exists."
returns:
description: "true if the resource exists; false otherwise"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.delete(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
name: "delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
nameWithType: "GenericResources.delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
summary: "Delete resource and all of its child resources."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "resourceProviderNamespace"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "parentResourcePath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "resourceType"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the API version"
name: "apiVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
desc: "Delete resource and all of its child resources."
- uid: "com.azure.resourcemanager.resources.models.GenericResources.deleteAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
name: "deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
nameWithType: "GenericResources.deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
summary: "Delete resource and all of its child resources asynchronously."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "resourceProviderNamespace"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "parentResourcePath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "resourceType"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the API version"
name: "apiVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Void> deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
desc: "Delete resource and all of its child resources asynchronously."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.deleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.deleteById(String id)"
name: "deleteById(String id)"
nameWithType: "GenericResources.deleteById(String id)"
summary: "Deletes a resource from Azure, identifying it by its resource ID."
modifiers:
- "abstract"
parameters:
- description: "the resource ID of the resource to delete"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void deleteById(String id)"
desc: "Deletes a resource from Azure, identifying it by its resource ID. For consistency across service versions, please use <xref uid=\"com.azure.resourcemanager.resources.models.GenericResources.deleteById(java.lang.String,java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#deleteById(String, String)\"></xref> instead."
- uid: "com.azure.resourcemanager.resources.models.GenericResources.deleteById(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.deleteById(String id, String apiVersion)"
name: "deleteById(String id, String apiVersion)"
nameWithType: "GenericResources.deleteById(String id, String apiVersion)"
summary: "Deletes a resource from Azure, identifying it by its resource ID."
modifiers:
- "abstract"
parameters:
- description: "the resource ID of the resource to delete"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the API version"
name: "apiVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void deleteById(String id, String apiVersion)"
desc: "Deletes a resource from Azure, identifying it by its resource ID."
- uid: "com.azure.resourcemanager.resources.models.GenericResources.deleteByIdAsync(java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.deleteByIdAsync(String id)"
name: "deleteByIdAsync(String id)"
nameWithType: "GenericResources.deleteByIdAsync(String id)"
summary: "Asynchronously delete a resource from Azure, identifying it by its resource ID."
modifiers:
- "abstract"
parameters:
- description: "the resource ID of the resource to delete"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Void> deleteByIdAsync(String id)"
desc: "Asynchronously delete a resource from Azure, identifying it by its resource ID. For consistency across service versions, please use <xref uid=\"com.azure.resourcemanager.resources.models.GenericResources.deleteByIdAsync(java.lang.String,java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#deleteByIdAsync(String, String)\"></xref> instead."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.deleteByIdAsync(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.deleteByIdAsync(String id, String apiVersion)"
name: "deleteByIdAsync(String id, String apiVersion)"
nameWithType: "GenericResources.deleteByIdAsync(String id, String apiVersion)"
summary: "Asynchronously delete a resource from Azure, identifying it by its resource ID."
modifiers:
- "abstract"
parameters:
- description: "the resource ID of the resource to delete"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the API version"
name: "apiVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Void> deleteByIdAsync(String id, String apiVersion)"
desc: "Asynchronously delete a resource from Azure, identifying it by its resource ID."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.get(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.get(String resourceGroupName, String providerNamespace, String resourceType, String resourceName)"
name: "get(String resourceGroupName, String providerNamespace, String resourceType, String resourceName)"
nameWithType: "GenericResources.get(String resourceGroupName, String providerNamespace, String resourceType, String resourceName)"
summary: "Returns a resource belonging to a resource group."
modifiers:
- "abstract"
parameters:
- description: "the resource group name"
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the provider namespace"
name: "providerNamespace"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the resource type"
name: "resourceType"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the name of the resource"
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract GenericResource get(String resourceGroupName, String providerNamespace, String resourceType, String resourceName)"
desc: "Returns a resource belonging to a resource group."
returns:
description: "the generic resource"
type: "<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.get(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.get(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
name: "get(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
nameWithType: "GenericResources.get(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
summary: "Returns a resource belonging to a resource group."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group. The name is case insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "resourceProviderNamespace"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "parentResourcePath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "resourceType"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Resource identity."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the API version"
name: "apiVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract GenericResource get(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)"
desc: "Returns a resource belonging to a resource group."
returns:
description: "the generic resource"
type: "<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.getById(java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.getById(String id)"
name: "getById(String id)"
nameWithType: "GenericResources.getById(String id)"
summary: "Gets the information about a resource from Azure based on the resource id."
modifiers:
- "abstract"
parameters:
- description: "the id of the resource."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract GenericResource getById(String id)"
desc: "Gets the information about a resource from Azure based on the resource id. For consistency across service versions, please use <xref uid=\"com.azure.resourcemanager.resources.models.GenericResources.getById(java.lang.String,java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getById(String, String)\"></xref> instead."
returns:
description: "an immutable representation of the resource"
type: "<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.getById(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.getById(String id, String apiVersion)"
name: "getById(String id, String apiVersion)"
nameWithType: "GenericResources.getById(String id, String apiVersion)"
summary: "Gets the information about a resource from Azure based on the resource id."
modifiers:
- "abstract"
parameters:
- description: "the id of the resource."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the API version"
name: "apiVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract GenericResource getById(String id, String apiVersion)"
desc: "Gets the information about a resource from Azure based on the resource id."
returns:
description: "an immutable representation of the resource"
type: "<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.getByIdAsync(java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.getByIdAsync(String id)"
name: "getByIdAsync(String id)"
nameWithType: "GenericResources.getByIdAsync(String id)"
summary: "Gets the information about a resource from Azure based on the resource id."
modifiers:
- "abstract"
parameters:
- description: "the id of the resource."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<GenericResource> getByIdAsync(String id)"
desc: "Gets the information about a resource from Azure based on the resource id. For consistency across service versions, please use <xref uid=\"com.azure.resourcemanager.resources.models.GenericResources.getByIdAsync(java.lang.String,java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getByIdAsync(String, String)\"></xref> instead."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that emits the found resource asynchronously"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.getByIdAsync(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.getByIdAsync(String id, String apiVersion)"
name: "getByIdAsync(String id, String apiVersion)"
nameWithType: "GenericResources.getByIdAsync(String id, String apiVersion)"
summary: "Gets the information about a resource from Azure based on the resource id."
modifiers:
- "abstract"
parameters:
- description: "the id of the resource."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the API version"
name: "apiVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<GenericResource> getByIdAsync(String id, String apiVersion)"
desc: "Gets the information about a resource from Azure based on the resource id."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that emits the found resource asynchronously"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.moveResources(java.lang.String,com.azure.resourcemanager.resources.models.ResourceGroup,java.util.List<java.lang.String>)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.moveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
name: "moveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
nameWithType: "GenericResources.moveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
summary: "Move resources from one resource group to another."
modifiers:
- "abstract"
parameters:
- description: "Source resource group name"
name: "sourceResourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "target resource group, can be in a different subscription"
name: "targetResourceGroup"
type: "<xref href=\"com.azure.resourcemanager.resources.models.ResourceGroup?alt=com.azure.resourcemanager.resources.models.ResourceGroup&text=ResourceGroup\" data-throw-if-not-resolved=\"False\" />"
- description: "the list of IDs of the resources to move"
name: "resourceIds"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
syntax: "public abstract void moveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
desc: "Move resources from one resource group to another."
- uid: "com.azure.resourcemanager.resources.models.GenericResources.moveResourcesAsync(java.lang.String,com.azure.resourcemanager.resources.models.ResourceGroup,java.util.List<java.lang.String>)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.moveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
name: "moveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
nameWithType: "GenericResources.moveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
summary: "Move resources from one resource group to another asynchronously."
modifiers:
- "abstract"
parameters:
- description: "Source resource group name"
name: "sourceResourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "target resource group, can be in a different subscription"
name: "targetResourceGroup"
type: "<xref href=\"com.azure.resourcemanager.resources.models.ResourceGroup?alt=com.azure.resourcemanager.resources.models.ResourceGroup&text=ResourceGroup\" data-throw-if-not-resolved=\"False\" />"
- description: "the list of IDs of the resources to move"
name: "resourceIds"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
syntax: "public abstract Mono<Void> moveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
desc: "Move resources from one resource group to another asynchronously."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
- uid: "com.azure.resourcemanager.resources.models.GenericResources.validateMoveResources(java.lang.String,com.azure.resourcemanager.resources.models.ResourceGroup,java.util.List<java.lang.String>)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.validateMoveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
name: "validateMoveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
nameWithType: "GenericResources.validateMoveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
summary: "Validates move resources from one resource group to another."
modifiers:
- "abstract"
parameters:
- description: "Source resource group name"
name: "sourceResourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "target resource group, can be in a different subscription"
name: "targetResourceGroup"
type: "<xref href=\"com.azure.resourcemanager.resources.models.ResourceGroup?alt=com.azure.resourcemanager.resources.models.ResourceGroup&text=ResourceGroup\" data-throw-if-not-resolved=\"False\" />"
- description: "the list of IDs of the resources to move"
name: "resourceIds"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
syntax: "public abstract void validateMoveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
desc: "Validates move resources from one resource group to another. If validation fails, <xref uid=\"com.azure.core.management.exception.ManagementException\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.core.management.exception.ManagementException\"></xref> is thrown."
- uid: "com.azure.resourcemanager.resources.models.GenericResources.validateMoveResourcesAsync(java.lang.String,com.azure.resourcemanager.resources.models.ResourceGroup,java.util.List<java.lang.String>)"
fullName: "com.azure.resourcemanager.resources.models.GenericResources.validateMoveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
name: "validateMoveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
nameWithType: "GenericResources.validateMoveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
summary: "Validates move resources from one resource group to another asynchronously."
modifiers:
- "abstract"
parameters:
- description: "Source resource group name"
name: "sourceResourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "target resource group, can be in a different subscription"
name: "targetResourceGroup"
type: "<xref href=\"com.azure.resourcemanager.resources.models.ResourceGroup?alt=com.azure.resourcemanager.resources.models.ResourceGroup&text=ResourceGroup\" data-throw-if-not-resolved=\"False\" />"
- description: "the list of IDs of the resources to move"
name: "resourceIds"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
syntax: "public abstract Mono<Void> validateMoveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)"
desc: "Validates move resources from one resource group to another asynchronously. If validation fails, <xref uid=\"com.azure.core.management.exception.ManagementException\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.core.management.exception.ManagementException\"></xref> is thrown."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
type: "interface"
desc: "Entry point to generic resources management API."
implements:
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById&text=SupportsGettingById\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup&text=SupportsListingByResourceGroup\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingInResourceGroupByTag?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingInResourceGroupByTag&text=SupportsListingInResourceGroupByTag\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager&text=HasManager\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.ResourceManager?alt=com.azure.resourcemanager.resources.ResourceManager&text=ResourceManager\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating&text=SupportsCreating\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource.DefinitionStages.Blank?alt=com.azure.resourcemanager.resources.models.GenericResource.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById&text=SupportsDeletingById\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsListing?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsListing&text=SupportsListing\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.resources.models.GenericResource?alt=com.azure.resourcemanager.resources.models.GenericResource&text=GenericResource\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.azure.resourcemanager.resources.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-resources:2.41.0