az iot ops asset endpoint

  • Preview
  • Reference

Note

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

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

Manage asset endpoint profiles.

Commands

Name Description Type Status
az iot ops asset endpoint create

Create asset endpoint profiles.

 Extension Preview
az iot ops asset endpoint create opcua

Create an asset endpoint profile with an OPCUA connector.

 Extension Preview
az iot ops asset endpoint delete

Delete an asset endpoint profile.

 Extension Preview
az iot ops asset endpoint query

Query the Resource Graph for asset endpoint profiles.

 Extension Preview
az iot ops asset endpoint show

Show an asset endpoint profile.

 Extension Preview
az iot ops asset endpoint update

Update an asset endpoint profile.

 Extension Preview

az iot ops asset endpoint delete

Preview

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

Delete an asset endpoint profile.

az iot ops asset endpoint delete --name
                                 --resource-group

Examples

Delete an asset endpoint profile.

az iot ops asset endpoint delete --name myprofile -g myresourcegroup

Required Parameters

--name -n

Asset Endpoint Profile 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az iot ops asset endpoint query

Preview

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

Query the Resource Graph for asset endpoint profiles.

az iot ops asset endpoint query [--am {Anonymous, Certificate, UsernamePassword}]
                                [--cq]
                                [--endpoint-profile-type]
                                [--ig]
                                [--instance]
                                [--location]
                                [--name]
                                [--resource-group]
                                [--ta]

Examples

Query for asset endpoint profiles that have anonymous authentication.

az iot ops asset endpoint query --authentication-mode Anonymous

Query for asset endpoint profiles that have the given target address and instance name.

az iot ops asset endpoint query --target-address opc.tcp://opcplc-000000:50000 --instance myinstance

Optional Parameters

--am --authentication-mode

Authentication Mode.

Accepted values: Anonymous, Certificate, UsernamePassword
--cq --custom-query

Custom query to use. All other query arguments will be ignored.

--endpoint-profile-type --ept

Connector type for the endpoint profile.

--ig --instance-resource-group

Instance resource group. If not provided, asset endpoint profile resource group will be used.

--instance

Instance name to associate the created asset with.

--location -l

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

--name -n

Asset Endpoint Profile name.

--resource-group -g

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

--ta --target-address

Target Address. Must be a valid local address that follows the opc.tcp protocol.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az iot ops asset endpoint show

Preview

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

Show an asset endpoint profile.

az iot ops asset endpoint show --name
                               --resource-group

Examples

Show the details of an asset endpoint profile.

az iot ops asset endpoint show --name myprofile -g myresourcegroup

Required Parameters

--name -n

Asset Endpoint Profile 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az iot ops asset endpoint update

Preview

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

Update an asset endpoint profile.

To update owned certificates, please use the command group az iot ops asset endpoint certificate.

az iot ops asset endpoint update --name
                                 --resource-group
                                 [--am {Anonymous, Certificate, UsernamePassword}]
                                 [--cert-ref]
                                 [--password-ref]
                                 [--ta]
                                 [--tags]
                                 [--ur]

Examples

Update an asset endpoint profile's authentication mode to use anonymous user authentication.

az iot ops asset endpoint update --name myprofile -g myresourcegroup --authentication-mode Anonymous

Update an asset endpoint profile's username and password reference with prefilled values. This will transform the authentication mode to username-password if it is not so already.

az iot ops asset endpoint update --name myAssetEndpoint -g myRG --username-ref "aio-opc-ua-broker-user-authentication/opc-plc-username" --password-ref "aio-opc-ua-broker-user-authentication/opc-plc-password"

Required Parameters

--name -n

Asset Endpoint Profile name.

--resource-group -g

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

Optional Parameters

--am --authentication-mode

Authentication Mode.

Accepted values: Anonymous, Certificate, UsernamePassword
--cert-ref --certificate-ref --cr

Reference for the certificate used in authentication. This method of user authentication is not supported yet.

--password-ref --pr

Reference for the password used in authentication.

--ta --target-address

Target Address. Must be a valid local address that follows the opc.tcp protocol.

--tags

Asset Endpoint Profile resource tags. Property bag in key-value pairs with the following format: a=b c=d.

--ur --username-reference

Reference for the username used in authentication.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.