Share via


az iot ops ns

Note

This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az iot ops ns command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Device Registry Namespaces management.

Namespaces enable organizing your namespaced assets and devices.

Commands

Name Description Type Status
az iot ops ns asset

Manage namespaced assets in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom

Manage namespaced assets that point to custom device endpoints.

Extension Preview
az iot ops ns asset custom create

Create a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom dataset

Manage datasets for custom namespaced assets in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom dataset add

Add a dataset to a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom dataset list

List datasets for a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom dataset point

Manage data points for custom asset datasets in Device Registry namespaces.

Extension Preview
az iot ops ns asset custom dataset point add

Add a data point to a custom asset dataset in a Device Registry namespace.

Extension Preview
az iot ops ns asset custom dataset point list

List data points for a custom asset dataset in a Device Registry namespace.

Extension Preview
az iot ops ns asset custom dataset point remove

Remove a data point from a custom asset dataset in a Device Registry namespace.

Extension Preview
az iot ops ns asset custom dataset remove

Remove a dataset from a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom dataset show

Show details of a dataset for a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom dataset update

Update a dataset for a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom event

Manage events for custom namespaced assets in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom event add

Add an event to a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom event list

List events for a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom event point

Manage event points for custom asset events in Device Registry namespaces.

Extension Preview
az iot ops ns asset custom event point add

Add an event data point to a custom asset event in a Device Registry namespace.

Extension Preview
az iot ops ns asset custom event point list

List event points for a custom asset event in a Device Registry namespace.

Extension Preview
az iot ops ns asset custom event point remove

Remove an event point from a custom asset event in a Device Registry namespace.

Extension Preview
az iot ops ns asset custom event remove

Remove an event from a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom event show

Show details of an event for a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom event update

Update an event for a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom mgmt

Manage custom asset management groups in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom mgmt action

Manage actions within custom asset management groups.

Extension Preview
az iot ops ns asset custom mgmt action add

Add an action to a custom asset management group.

Extension Preview
az iot ops ns asset custom mgmt action list

List actions in a custom asset management group.

Extension Preview
az iot ops ns asset custom mgmt action remove

Remove an action from a custom asset management group.

Extension Preview
az iot ops ns asset custom mgmt add

Add a management group to a custom asset.

Extension Preview
az iot ops ns asset custom mgmt list

List management groups for a custom asset.

Extension Preview
az iot ops ns asset custom mgmt remove

Remove a management group from a custom asset.

Extension Preview
az iot ops ns asset custom mgmt show

Show details of a management group for a custom asset.

Extension Preview
az iot ops ns asset custom mgmt update

Update a management group for a custom asset.

Extension Preview
az iot ops ns asset custom stream

Manage streams for custom namespaced assets in an IoT Operations instance.

Extension Preview
az iot ops ns asset custom stream add

Add a stream to a custom asset.

Extension Preview
az iot ops ns asset custom stream list

List streams in a custom asset.

Extension Preview
az iot ops ns asset custom stream remove

Remove a stream from a custom asset.

Extension Preview
az iot ops ns asset custom stream show

Show details of a stream in a custom asset.

Extension Preview
az iot ops ns asset custom stream update

Update a stream in a custom asset.

Extension Preview
az iot ops ns asset custom update

Update a custom namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset delete

Delete a namespaced asset from an IoT Operations instance.

Extension Preview
az iot ops ns asset media

Manage namespaced assets that point to media device endpoints.

Extension Preview
az iot ops ns asset media create

Create a media namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset media stream

Manage streams for media namespaced assets in an IoT Operations instance.

Extension Preview
az iot ops ns asset media stream add

Add a stream to a media asset.

Extension Preview
az iot ops ns asset media stream list

List streams in a media asset.

Extension Preview
az iot ops ns asset media stream remove

Remove a stream from a media asset.

Extension Preview
az iot ops ns asset media stream show

Show details of a stream in a media asset.

Extension Preview
az iot ops ns asset media stream update

Update a stream in a media asset.

Extension Preview
az iot ops ns asset media update

Update a media namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset onvif

Manage namespaced assets that point to ONVIF device endpoints.

Extension Preview
az iot ops ns asset onvif create

Create an ONVIF namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset onvif event

Manage events for ONVIF namespaced assets in an IoT Operations instance.

Extension Preview
az iot ops ns asset onvif event add

Add an event to an ONVIF namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset onvif event list

List events for an ONVIF namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset onvif event remove

Remove an event from an ONVIF namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset onvif event show

Show details of an event for an ONVIF namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset onvif event update

Update an event for an ONVIF namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset onvif mgmt

Manage ONVIF asset management groups in an IoT Operations instance.

Extension Preview
az iot ops ns asset onvif mgmt add

Add a management group to an ONVIF asset.

Extension Preview
az iot ops ns asset onvif mgmt list

List management groups for an ONVIF asset.

Extension Preview
az iot ops ns asset onvif mgmt remove

Remove a management group from an ONVIF asset.

Extension Preview
az iot ops ns asset onvif mgmt show

Show details of a management group for an ONVIF asset.

Extension Preview
az iot ops ns asset onvif mgmt update

Update a management group for an ONVIF asset.

Extension Preview
az iot ops ns asset onvif update

Update an ONVIF namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua

Manage namespaced assets that point to OPC UA device endpoints.

Extension Preview
az iot ops ns asset opcua create

Create an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua dataset

Manage datasets for OPC UA namespaced assets in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua dataset add

Add a dataset to an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua dataset list

List datasets for an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua dataset point

Manage data points for OPC UA asset datasets in Device Registry namespaces.

Extension Preview
az iot ops ns asset opcua dataset point add

Add a data point to an OPC UA asset dataset in a Device Registry namespace.

Extension Preview
az iot ops ns asset opcua dataset point list

List data points for an OPC UA asset dataset in a Device Registry namespace.

Extension Preview
az iot ops ns asset opcua dataset point remove

Remove a data point from an OPC UA asset dataset in a Device Registry namespace.

Extension Preview
az iot ops ns asset opcua dataset remove

Remove a dataset from an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua dataset show

Show details of a dataset for an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua dataset update

Update a dataset for an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua event

Manage events for OPC UA namespaced assets in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua event add

Add an event to an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua event list

List events for an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua event remove

Remove an event from an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua event show

Show details of an event for an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua event update

Update an event for an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua mgmt

Manage OPC UA asset management groups in an IoT Operations instance.

Extension Preview
az iot ops ns asset opcua mgmt action

Manage actions within OPC UA asset management groups.

Extension Preview
az iot ops ns asset opcua mgmt action add

Add an action to an OPC UA asset management group.

Extension Preview
az iot ops ns asset opcua mgmt action list

List actions in an OPC UA asset management group.

Extension Preview
az iot ops ns asset opcua mgmt action remove

Remove an action from an OPC UA asset management group.

Extension Preview
az iot ops ns asset opcua mgmt add

Add a management group to an OPC UA asset.

Extension Preview
az iot ops ns asset opcua mgmt list

List management groups for an OPC UA asset.

Extension Preview
az iot ops ns asset opcua mgmt remove

Remove a management group from an OPC UA asset.

Extension Preview
az iot ops ns asset opcua mgmt show

Show details of a management group for an OPC UA asset.

Extension Preview
az iot ops ns asset opcua mgmt update

Update a management group for an OPC UA asset.

Extension Preview
az iot ops ns asset opcua update

Update an OPC UA namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset query

Query namespaced assets.

Extension Preview
az iot ops ns asset rest

Manage namespaced assets that point to REST device endpoints.

Extension Preview
az iot ops ns asset rest create

Create a REST namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset rest dataset

Manage datasets for REST namespaced assets in an IoT Operations instance.

Extension Preview
az iot ops ns asset rest dataset add

Add a dataset to a REST namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset rest dataset list

List datasets for a REST namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset rest dataset remove

Remove a dataset from a REST namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset rest dataset show

Show details of a dataset for a REST namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset rest dataset update

Update a dataset for a REST namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset rest update

Update a REST namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns asset show

Show details of a namespaced asset in an IoT Operations instance.

Extension Preview
az iot ops ns create

Create a Device Registry namespace.

Extension Preview
az iot ops ns delete

Delete a Device Registry namespace.

Extension Preview
az iot ops ns device

Manage devices in Device Registry namespaces.

Extension Preview
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 list

List Device Registry namespaces.

Extension Preview
az iot ops ns show

Show details of a Device Registry namespace.

Extension Preview
az iot ops ns update

Update a Device Registry namespace.

Extension Preview

az iot ops ns create

Preview

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Device Registry namespace.

az iot ops ns create --name
                     --resource-group
                     [--location]
                     [--tags]

Examples

Create a namespace with minimal configuration.

az iot ops ns create -n mynamespace -g myResourceGroup

Create a namespace with custom location and tags

az iot ops ns create -n mynamespace -g myResourceGroup --location "eastus" --tags env=prod department=operations

Required Parameters

--name -n

Namespace name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 delete

Preview

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Device Registry namespace.

az iot ops ns delete --name
                     --resource-group
                     [--yes {false, true}]

Examples

Delete a namespace

az iot ops ns delete -n mynamespace -g myResourceGroup

Required Parameters

--name -n

Namespace name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--yes -y

Confirm [y]es without a prompt. Useful for CI and automation scenarios.

Property Value
Accepted values: false, true
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 list

Preview

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Device Registry namespaces.

az iot ops ns list [--resource-group]

Examples

List all namespaces in a resource group

az iot ops ns list -g myResourceGroup

List all namespaces in the current subscription

az iot ops ns list

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 ops ns show

Preview

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details of a Device Registry namespace.

az iot ops ns show --name
                   --resource-group

Examples

Show details of a namespace

az iot ops ns show -n mynamespace -g myResourceGroup

Required Parameters

--name -n

Namespace name.

--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 ops ns update

Preview

Command group 'iot ops ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a Device Registry namespace.

az iot ops ns update --name
                     --resource-group
                     [--tags]

Examples

Update tags for a namespace

az iot ops ns update -n mynamespace -g myResourceGroup --tags env=test department=iot

Required Parameters

--name -n

Namespace name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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