Trivial: Improve sample parameter name convention

documents/FAQ.md

@@ -108,7 +108,7 @@ Here is an example launch.json file to run the pubsub sample
                 "--ca_file", "<path to root-CA>",
                 "--cert", "<path to cert>",
                 "--key", "<path to key>",
-                "--client-id", "test-client"
+                "--client_id", "test-client"
             ]
         }
     ]

samples/README.md

@@ -71,7 +71,7 @@ required arguments:
   --key         Path to the private key file to use during mTLS connection establishment (default: None)
 
 optional arguments:
-  --client-id   Client ID (default: mqtt5-sample-5873a450)
+  --client_id   Client ID (default: mqtt5-sample-5873a450)
   --ca_file     Path to optional CA bundle (PEM) (default: None)
   --topic       Topic (default: test/topic)
   --message     Message payload (default: Hello from mqtt5 sample)

samples/greengrass/basic_discovery.py

@@ -42,11 +42,11 @@
                     help="(optional, default='False').")
 optional.add_argument("--mode", default='both',  metavar="", dest="input_mode",
                     help=f"The operation mode (optional, default='both').\nModes:{allowed_actions}")
-optional.add_argument("--proxy-host",  metavar="", dest="input_proxy_host",
+optional.add_argument("--proxy_host",  metavar="", dest="input_proxy_host",
                       help="HTTP proxy host")
-optional.add_argument("--proxy-port", type=int, default=0,  metavar="", dest="input_proxy_port",
+optional.add_argument("--proxy_port", type=int, default=0,  metavar="", dest="input_proxy_port",
                       help="HTTP proxy port")
-optional.add_argument("--client-id",  metavar="", dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
+optional.add_argument("--client_id",  metavar="", dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
                     help="Client ID")
 
 # args contains all the parsed commandline arguments used by the sample

samples/mqtt/mqtt5_aws_websocket.md

@@ -72,7 +72,7 @@ To Run this sample from the `samples\mqtt` folder, use the following command:
 # For Windows: replace 'python3' with 'python' and '/' with '\'
 python3 mqtt5_aws_websocket.py \
   --endpoint <AWS IoT endpoint> \
-  --signing-region <Signing region for websocket connection>
+  --signing_region <Signing region for websocket connection>
 ```
 If you would like to see what optional arguments are available, use the `--help` argument:
 ``` sh
@@ -89,10 +89,10 @@ options:
 
 required arguments:
   --endpoint         IoT endpoint hostname (default: None)
-  --signing-region   Signing region for websocket connection (default: None)
+  --signing_region   Signing region for websocket connection (default: None)
 
 optional arguments:
-  --client-id        Client ID (default: mqtt5-sample-809571c8)
+  --client_id        Client ID (default: mqtt5-sample-809571c8)
   --ca_file          Path to optional CA bundle (PEM) (default: None)
   --topic            Topic (default: test/topic)
   --message          Message payload (default: Hello from mqtt5 sample)

samples/mqtt/mqtt5_aws_websocket.py

@@ -18,11 +18,11 @@
 # Required Arguments
 required.add_argument("--endpoint", required=True,  metavar="", dest="input_endpoint",
                       help="IoT endpoint hostname")
-required.add_argument("--signing-region", required=True,  metavar="", dest="input_signing_region",
+required.add_argument("--signing_region", required=True,  metavar="", dest="input_signing_region",
                       help="Signing region for websocket connection")
 
 # Optional Arguments
-optional.add_argument("--client-id",  metavar="", dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
+optional.add_argument("--client_id",  metavar="", dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
                       help="Client ID")
 optional.add_argument("--ca_file",  metavar="", dest="input_ca",
                       help="Path to optional CA bundle (PEM)")

samples/mqtt/mqtt5_custom_auth.md

@@ -121,7 +121,7 @@ required arguments:
   --auth_password       The password to send when connecting through a custom authorizer (optional) (default: None)
 
 optional arguments:
-  --client-id           Client ID (default: test-f3168b42)
+  --client_id           Client ID (default: test-f3168b42)
   --topic               Topic (default: test/topic)
   --message             Message payload (default: Hello from mqtt5 sample)
   --count               Messages to publish (0 = infinite) (default: 5)

samples/mqtt/mqtt5_custom_auth_signed.py

@@ -33,7 +33,7 @@
                     help="The password to send when connecting through a custom authorizer (optional)")
 
 # Optional Arguments
-optional.add_argument("--client-id",  metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}", 
+optional.add_argument("--client_id",  metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}", 
                       help="Client ID")
 optional.add_argument("--topic", default="test/topic",  metavar="", dest="input_topic", 
                       help="Topic")

samples/mqtt/mqtt5_custom_auth_unsigned.py

@@ -26,7 +26,7 @@
                     help="The password to send when connecting through a custom authorizer")
 
 # Optional Arguments
-optional.add_argument("--client-id",  metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
+optional.add_argument("--client_id",  metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
                       help="Client ID")
 optional.add_argument("--topic", default="test/topic",  metavar="", dest="input_topic",
                       help="Topic")

samples/mqtt/mqtt5_pkcs11_connect.md

@@ -109,9 +109,9 @@ optional arguments:
   --topic         Topic (default: test/topic)
   --message       Message payload (default: Hello from mqtt5 sample)
   --count         Messages to publish (0 = infinite) (default: 5)
-  --proxy-host    HTTP proxy host (default: None)
-  --proxy-port    HTTP proxy port (default: 0)
-  --client-id     Client ID (default: test-548e4344)
+  --proxy_host    HTTP proxy host (default: None)
+  --proxy_port    HTTP proxy port (default: 0)
+  --client_id     Client ID (default: test-548e4344)
   ```
 
 ### Run sample with SoftHSM

samples/mqtt/mqtt5_pkcs11_connect.py

@@ -42,11 +42,11 @@
                       help="Message payload")
 optional.add_argument("--count", type=int, default=5,  metavar="", dest="input_count",
                     help="Messages to publish (0 = infinite)")
-optional.add_argument("--proxy-host",  metavar="", dest="input_proxy_host",
+optional.add_argument("--proxy_host",  metavar="", dest="input_proxy_host",
                       help="HTTP proxy host")
-optional.add_argument("--proxy-port", type=int, default=0,  metavar="", dest="input_proxy_port",
+optional.add_argument("--proxy_port", type=int, default=0,  metavar="", dest="input_proxy_port",
                       help="HTTP proxy port")
-optional.add_argument("--client-id",  metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
+optional.add_argument("--client_id",  metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
                     help="Client ID")
 
 # args contains all the parsed commandline arguments used by the sample

samples/mqtt/mqtt5_x509.md

@@ -96,7 +96,7 @@ required arguments:
   --key         Path to the private key file to use during mTLS connection establishment (default: None)
 
 optional arguments:
-  --client-id   Client ID (default: mqtt5-sample-5873a450)
+  --client_id   Client ID (default: mqtt5-sample-5873a450)
   --ca_file     Path to optional CA bundle (PEM) (default: None)
   --topic       Topic (default: test/topic)
   --message     Message payload (default: Hello from mqtt5 sample)

samples/mqtt/mqtt5_x509.py

@@ -24,7 +24,7 @@
                     help="Path to the private key file to use during mTLS connection establishment")
 
 # Optional Arguments
-optional.add_argument("--client-id", metavar="",dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
+optional.add_argument("--client_id", metavar="",dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
                       help="Client ID")
 optional.add_argument("--ca_file", metavar="",dest="input_ca",
                       help="Path to optional CA bundle (PEM)")

servicetests/tests/FleetProvisioning/fleet_provisioning.py

@@ -39,11 +39,11 @@ def parse_sample_input():
     parser.add_argument("--ca_file", dest="input_ca", help="Path to optional CA bundle (PEM)")
 
     # Proxy (optional)
-    parser.add_argument("--proxy-host", dest="input_proxy_host", help="HTTP proxy host")
-    parser.add_argument("--proxy-port", type=int, default=0, dest="input_proxy_port", help="HTTP proxy port")
+    parser.add_argument("--proxy_host", dest="input_proxy_host", help="HTTP proxy host")
+    parser.add_argument("--proxy_port", type=int, default=0, dest="input_proxy_port", help="HTTP proxy port")
 
     # Misc
-    parser.add_argument("--client-id", dest="input_clientId",
+    parser.add_argument("--client_id", dest="input_clientId",
                         default=f"test-{uuid.uuid4().hex[:8]}", help="Client ID")
     parser.add_argument("--mqtt_version", type=int, default=0, dest="input_mqtt_version", help="MQTT Version")
     parser.add_argument("--csr", dest="input_csr_path", help="Path to CSR in Pem format (optional).")

servicetests/tests/JobsExecution/jobs.py

@@ -52,11 +52,11 @@ def parse_sample_input():
     parser.add_argument("--ca_file", dest="input_ca", help="Path to optional CA bundle (PEM)")
 
     # Proxy (optional)
-    parser.add_argument("--proxy-host", dest="input_proxy_host", help="HTTP proxy host")
-    parser.add_argument("--proxy-port", type=int, default=0, dest="input_proxy_port", help="HTTP proxy port")
+    parser.add_argument("--proxy_host", dest="input_proxy_host", help="HTTP proxy host")
+    parser.add_argument("--proxy_port", type=int, default=0, dest="input_proxy_port", help="HTTP proxy port")
 
     # Misc
-    parser.add_argument("--client-id", dest="input_clientId",
+    parser.add_argument("--client_id", dest="input_clientId",
                         default=f"test-{uuid.uuid4().hex[:8]}", help="Client ID")
     parser.add_argument("--mqtt_version", type=int, default=0, dest="input_mqtt_version", help="MQTT Version")
     parser.add_argument("--thing_name", required=True, dest="input_thing_name", help="The name assigned to your IoT Thing.")

servicetests/tests/ShadowUpdate/shadow_update.py

@@ -43,11 +43,11 @@ def parse_sample_input():
     parser.add_argument("--ca_file", dest="input_ca", help="Path to optional CA bundle (PEM)")
 
     # Proxy (optional)
-    parser.add_argument("--proxy-host", dest="input_proxy_host", help="HTTP proxy host")
-    parser.add_argument("--proxy-port", type=int, default=0, dest="input_proxy_port", help="HTTP proxy port")
+    parser.add_argument("--proxy_host", dest="input_proxy_host", help="HTTP proxy host")
+    parser.add_argument("--proxy_port", type=int, default=0, dest="input_proxy_port", help="HTTP proxy port")
 
     # Misc
-    parser.add_argument("--client-id", dest="input_clientId",
+    parser.add_argument("--client_id", dest="input_clientId",
                         default=f"test-{uuid.uuid4().hex[:8]}", help="Client ID")
     parser.add_argument("--mqtt_version", type=int, default=0, dest="input_mqtt_version", help="MQTT Version")
     parser.add_argument("--thing_name", required=True, dest="input_thing_name", help="The name assigned to your IoT Thing.")