[hpc-cache] Improve help for nfs3_usage_model (Azure#3130)

* Improve help for nfs3_usage_model * Update src/hpc-cache/azext_hpc_cache/_params.py * Update src/hpc-cache/azext_hpc_cache/_params.py
I90Runner · Mar 30, 2021 · fa0ff87 · fa0ff87
1 parent f2ba430
commit fa0ff87
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/src/hpc-cache/HISTORY.rst b/src/hpc-cache/HISTORY.rst
@@ -3,9 +3,13 @@
 Release History
 ===============
 
+0.1.4
+++++++
+* Fix #2695: Improve the help description of parameter `--nfs3-usage-model`.
+
 0.1.3
 ++++++
-* GA hpc-cache extension
+* GA hpc-cache extension.
 
 0.1.2
 ++++++

diff --git a/src/hpc-cache/azext_hpc_cache/_params.py b/src/hpc-cache/azext_hpc_cache/_params.py
@@ -31,6 +31,11 @@
 
 storage_target_type = CLIArgumentType(help='Name of the Storage Target.')
 
+nfs3_usage_model_type = CLIArgumentType(
+    help='Identify the primary usage model to be used for this Storage Target. '
+         'You can use command `az hpc-cache usage-model list` to see the names of usage models. '
+         'For more details about usage models, please refer to https://docs.microsoft.com/azure/hpc-cache/hpc-cache-add-storage?tabs=azure-cli#choose-a-usage-model')
+
 
 def load_arguments(self, _):
 
@@ -94,12 +99,11 @@ def load_arguments(self, _):
 
         c.argument('junctions', junction_type, required=True)
         c.argument('nfs3_target', help='IP address or host name of an NFSv3 host (e.g., 10.0.44.44).', required=True)
-        c.argument('nfs3_usage_model', help='Identifies the primary usage model to be used for this Storage Target.',
-                   required=True)
+        c.argument('nfs3_usage_model', nfs3_usage_model_type, required=True)
 
     with self.argument_context('hpc-cache nfs-storage-target update') as c:
         c.argument('cache_name', cache_name_type)
         c.argument('name', storage_target_type)
         c.argument('junctions', junction_type)
         c.argument('nfs3_target', help='IP address or host name of an NFSv3 host (e.g., 10.0.44.44).')
-        c.argument('nfs3_usage_model', help='Identifies the primary usage model to be used for this Storage Target.')
+        c.argument('nfs3_usage_model', nfs3_usage_model_type)
diff --git a/src/hpc-cache/setup.py b/src/hpc-cache/setup.py
@@ -16,7 +16,7 @@
 
 # TODO: Confirm this is the right version number you want and it matches your
 # HISTORY.rst entry.
-VERSION = '0.1.3'
+VERSION = '0.1.4'
 
 # The full list of classifiers is available at
 # https://pypi.python.org/pypi?%3Aaction=list_classifiers