From 716d78599b72f473e082520b982c0957bfde69b1 Mon Sep 17 00:00:00 2001 From: Victoria Litvinova Date: Thu, 1 Aug 2024 15:16:55 -0700 Subject: [PATCH 1/3] change < to { --- azext_iot/central/params.py | 8 ++++---- azext_iot/deviceupdate/params.py | 8 ++++---- azext_iot/digitaltwins/params.py | 6 +++--- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/azext_iot/central/params.py b/azext_iot/central/params.py index 8387f45ea..112867a74 100644 --- a/azext_iot/central/params.py +++ b/azext_iot/central/params.py @@ -97,7 +97,7 @@ def load_central_arguments(self, _): "content", options_list=["--content", "-k"], help="The device template definition. Provide path to JSON file or raw stringified JSON." - " [File Path Example: ./path/to/file.json] [Example of stringified JSON: {}]." + " [File Path Example: ./path/to/file.json] [Example of stringified JSON: {Device Template JSON}]." " The request body must contain CapabilityModel.", ) @@ -480,7 +480,7 @@ def load_central_arguments(self, _): options_list=["--content", "-k"], help="The job data definition. Provide path to JSON file or raw stringified JSON." " [File Path Example:./path/to/file.json]" - " [Example of stringified JSON:[{}]. The request body must contain array of JobData.", + " [Example of stringified JSON:[{Job Data JSON}]. The request body must contain array of JobData.", ) context.argument( "batch_type", @@ -591,7 +591,7 @@ def load_central_arguments(self, _): options_list=["--content", "-k"], help="The partial export definition. Provide path to JSON file or raw stringified JSON." " [File Path Example:./path/to/file.json]" - " [Example of stringified JSON:{}]. The request body must contain partial content of Export.", + " [Example of stringified JSON:{Export Data JSON}]. The request body must contain partial content of Export.", ) with self.argument_context("iot central export destination") as context: @@ -650,7 +650,7 @@ def load_central_arguments(self, _): options_list=["--content", "-k"], help="The partial destination definition. Provide path to JSON file or raw stringified JSON." " [File Path Example:./path/to/file.json]" - " [Example of stringified JSON:{}]." + " [Example of stringified JSON:{Destination Data JSON}]." " The request body must contain partial content of Destination.", ) diff --git a/azext_iot/deviceupdate/params.py b/azext_iot/deviceupdate/params.py index ce5df0608..22c85482c 100644 --- a/azext_iot/deviceupdate/params.py +++ b/azext_iot/deviceupdate/params.py @@ -32,7 +32,7 @@ def load_deviceupdate_arguments(self, _): "resource_group_name", arg_type=resource_group_name_type, help="Device Update account resource group name. " - "You can configure the default group using `az config set defaults.adu_group=`.", + "You can configure the default group using `az config set defaults.adu_group={name}`.", arg_group="Account Identifier", configured_default="adu_group", ) @@ -40,7 +40,7 @@ def load_deviceupdate_arguments(self, _): "name", options_list=["-n", "--account"], help="Device Update account name. " - "You can configure the default account name using `az config set defaults.adu_account=`.", + "You can configure the default account name using `az config set defaults.adu_account={name}`.", arg_group="Account Identifier", configured_default="adu_account", ) @@ -48,7 +48,7 @@ def load_deviceupdate_arguments(self, _): "instance_name", options_list=["-i", "--instance"], help="Device Update instance name. " - "You can configure the default instance name using `az config set defaults.adu_instance=`.", + "You can configure the default instance name using `az config set defaults.adu_instance={name}`.", arg_group="Account Identifier", configured_default="adu_instance", ) @@ -71,7 +71,7 @@ def load_deviceupdate_arguments(self, _): "location", options_list=["-l", "--location"], help="Device Update account location. If no location is provided the resource group location is used. " - "You can configure the default location using `az configure --defaults location=`.", + "You can configure the default location using `az configure --defaults location={name}`.", ) context.argument( "assign_identity", diff --git a/azext_iot/digitaltwins/params.py b/azext_iot/digitaltwins/params.py index 602ba7821..0dd3b0c25 100644 --- a/azext_iot/digitaltwins/params.py +++ b/azext_iot/digitaltwins/params.py @@ -40,7 +40,7 @@ def load_digitaltwins_arguments(self, _): "resource_group_name", arg_type=resource_group_name_type, help="Digital Twins instance resource group. " - "You can configure the default group using `az configure --defaults group=`.", + "You can configure the default group using `az configure --defaults group={name}`.", ) context.argument( "name", @@ -58,7 +58,7 @@ def load_digitaltwins_arguments(self, _): "location", options_list=["--location", "-l"], help="Digital Twins instance location. If no location is provided the resource group location is used." - "You can configure the default location using `az configure --defaults location=`.", + "You can configure the default location using `az configure --defaults location={name}`.", ), context.argument( "tags", @@ -699,7 +699,7 @@ def load_digitaltwins_arguments(self, _): options_list=["--output-file", "--of"], help="Name of the bulk import job's output file. This file will contain logs as well as error information. " "The file gets created automatically once the job finishes. The file gets overwritten if it already exists. " - "If not provided the output file is created with the name: _output.txt", + "If not provided the output file is created with the name: {job_id}_output.txt", arg_group="Bulk Import Job", ) context.argument( From 83f773a334b0ced9036c723b9c58ec6fcacaa3a8 Mon Sep 17 00:00:00 2001 From: Victoria Litvinova Date: Thu, 1 Aug 2024 15:27:17 -0700 Subject: [PATCH 2/3] removing some more just incase --- azext_iot/iothub/_help.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azext_iot/iothub/_help.py b/azext_iot/iothub/_help.py index a948372b1..569be8626 100644 --- a/azext_iot/iothub/_help.py +++ b/azext_iot/iothub/_help.py @@ -291,9 +291,9 @@ def load_iothub_help(): - name: Send application properties text: az iot device send-d2c-message -n {iothub_name} -d {device_id} --props 'key0=value0;key1=value1' - name: Send system properties (Message Id and Correlation Id) - text: az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.mid=;$.cid=' + text: az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.mid={id};$.cid={id}' - name: Send custom data by specifying content-type and content-encoding in system properties - text: az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=;$.ce=' --data {message_body} + text: az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct={content-type};$.ce={content-encoding}' --data {message_body} - name: Send custom data in binary format by specifying content-encoding in system properties text: az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/octet-stream' --data-file-path {file_path} - name: Send custom data in JSON format by specifying content-type and content-encoding in system properties From e43b9ce7647c68424220bea06511022f24b285fa Mon Sep 17 00:00:00 2001 From: Victoria Litvinova Date: Fri, 2 Aug 2024 14:12:41 -0700 Subject: [PATCH 3/3] help --- azext_iot/_params.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azext_iot/_params.py b/azext_iot/_params.py index 54bf532db..c91d4973b 100644 --- a/azext_iot/_params.py +++ b/azext_iot/_params.py @@ -46,7 +46,7 @@ arg_group="Access Control", help="Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. " "If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed." - "You can configure the default using `az configure --defaults iotdps-data-auth-type=`", + "You can configure the default using `az configure --defaults iotdps-data-auth-type={auth-type-value}`", configured_default="iotdps-data-auth-type", ) @@ -58,7 +58,7 @@ arg_group="Access Control", help="Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. " "If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed." - "You can configure the default using `az configure --defaults iothub-data-auth-type=`", + "You can configure the default using `az configure --defaults iothub-data-auth-type={auth-type-value}`", configured_default="iothub-data-auth-type", )