az iot hub message-enrichment

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage message enrichments for endpoints of an IoT Hub.

Commands

Name	Description	Type	Status
az iot hub message-enrichment create	Create a message enrichment for chosen endpoints in your IoT Hub.	Core	GA
az iot hub message-enrichment create (azure-iot extension)	Create a message enrichment for chosen endpoints in your IoT Hub.	Extension	GA
az iot hub message-enrichment delete	Delete a message enrichment in your IoT hub (by key).	Core	GA
az iot hub message-enrichment delete (azure-iot extension)	Delete a message enrichment in your IoT hub (by key).	Extension	GA
az iot hub message-enrichment list	Get information on all message enrichments for your IoT Hub.	Core	GA
az iot hub message-enrichment list (azure-iot extension)	Get information on all message enrichments for your IoT Hub.	Extension	GA
az iot hub message-enrichment update	Update a message enrichment in your IoT hub (by key).	Core	GA
az iot hub message-enrichment update (azure-iot extension)	Update a message enrichment in your IoT hub (by key).	Extension	GA

az iot hub message-enrichment create

Create a message enrichment for chosen endpoints in your IoT Hub.

az iot hub message-enrichment create --endpoints
                                     --key
                                     --name
                                     --value
                                     [--resource-group]

Examples

Create a message enrichment of {"key":"value"} for the "events" endpoint in your IoT Hub

az iot hub message-enrichment create --key key --value value --endpoints events -n {iothub_name}

Required Parameters

--endpoints -e

Endpoint(s) to apply enrichments to. Use a space-separated list for multiple endpoints.

--key -k

The enrichment's key.

--name -n

IoT Hub name.

--value -v

The enrichment's value.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot hub message-enrichment create (azure-iot extension)

Create a message enrichment for chosen endpoints in your IoT Hub.

az iot hub message-enrichment create --endpoints
                                     --key
                                     --name
                                     --value
                                     [--resource-group]

Examples

Create a message enrichment of {"key":"value"} for the "events" endpoint in your IoT Hub

az iot hub message-enrichment create --key key --value value --endpoints events -n {iothub_name}

Required Parameters

--endpoints -e

Endpoint(s) to apply enrichments to. Use a space-separated list for multiple endpoints.

--key -k

The enrichment's key.

--name -n

IoT Hub name.

--value -v

The enrichment's value.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot hub message-enrichment delete

Delete a message enrichment in your IoT hub (by key).

az iot hub message-enrichment delete --key
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Examples

Delete a message enrichment with key 'test' from your IoT Hub

az iot hub message-enrichment delete --key test -n {iothub_name}

Required Parameters

--key -k

The enrichment's key.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

IoT Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot hub message-enrichment delete (azure-iot extension)

Delete a message enrichment in your IoT hub (by key).

az iot hub message-enrichment delete --key
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Examples

Delete a message enrichment with key 'test' from your IoT Hub

az iot hub message-enrichment delete --key test -n {iothub_name}

Required Parameters

--key -k

The enrichment's key.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

IoT Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot hub message-enrichment list

Get information on all message enrichments for your IoT Hub.

az iot hub message-enrichment list [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

Examples

List all message enrichments for your IoT Hub

az iot hub message-enrichment list -n {iothub_name}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

IoT Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot hub message-enrichment list (azure-iot extension)

Get information on all message enrichments for your IoT Hub.

az iot hub message-enrichment list [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

Examples

List all message enrichments for your IoT Hub

az iot hub message-enrichment list -n {iothub_name}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

IoT Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot hub message-enrichment update

Update a message enrichment in your IoT hub (by key).

az iot hub message-enrichment update --endpoints
                                     --key
                                     --value
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Examples

Update a message enrichment in your IoT hub to apply to a new set of endpoints

az iot hub message-enrichment update --key {key} --value {value} --endpoints NewEndpoint1 NewEndpoint2 -n {iothub_name}

Required Parameters

--endpoints -e

Endpoint(s) to apply enrichments to. Use a space-separated list for multiple endpoints.

--key -k

The enrichment's key.

--value -v

The enrichment's value.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

IoT Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot hub message-enrichment update (azure-iot extension)

Update a message enrichment in your IoT hub (by key).

az iot hub message-enrichment update --endpoints
                                     --key
                                     --value
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Examples

Update a message enrichment in your IoT hub to apply to a new set of endpoints

az iot hub message-enrichment update --key {key} --value {value} --endpoints NewEndpoint1 NewEndpoint2 -n {iothub_name}

Required Parameters

--endpoints -e

Endpoint(s) to apply enrichments to. Use a space-separated list for multiple endpoints.

--key -k

The enrichment's key.

--value -v

The enrichment's value.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

IoT Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False