/
FabricClient+ClusterManagementClient.xml
2750 lines (2750 loc) · 197 KB
/
FabricClient+ClusterManagementClient.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
<Type Name="FabricClient+ClusterManagementClient" FullName="System.Fabric.FabricClient+ClusterManagementClient">
<TypeSignature Language="C#" Value="public sealed class FabricClient.ClusterManagementClient" />
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi sealed beforefieldinit FabricClient/ClusterManagementClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Fabric.FabricClient.ClusterManagementClient" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class FabricClient.ClusterManagementClient" />
<TypeSignature Language="F#" Value="type FabricClient.ClusterManagementClient = class" />
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
<para>Represents the cluster management client for performing cluster maintenance operations.</para>
</summary>
<remarks>
<para>The <see cref="T:System.Fabric.FabricClient.ClusterManagementClient" /> provides APIs which help to manage the cluster as a whole.
These are typically administrative commands which relate to major cluster events such as the loss of nodes and the need to recover services in the case of major failures.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="ActivateNodeAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ActivateNodeAsync (string nodeName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task ActivateNodeAsync(string nodeName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.ActivateNodeAsync(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function ActivateNodeAsync (nodeName As String) As Task" />
<MemberSignature Language="F#" Value="member this.ActivateNodeAsync : string -> System.Threading.Tasks.Task" Usage="clusterManagementClient.ActivateNodeAsync nodeName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nodeName" Type="System.String" />
</Parameters>
<Docs>
<param name="nodeName">
<para>The Node to be Activated.</para>
</param>
<summary>
<para>Activates a Service Fabric cluster node which is currently deactivated.</para>
</summary>
<returns>
<para>A Task that represents the asynchronous acknowledgment of the request.</para>
</returns>
<remarks>
<para>
Once activated, the node will again become a viable target for placing new replicas, and any closed replicas remaining on the node will be opened.</para>
<para>
When this API completes it implies that the intent to activate has been registered by the system. It does not mean that the activation is complete. The progress of the operation can be determined by using the <see cref="M:System.Fabric.FabricClient.QueryClient.GetNodeListAsync" /> API </para>
</remarks>
<exception cref="T:System.Fabric.FabricObjectClosedException">
<para>
See <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
<exception cref="T:System.TimeoutException">
<para>
See <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
<exception cref="T:System.Fabric.FabricException">
<para>
See also <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
</Docs>
</Member>
<Member MemberName="ActivateNodeAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ActivateNodeAsync (string nodeName, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task ActivateNodeAsync(string nodeName, valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.ActivateNodeAsync(System.String,System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ActivateNodeAsync (nodeName As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="member this.ActivateNodeAsync : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="clusterManagementClient.ActivateNodeAsync (nodeName, timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nodeName" Type="System.String" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="nodeName">
<para>The Node to be Activated.</para>
</param>
<param name="timeout">
<para>The timespan that defines the maximum amount of time will allow this operation to continue before returning a <see cref="T:System.TimeoutException" />.</para>
</param>
<param name="cancellationToken">
<para>The optional cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is cancelled.</para>
</param>
<summary>
<para>Activates a Service Fabric cluster node which is currently deactivated.</para>
</summary>
<returns>
<para>A Task that represents the asynchronous acknowledgment of the request.</para>
</returns>
<remarks>
<para>
Once activated, the node will again become a viable target for placing new replicas, and any closed replicas remaining on the node will be opened.</para>
<para>
When this API completes it implies that the intent to activate has been registered by the system. It does not mean that the activation is complete. The progress of the operation can be determined by using the <see cref="M:System.Fabric.FabricClient.QueryClient.GetNodeListAsync" /> API </para>
</remarks>
<exception cref="T:System.Fabric.FabricObjectClosedException">
<para>
See <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
<exception cref="T:System.TimeoutException">
<para>
See <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
<exception cref="T:System.Fabric.FabricException">
<para>
See also <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
</Docs>
</Member>
<Member MemberName="AddConfigurationParameterOverridesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task AddConfigurationParameterOverridesAsync (string nodeName, System.Collections.Generic.IList<System.Fabric.Description.ConfigParameterOverride> configurationOverrideList, bool force);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task AddConfigurationParameterOverridesAsync(string nodeName, class System.Collections.Generic.IList`1<class System.Fabric.Description.ConfigParameterOverride> configurationOverrideList, bool force) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.AddConfigurationParameterOverridesAsync(System.String,System.Collections.Generic.IList{System.Fabric.Description.ConfigParameterOverride},System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function AddConfigurationParameterOverridesAsync (nodeName As String, configurationOverrideList As IList(Of ConfigParameterOverride), force As Boolean) As Task" />
<MemberSignature Language="F#" Value="member this.AddConfigurationParameterOverridesAsync : string * System.Collections.Generic.IList<System.Fabric.Description.ConfigParameterOverride> * bool -> System.Threading.Tasks.Task" Usage="clusterManagementClient.AddConfigurationParameterOverridesAsync (nodeName, configurationOverrideList, force)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nodeName" Type="System.String" />
<Parameter Name="configurationOverrideList" Type="System.Collections.Generic.IList<System.Fabric.Description.ConfigParameterOverride>" />
<Parameter Name="force" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="nodeName" />
<param name="configurationOverrideList" />
<param name="force" />
<summary>
Adds configuration override
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddConfigurationParameterOverridesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task AddConfigurationParameterOverridesAsync (string nodeName, System.Collections.Generic.IList<System.Fabric.Description.ConfigParameterOverride> configurationOverrideList, bool force, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task AddConfigurationParameterOverridesAsync(string nodeName, class System.Collections.Generic.IList`1<class System.Fabric.Description.ConfigParameterOverride> configurationOverrideList, bool force, valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.AddConfigurationParameterOverridesAsync(System.String,System.Collections.Generic.IList{System.Fabric.Description.ConfigParameterOverride},System.Boolean,System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function AddConfigurationParameterOverridesAsync (nodeName As String, configurationOverrideList As IList(Of ConfigParameterOverride), force As Boolean, timeout As TimeSpan, cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="member this.AddConfigurationParameterOverridesAsync : string * System.Collections.Generic.IList<System.Fabric.Description.ConfigParameterOverride> * bool * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="clusterManagementClient.AddConfigurationParameterOverridesAsync (nodeName, configurationOverrideList, force, timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nodeName" Type="System.String" />
<Parameter Name="configurationOverrideList" Type="System.Collections.Generic.IList<System.Fabric.Description.ConfigParameterOverride>" />
<Parameter Name="force" Type="System.Boolean" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="nodeName" />
<param name="configurationOverrideList" />
<param name="force" />
<param name="timeout" />
<param name="cancellationToken" />
<summary>
Adds configuration override
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddNodeTagsAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task AddNodeTagsAsync (string nodeName, System.Collections.Generic.List<string> nodeTagsList);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task AddNodeTagsAsync(string nodeName, class System.Collections.Generic.List`1<string> nodeTagsList) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.AddNodeTagsAsync(System.String,System.Collections.Generic.List{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Function AddNodeTagsAsync (nodeName As String, nodeTagsList As List(Of String)) As Task" />
<MemberSignature Language="F#" Value="member this.AddNodeTagsAsync : string * System.Collections.Generic.List<string> -> System.Threading.Tasks.Task" Usage="clusterManagementClient.AddNodeTagsAsync (nodeName, nodeTagsList)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nodeName" Type="System.String" />
<Parameter Name="nodeTagsList" Type="System.Collections.Generic.List<System.String>" />
</Parameters>
<Docs>
<param name="nodeName" />
<param name="nodeTagsList" />
<summary>
Adds tags to the node
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddNodeTagsAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task AddNodeTagsAsync (string nodeName, System.Collections.Generic.List<string> nodeTagsList, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task AddNodeTagsAsync(string nodeName, class System.Collections.Generic.List`1<string> nodeTagsList, valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.AddNodeTagsAsync(System.String,System.Collections.Generic.List{System.String},System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function AddNodeTagsAsync (nodeName As String, nodeTagsList As List(Of String), timeout As TimeSpan, cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="member this.AddNodeTagsAsync : string * System.Collections.Generic.List<string> * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="clusterManagementClient.AddNodeTagsAsync (nodeName, nodeTagsList, timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nodeName" Type="System.String" />
<Parameter Name="nodeTagsList" Type="System.Collections.Generic.List<System.String>" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="nodeName" />
<param name="nodeTagsList" />
<param name="timeout" />
<param name="cancellationToken" />
<summary>
Adds tags to the node
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CopyClusterPackage">
<MemberSignature Language="C#" Value="public void CopyClusterPackage (string imageStoreConnectionString, string clusterManifestPath, string clusterManifestPathInImageStore, string codePackagePath, string codePackagePathInImageStore);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CopyClusterPackage(string imageStoreConnectionString, string clusterManifestPath, string clusterManifestPathInImageStore, string codePackagePath, string codePackagePathInImageStore) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.CopyClusterPackage(System.String,System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub CopyClusterPackage (imageStoreConnectionString As String, clusterManifestPath As String, clusterManifestPathInImageStore As String, codePackagePath As String, codePackagePathInImageStore As String)" />
<MemberSignature Language="F#" Value="member this.CopyClusterPackage : string * string * string * string * string -> unit" Usage="clusterManagementClient.CopyClusterPackage (imageStoreConnectionString, clusterManifestPath, clusterManifestPathInImageStore, codePackagePath, codePackagePathInImageStore)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="imageStoreConnectionString" Type="System.String" />
<Parameter Name="clusterManifestPath" Type="System.String" />
<Parameter Name="clusterManifestPathInImageStore" Type="System.String" />
<Parameter Name="codePackagePath" Type="System.String" />
<Parameter Name="codePackagePathInImageStore" Type="System.String" />
</Parameters>
<Docs>
<param name="imageStoreConnectionString">
<para>The connection string for the image store, which should match the "ImageStoreConnectionString" setting value found in the cluster manifest of the target cluster. In an on-premise cluster, the value is chosen during initial deployment by the cluster administrator. In an Azure cluster created through the Azure Resource Manager, this value is "fabric:ImageStore". The image store connection string value can be checked by looking at the cluster manifest contents returned by <see cref="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterManifestAsync" />.
</para>
</param>
<param name="clusterManifestPath">
<para>The full path to the cluster manifest file to be copied.</para>
</param>
<param name="clusterManifestPathInImageStore">
<para>The relative path along with the file name of the destination in the image store. This parameter is required when clusterManifestPath is specified. This path is created relative to the root directory in the image store and used as the destination for the cluster manifest copy.</para>
</param>
<param name="codePackagePath">
<para>The full path to the Service Fabric code package to be copied.</para>
</param>
<param name="codePackagePathInImageStore">
<para>The relative path along with the file name of the destination in the image store. This parameter is required when codePackagePathInImageStore is specified. This path is created relative to the root directory in the image store and used as the destination for the code package copy.</para>
</param>
<summary>
<para>Copies the cluster manifest file and/or Service Fabric code package to the image store.</para>
</summary>
<remarks>
<para>Both source cluster manifest path and source code path cannot be null.</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">
<para>There was an error accessing a file on the image store.</para>
</exception>
<exception cref="T:System.IO.FileNotFoundException">
<para>A required file was not found on the image store.</para>
</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">
<para>A required directory was not found on the image store.</para>
</exception>
<exception cref="T:System.IO.PathTooLongException">
<para>A path to an image store file/directory was too long.</para>
</exception>
<exception cref="T:System.Fabric.FabricException">
<para>
<see cref="F:System.Fabric.FabricErrorCode.ImageStoreIOException" />: There was an IO error communicating with the image store.</para>
</exception>
<exception cref="T:System.TimeoutException">
<para>The request timed out but may have already been accepted for processing by the system.</para>
</exception>
</Docs>
</Member>
<Member MemberName="CopyClusterPackage">
<MemberSignature Language="C#" Value="public void CopyClusterPackage (string imageStoreConnectionString, string clusterManifestPath, string clusterManifestPathInImageStore, string codePackagePath, string codePackagePathInImageStore, TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CopyClusterPackage(string imageStoreConnectionString, string clusterManifestPath, string clusterManifestPathInImageStore, string codePackagePath, string codePackagePathInImageStore, valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.CopyClusterPackage(System.String,System.String,System.String,System.String,System.String,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Sub CopyClusterPackage (imageStoreConnectionString As String, clusterManifestPath As String, clusterManifestPathInImageStore As String, codePackagePath As String, codePackagePathInImageStore As String, timeout As TimeSpan)" />
<MemberSignature Language="F#" Value="member this.CopyClusterPackage : string * string * string * string * string * TimeSpan -> unit" Usage="clusterManagementClient.CopyClusterPackage (imageStoreConnectionString, clusterManifestPath, clusterManifestPathInImageStore, codePackagePath, codePackagePathInImageStore, timeout)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="imageStoreConnectionString" Type="System.String" />
<Parameter Name="clusterManifestPath" Type="System.String" />
<Parameter Name="clusterManifestPathInImageStore" Type="System.String" />
<Parameter Name="codePackagePath" Type="System.String" />
<Parameter Name="codePackagePathInImageStore" Type="System.String" />
<Parameter Name="timeout" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="imageStoreConnectionString">
<para>The connection string for the image store, which should match the "ImageStoreConnectionString" setting value found in the cluster manifest of the target cluster. In an on-premise cluster, the value is chosen during initial deployment by the cluster administrator. In an Azure cluster created through the Azure Resource Manager, this value is "fabric:ImageStore". The image store connection string value can be checked by looking at the cluster manifest contents returned by <see cref="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterManifestAsync" />.
</para>
</param>
<param name="clusterManifestPath">
<para>The full path to the cluster manifest file to be copied.</para>
</param>
<param name="clusterManifestPathInImageStore">
<para>The relative path along with the file name of the destination in the image store. This parameter is required when clusterManifestPath is specified. This path is created relative to the root directory in the image store and used as the destination for the cluster manifest copy.</para>
</param>
<param name="codePackagePath">
<para>The full path to the Service Fabric code package to be copied.</para>
</param>
<param name="codePackagePathInImageStore">
<para>The relative path along with the file name of the destination in the image store. This parameter is required when codePackagePathInImageStore is specified. This path is created relative to the root directory in the image store and used as the destination for the code package copy.</para>
</param>
<param name="timeout">
<para>The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a <see cref="T:System.TimeoutException" />.</para>
</param>
<summary>
<para>Copies the cluster manifest file and/or Service Fabric code package to the image store.</para>
</summary>
<remarks>
<para>Both source cluster manifest path and source code path cannot be null.</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">
<para>There was an error accessing a file on the image store.</para>
</exception>
<exception cref="T:System.IO.FileNotFoundException">
<para>A required file was not found on the image store.</para>
</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">
<para>A required directory was not found on the image store.</para>
</exception>
<exception cref="T:System.IO.PathTooLongException">
<para>A path to an image store file/directory was too long.</para>
</exception>
<exception cref="T:System.Fabric.FabricException">
<para>
<see cref="F:System.Fabric.FabricErrorCode.ImageStoreIOException" />: There was an IO error communicating with the image store.</para>
</exception>
<exception cref="T:System.TimeoutException">
<para>The request timed out but may have already been accepted for processing by the system.</para>
</exception>
</Docs>
</Member>
<Member MemberName="DeactivateNodeAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeactivateNodeAsync (string nodeName, System.Fabric.NodeDeactivationIntent deactivationIntent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeactivateNodeAsync(string nodeName, valuetype System.Fabric.NodeDeactivationIntent deactivationIntent) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.DeactivateNodeAsync(System.String,System.Fabric.NodeDeactivationIntent)" />
<MemberSignature Language="VB.NET" Value="Public Function DeactivateNodeAsync (nodeName As String, deactivationIntent As NodeDeactivationIntent) As Task" />
<MemberSignature Language="F#" Value="member this.DeactivateNodeAsync : string * System.Fabric.NodeDeactivationIntent -> System.Threading.Tasks.Task" Usage="clusterManagementClient.DeactivateNodeAsync (nodeName, deactivationIntent)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nodeName" Type="System.String" />
<Parameter Name="deactivationIntent" Type="System.Fabric.NodeDeactivationIntent" />
</Parameters>
<Docs>
<param name="nodeName">
<para>The name of the node to deactivate.</para>
</param>
<param name="deactivationIntent">
<para>The <see cref="T:System.Fabric.NodeDeactivationIntent" /> for deactivating the node.</para>
</param>
<summary>
<para>Deactivates a particular node with the specified <see cref="T:System.Fabric.NodeDeactivationIntent" />.</para>
</summary>
<returns>
<para>A Task that represents the asynchronous acknowledgment of the request.</para>
</returns>
<remarks>
<para>
When this API completes it implies that the intent to deactivate has been registered by the system. It does not mean that the deactivation is complete. The progress of the operation can be determined by using the <see cref="M:System.Fabric.FabricClient.QueryClient.GetNodeListAsync" /> API </para>
<para>
Once the deactivation is in progress, the deactivation intent can be “increased” but not decreased (for example, a node which is was deactivated with the <see cref="F:System.Fabric.NodeDeactivationIntent.Pause" /> intent can be deactivated further with <see cref="F:System.Fabric.NodeDeactivationIntent.Restart" />, but not the other way around. Nodes may be reactivated via <see cref="M:System.Fabric.FabricClient.ClusterManagementClient.ActivateNodeAsync(System.String)" /> any time after they are deactivated. If the deactivation is not complete this will cancel the deactivation. A node which goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.</para>
<para>
Service Fabric ensures that deactivation is a 'safe' process. It performs several safety checks (see <see cref="T:System.Fabric.SafetyCheckKind" />) to ensure that there is no loss of availability or data </para>
</remarks>
<exception cref="T:System.Fabric.FabricObjectClosedException">
<para>
See <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
<exception cref="T:System.TimeoutException">
<para>
See <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
<exception cref="T:System.Fabric.FabricException">
<para>
See also <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
</Docs>
</Member>
<Member MemberName="DeactivateNodeAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeactivateNodeAsync (string nodeName, System.Fabric.NodeDeactivationIntent deactivationIntent, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeactivateNodeAsync(string nodeName, valuetype System.Fabric.NodeDeactivationIntent deactivationIntent, valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.DeactivateNodeAsync(System.String,System.Fabric.NodeDeactivationIntent,System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function DeactivateNodeAsync (nodeName As String, deactivationIntent As NodeDeactivationIntent, timeout As TimeSpan, cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="member this.DeactivateNodeAsync : string * System.Fabric.NodeDeactivationIntent * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="clusterManagementClient.DeactivateNodeAsync (nodeName, deactivationIntent, timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nodeName" Type="System.String" />
<Parameter Name="deactivationIntent" Type="System.Fabric.NodeDeactivationIntent" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="nodeName">
<para>The name of the node to deactivate.</para>
</param>
<param name="deactivationIntent">
<para>The <see cref="T:System.Fabric.NodeDeactivationIntent" /> for deactivating the node.</para>
</param>
<param name="timeout">
<para>The timespan that defines the maximum amount of time will allow this operation to continue before returning a <see cref="T:System.TimeoutException" />.</para>
</param>
<param name="cancellationToken">
<para>The optional cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is cancelled.</para>
</param>
<summary>
<para>Deactivates a particular node with the specified <see cref="T:System.Fabric.NodeDeactivationIntent" />.</para>
</summary>
<returns>
<para>A Task that represents the asynchronous acknowledgment of the request.</para>
</returns>
<remarks>
<para>
When this API completes it implies that the intent to deactivate has been registered by the system. It does not mean that the deactivation is complete. The progress of the operation can be determined by using the <see cref="M:System.Fabric.FabricClient.QueryClient.GetNodeListAsync" /> API </para>
<para>
Once the deactivation is in progress, the deactivation intent can be “increased” but not decreased (for example, a node which is was deactivated with the <see cref="F:System.Fabric.NodeDeactivationIntent.Pause" /> intent can be deactivated further with <see cref="F:System.Fabric.NodeDeactivationIntent.Restart" />, but not the other way around. Nodes may be reactivated via <see cref="M:System.Fabric.FabricClient.ClusterManagementClient.ActivateNodeAsync(System.String)" /> any time after they are deactivated. If the deactivation is not complete this will cancel the deactivation. A node which goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.</para>
<para>
Service Fabric ensures that deactivation is a 'safe' process. It performs several safety checks (see <see cref="T:System.Fabric.SafetyCheckKind" />) to ensure that there is no loss of availability or data </para>
</remarks>
<exception cref="T:System.Fabric.FabricObjectClosedException">
<para>
See <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
<exception cref="T:System.TimeoutException">
<para>
See <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
<exception cref="T:System.Fabric.FabricException">
<para>
See also <see href="https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/" /> for handling common FabricClient failures.</para>
</exception>
</Docs>
</Member>
<Member MemberName="GetClusterConfigurationAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<string> GetClusterConfigurationAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<string> GetClusterConfigurationAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterConfigurationAsync" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterConfigurationAsync () As Task(Of String)" />
<MemberSignature Language="F#" Value="member this.GetClusterConfigurationAsync : unit -> System.Threading.Tasks.Task<string>" Usage="clusterManagementClient.GetClusterConfigurationAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.String></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Gets the Service Fabric cluster configuration file as a string.</para>
</summary>
<returns>
<para>The Service Fabric cluster configuration file as a string.</para>
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClusterConfigurationAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<string> GetClusterConfigurationAsync (string apiVersion);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<string> GetClusterConfigurationAsync(string apiVersion) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterConfigurationAsync(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterConfigurationAsync (apiVersion As String) As Task(Of String)" />
<MemberSignature Language="F#" Value="member this.GetClusterConfigurationAsync : string -> System.Threading.Tasks.Task<string>" Usage="clusterManagementClient.GetClusterConfigurationAsync apiVersion" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.String></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="apiVersion" Type="System.String" />
</Parameters>
<Docs>
<param name="apiVersion">Api version.</param>
<summary>
<para>Gets the Service Fabric cluster configuration file as a string.</para>
</summary>
<returns>
<para>The Service Fabric cluster configuration file as a string.</para>
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClusterConfigurationAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<string> GetClusterConfigurationAsync (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<string> GetClusterConfigurationAsync(valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterConfigurationAsync(System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterConfigurationAsync (timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of String)" />
<MemberSignature Language="F#" Value="member this.GetClusterConfigurationAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>" Usage="clusterManagementClient.GetClusterConfigurationAsync (timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.String></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="timeout">
<para>The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a <see cref="T:System.TimeoutException" />.</para>
</param>
<param name="cancellationToken">
<para>The cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled.
Note that cancellation is advisory and that the operation may still be completed even if it is canceled.</para>
</param>
<summary>
<para>Gets the Service Fabric cluster configuration file as a string, by using the specified timeout and cancellation token.</para>
</summary>
<returns>
<para>The Service Fabric cluster configuration file as a string, by using the specified timeout and cancellation token.</para>
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClusterConfigurationAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<string> GetClusterConfigurationAsync (string apiVersion, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<string> GetClusterConfigurationAsync(string apiVersion, valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterConfigurationAsync(System.String,System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterConfigurationAsync (apiVersion As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of String)" />
<MemberSignature Language="F#" Value="member this.GetClusterConfigurationAsync : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>" Usage="clusterManagementClient.GetClusterConfigurationAsync (apiVersion, timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.String></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="apiVersion" Type="System.String" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="apiVersion">Api verison.</param>
<param name="timeout">
<para>The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a <see cref="T:System.TimeoutException" />.</para>
</param>
<param name="cancellationToken">
<para>The cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled.
Note that cancellation is advisory and that the operation may still be completed even if it is canceled.</para>
</param>
<summary>
<para>Gets the Service Fabric cluster configuration file as a string, by using the specified timeout and cancellation token.</para>
</summary>
<returns>
<para>The Service Fabric cluster configuration file as a string, by using the specified timeout and cancellation token.</para>
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClusterConfigurationUpgradeStatusAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress> GetClusterConfigurationUpgradeStatusAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Fabric.FabricOrchestrationUpgradeProgress> GetClusterConfigurationUpgradeStatusAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterConfigurationUpgradeStatusAsync" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterConfigurationUpgradeStatusAsync () As Task(Of FabricOrchestrationUpgradeProgress)" />
<MemberSignature Language="F#" Value="member this.GetClusterConfigurationUpgradeStatusAsync : unit -> System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress>" Usage="clusterManagementClient.GetClusterConfigurationUpgradeStatusAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Obtains the status of an upgrade in progress.
</summary>
<returns>FabricOrchestrationUpgradeProgress</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClusterConfigurationUpgradeStatusAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress> GetClusterConfigurationUpgradeStatusAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Fabric.FabricOrchestrationUpgradeProgress> GetClusterConfigurationUpgradeStatusAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterConfigurationUpgradeStatusAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterConfigurationUpgradeStatusAsync (cancellationToken As CancellationToken) As Task(Of FabricOrchestrationUpgradeProgress)" />
<MemberSignature Language="F#" Value="member this.GetClusterConfigurationUpgradeStatusAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress>" Usage="clusterManagementClient.GetClusterConfigurationUpgradeStatusAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken" />
<summary>
Obtains the status of an upgrade in progress.
</summary>
<returns>FabricOrchestrationUpgradeProgress</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClusterConfigurationUpgradeStatusAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress> GetClusterConfigurationUpgradeStatusAsync (TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Fabric.FabricOrchestrationUpgradeProgress> GetClusterConfigurationUpgradeStatusAsync(valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterConfigurationUpgradeStatusAsync(System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterConfigurationUpgradeStatusAsync (timeout As TimeSpan) As Task(Of FabricOrchestrationUpgradeProgress)" />
<MemberSignature Language="F#" Value="member this.GetClusterConfigurationUpgradeStatusAsync : TimeSpan -> System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress>" Usage="clusterManagementClient.GetClusterConfigurationUpgradeStatusAsync timeout" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="timeout">
<para>The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a <see cref="T:System.TimeoutException" />.</para>
</param>
<summary>
Obtains the status of an upgrade in progress.
</summary>
<returns>FabricOrchestrationUpgradeProgress</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClusterConfigurationUpgradeStatusAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress> GetClusterConfigurationUpgradeStatusAsync (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Fabric.FabricOrchestrationUpgradeProgress> GetClusterConfigurationUpgradeStatusAsync(valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterConfigurationUpgradeStatusAsync(System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterConfigurationUpgradeStatusAsync (timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of FabricOrchestrationUpgradeProgress)" />
<MemberSignature Language="F#" Value="member this.GetClusterConfigurationUpgradeStatusAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress>" Usage="clusterManagementClient.GetClusterConfigurationUpgradeStatusAsync (timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Fabric.FabricOrchestrationUpgradeProgress></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="timeout">
<para>The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a <see cref="T:System.TimeoutException" />.</para>
</param>
<param name="cancellationToken">
<para>The cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled.
Note that cancellation is advisory and that the operation may still be completed even if it is canceled.</para>
</param>
<summary>
Obtains the status of an upgrade in progress.
</summary>
<returns>FabricOrchestrationUpgradeProgress</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClusterManifestAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<string> GetClusterManifestAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<string> GetClusterManifestAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterManifestAsync" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterManifestAsync () As Task(Of String)" />
<MemberSignature Language="F#" Value="member this.GetClusterManifestAsync : unit -> System.Threading.Tasks.Task<string>" Usage="clusterManagementClient.GetClusterManifestAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.String></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Gets the XML contents of the current running cluster manifest.</para>
</summary>
<returns>
<para>The cluster manifest contents.</para>
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Fabric.FabricObjectClosedException">
<para>The <see cref="T:System.Fabric.FabricClient" /> object is in a closed state. Dispose of the <see cref="T:System.Fabric.FabricClient" /> object you are using and instantiate a new <see cref="T:System.Fabric.FabricClient" /> object.</para>
</exception>
<exception cref="T:System.Fabric.FabricTransientException">
<para>Failure of an operation due to a transient environmental or runtime circumstance
clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.</para>
</exception>
<exception cref="T:System.TimeoutException">
<para>Failure of an operation due to a transient environmental or runtime circumstance
clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.</para>
</exception>
</Docs>
</Member>
<Member MemberName="GetClusterManifestAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<string> GetClusterManifestAsync (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<string> GetClusterManifestAsync(valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterManifestAsync(System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterManifestAsync (timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of String)" />
<MemberSignature Language="F#" Value="member this.GetClusterManifestAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>" Usage="clusterManagementClient.GetClusterManifestAsync (timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.String></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="timeout">
<para>The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a <see cref="T:System.TimeoutException" />.</para>
</param>
<param name="cancellationToken">
<para>The cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled.
Note that cancellation is advisory and that the operation may still be completed even if it is canceled.</para>
</param>
<summary>
<para>Gets the XML contents of the current running cluster manifest.</para>
</summary>
<returns>
<para>The cluster manifest contents.</para>
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Fabric.FabricObjectClosedException">
<para>The <see cref="T:System.Fabric.FabricClient" /> object is in a closed state. Dispose of the <see cref="T:System.Fabric.FabricClient" /> object you are using
and instantiate a new <see cref="T:System.Fabric.FabricClient" /> object.</para>
</exception>
<exception cref="T:System.Fabric.FabricTransientException">
<para>Failure of an operation due to a transient environmental or runtime circumstance
clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.</para>
</exception>
<exception cref="T:System.TimeoutException">
<para>Failure of an operation due to a transient environmental or runtime circumstance
clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.</para>
</exception>
</Docs>
</Member>
<Member MemberName="GetClusterManifestAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<string> GetClusterManifestAsync (System.Fabric.Description.ClusterManifestQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<string> GetClusterManifestAsync(class System.Fabric.Description.ClusterManifestQueryDescription queryDescription, valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetClusterManifestAsync(System.Fabric.Description.ClusterManifestQueryDescription,System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClusterManifestAsync (queryDescription As ClusterManifestQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of String)" />
<MemberSignature Language="F#" Value="member this.GetClusterManifestAsync : System.Fabric.Description.ClusterManifestQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>" Usage="clusterManagementClient.GetClusterManifestAsync (queryDescription, timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.String></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="queryDescription" Type="System.Fabric.Description.ClusterManifestQueryDescription" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="queryDescription">
<para>Specifies additional parameters to determine which cluster manifest to retrieve.</para>
</param>
<param name="timeout">
<para>The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a <see cref="T:System.TimeoutException" />.</para>
</param>
<param name="cancellationToken">
<para>The cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled.
Note that cancellation is advisory and that the operation may still be completed even if it is canceled.</para>
</param>
<summary>
<para>Gets the XML contents of a cluster manifest as specified by <paramref name="queryDescription" />.</para>
</summary>
<returns>
<para>The cluster manifest contents.</para>
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Fabric.FabricObjectClosedException">
<para>The <see cref="T:System.Fabric.FabricClient" /> object is in a closed state. Dispose of the <see cref="T:System.Fabric.FabricClient" /> object you are using
and instantiate a new <see cref="T:System.Fabric.FabricClient" /> object.</para>
</exception>
<exception cref="T:System.Fabric.FabricTransientException">
<para>Failure of an operation due to a transient environmental or runtime circumstance
clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.</para>
</exception>
<exception cref="T:System.TimeoutException">
<para>Failure of an operation due to a transient environmental or runtime circumstance
clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.</para>
</exception>
</Docs>
</Member>
<Member MemberName="GetConfigurationOverridesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Fabric.Description.ConfigParameterOverrideList> GetConfigurationOverridesAsync (string nodeName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Fabric.Description.ConfigParameterOverrideList> GetConfigurationOverridesAsync(string nodeName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetConfigurationOverridesAsync(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetConfigurationOverridesAsync (nodeName As String) As Task(Of ConfigParameterOverrideList)" />
<MemberSignature Language="F#" Value="member this.GetConfigurationOverridesAsync : string -> System.Threading.Tasks.Task<System.Fabric.Description.ConfigParameterOverrideList>" Usage="clusterManagementClient.GetConfigurationOverridesAsync nodeName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Fabric.Description.ConfigParameterOverrideList></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nodeName" Type="System.String" />
</Parameters>
<Docs>
<param name="nodeName" />
<summary>
Gets configuration override
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetConfigurationOverridesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Fabric.Description.ConfigParameterOverrideList> GetConfigurationOverridesAsync (string nodeName, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Fabric.Description.ConfigParameterOverrideList> GetConfigurationOverridesAsync(string nodeName, valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetConfigurationOverridesAsync(System.String,System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetConfigurationOverridesAsync (nodeName As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ConfigParameterOverrideList)" />
<MemberSignature Language="F#" Value="member this.GetConfigurationOverridesAsync : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Description.ConfigParameterOverrideList>" Usage="clusterManagementClient.GetConfigurationOverridesAsync (nodeName, timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Fabric.Description.ConfigParameterOverrideList></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nodeName" Type="System.String" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="nodeName" />
<param name="timeout" />
<param name="cancellationToken" />
<summary>
Gets configuration override
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetFabricUpgradeProgressAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Fabric.FabricUpgradeProgress> GetFabricUpgradeProgressAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Fabric.FabricUpgradeProgress> GetFabricUpgradeProgressAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetFabricUpgradeProgressAsync" />
<MemberSignature Language="VB.NET" Value="Public Function GetFabricUpgradeProgressAsync () As Task(Of FabricUpgradeProgress)" />
<MemberSignature Language="F#" Value="member this.GetFabricUpgradeProgressAsync : unit -> System.Threading.Tasks.Task<System.Fabric.FabricUpgradeProgress>" Usage="clusterManagementClient.GetFabricUpgradeProgressAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Fabric.FabricUpgradeProgress></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Returns the progress of a Service Fabric upgrade process.</para>
</summary>
<returns>
<para>The progress of a Service Fabric upgrade process.</para>
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Fabric.FabricObjectClosedException">
<para>The <see cref="T:System.Fabric.FabricClient" /> object is in a closed state. Dispose of the <see cref="T:System.Fabric.FabricClient" /> object you are using and instantiate a new <see cref="T:System.Fabric.FabricClient" /> object.</para>
</exception>
</Docs>
</Member>
<Member MemberName="GetFabricUpgradeProgressAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Fabric.FabricUpgradeProgress> GetFabricUpgradeProgressAsync (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Fabric.FabricUpgradeProgress> GetFabricUpgradeProgressAsync(valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.FabricClient.ClusterManagementClient.GetFabricUpgradeProgressAsync(System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetFabricUpgradeProgressAsync (timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of FabricUpgradeProgress)" />
<MemberSignature Language="F#" Value="member this.GetFabricUpgradeProgressAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.FabricUpgradeProgress>" Usage="clusterManagementClient.GetFabricUpgradeProgressAsync (timeout, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Fabric.FabricUpgradeProgress></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="timeout">
<para>The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a <see cref="T:System.TimeoutException" />.</para>
</param>
<param name="cancellationToken">