az iot hub message-endpoint update
Hinweis
Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.46.0 oder höher). Die Erweiterung installiert automatisch, wenn Sie einen Az iot Hub-Nachrichtenendpunkt-Updatebefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen
Die Befehlsgruppe "iot hub message-endpoint" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Aktualisieren Sie die Eigenschaften eines vorhandenen Endpunkts für einen IoT Hub.
Befehle
Name | Beschreibung | Typ | Status |
---|---|---|---|
az iot hub message-endpoint update cosmosdb-container |
Aktualisieren Sie die Eigenschaften eines vorhandenen Cosmos DB-Containerendpunkts für einen IoT Hub. |
Erweiterung | Vorschau |
az iot hub message-endpoint update eventhub |
Aktualisieren Sie die Eigenschaften eines vorhandenen Event Hub-Endpunkts für einen IoT Hub. |
Erweiterung | Vorschau |
az iot hub message-endpoint update servicebus-queue |
Aktualisieren Sie die Eigenschaften eines vorhandenen Service Bus Queue-Endpunkts für einen IoT Hub. |
Erweiterung | Vorschau |
az iot hub message-endpoint update servicebus-topic |
Aktualisieren sie die Eigenschaften eines vorhandenen ServiceBus-Themenendpunkts für einen IoT Hub. |
Erweiterung | Vorschau |
az iot hub message-endpoint update storage-container |
Aktualisieren Sie die Eigenschaften eines vorhandenen Speichercontainer-Endpunkts für einen IoT Hub. |
Erweiterung | Vorschau |
az iot hub message-endpoint update cosmosdb-container
Die Befehlsgruppe "iot hub message-endpoint" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Aktualisieren Sie die Eigenschaften eines vorhandenen Cosmos DB-Containerendpunkts für einen IoT Hub.
Wenn Sie den Authentifizierungstyp von einem schlüsselbasierten auf den identitätsbasierten Cosmos DB-Containerendpunkt aktualisieren, müssen Sie die Identität (über --identity) und den Endpunkt-URI (über --endpoint-uri) bereitstellen. Der alte Primärschlüssel und der sekundäre Schlüssel werden nulliert.
Wenn Sie den Authentifizierungstyp von einem identitätsbasierten auf einen schlüsselbasierten Cosmos DB-Containerendpunkt aktualisieren, müssen Sie die Verbindungszeichenfolge (über --connection-string), den Primärschlüssel (über --primary-key) oder den Sekundärschlüssel (über --secondary-key) bereitstellen.
Containername für den Endpunkt kann nicht geändert werden. Kontonamen können nur geändert werden, wenn Container mit demselben Namen in beiden Konten vorhanden sind.
az iot hub message-endpoint update cosmosdb-container --en
--hub-name
[--connection-string]
[--database-name]
[--endpoint-resource-group]
[--endpoint-subscription-id]
[--endpoint-uri]
[--identity]
[--partition-key-name]
[--partition-key-template]
[--pk]
[--resource-group]
[--secondary-key]
Beispiele
Aktualisieren Sie einen schlüsselbasierten oder identitätsbasierten Cosmos DB-Containerendpunkt für einen IoT Hub, um eine neue angegebene Verbindungszeichenfolge zu verwenden.
az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --connection-string {connection_string}
Aktualisieren Sie einen Cosmos DB-Containerendpunkt für einen IoT Hub, um einen angegebenen Primärschlüssel und sekundären Schlüssel zu verwenden.
az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pk {primary_key} --sk {secondary_key}
Aktualisieren Sie einen Cosmos DB-Containerendpunkt für einen IoT Hub, um die vom System zugewiesene Identität und einen Partitionsschlüsselnamen zu verwenden. Die Partitionsschlüsselvorlage ist die Standardeinstellung.
az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pkn {partition_key_name} --identity [system]
Aktualisieren Sie einen schlüsselbasierten Cosmos DB-Containerendpunkt für einen IoT Hub, um die vom Benutzer zugewiesene Identität zu verwenden (Sie können --endpoint-uri weglassen, wenn der Endpunkt bereits identitätsbasiert ist).
az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}
Erforderliche Parameter
Name des Routingendpunkts.
IoT Hub-Name.
Optionale Parameter
Verbindungszeichenfolge des Routingendpunkts.
Der Name der Cosmos DB-Datenbank im Cosmos DB-Konto.
Ressourcengruppe der Endpunktresoure. Wenn nicht angegeben, wird die Ressourcengruppe des IoT Hub verwendet.
Abonnement-ID der Endpunktressource. Wenn nicht angegeben, wird das IoT Hub-Abonnement verwendet.
Der URI der Endpunktressource.
Verwenden Sie eine vom System zugewiesene oder vom Benutzer zugewiesene verwaltete Identität für die Endpunktauthentifizierung. Verwenden Sie "[System]", um auf die vom System zugewiesene Identität oder eine Ressourcen-ID zu verweisen, um auf eine vom Benutzer zugewiesene Identität zu verweisen.
Der Name des Partitionsschlüssels, der diesem Cosmos DB SQL-Container zugeordnet ist, falls vorhanden. Legen Sie diese Eigenschaft auf "" fest, um diese Eigenschaft zu löschen.
Die Vorlage zum Generieren eines synthetischen Partitionsschlüsselwerts für die Verwendung mit diesem Cosmos DB SQL-Container. Die Vorlage muss mindestens einen der folgenden Platzhalter enthalten: {iothub}, {deviceid}, {DD}, {MM} und {JJJJ}. Jeder Platzhalter kann höchstens einmal angegeben werden, aber Reihenfolge und Nicht-Platzhalterkomponenten sind beliebig. Wenn der Partitionsschlüsselname angegeben wird, wird standardmäßig die Partitionsschlüsselvorlage auf {deviceid}-{YYYY}-{MM} festgelegt. Legen Sie diese Eigenschaft auf "" fest, um diese Eigenschaft zu löschen.
Der Primärschlüssel des Cosmos DB-Kontos.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Sekundärschlüssel des Cosmos DB-Kontos.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot hub message-endpoint update eventhub
Die Befehlsgruppe "iot hub message-endpoint" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Aktualisieren Sie die Eigenschaften eines vorhandenen Event Hub-Endpunkts für einen IoT Hub.
Wenn Sie den Authentifizierungstyp von einem schlüsselbasierten auf einen identitätsbasierten Event Hub-Endpunkt aktualisieren, müssen Sie die Identität (über --identity), den Endpunkt-URI (über --endpoint-uri) und den Entitätspfad (über --entity-path) bereitstellen. Die alte Verbindungszeichenfolge wird nulliert.
Wenn Sie den Authentifizierungstyp von einem identitätsbasierten auf einen schlüsselbasierten Event Hub-Endpunkt aktualisieren, müssen Sie die Verbindungszeichenfolge (über --connection-string) bereitstellen. Der alte Endpunkt-URI und der Entitätspfad werden null entfernt.
az iot hub message-endpoint update eventhub --en
--hub-name
[--connection-string]
[--endpoint-resource-group]
[--endpoint-subscription-id]
[--endpoint-uri]
[--entity-path]
[--identity]
[--resource-group]
Beispiele
Aktualisieren Sie einen schlüsselbasierten oder identitätsbasierten Event Hub-Endpunkt für einen IoT Hub, um eine neue angegebene Verbindungszeichenfolge zu verwenden.
az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} -c {connection_string}
Aktualisieren Sie einen Event Hub-Endpunkt für einen IoT Hub, um die vom System zugewiesene Identität und einen anderen Entitätspfad zu verwenden.
az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]
Aktualisieren Sie einen schlüsselbasierten Event Hub-Endpunkt für einen IoT Hub, um die vom Benutzer zugewiesene Identität zu verwenden (Sie können --endpoint-uri weglassen, wenn der Endpunkt bereits identitätsbasiert ist).
az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}
Erforderliche Parameter
Name des Routingendpunkts.
IoT Hub-Name.
Optionale Parameter
Verbindungszeichenfolge des Routingendpunkts.
Ressourcengruppe der Endpunktresoure. Wenn nicht angegeben, wird die Ressourcengruppe des IoT Hub verwendet.
Abonnement-ID der Endpunktressource. Wenn nicht angegeben, wird das IoT Hub-Abonnement verwendet.
Der URI der Endpunktressource.
Der Entitätspfad der Endpunktressource.
Verwenden Sie eine vom System zugewiesene oder vom Benutzer zugewiesene verwaltete Identität für die Endpunktauthentifizierung. Verwenden Sie "[System]", um auf die vom System zugewiesene Identität oder eine Ressourcen-ID zu verweisen, um auf eine vom Benutzer zugewiesene Identität zu verweisen.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot hub message-endpoint update servicebus-queue
Die Befehlsgruppe "iot hub message-endpoint" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Aktualisieren Sie die Eigenschaften eines vorhandenen Service Bus Queue-Endpunkts für einen IoT Hub.
Wenn Sie den Authentifizierungstyp von einem schlüsselbasierten auf den identitätsbasierten Dienstenbus-Warteschlangenendpunkt aktualisieren, müssen Sie die Identität (über --identity), den Endpunkt-URI (über --endpoint-uri) und den Entitätspfad (über --entity-path) bereitstellen. Die alte Verbindungszeichenfolge wird nulliert.
Wenn Sie den Authentifizierungstyp von einem identitätsbasierten auf einen schlüsselbasierten Dienstenbus-Warteschlangenendpunkt aktualisieren, müssen Sie die Verbindungszeichenfolge (über --connection-string) bereitstellen. Der alte Endpunkt-URI und der Entitätspfad werden null entfernt.
az iot hub message-endpoint update servicebus-queue --en
--hub-name
[--connection-string]
[--endpoint-resource-group]
[--endpoint-subscription-id]
[--endpoint-uri]
[--entity-path]
[--identity]
[--resource-group]
Beispiele
Aktualisieren Sie einen schlüsselbasierten oder identitätsbasierten Servicebus-Warteschlangenendpunkt für einen IoT Hub, um eine neue angegebene Verbindungszeichenfolge zu verwenden.
az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} -c {connection_string}
Aktualisieren Sie einen Service Bus Queue-Endpunkt für einen IoT Hub, um die vom System zugewiesene Identität und einen anderen Entitätspfad zu verwenden.
az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]
Aktualisieren Sie einen schlüsselbasierten Dienstbuswarteschlangen-Endpunkt für einen IoT Hub, um die vom Benutzer zugewiesene Identität zu verwenden (Sie können --endpoint-uri weglassen, wenn der Endpunkt bereits identitätsbasiert ist).
az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}
Erforderliche Parameter
Name des Routingendpunkts.
IoT Hub-Name.
Optionale Parameter
Verbindungszeichenfolge des Routingendpunkts.
Ressourcengruppe der Endpunktresoure. Wenn nicht angegeben, wird die Ressourcengruppe des IoT Hub verwendet.
Abonnement-ID der Endpunktressource. Wenn nicht angegeben, wird das IoT Hub-Abonnement verwendet.
Der URI der Endpunktressource.
Der Entitätspfad der Endpunktressource.
Verwenden Sie eine vom System zugewiesene oder vom Benutzer zugewiesene verwaltete Identität für die Endpunktauthentifizierung. Verwenden Sie "[System]", um auf die vom System zugewiesene Identität oder eine Ressourcen-ID zu verweisen, um auf eine vom Benutzer zugewiesene Identität zu verweisen.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot hub message-endpoint update servicebus-topic
Die Befehlsgruppe "iot hub message-endpoint" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Aktualisieren sie die Eigenschaften eines vorhandenen ServiceBus-Themenendpunkts für einen IoT Hub.
Wenn Sie den Authentifizierungstyp von einem schlüsselbasierten auf einen identitätsbasierten Servicebus-Endpunkt aktualisieren, müssen Sie die Identität (über --identity), den Endpunkt-URI (über --endpoint-uri) und den Entitätspfad (über --entity-path) bereitstellen. Die alte Verbindungszeichenfolge wird nulliert.
Wenn Sie den Authentifizierungstyp von einem identitätsbasierten auf einen schlüsselbasierten Servicebus-Themenendpunkt aktualisieren, müssen Sie die Verbindungszeichenfolge (über --connection-string) bereitstellen. Der alte Endpunkt-URI und der Entitätspfad werden null entfernt.
az iot hub message-endpoint update servicebus-topic --en
--hub-name
[--connection-string]
[--endpoint-resource-group]
[--endpoint-subscription-id]
[--endpoint-uri]
[--entity-path]
[--identity]
[--resource-group]
Beispiele
Aktualisieren Sie einen schlüsselbasierten oder identitätsbasierten Servicebus-Themenendpunkt für einen IoT Hub, um eine neue angegebene Verbindungszeichenfolge zu verwenden.
az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} -c {connection_string}
Aktualisieren Sie einen Service Bus-Themenendpunkt für einen IoT Hub, um die vom System zugewiesene Identität und einen anderen Entitätspfad zu verwenden.
az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]
Aktualisieren Sie einen schlüsselbasierten ServiceBus-Themenendpunkt für einen IoT Hub, um die vom Benutzer zugewiesene Identität zu verwenden (Sie können --endpoint-uri weglassen, wenn der Endpunkt bereits identitätsbasiert ist).
az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}
Erforderliche Parameter
Name des Routingendpunkts.
IoT Hub-Name.
Optionale Parameter
Verbindungszeichenfolge des Routingendpunkts.
Ressourcengruppe der Endpunktresoure. Wenn nicht angegeben, wird die Ressourcengruppe des IoT Hub verwendet.
Abonnement-ID der Endpunktressource. Wenn nicht angegeben, wird das IoT Hub-Abonnement verwendet.
Der URI der Endpunktressource.
Der Entitätspfad der Endpunktressource.
Verwenden Sie eine vom System zugewiesene oder vom Benutzer zugewiesene verwaltete Identität für die Endpunktauthentifizierung. Verwenden Sie "[System]", um auf die vom System zugewiesene Identität oder eine Ressourcen-ID zu verweisen, um auf eine vom Benutzer zugewiesene Identität zu verweisen.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot hub message-endpoint update storage-container
Die Befehlsgruppe "iot hub message-endpoint" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Aktualisieren Sie die Eigenschaften eines vorhandenen Speichercontainer-Endpunkts für einen IoT Hub.
Wenn Sie den Authentifizierungstyp von einem schlüsselbasierten auf einen identitätsbasierten Speichercontainer-Endpunkt aktualisieren, müssen Sie die Identität (über --identity) und den Endpunkt-URI (über --endpoint-uri) bereitstellen. Die alte Verbindungszeichenfolge wird nulliert.
Wenn Sie den Authentifizierungstyp von einem identitätsbasierten auf einen schlüsselbasierten Speichercontainerendpunkt aktualisieren, müssen Sie die Verbindungszeichenfolge (über --connection-string) bereitstellen.
Containername und -codierung für den Endpunkt können nicht geändert werden. Kontonamen können nur geändert werden, wenn Container mit demselben Namen in beiden Konten vorhanden sind.
az iot hub message-endpoint update storage-container --en
--hub-name
[--batch-frequency]
[--chunk-size]
[--connection-string]
[--endpoint-resource-group]
[--endpoint-subscription-id]
[--endpoint-uri]
[--ff]
[--identity]
[--resource-group]
Beispiele
Aktualisieren Sie einen schlüsselbasierten oder identitätsbasierten Speichercontainerendpunkt für einen IoT Hub, um eine neue angegebene Verbindungszeichenfolge zu verwenden.
az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} -c {connection_string}
Aktualisieren Sie einen Speichercontainer-Endpunkt für einen IoT Hub, um die vom System zugewiesene Identität mit der angegebenen Batchhäufigkeit, blockgröße und Dateinamenformat zu verwenden.
az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} -b {batch_frequency} -w {chunk_size} --ff {file_format} --identity [system]
Aktualisieren Sie einen schlüsselbasierten Speichercontainerendpunkt für einen IoT Hub, um die vom Benutzer zugewiesene Identität zu verwenden (Sie können --endpoint-uri weglassen, wenn der Endpunkt bereits identitätsbasiert ist).
az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}
Erforderliche Parameter
Name des Routingendpunkts.
IoT Hub-Name.
Optionale Parameter
Anforderungsbatchhäufigkeit in Sekunden. Die maximale Zeitspanne, die verstrichen werden kann, bevor Daten in ein Blob geschrieben werden, zwischen 60 und 720 Sekunden.
Anforderungsabschnittsgröße in Megabyte(MB). Die maximale Größe von Blobs zwischen 10 und 500 MB.
Verbindungszeichenfolge des Routingendpunkts.
Ressourcengruppe der Endpunktresoure. Wenn nicht angegeben, wird die Ressourcengruppe des IoT Hub verwendet.
Abonnement-ID der Endpunktressource. Wenn nicht angegeben, wird das IoT Hub-Abonnement verwendet.
Der URI der Endpunktressource.
Dateinamenformat für das Blob. Das Dateinamenformat muss {iothub}, {partition}, {JJJJ}, {MM}, {DD}, {HH} und {mm} felder enthalten. Alle Parameter sind obligatorisch, können aber mit oder ohne Trennzeichen neu angeordnet werden.
Verwenden Sie eine vom System zugewiesene oder vom Benutzer zugewiesene verwaltete Identität für die Endpunktauthentifizierung. Verwenden Sie "[System]", um auf die vom System zugewiesene Identität oder eine Ressourcen-ID zu verweisen, um auf eine vom Benutzer zugewiesene Identität zu verweisen.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.