forked from dataplat/dbatools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdbatools.xml
6553 lines (6421 loc) · 308 KB
/
dbatools.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>dbatools</name>
</assembly>
<members>
<member name="T:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand">
<summary>
Implements the Select-DbaObject command
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.InputObject">
<summary>
The actual input object that is being processed
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.Property">
<summary>
The properties to select. Supports fancy DSL
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.ExcludeProperty">
<summary>
Properties to skip
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.ExpandProperty">
<summary>
A property to expand.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.Alias">
<summary>
Allow users to specify an alias property as part of the select
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.ScriptProperty">
<summary>
Specify script properties at runtime as part of the select
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.ScriptMethod">
<summary>
Specify script methods at runtime as part of the select
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.Unique">
<summary>
Whether to exclude duplicates
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.Last">
<summary>
The last number of items to pick
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.First">
<summary>
Pick the first n items.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.Skip">
<summary>
Skip n items before picking items
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.SkipLast">
<summary>
Skip the last n items
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.Wait">
<summary>
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.Index">
<summary>
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.ShowProperty">
<summary>
THe properties to display by default
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.ShowExcludeProperty">
<summary>
The properties to NOT display by default
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.TypeName">
<summary>
The typename to assign to the psobject
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.KeepInputObject">
<summary>
Keep the original input object, just add to it.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand._NonclonedProperties">
<summary>
List of properties to NOT clone into the hashtable used against Select-Object
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand._NoAdjustment">
<summary>
Whether some adjustments to the object need to be done or whether the Select-Object output can be simply passed through.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand._DisplayPropertySet">
<summary>
The set controlling what properties will be shown by default
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand._Pipeline">
<summary>
THe pipeline that is wrapped around Select-Object
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.BeginProcessing">
<summary>
Implements the begin action of the command
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.ProcessRecord">
<summary>
Implements the process action of the command
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.SelectDbaObjectCommand.EndProcessing">
<summary>
Implements the end action of the command
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand">
<summary>
Implements the Set-PSFConfig command
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.FullName">
<summary>
The full name of the setting
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.Module">
<summary>
The name of the module the setting belongs to.
Is optional due to just specifying a name is legal, in which case the first name segment becomes the module name.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.Name">
<summary>
The name of the setting within a module.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.Value">
<summary>
The value to apply.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.PersistedValue">
<summary>
The persisted value to apply.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.PersistedType">
<summary>
The persisted type to apply.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.Description">
<summary>
Add documentation to the setting.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.Validation">
<summary>
The validation script to use.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.Handler">
<summary>
The handling script to apply when changing the value.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.Hidden">
<summary>
Whether the setting should be hidden from casual discovery.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.Default">
<summary>
Whether the setting should be applied only when nothing exists yet.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.Initialize">
<summary>
Whether this is the configuration initialization call.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.SimpleExport">
<summary>
Enabling this will cause the module to use friendly json notation on export to file.
This may result in loss of data precision, but is more userfriendly.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.ModuleExport">
<summary>
Whether this setting applies to module scope file export.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.DisableValidation">
<summary>
Do not apply the validation script when changing values.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.DisableHandler">
<summary>
Do not run the handler script when changing values.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.PassThru">
<summary>
Return the changed configuration setting.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.Register">
<summary>
Registers the configuration setting into the user scope.
As if running Register-PSFConfig.
Only applies when updating an existing setting.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.EnableException">
<summary>
Enable throwing exceptions.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand._Config">
<summary>
The configuration item changed
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand._KillIt">
<summary>
Whether execution should be terminated silently.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand._Initialize">
<summary>
Whether this is an initialization execution.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand._Persisted">
<summary>
Whether persisted values need to be restored.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand._Exists">
<summary>
Whether the setting already exists.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand._PolicyEnforced">
<summary>
The setting to be affected was enforced by policy and cannot be changed by the user.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand._NameModule">
<summary>
Processed name of module.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand._NameName">
<summary>
Processed name of setting within module.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand._NameFull">
<summary>
Processed full name of setting.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand._ValidationErrorMessage">
<summary>
The reason validation failed.
Filled by ApplyValue.
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.BeginProcessing">
<summary>
Implements the begin action of Set-PSFConfig
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.ProcessRecord">
<summary>
Implements the process action of Set-PSFConfig
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.ApplyValue(System.Object)">
<summary>
Applies a value to a configuration item, invoking validation and handler scriptblocks.
</summary>
<param name="Value">The value to apply</param>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.SetDbatoolsConfigCommand.ApplyCommonSettings">
<summary>
Abstracts out
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand">
<summary>
Implements the Write-Message command, performing message handling and loggin
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.Level">
<summary>
This parameter represents the verbosity of the message. The lower the number, the more important it is for a human user to read the message.
By default, the levels are distributed like this:
- 1-3 Direct verbose output to the user (using Write-Host)
- 4-6 Output only visible when requesting extra verbosity (using Write-Verbose)
- 1-9 Debugging information, written using Write-Debug
In addition, it is possible to select the level "Warning" which moves the message out of the configurable range:
The user will always be shown this message, unless he silences the entire verbosity.
Possible levels:
Critical (1), Important / Output / Host (2), Significant (3), VeryVerbose (4), Verbose (5), SomewhatVerbose (6), System (7), Debug (8), InternalComment (9), Warning (666)
Either one of the strings or its respective number will do as input.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.Message">
<summary>
The message to write/log. The function name and timestamp will automatically be prepended.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.Tag">
<summary>
Tags to add to the message written.
This allows filtering and grouping by category of message, targeting specific messages.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.FunctionName">
<summary>
The name of the calling function.
Will be automatically set, but can be overridden when necessary.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.ModuleName">
<summary>
The name of the module, the calling function is part of.
Will be automatically set, but can be overridden when necessary.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.File">
<summary>
The file in which Write-Message was called.
Will be automatically set, but can be overridden when necessary.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.Line">
<summary>
The line on which Write-Message was called.
Will be automatically set, but can be overridden when necessary.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.ErrorRecord">
<summary>
If an error record should be noted with the message, add the full record here.
Especially designed for use with Warning-mode, it can legally be used in either mode.
The error will be added to the $Error variable and enqued in the logging/debugging system.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.Exception">
<summary>
Allows specifying an inner exception as input object. This will be passed on to the logging and used for messages.
When specifying both ErrorRecord AND Exception, Exception wins, but ErrorRecord is still used for record metadata.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.Once">
<summary>
Setting this parameter will cause this function to write the message only once per session.
The string passed here and the calling function's name are used to create a unique ID, which is then used to register the action in the configuration system.
Thus will the lockout only be written if called once and not burden the system unduly.
This lockout will be written as a hidden value, to see it use Get-DbaConfig -Force.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.OverrideExceptionMessage">
<summary>
Disables automatic appending of exception messages.
Use in cases where you already have a speaking message interpretation and do not need the original message.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.Target">
<summary>
Add the object the message is all about, in order to simplify debugging / troubleshooting.
For example, when calling this from a function targeting a remote computer, the computername could be specified here, allowing all messages to easily be correlated to the object processed.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.EnableException">
<summary>
This parameters disables user-friendly warnings and enables the throwing of exceptions.
This is less user friendly, but allows catching exceptions in calling scripts.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.Breakpoint">
<summary>
Enables breakpoints on the current message. By default, setting '-Debug' will NOT cause an interrupt on the current position.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._timestamp">
<summary>
The start time of the cmdlet
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._silent">
<summary>
Whether this cmdlet is run in silent mode
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._fromStopFunction">
<summary>
Whether this cmdlet was called by Stop-Function
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._callStack">
<summary>
The current callstack
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._stackDepth">
<summary>
How many items exist on the callstack
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._message">
<summary>
The message to write
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._messageSimple">
<summary>
The message simplified without timestamps. Used for logging.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._messageColor">
<summary>
The message to write in color
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._messageDeveloper">
<summary>
Non-colored version of developermode
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._messageDeveloperColor">
<summary>
Colored version of developermode
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._writeHostScript">
<summary>
Scriptblock that writes the host messages
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._Tags">
<summary>
List of tags to process
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._isDebug">
<summary>
Whether debug mode is enabled
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._errorQualifiedMessage">
<summary>
The input message with the error content included if desired
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._MessageSystem">
<summary>
The final message to use for internal logging
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._MessageStreams">
<summary>
The final message to use for writing to streams, such as verbose or warning
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._MessageHost">
<summary>
The final message to use for host messages (write using Write-HostColor)
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._BreadCrumbsString">
<summary>
Provide breadcrumb queue of the callstack
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand._BreadCrumbsStringColored">
<summary>
Provide a breadcrumb queue of the callstack in color tags
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.BeginProcessing">
<summary>
Processes the begin phase of the cmdlet
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.ProcessRecord">
<summary>
Processes the process phase of the cmdlet
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.ResolveTarget(System.Object)">
<summary>
Processes the target transform rules on an input object
</summary>
<param name="Item">The item to transform</param>
<returns>The transformed object</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.ResolveException(System.Exception)">
<summary>
Processes the specified exception specified
</summary>
<param name="Item">The exception to process</param>
<returns>The transformed exception</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.ResolveLevel(Sqlcollaborative.Dbatools.Message.MessageLevel)">
<summary>
Processs the input level and apply policy and rules
</summary>
<param name="Level">The original level of the message</param>
<returns>The processed level</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.GetMessage">
<summary>
Builds the message item for display of Verbose, Warning and Debug streams
</summary>
<returns>The message to return</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.GetMessageSimple">
<summary>
Builds the base message for internal system use.
</summary>
<returns>The message to return</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.GetMessageColor">
<summary>
Builds the message item if needed and returns it
</summary>
<returns>The message to return</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.GetMessageDeveloper">
<summary>
Non-host output in developermode
</summary>
<returns>The string to write on messages that don't go straight to Write-HostColor</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Commands.WriteMessageCommand.GetMessageDeveloperColor">
<summary>
Host output in developermode
</summary>
<returns>The string to write on messages that go straight to Write-HostColor</returns>
</member>
<member name="T:Sqlcollaborative.Dbatools.Computer.DiskSpace">
<summary>
Data Container for the output of Get-DbaDiskSpace
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.ComputerName">
<summary>
The computer that was scanned
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Name">
<summary>
Name of the disk
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Label">
<summary>
Label of the disk
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Capacity">
<summary>
What's the total capacity of the disk?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Free">
<summary>
How much is still free?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.PercentFree">
<summary>
How much is still free
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.BlockSize">
<summary>
What blocksize is the object set to
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FileSystem">
<summary>
What filesystem is installed on the system
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Type">
<summary>
What kind of drive is it?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.IsSqlDisk">
<summary>
Whether the drive is a sql disk. Nullable, because it is an optional property and may not always be included, thus a third state is necessary.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Server">
<summary>
The computer that was scanned. Legacy-Name
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.DriveType">
<summary>
The type of drive this is in the legacy string notation
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInBytes">
<summary>
The total capacity in Bytes
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInBytes">
<summary>
The free space in Bytes
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInKB">
<summary>
The total capacity in KB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInKB">
<summary>
The free space in KB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInMB">
<summary>
The total capacity in MB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInMB">
<summary>
The free space in MB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInGB">
<summary>
The total capacity in GB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInGB">
<summary>
The free space in GB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInTB">
<summary>
The total capacity in TB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInTB">
<summary>
The free space in TB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInPB">
<summary>
The total capacity in PB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInPB">
<summary>
The free space in PB
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Computer.DriveType">
<summary>
What kind of drive are you?
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.Unknown">
<summary>
The drive type is not actually known
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.NoRootDirectory">
<summary>
The drive has no root directory
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.RemovableDisk">
<summary>
The drive is a removable disk
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.LocalDisk">
<summary>
The drive is a local disk
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.NetworkDrive">
<summary>
The drive is a network drive
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.CompactDisk">
<summary>
The drive is a compact disk
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.RAMDisk">
<summary>
The drive is a RAM disk
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Computer.PageFileSetting">
<summary>
Data container, listing pagefile settings.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.ComputerName">
<summary>
The name of the computer
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.AutoPageFile">
<summary>
Whether Automatic PageFile management is enabled
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.FileName">
<summary>
The pagefile name
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.Status">
<summary>
The pagefile status
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.SystemManaged">
<summary>
Whether the pagefile is system managed
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.LastModified">
<summary>
When were the settings last changed
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.LastAccessed">
<summary>
When were the settings last accessed
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.AllocatedBaseSize">
<summary>
The base allocated pagefile size in MB
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.InitialSize">
<summary>
The initial pagefile size in MB
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.MaximumSize">
<summary>
The maximum pagefile size in MB
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.PeakUsage">
<summary>
The maximum percent of the pagefile limit that has been used
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.PageFileSetting.CurrentUsage">
<summary>
The currently used percentage of the pagefile limit that is in use.
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Configuration.Config">
<summary>
Configuration Manager as well as individual configuration object.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.Config.Name">
<summary>
The Name of the setting
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.FullName">
<summary>
The full name of the configuration entry, comprised of both Module and Name.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.Config.Module">
<summary>
The module of the setting. Helps being able to group configurations.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.Config.Description">
<summary>
A description of the specific setting
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Type">
<summary>
The data type of the value stored in the configuration element.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Value">
<summary>
The value stored in the configuration element
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.SafeValue">
<summary>
The value stored in the configuration element, but without deserializing objects.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Unchanged">
<summary>
Whether the value of the configuration setting has been changed since its initialization.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.Config.Handler">
<summary>
The handler script that is run whenever the configuration value is set.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.Config.Validation">
<summary>
Validates the user input
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.Config.Hidden">
<summary>
Setting this to true will cause the element to not be discovered unless using the '-Force' parameter on "Get-DbaConfig"
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Initialized">
<summary>
Whether the setting has been initialized. This handles module imports and avoids modules overwriting settings when imported in multiple runspaces.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.Config.PolicySet">
<summary>
Whether this setting was set by policy
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.PolicyEnforced">
<summary>
Whether this setting was set by policy and forbids changes to the configuration.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.Config.SimpleExport">
<summary>
Enabling this causes export to json to use simple json serialization for data transmission.
This is suitable for simple data that is not sensitive to conversion losses.
Simple export leads to exports more easily readable to the human eye.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.Config.ModuleExport">
<summary>
Whether this setting should be exported to a module specific file when exporting to json by modulename.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.RegistryData">
<summary>
The finalized value to put into the registry value when using policy to set this setting.
Deprecated property.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.Config.DefaultValue">
<summary>
The default value the configuration item was set to when initializing
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Configuration.Config.SetPersistedValue(Sqlcollaborative.Dbatools.Configuration.ConfigurationValueType,System.String)">
<summary>
Applies the persisted value to the configuration item.
This method should only be called by PSFramework internals
</summary>
<param name="Type">The type of data being specified</param>
<param name="ValueString">The value string to register</param>
</member>
<member name="M:Sqlcollaborative.Dbatools.Configuration.Config.ResetValue">
<summary>
Resets the configuration value to its configured default value
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Configuration.ConfigScope">
<summary>
The location where a setting was applied
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.UserDefault">
<summary>
The configuration is set as default value for the user
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.UserMandatory">
<summary>
The configuration is enforced for the user
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.SystemDefault">
<summary>
The configuration is set as default value for all users on the system
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.SystemMandatory">
<summary>
The configuration is enforced for all users on the system.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.FileUserLocal">
<summary>
The configuration is stored as Json in the per user local machine config directory.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.FileUserShared">
<summary>
The configuration is stored as Json in the per user config directory shared across machines.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.FileSystem">
<summary>
The configuration is stored as Json in the local computer config directory.
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost">
<summary>
Host class providing static configuration settings that are constant across all runspaces within the process.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.Configurations">
<summary>
Hashtable containing all the configuration entries
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.Validation">
<summary>
Hashtable containing all the registered validations
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.ImportFromRegistryDone">
<summary>
Whether the import from registry has been completed. Prevents multiple imports and overwrites when importing the module multiple times.
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.ConvertToPersistedValue(System.Object)">
<summary>
Converts any object into its persisted state.
</summary>
<param name="Item">The item to convert.</param>
<returns>Its persisted state representation.</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.ConvertFromPersistedValue(System.String,Sqlcollaborative.Dbatools.Configuration.ConfigurationValueType)">
<summary>
Converts a persisted value back to its original data type
</summary>
<param name="PersistedValue">The value in its persisted state</param>
<param name="Type">The type of the persisted value</param>
<returns>The natural state of the value originally persisted</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.ConvertFromPersistedValue(System.String)">
<summary>
Converts a persisted value back to its original data type
</summary>
<param name="TypeQualifiedPersistedValue">The value in its persisted state, with a prefixed type identifier.</param>
<returns>The natural state of the value originally persisted</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.Utf8ToBase64(System.String)">
<summary>
Converts a plain text into a base64 string
</summary>
<param name="Value">The string to convert</param>
<returns>base64 encoded version of string.</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.Base64ToUtf8(System.String)">
<summary>