az iot hub message-endpoint

Note

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

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

Manage custom endpoints of an IoT hub.

Commands

Name	Description	Type	Status
az iot hub message-endpoint create	Add an endpoint to an IoT Hub.	Extension	Preview
az iot hub message-endpoint create cosmosdb-container	Add a Cosmos DB Container endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint create eventhub	Add an Event Hub endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint create servicebus-queue	Add a Service Bus Queue endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint create servicebus-topic	Add a Service Bus Topic endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint create storage-container	Add a Storage Container endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint delete	Delete all or a specific endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint list	Get information on all the endpoints for an IoT Hub.	Extension	Preview
az iot hub message-endpoint show	Get information on mentioned endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint update	Update the properties of an existing endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint update cosmosdb-container	Update the properties of an existing Cosmos DB Container endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint update eventhub	Update the properties of an existing Event Hub endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint update servicebus-queue	Update the properties of an existing Service Bus Queue endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint update servicebus-topic	Update the properties of an existing Service Bus Topic endpoint for an IoT Hub.	Extension	Preview
az iot hub message-endpoint update storage-container	Update the properties of an existing Storage Container endpoint for an IoT Hub.	Extension	Preview

az iot hub message-endpoint delete

Preview

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

Delete all or a specific endpoint for an IoT Hub.

You must delete any routes and message enrichments to the endpoint, before deleting the endpoint.

az iot hub message-endpoint delete --hub-name
                                   [--en]
                                   [--endpoint-type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                   [--force]
                                   [--resource-group]
                                   [--yes {false, true}]

Examples

Delete an endpoint from an IoT Hub.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name}

Delete all the endpoints of type "EventHub" from an IoT Hub.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub

Delete all the endpoints from an IoT Hub.

az iot hub message-endpoint delete -n {iothub_name}

Force delete an endpoint from an IoT Hub. This will delete any routes and message enrichments associated with this endpoint.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name} -f

Force delete all the endpoints of type "EventHub" from an IoT Hub. This will delete any routes and message enrichments associated with this endpoint.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub -f

Required Parameters

--hub-name -n

IoT Hub name.

Optional Parameters

--en --endpoint --endpoint-name

Name of the routing endpoint.

--endpoint-type --type -t

Type of the routing endpoint.

Accepted values: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container

--force -f

Force delete the endpoint(s) and any routes and message enrichments associated.

Default value: False

--resource-group -g

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

--yes -y

Skip user prompts. Indicates acceptance of action. Used primarily for automation scenarios. Default: false.

Accepted values: false, true

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 hub message-endpoint list

Preview

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

Get information on all the endpoints for an IoT Hub.

You can also specify which endpoint type you want to get information on.

az iot hub message-endpoint list --hub-name
                                 [--endpoint-type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                 [--resource-group]

Examples

Get all the endpoints from an IoT Hub.

az iot hub message-endpoint list -n {iothub_name}

Get all the endpoints of type "EventHub" from an IoT Hub.

az iot hub message-endpoint list -n {iothub_name} --endpoint-type eventhub

Required Parameters

--hub-name -n

IoT Hub name.

Optional Parameters

--endpoint-type --type -t

Type of the routing endpoint.

Accepted values: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container

--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 hub message-endpoint show

Preview

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

Get information on mentioned endpoint for an IoT Hub.

az iot hub message-endpoint show --en
                                 --hub-name
                                 [--resource-group]

Examples

Get an endpoint information from an IoT Hub.

az iot hub message-endpoint show -n {iothub_name} --endpoint-name {endpoint_name}

Required Parameters

--en --endpoint --endpoint-name

Name of the routing endpoint.

--hub-name -n

IoT Hub name.

Optional Parameters

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