az iot ops ns device

Commands

Name	Description	Type	Status
az iot ops ns device create	Create a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device delete	Delete a device from a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint	Manage endpoints for devices in Device Registry namespaces.	Extension	Preview
az iot ops ns device endpoint inbound	Manage inbound endpoints for devices in Device Registry namespaces.	Extension	Preview
az iot ops ns device endpoint inbound add	Add inbound endpoints to devices in Device Registry namespaces.	Extension	Preview
az iot ops ns device endpoint inbound add custom	Add a custom inbound endpoint to a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint inbound add media	Add a media inbound endpoint to a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint inbound add onvif	Add an ONVIF inbound endpoint to a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint inbound add opcua	Add an OPC UA inbound endpoint to a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint inbound add rest	Add a rest inbound endpoint to a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint inbound list	List inbound endpoints of a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint inbound remove	Remove inbound endpoints from a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device endpoint list	List all endpoints of a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device query	Query devices in Device Registry namespaces.	Extension	Preview
az iot ops ns device show	Show details of a device in a Device Registry namespace.	Extension	Preview
az iot ops ns device update	Update a device in a Device Registry namespace.	Extension	Preview

az iot ops ns device create --instance
                            --name
                            --resource-group
                            [--attr --custom-attribute]
                            [--disabled {false, true}]
                            [--manufacturer]
                            [--model]
                            [--os]
                            [--os-version --osv]
                            [--tags]

Examples

Create a device with minimal configuration

az iot ops ns device create --name mydevice --instance myInstance -g myInstanceResourceGroup

Create a device with custom attributes

az iot ops ns device create --name mydevice --instance myInstance -g myInstanceResourceGroup --attr location=building1 floor=3

Create a device with manufacturer information and operating system details

az iot ops ns device create --name mydevice --instance myInstance -g myInstanceResourceGroup --manufacturer "Contoso" --model "Gateway X1" --os "Linux" --os-version "4.15"

Create a disabled device with tags

az iot ops ns device create --name mydevice --instance myInstance -g myInstanceResourceGroup --disabled --tags environment=test criticality=low

Required Parameters

Optional Parameters

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

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 ops ns device delete --instance
                            --name
                            --resource-group
                            [--yes {false, true}]

Examples

Delete a device

az iot ops ns device delete --name mydevice --instance myInstance -g myInstanceResourceGroup

Required Parameters

Optional Parameters

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

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 ops ns device query [--cq --custom-query]
                           [--disabled {false, true}]
                           [--instance]
                           [--manufacturer]
                           [--model]
                           [--name]
                           [--os]
                           [--os-version --osv]
                           [--resource-group]

Examples

Query for devices in an IoT Operations instance

az iot ops ns device query --instance myInstance -g myInstanceResourceGroup

Query for a specific device by name

az iot ops ns device query --name mydevice

Query for devices from a specific manufacturer

az iot ops ns device query --manufacturer "Contoso"

Use a custom query to search for devices

az iot ops ns device query --custom-query "where tags.environment=='production'"

Optional Parameters

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

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 ops ns device show --instance
                          --name
                          --resource-group

Examples

Show details of a device

az iot ops ns device show --name mydevice --instance myInstance -g myInstanceResourceGroup

Required Parameters

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 ops ns device update --instance
                            --name
                            --resource-group
                            [--attr --custom-attribute]
                            [--disabled {false, true}]
                            [--os-version --osv]
                            [--tags]

Examples

Update device custom attributes

az iot ops ns device update --name mydevice --instance myInstance -g myInstanceResourceGroup --attr location=building2 floor=5

Update operating system version

az iot ops ns device update --name mydevice --instance myInstance -g myInstanceResourceGroup --os-version "4.18"

Disable a device

az iot ops ns device update --name mydevice --instance myInstance -g myInstanceResourceGroup --disabled

Update device tags

az iot ops ns device update --name mydevice --instance myInstance -g myInstanceResourceGroup --tags environment=production criticality=high

Required Parameters

Optional Parameters

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

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