Add examples

src/aosm/azext_aosm/_help.py

@@ -42,6 +42,15 @@
       - name: --output-file
         type: string
         short-summary: The name of the output file to write the generated config text to.
+    examples:
+      - name: Generate a configuration file for a Virtual Network Function.
+        text: az aosm nfd generate-config --definition-type vnf
+      - name: Generate a configuration file for a Containerised Network Function.
+        text: az aosm nfd generate-config --definition-type cnf
+      - name: Generate a configuration file for a Virtual Network Function for use on Azure Nexus.
+        text: az aosm nfd generate-config --definition-type vnf-nexus
+      - name: Generate a configuration file for a Virtual Network Function and write to a specific file.
+        text: az aosm nfd generate-config --definition-type vnf --output-file my-vnf-input-config.jsonc
 """
 
 helps[
@@ -65,6 +74,13 @@
         short-summary: The path to the configuration file.
         long-summary: |
           The path to the configuration file. This is a JSONC file that contains the required parameters for building the NFD.
+    examples:
+      - name: Build a Virtual Network Function.
+        text: az aosm nfd build --definition-type vnf --config-file my-vnf-input-config.jsonc
+      - name: Build a Containerised Network Function.
+        text: az aosm nfd build --definition-type cnf --config-file my-cnf-input-config.jsonc
+      - name: Build a Virtual Network Function for use on Azure Nexus.
+        text: az aosm nfd build --definition-type vnf-nexus --config-file my-vnf-nexus-input-config.jsonc
 """
 
 helps[
@@ -91,6 +107,15 @@
         short-summary: Pass this flag if you do not have permission to import to the Publisher subscription.
         long-summary: |
           Applies only when publishing CNFs - ignored for VNF. Pass this flag if you do not have permission to import to the Publisher subscription (Contributor role + AcrPush role, or a custom role that allows the importImage action and AcrPush over the whole subscription). Using this flag causes image artifacts to be pulled to your local machine and then pushed to the Artifact Store. This is slower than a copy entirely within Azure, but is an alterative if you do not have the required permissions.
+    examples:
+      - name: Publish a Virtual Network Function.
+        text: az aosm nfd publish --definition-type vnf --build-output-folder my-vnf-output-folder
+      - name: Publish a Containerised Network Function.
+        text: az aosm nfd publish --definition-type cnf --build-output-folder my-cnf-output-folder
+      - name: Publish a Virtual Network Function for use on Azure Nexus.
+        text: az aosm nfd publish --definition-type vnf-nexus --build-output-folder my-vnf-nexus-output-folder
+      - name: Publish a Containerised Network Function when you do not have the required import permissions.
+        text: az aosm nfd publish --definition-type cnf --build-output-folder my-cnf-output-folder --no-subscription-permissions
 """
 
 helps[
@@ -113,6 +138,11 @@
       - name: --output-file
         type: string
         short-summary: The name of the output file to write the generated config text to.
+    examples:
+      - name: Generate a configuration file for a Network Service Design.
+        text: az aosm nsd generate-config
+      - name: Generate a configuration file for a Network Service Design and write to a specific file.
+        text: az aosm nsd generate-config --output-file my-nsd-input-config.jsonc
 """
 
 helps[
@@ -128,6 +158,9 @@
         short-summary: The path to the configuration file.
         long-summary: |
           The path to the configuration file. This is a JSONC file that contains the required parameters for building the NFD.
+    examples:
+      - name: Build a Network Service Design.
+        text: az aosm nsd build --config-file my-nsd-input-config.jsonc
 """
 
 helps[
@@ -141,4 +174,7 @@
       - name: --build-output-folder
         type: string
         short-summary: Path to the folder to publish, created by the build command.
+    examples:
+      - name: Publish a Network Service Design.
+        text: az aosm nsd publish --build-output-folder my-nsd-output-folder
 """