A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://docs.microsoft.com/en-us/cli/azure/iot/hub/connection-string below:

az iot hub connection-string | Microsoft Learn

az iot hub connection-string

Note

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

Manage IoT Hub connection strings.

Commands Name Description Type Status az iot hub connection-string show

Show the connection strings for the specified IoT Hubs using the given policy name and key.

Extension GA

az iot hub connection-string show

Show the connection strings for the specified IoT Hubs using the given policy name and key.

az iot hub connection-string show [--all --show-all]
                                  [--default-eventhub --eh {false, true}]
                                  [--hub-name]
                                  [--key-type --kt {primary, secondary}]
                                  [--pn --policy-name]
                                  [--resource-group]
Examples

Show the connection strings for all active state IoT Hubs in a subscription using the default policy and primary key.

az iot hub connection-string show

Show the connection strings for all active state IoT Hubs in a resource group using the default policy and primary key.

az iot hub connection-string show --resource-group MyResourceGroup

Show all connection strings of the given IoT Hub using primary key.

az iot hub connection-string show -n MyIotHub --all

Show the connection string of the given IoT Hub using the default policy and primary key.

az iot hub connection-string show -n MyIotHub

Show the connection string of the given IoT Hub using policy 'service' and secondary key.

az iot hub connection-string show -n MyIotHub --policy-name service --key-type secondary

Show the eventhub compatible connection string of the given IoT Hub's default eventhub.

az iot hub connection-string show -n MyIotHub --default-eventhub
Optional Parameters

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

Show all shared access policies for the respective IoT Hub.

Property Value Default value: False

Flag indicating the connection string returned is for the default EventHub endpoint. Default: false.

Property Value Default value: False Accepted values: false, true

IoT Hub name or hostname. Required if --login is not provided.

Property Value Parameter group: IoT Hub Identifier Arguments

Shared access policy key type for authentication.

Property Value Default value: primary Accepted values: primary, secondary

Shared access policy with operation permissions for target IoT Hub entity.

Property Value Default value: iothubowner

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

Global Parameters

Increase logging verbosity to show all debug logs.

Property Value Default value: False

Show this help message and exit.

Only show errors, suppressing warnings.

Property Value Default value: False

Output format.

Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

JMESPath query string. See http://jmespath.org/ for more information and examples.

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Increase logging verbosity. Use --debug for full debug logs.

Property Value Default value: False

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4