az iot hub distributed-tracing

Manage distributed settings per-device.

Commands

az iot hub distributed-tracing show

Get the distributed tracing settings for a device.

az iot hub distributed-tracing update

Update the distributed tracing options for a device.

az iot hub distributed-tracing show

Get the distributed tracing settings for a device.

az iot hub distributed-tracing show --device-id
                                    --hub-name
                                    [--login]
                                    [--resource-group]

Examples

Get the distributed tracing settings for a device

az iot hub distributed-tracing show -d {device_id} -n {iothub_name}

Required Parameters

--device-id -d

Target Device.

--hub-name -n

IoT Hub name.

Optional Parameters

--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority.

--resource-group -g

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

az iot hub distributed-tracing update

Update the distributed tracing options for a device.

az iot hub distributed-tracing update --device-id
                                      --hub-name
                                      --sampling-mode {off, on}
                                      --sampling-rate
                                      [--login]
                                      [--resource-group]

Examples

Update the distributed tracing options for a device

az iot hub distributed-tracing update -d {device_id} --sm on --sr 50 -n {iothub_name}

Required Parameters

--device-id -d

Target Device.

--hub-name -n

IoT Hub name.

--sampling-mode --sm

Turns sampling for distributed tracing on and off. 1 is On and, 2 is Off.

accepted values: off, on
--sampling-rate --sr

Controls the amount of messages sampled for adding trace context. This value isa percentage. Only values from 0 to 100 (inclusive) are permitted.

Optional Parameters

--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority.

--resource-group -g

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