Skip to content

Commit 3a1450d

Browse files
authored
[Service Fabric] az sf cluster setting: Add examples for using --settings-section parameter (#31809)
1 parent d8c910c commit 3a1450d

1 file changed

Lines changed: 20 additions & 26 deletions

File tree

  • src/azure-cli/azure/cli/command_modules/servicefabric

src/azure-cli/azure/cli/command_modules/servicefabric/_help.py

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
helps['sf application update'] = """
3636
type: command
37-
short-summary: Update a Azure Service Fabric application. This allows updating the application parameters and/or upgrade the application type version which will trigger an application upgrade.
37+
short-summary: Update an Azure Service Fabric application. This allows updating the application parameters and/or upgrade the application type version which will trigger an application upgrade.
3838
examples:
3939
- name: Update application parameters and upgrade policy values and app type version to v2.
4040
text: >
@@ -92,11 +92,6 @@
9292
short-summary: Manage applications types and its versions running on an Azure Service Fabric cluster. Only support ARM deployed application types.
9393
"""
9494

95-
helps['sf application-type'] = """
96-
type: group
97-
short-summary: Manage application types on an Azure Service Fabric cluster.
98-
"""
99-
10095
helps['sf application-type create'] = """
10196
type: command
10297
short-summary: Create a new application type on an Azure Service Fabric cluster.
@@ -352,7 +347,9 @@
352347
- name: Remove the `MaxFileOperationTimeout` setting from a cluster.
353348
text: >
354349
az sf cluster setting remove -g group-name -c cluster1 --section 'NamingService' --parameter 'MaxFileOperationTimeout'
355-
350+
- name: Remove the `MaxFileOperationTimeout` setting from a cluster using settings file.
351+
text: >
352+
az sf cluster setting remove -g group-name -c cluster1 --settings-section '@settings-section.json'
356353
"""
357354

358355
helps['sf cluster setting set'] = """
@@ -362,7 +359,9 @@
362359
- name: Set the `MaxFileOperationTimeout` setting for a cluster to 5 seconds.
363360
text: >
364361
az sf cluster setting set -g group-name -c cluster1 --section 'NamingService' --parameter 'MaxFileOperationTimeout' --value 5000
365-
362+
- name: Set the `MaxFileOperationTimeout` setting for a cluster to 5 seconds using settings file.
363+
text: >
364+
az sf cluster setting set -g group-name -c cluster1 --settings-section '@settings-section.json'
366365
"""
367366

368367
helps['sf cluster upgrade-type'] = """
@@ -372,7 +371,7 @@
372371

373372
helps['sf cluster upgrade-type set'] = """
374373
type: command
375-
short-summary: Change the upgrade type for a cluster.
374+
short-summary: Change the upgrade type for a cluster.
376375
examples:
377376
- name: Set a cluster to use the 'Automatic' upgrade mode.
378377
text: >
@@ -407,7 +406,7 @@
407406

408407
helps['sf managed-cluster create'] = """
409408
type: command
410-
short-summary: Delete a managed cluster.
409+
short-summary: Create a managed cluster.
411410
examples:
412411
- name: Create cluster with standard sku and client cert by thumbprint.
413412
text: >
@@ -437,7 +436,7 @@
437436

438437
helps['sf managed-cluster client-certificate'] = """
439438
type: group
440-
short-summary: Manage client certificates of a manged cluster.
439+
short-summary: Manage client certificates of a managed cluster.
441440
"""
442441

443442
helps['sf managed-cluster client-certificate add'] = """
@@ -466,7 +465,7 @@
466465

467466
helps['sf managed-cluster network-security-rule'] = """
468467
type: group
469-
short-summary: network security rule of a managed cluster.
468+
short-summary: Manage network security rules of a managed cluster.
470469
"""
471470

472471
helps['sf managed-cluster network-security-rule add'] = """
@@ -505,16 +504,16 @@
505504

506505
helps['sf managed-cluster network-security-rule list'] = """
507506
type: command
508-
short-summary: list of network security rules in a cluster.
507+
short-summary: List network security rules in a cluster.
509508
examples:
510-
- name: list network security rules.
509+
- name: List network security rules.
511510
text: >
512511
az sf managed-cluster network-security-rule list -g testRG -c testCluster
513512
"""
514513

515514
helps['sf managed-cluster network-security-rule delete'] = """
516515
type: command
517-
short-summary: Delete a network security rule to a managed cluster.
516+
short-summary: Delete a network security rule from a managed cluster.
518517
examples:
519518
- name: Delete network security rule.
520519
text: >
@@ -551,7 +550,7 @@
551550
- name: Create primary node type with 5 nodes.
552551
text: >
553552
az sf managed-node-type create -g testRG -c testCluster -n pnt --instance-count 5 --primary
554-
- name: Create non primary node type with placement properities, capacities and ports.
553+
- name: Create non primary node type with placement properties, capacities and ports.
555554
text: >
556555
az sf managed-node-type create -g testRG -c testCluster -n snt --instance-count 5 --placement-property NodeColor=Green SomeProperty=5 --capacity ClientConnections=65536 --app-start-port 20575 --app-end-port 20605 --ephemeral-start-port 20606 --ephemeral-end-port 20861
557556
"""
@@ -625,7 +624,7 @@
625624

626625
helps['sf managed-node-type vm-extension delete'] = """
627626
type: command
628-
short-summary: Delete an extension to the node type.
627+
short-summary: Delete an extension from the node type.
629628
examples:
630629
- name: Delete extension by name.
631630
text: >
@@ -668,10 +667,10 @@
668667

669668
helps['sf managed-application update'] = """
670669
type: command
671-
short-summary: Update a Azure Service Fabric managed application.
672-
long-summary: This allows for updating the tags, the application parameters, value is the application UpgradePolicy and/or upgrade the application type version which will trigger an application upgrade.
670+
short-summary: Update an Azure Service Fabric managed application.
671+
long-summary: This allows for updating the tags, the application parameters, the application UpgradePolicy, and/or upgrading the application type version, which will trigger an application upgrade.
673672
examples:
674-
- name: Update application parameters and upgreade policy values and app type version to v2.
673+
- name: Update application parameters and upgrade policy values and app type version to v2.
675674
text: >
676675
az sf managed-application update -g testRG -c testCluster --application-name testApp --application-type-version v2 \\
677676
--application-parameters key0=value0 --health-check-stable-duration 0 --health-check-wait-duration 0 --health-check-retry-timeout 0 \\
@@ -713,11 +712,6 @@
713712
short-summary: Manage applications types and its versions running on an Azure Service Fabric managed cluster. Only support ARM deployed application types.
714713
"""
715714

716-
helps['sf managed-application-type'] = """
717-
type: group
718-
short-summary: Manage application types on an Azure Service Fabric cluster.
719-
"""
720-
721715
helps['sf managed-application-type create'] = """
722716
type: command
723717
short-summary: Create a new managed application type on an Azure Service Fabric managed cluster.
@@ -747,7 +741,7 @@
747741

748742
helps['sf managed-application-type update'] = """
749743
type: command
750-
short-summary: Update an managed application type.
744+
short-summary: Update a managed application type.
751745
long-summary: This allows for updating of application type tags.
752746
examples:
753747
- name: Update application type tags.

0 commit comments

Comments
 (0)