az iot edge

  • Reference

Manage IoT solutions on the Edge.

Commands

az iot edge deployment

Manage IoT Edge deployments at scale.
az iot edge deployment create

Create an IoT Edge deployment in a target IoT Hub.
az iot edge deployment delete

Delete an IoT Edge deployment.
az iot edge deployment list

List IoT Edge deployments in an IoT Hub.
az iot edge deployment show

Get the details of an IoT Edge deployment.
az iot edge deployment show-metric

Evaluate a target system metric defined in an IoT Edge deployment.
az iot edge deployment update

Update specified properties of an IoT Edge deployment.

Use --set followed by property assignments for updating a deployment.

Note: IoT Edge deployment content is immutable. Deployment properties that can be updated are 'labels', 'metrics', 'priority' and 'targetCondition'.
az iot edge set-modules

Set edge modules on a single device.

az iot edge set-modules

Set edge modules on a single device.

Modules content is json and in the form of {"modulesContent":{...}} or {"content":{"modulesContent":{...}}}.

Note: Upon execution the command will output the collection of modules applied to the device.

az iot edge set-modules --content
                        --device-id
                        [--hub-name]
                        [--login]
                        [--resource-group]

Examples

Test edge modules while in development by setting modules on a target device.

az iot edge set-modules --hub-name {iothub_name} --device-id {device_id} --content ../modules_content.json

Required Parameters

--content -k

IoT Edge deployment content. Provide file path or raw json.

--device-id -d

Target Device.

Optional Parameters

--hub-name -n

IoT Hub name.

--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>.