networkfabric CLI- Add missing examples and update verbiage of existing examples

src/managednetworkfabric/HISTORY.rst

@@ -2,6 +2,8 @@
 
 Release History
 ===============
+8.0.0b7
+* Added missing examples and updated verbiage on existing examples
 
 8.0.0b6
 * Enables the 'device refresh-configuration' command that was previously disabled/removed.

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/acl/_create.py

@@ -17,10 +17,10 @@
 class Create(AAZCommand):
     """Create a Access Control List resource
 
-    :example: Creates an Access Control List with Configuration type as "File".
+    :example: Create an Access Control List with Configuration type as "File".
         az networkfabric acl create --resource-group "example-rg" --location "westus3" --resource-name "example-accesscontrollist" --configuration-type "File" --acls-url "https://ACL-Storage-URL"
 
-    :example: Creates an Access Control List with Configuration type as "Inline".
+    :example: Create an Access Control List with Configuration type as "Inline".
         az networkfabric acl create --resource-group "example-rg" --location "westus3" --resource-name "example-accesscontrollist" --configuration-type "Inline" --default-action "Permit" --dynamic-match-configurations "[{ipGroups:[{name:'example-ipGroup',ipAddressType:IPv4,ipPrefixes:['10.20.3.1/20']}],vlanGroups:[{name:'example-vlanGroup',vlans:['20-30']}],portGroups:[{name:'example-portGroup',ports:['100-200']}]}]" --match-configurations "[{matchConfigurationName:'example-match',sequenceNumber:123,ipAddressType:IPv4,matchConditions:[{etherTypes:['0x1'],fragments:['0xff00-0xffff'],ipLengths:['4094-9214'],ttlValues:[23],dscpMarkings:[32],portCondition:{flags:[established],portType:SourcePort,layer4Protocol:TCP,ports:['1-20'],portGroupNames:['example-portGroup']},protocolTypes:[TCP],vlanMatchCondition:{vlans:['20-30'],innerVlans:[30],vlanGroupNames:['example-vlanGroup']},ipCondition:{type:SourceIP,prefixType:Prefix,ipPrefixValues:['10.20.20.20/12'],ipGroupNames:['example-ipGroup']}}],actions:[{type:Count,counterName:'example-counter'}]}]"
 
     :example: Help text for sub parameters under the specific parent can be viewed by using the shorthand syntax '??'. See https://github.com/Azure/azure-cli/tree/dev/doc/shorthand_syntax.md for more about shorthand syntax.

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/device/_reboot.py

@@ -17,7 +17,7 @@
 class Reboot(AAZCommand):
     """Reboot the Network Device.
 
-    :example: NetworkDevices_Reboot_MaximumSet_Gen
+    :example: Reboot the Network Device
         az networkfabric device reboot --resource-group example-rg --resource-name example-device --reboot-type GracefulRebootWithZTP
     """
 
@@ -246,13 +246,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/device/_refresh_configuration.py

@@ -17,7 +17,7 @@
 class RefreshConfiguration(AAZCommand):
     """Refreshes the configuration the Network Device.
 
-    :example: NetworkDevices_RefreshConfiguration_MaximumSet_Gen
+    :example: Run refresh configuration on the Network Device
         az networkfabric device refresh-configuration --resource-group example-rg --resource-name example-device
     """
 
@@ -222,13 +222,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/device/_run_ro.py

@@ -17,7 +17,7 @@
 class RunRo(AAZCommand):
     """Run the RO Command on the Network Device.
 
-    :example: Run ro on the network device
+    :example: Run ro on the Network Device
         az networkfabric device run-ro --resource-name "example-device" --resource-group "example-rg" --ro-command "example command"
     """
 
@@ -275,13 +275,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/device/_run_rw.py

@@ -17,7 +17,7 @@
 class RunRw(AAZCommand):
     """Run the RW Command on the Network Device.
 
-    :example: Run rw on the network device
+    :example: Run rw on the Network Device
         az networkfabric device run-rw --resource-name "example-device" --resource-group "example-rg" --rw-command "example command"
     """
 
@@ -248,13 +248,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/device/_update_admin_state.py

@@ -17,7 +17,7 @@
 class UpdateAdminState(AAZCommand):
     """Updates the Administrative state of the Network Device.
 
-    :example: Update admin state
+    :example: Update the admin state of the Network Device
         az networkfabric device update-admin-state --resource-name "example-device-name" --resource-group "example-RG" --state "UnderMaintenance"
     """
 
@@ -259,13 +259,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/device/_upgrade.py

@@ -16,6 +16,9 @@
 )
 class Upgrade(AAZCommand):
     """Upgrades the version of the Network Device.
+
+    :example: Upgrade the Network Device
+        az networkfabric device upgrade --resource-group example-rg --resource-name example-device --version 1.0.0
     """
 
     _aaz_info = {
@@ -242,13 +245,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/externalnetwork/_update_bfd_administrative_state.py

@@ -16,6 +16,9 @@
 )
 class UpdateBfdAdministrativeState(AAZCommand):
     """BFD administrative state for either static or bgp for internalNetwork.
+
+    :example: Update bfd admin state of External Network
+        az networkfabric externalnetwork update-bfd-administrative-state --resource-group example-rg --l3-isolation-domain-name example-externalnetwork --external-network-name example-ext --route-type Static --administrative-state Enable
     """
 
     _aaz_info = {
@@ -265,13 +268,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/fabric/_arm_configuration_diff.py

@@ -16,6 +16,9 @@
 )
 class ArmConfigurationDiff(AAZCommand):
     """Post action: Triggers diff of NetworkFabric ARM Configuration.
+
+    :example: Run arm configuration diff on the Network Fabric
+        az networkfabric fabric arm-configuration-diff --resource-group example-rg --network-fabric-name example-fabric
     """
 
     _aaz_info = {
@@ -218,13 +221,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/fabric/_commit_batch_status.py

@@ -16,6 +16,9 @@
 )
 class CommitBatchStatus(AAZCommand):
     """Post action: Returns a status of commit batch operation.
+
+    :example: Run commit batch status on the Network Fabric
+        az networkfabric fabric commit-batch-status --resource-group example-rg --network-fabric-name example-fabric --commit-batch-id batch-id
     """
 
     _aaz_info = {
@@ -256,13 +259,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/fabric/_commit_configuration.py

@@ -17,7 +17,7 @@
 class CommitConfiguration(AAZCommand):
     """Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.
 
-    :example: Commit Configuration
+    :example: Run commit configuration on the Network Fabric
         az networkfabric fabric commit-configuration --resource-group "example-rg" --resource-name "example-fabric"
     """
 
@@ -222,13 +222,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/fabric/_deprovision.py

@@ -234,13 +234,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/fabric/_discard_commit_batch.py

@@ -16,6 +16,9 @@
 )
 class DiscardCommitBatch(AAZCommand):
     """Post action: Discards a Batch operation in progress.
+
+    :example: Run discard commit batch on the Network Fabric
+        az networkfabric fabric discard-commit-batch --resource-group example-rg --network-fabric-name example-fabric --commit-batch-id batchId1
     """
 
     _aaz_info = {
@@ -241,13 +244,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/fabric/_lock_fabric.py

@@ -16,6 +16,9 @@
 )
 class LockFabric(AAZCommand):
     """Post action: Triggers network fabric lock operation.
+
+    :example: Run lock fabric on the Network Fabric
+        az networkfabric fabric lock-fabric --resource-group example-rg --network-fabric-name example-networkFabric --lock-type Administrative --action Lock
     """
 
     _aaz_info = {
@@ -250,13 +253,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)

src/managednetworkfabric/azext_managednetworkfabric/aaz/latest/networkfabric/fabric/_provision.py

@@ -234,13 +234,16 @@ def _build_schema_error_detail_read(cls, _schema):
         additional_info.Element = AAZObjectType()
 
         _element = _schema_error_detail_read.additional_info.Element
-        _element.info = AAZFreeFormDictType(
+        _element.info = AAZDictType(
             flags={"read_only": True},
         )
         _element.type = AAZStrType(
             flags={"read_only": True},
         )
 
+        info = _schema_error_detail_read.additional_info.Element.info
+        info.Element = AAZAnyType()
+
         details = _schema_error_detail_read.details
         details.Element = AAZObjectType()
         cls._build_schema_error_detail_read(details.Element)