-
Notifications
You must be signed in to change notification settings - Fork 180
/
AutomationModels.DscNodeListResult.yml
1130 lines (1093 loc) · 42.6 KB
/
AutomationModels.DscNodeListResult.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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### YamlMime:TSType
name: DscNodeListResult
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult'
package: '@azure/arm-automation'
summary: ''
fullName: DscNodeListResult
remarks: ''
isDeprecated: false
type: interface
properties:
- name: nextLink
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.nextLink'
package: '@azure/arm-automation'
summary: Gets or sets the next link.
fullName: nextLink
remarks: ''
isDeprecated: false
syntax:
content: 'nextLink?: string'
return:
description: ''
type: string
- name: totalCount
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.totalCount'
package: '@azure/arm-automation'
summary: Gets the total number of nodes matching filter criteria.
fullName: totalCount
remarks: ''
isDeprecated: false
syntax:
content: 'totalCount?: number'
return:
description: ''
type: number
inheritedProperties:
- name: length
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.length'
package: '@azure/arm-automation'
summary: >-
Gets or sets the length of the array. This is a number one higher than the
highest index in the array.
fullName: length
remarks: ''
isDeprecated: false
syntax:
content: 'length: number'
return:
description: ''
type: number
inheritanceDescription: <b>Inherited From</b> Array.length
inheritedMethods:
- name: at(number)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.at'
package: '@azure/arm-automation'
summary: |-
Takes an integer value and returns the item at that index,
allowing for positive and negative integers.
Negative integers count back from the last item in the array.
remarks: ''
isDeprecated: false
syntax:
content: 'function at(index: number): undefined | DscNode'
parameters:
- id: index
type: number
description: ''
return:
description: ''
type: >-
undefined | <xref uid="@azure/arm-automation.AutomationModels.DscNode"
/>
inheritanceDescription: <b>Inherited From</b> Array.at
- name: concat((DscNode | ConcatArray<DscNode>)[])
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.concat_1'
package: '@azure/arm-automation'
summary: |-
Combines two or more arrays.
This method returns a new array without modifying any existing arrays.
remarks: ''
isDeprecated: false
syntax:
content: 'function concat(items: (DscNode | ConcatArray<DscNode>)[]): DscNode[]'
parameters:
- id: items
type: >-
(<xref uid="@azure/arm-automation.AutomationModels.DscNode" /> |
ConcatArray<<xref
uid="@azure/arm-automation.AutomationModels.DscNode" />>)[]
description: Additional arrays and/or items to add to the end of the array.
return:
description: ''
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />[]
inheritanceDescription: <b>Inherited From</b> Array.concat
- name: concat(ConcatArray<DscNode>[])
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.concat'
package: '@azure/arm-automation'
summary: |-
Combines two or more arrays.
This method returns a new array without modifying any existing arrays.
remarks: ''
isDeprecated: false
syntax:
content: 'function concat(items: ConcatArray<DscNode>[]): DscNode[]'
parameters:
- id: items
type: >-
ConcatArray<<xref
uid="@azure/arm-automation.AutomationModels.DscNode" />>[]
description: Additional arrays and/or items to add to the end of the array.
return:
description: ''
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />[]
inheritanceDescription: <b>Inherited From</b> Array.concat
- name: copyWithin(number, number, number)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.copyWithin'
package: '@azure/arm-automation'
summary: >-
Returns the this object after copying a section of the array identified by
start and end
to the same array starting at position target
remarks: ''
isDeprecated: false
syntax:
content: >-
function copyWithin(target: number, start: number, end?: number):
DscNodeListResult
parameters:
- id: target
type: number
description: >-
If target is negative, it is treated as length+target where length
is the
length of the array.
- id: start
type: number
description: >-
If start is negative, it is treated as length+start. If end is
negative, it
is treated as length+end.
- id: end
type: number
description: >-
If not specified, length of the this object is used as its default
value.
return:
description: ''
type: >-
<xref uid="@azure/arm-automation.AutomationModels.DscNodeListResult"
/>
inheritanceDescription: <b>Inherited From</b> Array.copyWithin
- name: entries()
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.entries'
package: '@azure/arm-automation'
summary: Returns an iterable of key, value pairs for every entry in the array
remarks: ''
isDeprecated: false
syntax:
content: 'function entries(): IterableIterator<[number, DscNode]>'
return:
description: ''
type: IterableIterator<[number, DscNode]>
inheritanceDescription: <b>Inherited From</b> Array.entries
- name: 'every((value: DscNode, index: number, array: DscNode[]) => unknown, any)'
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.every_1'
package: '@azure/arm-automation'
summary: Determines whether all the members of an array satisfy the specified test.
remarks: ''
isDeprecated: false
syntax:
content: >-
function every(predicate: (value: DscNode, index: number, array:
DscNode[]) => unknown, thisArg?: any): boolean
parameters:
- id: predicate
type: '(value: DscNode, index: number, array: DscNode[]) => unknown'
description: >-
A function that accepts up to three arguments. The every method
calls
the predicate function for each element in the array until the
predicate returns a value
which is coercible to the Boolean value false, or until the end of
the array.
- id: thisArg
type: any
description: >-
An object to which the this keyword can refer in the predicate
function.
If thisArg is omitted, undefined is used as the this value.
return:
description: ''
type: boolean
inheritanceDescription: <b>Inherited From</b> Array.every
- name: 'every<S>((value: DscNode, index: number, array: DscNode[]) => value, any)'
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.every'
package: '@azure/arm-automation'
summary: Determines whether all the members of an array satisfy the specified test.
remarks: ''
isDeprecated: false
syntax:
content: >-
function every<S>(predicate: (value: DscNode, index: number, array:
DscNode[]) => value, thisArg?: any): this
parameters:
- id: predicate
type: '(value: DscNode, index: number, array: DscNode[]) => value'
description: >-
A function that accepts up to three arguments. The every method
calls
the predicate function for each element in the array until the
predicate returns a value
which is coercible to the Boolean value false, or until the end of
the array.
- id: thisArg
type: any
description: >-
An object to which the this keyword can refer in the predicate
function.
If thisArg is omitted, undefined is used as the this value.
return:
description: ''
type: this
inheritanceDescription: <b>Inherited From</b> Array.every
- name: fill(DscNode, number, number)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.fill'
package: '@azure/arm-automation'
summary: >-
Changes all array elements from `start` to `end` index to a static `value`
and returns the modified array
remarks: ''
isDeprecated: false
syntax:
content: >-
function fill(value: DscNode, start?: number, end?: number):
DscNodeListResult
parameters:
- id: value
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />
description: value to fill array section with
- id: start
type: number
description: >-
index to start filling the array at. If start is negative, it is
treated as
length+start where length is the length of the array.
- id: end
type: number
description: >-
index to stop filling the array at. If end is negative, it is
treated as
length+end.
return:
description: ''
type: >-
<xref uid="@azure/arm-automation.AutomationModels.DscNodeListResult"
/>
inheritanceDescription: <b>Inherited From</b> Array.fill
- name: 'filter((value: DscNode, index: number, array: DscNode[]) => unknown, any)'
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.filter_1'
package: '@azure/arm-automation'
summary: >-
Returns the elements of an array that meet the condition specified in a
callback function.
remarks: ''
isDeprecated: false
syntax:
content: >-
function filter(predicate: (value: DscNode, index: number, array:
DscNode[]) => unknown, thisArg?: any): DscNode[]
parameters:
- id: predicate
type: '(value: DscNode, index: number, array: DscNode[]) => unknown'
description: >-
A function that accepts up to three arguments. The filter method
calls the predicate function one time for each element in the array.
- id: thisArg
type: any
description: >-
An object to which the this keyword can refer in the predicate
function. If thisArg is omitted, undefined is used as the this
value.
return:
description: ''
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />[]
inheritanceDescription: <b>Inherited From</b> Array.filter
- name: 'filter<S>((value: DscNode, index: number, array: DscNode[]) => value, any)'
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.filter'
package: '@azure/arm-automation'
summary: >-
Returns the elements of an array that meet the condition specified in a
callback function.
remarks: ''
isDeprecated: false
syntax:
content: >-
function filter<S>(predicate: (value: DscNode, index: number, array:
DscNode[]) => value, thisArg?: any): S[]
parameters:
- id: predicate
type: '(value: DscNode, index: number, array: DscNode[]) => value'
description: >-
A function that accepts up to three arguments. The filter method
calls the predicate function one time for each element in the array.
- id: thisArg
type: any
description: >-
An object to which the this keyword can refer in the predicate
function. If thisArg is omitted, undefined is used as the this
value.
return:
description: ''
type: S[]
inheritanceDescription: <b>Inherited From</b> Array.filter
- name: 'find((value: DscNode, index: number, obj: DscNode[]) => unknown, any)'
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.find_1'
package: '@azure/arm-automation'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function find(predicate: (value: DscNode, index: number, obj: DscNode[])
=> unknown, thisArg?: any): undefined | DscNode
parameters:
- id: predicate
type: '(value: DscNode, index: number, obj: DscNode[]) => unknown'
description: ''
- id: thisArg
type: any
description: ''
return:
description: ''
type: >-
undefined | <xref uid="@azure/arm-automation.AutomationModels.DscNode"
/>
inheritanceDescription: <b>Inherited From</b> Array.find
- name: >-
find<S>((this: void, value: DscNode, index: number, obj: DscNode[]) =>
value, any)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.find'
package: '@azure/arm-automation'
summary: >-
Returns the value of the first element in the array where predicate is
true, and undefined
otherwise.
remarks: ''
isDeprecated: false
syntax:
content: >-
function find<S>(predicate: (this: void, value: DscNode, index: number,
obj: DscNode[]) => value, thisArg?: any): undefined | S
parameters:
- id: predicate
type: >-
(this: void, value: DscNode, index: number, obj: DscNode[]) =>
value
description: >-
find calls predicate once for each element of the array, in
ascending
order, until it finds one where predicate returns true. If such an
element is found, find
immediately returns that element value. Otherwise, find returns
undefined.
- id: thisArg
type: any
description: >-
If provided, it will be used as the this value for each invocation
of
predicate. If it is not provided, undefined is used instead.
return:
description: ''
type: undefined | S
inheritanceDescription: <b>Inherited From</b> Array.find
- name: 'findIndex((value: DscNode, index: number, obj: DscNode[]) => unknown, any)'
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.findIndex'
package: '@azure/arm-automation'
summary: >-
Returns the index of the first element in the array where predicate is
true, and -1
otherwise.
remarks: ''
isDeprecated: false
syntax:
content: >-
function findIndex(predicate: (value: DscNode, index: number, obj:
DscNode[]) => unknown, thisArg?: any): number
parameters:
- id: predicate
type: '(value: DscNode, index: number, obj: DscNode[]) => unknown'
description: >-
find calls predicate once for each element of the array, in
ascending
order, until it finds one where predicate returns true. If such an
element is found,
findIndex immediately returns that element index. Otherwise,
findIndex returns -1.
- id: thisArg
type: any
description: >-
If provided, it will be used as the this value for each invocation
of
predicate. If it is not provided, undefined is used instead.
return:
description: ''
type: number
inheritanceDescription: <b>Inherited From</b> Array.findIndex
- name: flat<A, D>(A, D)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.flat'
package: '@azure/arm-automation'
summary: >-
Returns a new array with all sub-array elements concatenated into it
recursively up to the
specified depth.
remarks: ''
isDeprecated: false
syntax:
content: 'function flat<A, D>(this: A, depth?: D): FlatArray<A, D>[]'
parameters:
- id: this
type: A
description: ''
- id: depth
type: D
description: The maximum recursion depth
return:
description: ''
type: FlatArray<A, D>[]
inheritanceDescription: <b>Inherited From</b> Array.flat
- name: >-
flatMap<U, This>((this: This, value: DscNode, index: number, array:
DscNode[]) => U | (readonly U[]), This)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.flatMap'
package: '@azure/arm-automation'
summary: >-
Calls a defined callback function on each element of an array. Then,
flattens the result into
a new array.
This is identical to a map followed by flat with depth 1.
remarks: ''
isDeprecated: false
syntax:
content: >-
function flatMap<U, This>(callback: (this: This, value: DscNode, index:
number, array: DscNode[]) => U | (readonly U[]), thisArg?: This): U[]
parameters:
- id: callback
type: >-
(this: This, value: DscNode, index: number, array: DscNode[]) =>
U | (readonly U[])
description: >-
A function that accepts up to three arguments. The flatMap method
calls the
callback function one time for each element in the array.
- id: thisArg
type: This
description: >-
An object to which the this keyword can refer in the callback
function. If
thisArg is omitted, undefined is used as the this value.
return:
description: ''
type: U[]
inheritanceDescription: <b>Inherited From</b> Array.flatMap
- name: 'forEach((value: DscNode, index: number, array: DscNode[]) => void, any)'
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.forEach'
package: '@azure/arm-automation'
summary: Performs the specified action for each element in an array.
remarks: ''
isDeprecated: false
syntax:
content: >-
function forEach(callbackfn: (value: DscNode, index: number, array:
DscNode[]) => void, thisArg?: any)
parameters:
- id: callbackfn
type: '(value: DscNode, index: number, array: DscNode[]) => void'
description: >-
A function that accepts up to three arguments. forEach calls the
callbackfn function one time for each element in the array.
- id: thisArg
type: any
description: >-
An object to which the this keyword can refer in the callbackfn
function. If thisArg is omitted, undefined is used as the this
value.
inheritanceDescription: <b>Inherited From</b> Array.forEach
- name: includes(DscNode, number)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.includes'
package: '@azure/arm-automation'
summary: >-
Determines whether an array includes a certain element, returning true or
false as appropriate.
remarks: ''
isDeprecated: false
syntax:
content: 'function includes(searchElement: DscNode, fromIndex?: number): boolean'
parameters:
- id: searchElement
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />
description: The element to search for.
- id: fromIndex
type: number
description: >-
The position in this array at which to begin searching for
searchElement.
return:
description: ''
type: boolean
inheritanceDescription: <b>Inherited From</b> Array.includes
- name: indexOf(DscNode, number)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.indexOf'
package: '@azure/arm-automation'
summary: >-
Returns the index of the first occurrence of a value in an array, or -1 if
it is not present.
remarks: ''
isDeprecated: false
syntax:
content: 'function indexOf(searchElement: DscNode, fromIndex?: number): number'
parameters:
- id: searchElement
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />
description: The value to locate in the array.
- id: fromIndex
type: number
description: >-
The array index at which to begin the search. If fromIndex is
omitted, the search starts at index 0.
return:
description: ''
type: number
inheritanceDescription: <b>Inherited From</b> Array.indexOf
- name: join(string)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.join'
package: '@azure/arm-automation'
summary: >-
Adds all the elements of an array into a string, separated by the
specified separator string.
remarks: ''
isDeprecated: false
syntax:
content: 'function join(separator?: string): string'
parameters:
- id: separator
type: string
description: >-
A string used to separate one element of the array from the next in
the resulting string. If omitted, the array elements are separated
with a comma.
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> Array.join
- name: keys()
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.keys'
package: '@azure/arm-automation'
summary: Returns an iterable of keys in the array
remarks: ''
isDeprecated: false
syntax:
content: 'function keys(): IterableIterator<number>'
return:
description: ''
type: IterableIterator<number>
inheritanceDescription: <b>Inherited From</b> Array.keys
- name: lastIndexOf(DscNode, number)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.lastIndexOf'
package: '@azure/arm-automation'
summary: >-
Returns the index of the last occurrence of a specified value in an array,
or -1 if it is not present.
remarks: ''
isDeprecated: false
syntax:
content: 'function lastIndexOf(searchElement: DscNode, fromIndex?: number): number'
parameters:
- id: searchElement
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />
description: The value to locate in the array.
- id: fromIndex
type: number
description: >-
The array index at which to begin searching backward. If fromIndex
is omitted, the search starts at the last index in the array.
return:
description: ''
type: number
inheritanceDescription: <b>Inherited From</b> Array.lastIndexOf
- name: 'map<U>((value: DscNode, index: number, array: DscNode[]) => U, any)'
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.map'
package: '@azure/arm-automation'
summary: >-
Calls a defined callback function on each element of an array, and returns
an array that contains the results.
remarks: ''
isDeprecated: false
syntax:
content: >-
function map<U>(callbackfn: (value: DscNode, index: number, array:
DscNode[]) => U, thisArg?: any): U[]
parameters:
- id: callbackfn
type: '(value: DscNode, index: number, array: DscNode[]) => U'
description: >-
A function that accepts up to three arguments. The map method calls
the callbackfn function one time for each element in the array.
- id: thisArg
type: any
description: >-
An object to which the this keyword can refer in the callbackfn
function. If thisArg is omitted, undefined is used as the this
value.
return:
description: ''
type: U[]
inheritanceDescription: <b>Inherited From</b> Array.map
- name: pop()
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.pop'
package: '@azure/arm-automation'
summary: >-
Removes the last element from an array and returns it.
If the array is empty, undefined is returned and the array is not
modified.
remarks: ''
isDeprecated: false
syntax:
content: 'function pop(): undefined | DscNode'
return:
description: ''
type: >-
undefined | <xref uid="@azure/arm-automation.AutomationModels.DscNode"
/>
inheritanceDescription: <b>Inherited From</b> Array.pop
- name: push(DscNode[])
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.push'
package: '@azure/arm-automation'
summary: >-
Appends new elements to the end of an array, and returns the new length of
the array.
remarks: ''
isDeprecated: false
syntax:
content: 'function push(items: DscNode[]): number'
parameters:
- id: items
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />[]
description: New elements to add to the array.
return:
description: ''
type: number
inheritanceDescription: <b>Inherited From</b> Array.push
- name: >-
reduce((previousValue: DscNode, currentValue: DscNode, currentIndex:
number, array: DscNode[]) => DscNode)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.reduce'
package: '@azure/arm-automation'
summary: >-
Calls the specified callback function for all the elements in an array.
The return value of the callback function is the accumulated result, and
is provided as an argument in the next call to the callback function.
remarks: ''
isDeprecated: false
syntax:
content: >-
function reduce(callbackfn: (previousValue: DscNode, currentValue:
DscNode, currentIndex: number, array: DscNode[]) => DscNode): DscNode
parameters:
- id: callbackfn
type: >-
(previousValue: DscNode, currentValue: DscNode, currentIndex:
number, array: DscNode[]) => DscNode
description: >-
A function that accepts up to four arguments. The reduce method
calls the callbackfn function one time for each element in the
array.
return:
description: ''
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />
inheritanceDescription: <b>Inherited From</b> Array.reduce
- name: >-
reduce((previousValue: DscNode, currentValue: DscNode, currentIndex:
number, array: DscNode[]) => DscNode, DscNode)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.reduce_1'
package: '@azure/arm-automation'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function reduce(callbackfn: (previousValue: DscNode, currentValue:
DscNode, currentIndex: number, array: DscNode[]) => DscNode,
initialValue: DscNode): DscNode
parameters:
- id: callbackfn
type: >-
(previousValue: DscNode, currentValue: DscNode, currentIndex:
number, array: DscNode[]) => DscNode
description: ''
- id: initialValue
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />
description: ''
return:
description: ''
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />
inheritanceDescription: <b>Inherited From</b> Array.reduce
- name: >-
reduce<U>((previousValue: U, currentValue: DscNode, currentIndex: number,
array: DscNode[]) => U, U)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.reduce_2'
package: '@azure/arm-automation'
summary: >-
Calls the specified callback function for all the elements in an array.
The return value of the callback function is the accumulated result, and
is provided as an argument in the next call to the callback function.
remarks: ''
isDeprecated: false
syntax:
content: >-
function reduce<U>(callbackfn: (previousValue: U, currentValue: DscNode,
currentIndex: number, array: DscNode[]) => U, initialValue: U): U
parameters:
- id: callbackfn
type: >-
(previousValue: U, currentValue: DscNode, currentIndex: number,
array: DscNode[]) => U
description: >-
A function that accepts up to four arguments. The reduce method
calls the callbackfn function one time for each element in the
array.
- id: initialValue
type: U
description: >-
If initialValue is specified, it is used as the initial value to
start the accumulation. The first call to the callbackfn function
provides this value as an argument instead of an array value.
return:
description: ''
type: U
inheritanceDescription: <b>Inherited From</b> Array.reduce
- name: >-
reduceRight((previousValue: DscNode, currentValue: DscNode, currentIndex:
number, array: DscNode[]) => DscNode)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.reduceRight'
package: '@azure/arm-automation'
summary: >-
Calls the specified callback function for all the elements in an array, in
descending order. The return value of the callback function is the
accumulated result, and is provided as an argument in the next call to the
callback function.
remarks: ''
isDeprecated: false
syntax:
content: >-
function reduceRight(callbackfn: (previousValue: DscNode, currentValue:
DscNode, currentIndex: number, array: DscNode[]) => DscNode): DscNode
parameters:
- id: callbackfn
type: >-
(previousValue: DscNode, currentValue: DscNode, currentIndex:
number, array: DscNode[]) => DscNode
description: >-
A function that accepts up to four arguments. The reduceRight method
calls the callbackfn function one time for each element in the
array.
return:
description: ''
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />
inheritanceDescription: <b>Inherited From</b> Array.reduceRight
- name: >-
reduceRight((previousValue: DscNode, currentValue: DscNode, currentIndex:
number, array: DscNode[]) => DscNode, DscNode)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.reduceRight_1'
package: '@azure/arm-automation'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function reduceRight(callbackfn: (previousValue: DscNode, currentValue:
DscNode, currentIndex: number, array: DscNode[]) => DscNode,
initialValue: DscNode): DscNode
parameters:
- id: callbackfn
type: >-
(previousValue: DscNode, currentValue: DscNode, currentIndex:
number, array: DscNode[]) => DscNode
description: ''
- id: initialValue
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />
description: ''
return:
description: ''
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />
inheritanceDescription: <b>Inherited From</b> Array.reduceRight
- name: >-
reduceRight<U>((previousValue: U, currentValue: DscNode, currentIndex:
number, array: DscNode[]) => U, U)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.reduceRight_2'
package: '@azure/arm-automation'
summary: >-
Calls the specified callback function for all the elements in an array, in
descending order. The return value of the callback function is the
accumulated result, and is provided as an argument in the next call to the
callback function.
remarks: ''
isDeprecated: false
syntax:
content: >-
function reduceRight<U>(callbackfn: (previousValue: U, currentValue:
DscNode, currentIndex: number, array: DscNode[]) => U, initialValue: U):
U
parameters:
- id: callbackfn
type: >-
(previousValue: U, currentValue: DscNode, currentIndex: number,
array: DscNode[]) => U
description: >-
A function that accepts up to four arguments. The reduceRight method
calls the callbackfn function one time for each element in the
array.
- id: initialValue
type: U
description: >-
If initialValue is specified, it is used as the initial value to
start the accumulation. The first call to the callbackfn function
provides this value as an argument instead of an array value.
return:
description: ''
type: U
inheritanceDescription: <b>Inherited From</b> Array.reduceRight
- name: reverse()
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.reverse'
package: '@azure/arm-automation'
summary: |-
Reverses the elements in an array in place.
This method mutates the array and returns a reference to the same array.
remarks: ''
isDeprecated: false
syntax:
content: 'function reverse(): DscNode[]'
return:
description: ''
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />[]
inheritanceDescription: <b>Inherited From</b> Array.reverse
- name: shift()
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.shift'
package: '@azure/arm-automation'
summary: >-
Removes the first element from an array and returns it.
If the array is empty, undefined is returned and the array is not
modified.
remarks: ''
isDeprecated: false
syntax:
content: 'function shift(): undefined | DscNode'
return:
description: ''
type: >-
undefined | <xref uid="@azure/arm-automation.AutomationModels.DscNode"
/>
inheritanceDescription: <b>Inherited From</b> Array.shift
- name: slice(number, number)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.slice'
package: '@azure/arm-automation'
summary: >-
Returns a copy of a section of an array.
For both start and end, a negative index can be used to indicate an offset
from the end of the array.
For example, -2 refers to the second to last element of the array.
remarks: ''
isDeprecated: false
syntax:
content: 'function slice(start?: number, end?: number): DscNode[]'
parameters:
- id: start
type: number
description: |-
The beginning index of the specified portion of the array.
If start is undefined, then the slice begins at index 0.
- id: end
type: number
description: >-
The end index of the specified portion of the array. This is
exclusive of the element at the index 'end'.
If end is undefined, then the slice extends to the end of the array.
return:
description: ''
type: <xref uid="@azure/arm-automation.AutomationModels.DscNode" />[]
inheritanceDescription: <b>Inherited From</b> Array.slice
- name: 'some((value: DscNode, index: number, array: DscNode[]) => unknown, any)'
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.some'
package: '@azure/arm-automation'
summary: >-
Determines whether the specified callback function returns true for any
element of an array.
remarks: ''
isDeprecated: false
syntax:
content: >-
function some(predicate: (value: DscNode, index: number, array:
DscNode[]) => unknown, thisArg?: any): boolean
parameters:
- id: predicate
type: '(value: DscNode, index: number, array: DscNode[]) => unknown'
description: >-
A function that accepts up to three arguments. The some method calls
the predicate function for each element in the array until the
predicate returns a value
which is coercible to the Boolean value true, or until the end of
the array.
- id: thisArg
type: any
description: >-
An object to which the this keyword can refer in the predicate
function.
If thisArg is omitted, undefined is used as the this value.
return:
description: ''
type: boolean
inheritanceDescription: <b>Inherited From</b> Array.some
- name: 'sort((a: DscNode, b: DscNode) => number)'
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.sort'
package: '@azure/arm-automation'
summary: |-
Sorts an array in place.
This method mutates the array and returns a reference to the same array.
remarks: ''
isDeprecated: false
syntax:
content: >-
function sort(compareFn?: (a: DscNode, b: DscNode) => number):
DscNodeListResult
parameters:
- id: compareFn
type: '(a: DscNode, b: DscNode) => number'
description: >-
Function used to determine the order of the elements. It is expected
to return
a negative value if the first argument is less than the second
argument, zero if they're equal, and a positive
value otherwise. If omitted, the elements are sorted in ascending,
ASCII character order.
```ts
[11,2,22,1].sort((a, b) => a - b)
```
return:
description: ''
type: >-
<xref uid="@azure/arm-automation.AutomationModels.DscNodeListResult"
/>
inheritanceDescription: <b>Inherited From</b> Array.sort
- name: splice(number, number)
uid: '@azure/arm-automation.AutomationModels.DscNodeListResult.splice'
package: '@azure/arm-automation'
summary: >-
Removes elements from an array and, if necessary, inserts new elements in
their place, returning the deleted elements.
remarks: ''
isDeprecated: false
syntax:
content: 'function splice(start: number, deleteCount?: number): DscNode[]'
parameters:
- id: start
type: number