az iot hub message-endpoint update

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.46.0 eller senare). Tillägget installeras automatiskt första gången du kör kommandot az iot hub message-endpoint update . Läs mer om tillägg.

Kommandogruppen "iot hub message-endpoint" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera egenskaperna för en befintlig slutpunkt för en IoT Hub.

Kommandon

Name	Description	Typ	Status
az iot hub message-endpoint update cosmosdb-container	Uppdatera egenskaperna för en befintlig Cosmos DB-containerslutpunkt för en IoT Hub.	Anknytning	Förhandsversion
az iot hub message-endpoint update eventhub	Uppdatera egenskaperna för en befintlig Event Hub-slutpunkt för en IoT Hub.	Anknytning	Förhandsversion
az iot hub message-endpoint update servicebus-queue	Uppdatera egenskaperna för en befintlig Service Bus-köslutpunkt för en IoT Hub.	Anknytning	Förhandsversion
az iot hub message-endpoint update servicebus-topic	Uppdatera egenskaperna för en befintlig Service Bus Topic-slutpunkt för en IoT Hub.	Anknytning	Förhandsversion
az iot hub message-endpoint update storage-container	Uppdatera egenskaperna för en befintlig slutpunkt för lagringscontainer för en IoT Hub.	Anknytning	Förhandsversion

az iot hub message-endpoint update cosmosdb-container

Förhandsgranskning

Kommandogruppen "iot hub message-endpoint" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera egenskaperna för en befintlig Cosmos DB-containerslutpunkt för en IoT Hub.

Om du uppdaterar autentiseringstypen från en nyckelbaserad till identitetsbaserad Cosmos DB-containerslutpunkt måste du ange identiteten (via --identity) och slutpunkts-uri (via --endpoint-uri). Den gamla primärnyckeln och den sekundära nyckeln kommer att vara null.

Om du uppdaterar autentiseringstypen från en identitetsbaserad till nyckelbaserad Cosmos DB-containerslutpunkt måste du ange niska veze (via --connection-string), primärnyckeln (via --primary-key) eller den sekundära nyckeln (via --secondary-key).

Det går inte att ändra containernamnet för slutpunkten. Kontonamn kan bara ändras om containrar med samma namn finns i båda kontona.

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]

Exempel

Uppdatera en nyckelbaserad eller identitetsbaserad Cosmos DB-containerslutpunkt för en IoT Hub för att använda en ny angiven niska veze.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --connection-string {connection_string}

Uppdatera en Cosmos DB-containerslutpunkt för en IoT Hub för att använda en angiven primärnyckel och sekundär nyckel.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pk {primary_key} --sk {secondary_key}

Uppdatera en Cosmos DB-containerslutpunkt för en IoT Hub för att använda systemtilldelad identitet och ett partitionsnyckelnamn. Partitionsnyckelmallen är standard.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pkn {partition_key_name} --identity [system]

Uppdatera en nyckelbaserad Cosmos DB-containerslutpunkt för en IoT Hub för att använda användartilldelad identitet (du kan utelämna --endpoint-uri om slutpunkten redan är identitetsbaserad).

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}

Obligatoriska parametrar

--en --endpoint --endpoint-name

Namn på routningsslutpunkten.

--hub-name -n

IoT Hub-namn.

Valfria parametrar

--connection-string -c

Anslutningssträng för routningsslutpunkten.

--database-name --db

Namnet på cosmos DB-databasen i cosmos DB-kontot.

--endpoint-resource-group --erg -r

Resursgrupp för slutpunktens resurs. Om det inte anges används IoT Hub-resursgruppen.

--endpoint-subscription-id -s

Prenumerations-ID för slutpunktsresursen. Om den inte tillhandahålls används IoT Hub-prenumerationen.

--endpoint-uri

URI för slutpunktsresursen.

--identity

Använd en systemtilldelad eller användartilldelad hanterad identitet för slutpunktsautentisering. Använd "[system]" för att referera till den systemtilldelade identiteten eller ett resurs-ID för att referera till en användartilldelad identitet.

--partition-key-name --pkn

Namnet på partitionsnyckeln som är associerad med den här Cosmos DB SQL-containern om det finns en sådan. Om du vill rensa den här egenskapen anger du "".

--partition-key-template --pkt

Mallen för att generera ett syntetiskt partitionsnyckelvärde för användning med den här Cosmos DB SQL-containern. Mallen måste innehålla minst en av följande platshållare: {iothub}, {deviceid}, {DD}, {MM} och {ÅÅÅÅ}. En platshållare kan anges högst en gång, men ordnings- och icke-platshållarkomponenter är godtyckliga. Om partitionsnyckelnamnet anges är mallen för partitionsnyckel standardvärdet {deviceid}-{ÅÅÅÅ}-{MM}. Om du vill rensa den här egenskapen anger du "".

--pk --primary-key

Den primära nyckeln för Cosmos DB-kontot.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--secondary-key --sk

Den sekundära nyckeln för Cosmos DB-kontot.

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub message-endpoint update eventhub

Förhandsgranskning

Kommandogruppen "iot hub message-endpoint" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera egenskaperna för en befintlig Event Hub-slutpunkt för en IoT Hub.

Om du uppdaterar autentiseringstypen från en nyckelbaserad till identitetsbaserad händelsehubbslutpunkt måste du ange identiteten (via --identitet), slutpunkts-uri (via --endpoint-uri) och entitetssökvägen (via --entity-path). Den gamla niska veze kommer att vara null.

Om du uppdaterar autentiseringstypen från en identitetsbaserad till en nyckelbaserad händelsehubbslutpunkt måste du ange niska veze (via --connection-string). Den gamla slutpunkts-URI:n och entitetssökvägen kommer att vara null.

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]

Exempel

Uppdatera en nyckelbaserad eller identitetsbaserad händelsehubbslutpunkt för en IoT Hub för att använda en ny angiven niska veze.

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} -c {connection_string}

Uppdatera en Event Hub-slutpunkt för en IoT Hub för att använda systemtilldelad identitet och en annan entitetssökväg.

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Uppdatera en nyckelbaserad Händelsehubbslutpunkt för en IoT Hub för att använda användartilldelad identitet (du kan utelämna --endpoint-uri om slutpunkten redan är identitetsbaserad).

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}

Obligatoriska parametrar

--en --endpoint --endpoint-name

Namn på routningsslutpunkten.

--hub-name -n

IoT Hub-namn.

Valfria parametrar

--connection-string -c

Anslutningssträng för routningsslutpunkten.

--endpoint-resource-group --erg -r

Resursgrupp för slutpunktens resurs. Om det inte anges används IoT Hub-resursgruppen.

--endpoint-subscription-id -s

Prenumerations-ID för slutpunktsresursen. Om den inte tillhandahålls används IoT Hub-prenumerationen.

--endpoint-uri

URI för slutpunktsresursen.

--entity-path

Entitetssökvägen för slutpunktsresursen.

--identity

Använd en systemtilldelad eller användartilldelad hanterad identitet för slutpunktsautentisering. Använd "[system]" för att referera till den systemtilldelade identiteten eller ett resurs-ID för att referera till en användartilldelad identitet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub message-endpoint update servicebus-queue

Förhandsgranskning

Kommandogruppen "iot hub message-endpoint" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera egenskaperna för en befintlig Service Bus-köslutpunkt för en IoT Hub.

Om du uppdaterar autentiseringstypen från en nyckelbaserad till identitetsbaserad Service Bus-köslutpunkt måste du ange identiteten (via --identity), slutpunkts-uri (via --endpoint-uri) och entitetssökvägen (via --entity-path). Den gamla niska veze kommer att vara null.

Om du uppdaterar autentiseringstypen från en identitetsbaserad till nyckelbaserad Service Bus-köslutpunkt måste du ange niska veze (via --connection-string). Den gamla slutpunkts-URI:n och entitetssökvägen kommer att vara null.

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]

Exempel

Uppdatera en nyckelbaserad eller identitetsbaserad Service Bus-köslutpunkt för en IoT Hub för att använda en ny angiven niska veze.

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} -c {connection_string}

Uppdatera en Service Bus-köslutpunkt för en IoT Hub för att använda systemtilldelad identitet och en annan entitetssökväg.

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Uppdatera en nyckelbaserad Service Bus-köslutpunkt för en IoT Hub för att använda användartilldelad identitet (du kan utelämna --endpoint-uri om slutpunkten redan är identitetsbaserad).

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}

Obligatoriska parametrar

--en --endpoint --endpoint-name

Namn på routningsslutpunkten.

--hub-name -n

IoT Hub-namn.

Valfria parametrar

--connection-string -c

Anslutningssträng för routningsslutpunkten.

--endpoint-resource-group --erg -r

Resursgrupp för slutpunktens resurs. Om det inte anges används IoT Hub-resursgruppen.

--endpoint-subscription-id -s

Prenumerations-ID för slutpunktsresursen. Om den inte tillhandahålls används IoT Hub-prenumerationen.

--endpoint-uri

URI för slutpunktsresursen.

--entity-path

Entitetssökvägen för slutpunktsresursen.

--identity

Använd en systemtilldelad eller användartilldelad hanterad identitet för slutpunktsautentisering. Använd "[system]" för att referera till den systemtilldelade identiteten eller ett resurs-ID för att referera till en användartilldelad identitet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub message-endpoint update servicebus-topic

Förhandsgranskning

Kommandogruppen "iot hub message-endpoint" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera egenskaperna för en befintlig Service Bus Topic-slutpunkt för en IoT Hub.

Om du uppdaterar autentiseringstypen från en nyckelbaserad till identitetsbaserad Service Bus Topic-slutpunkt måste du ange identiteten (via --identity), slutpunkts-uri (via --endpoint-uri) och entitetssökvägen (via --entity-path). Den gamla niska veze kommer att vara null.

Om du uppdaterar autentiseringstypen från en identitetsbaserad till nyckelbaserad Service Bus-ämnesslutpunkt måste du ange niska veze (via --connection-string). Den gamla slutpunkts-URI:n och entitetssökvägen kommer att vara null.

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]

Exempel

Uppdatera en nyckelbaserad eller identitetsbaserad Service Bus-ämnesslutpunkt för en IoT Hub för att använda en ny angiven niska veze.

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} -c {connection_string}

Uppdatera en Service Bus-ämnesslutpunkt för en IoT Hub för att använda systemtilldelad identitet och en annan entitetssökväg.

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Uppdatera en nyckelbaserad Service Bus-ämnesslutpunkt för en IoT Hub för att använda användartilldelad identitet (du kan utelämna --endpoint-uri om slutpunkten redan är identitetsbaserad).

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}

Obligatoriska parametrar

--en --endpoint --endpoint-name

Namn på routningsslutpunkten.

--hub-name -n

IoT Hub-namn.

Valfria parametrar

--connection-string -c

Anslutningssträng för routningsslutpunkten.

--endpoint-resource-group --erg -r

Resursgrupp för slutpunktens resurs. Om det inte anges används IoT Hub-resursgruppen.

--endpoint-subscription-id -s

Prenumerations-ID för slutpunktsresursen. Om den inte tillhandahålls används IoT Hub-prenumerationen.

--endpoint-uri

URI för slutpunktsresursen.

--entity-path

Entitetssökvägen för slutpunktsresursen.

--identity

Använd en systemtilldelad eller användartilldelad hanterad identitet för slutpunktsautentisering. Använd "[system]" för att referera till den systemtilldelade identiteten eller ett resurs-ID för att referera till en användartilldelad identitet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub message-endpoint update storage-container

Förhandsgranskning

Kommandogruppen "iot hub message-endpoint" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera egenskaperna för en befintlig slutpunkt för lagringscontainer för en IoT Hub.

Om du uppdaterar autentiseringstypen från en nyckelbaserad till identitetsbaserad lagringscontainerslutpunkt måste du ange identiteten (via --identity) och slutpunkts-uri (via --endpoint-uri). Den gamla niska veze kommer att vara null.

Om du uppdaterar autentiseringstypen från en identitetsbaserad till nyckelbaserad slutpunkt för lagringscontainer måste du ange niska veze (via --connection-string).

Det går inte att ändra containernamnet och kodningen för slutpunkten. Kontonamn kan bara ändras om containrar med samma namn finns i båda kontona.

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]

Exempel

Uppdatera en nyckelbaserad eller identitetsbaserad lagringscontainerslutpunkt för en IoT Hub för att använda en ny angiven niska veze.

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} -c {connection_string}

Uppdatera en lagringscontainerslutpunkt för en IoT Hub för att använda systemtilldelad identitet med angiven batchfrekvens, segmentstorlek och filnamnsformat.

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]

Uppdatera en nyckelbaserad lagringscontainerslutpunkt för en IoT Hub för att använda användartilldelad identitet (du kan utelämna --endpoint-uri om slutpunkten redan är identitetsbaserad).

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}

Obligatoriska parametrar

--en --endpoint --endpoint-name

Namn på routningsslutpunkten.

--hub-name -n

IoT Hub-namn.

Valfria parametrar

--batch-frequency -b

Begär batchfrekvens i sekunder. Den maximala tid som kan förflutit innan data skrivs till en blob, mellan 60 och 720 sekunder.

--chunk-size -w

Begär segmentstorlek i megabyte (MB). Den maximala storleken på blobar, mellan 10 och 500 MB.

--connection-string -c

Anslutningssträng för routningsslutpunkten.

--endpoint-resource-group --erg -r

Resursgrupp för slutpunktens resurs. Om det inte anges används IoT Hub-resursgruppen.

--endpoint-subscription-id -s

Prenumerations-ID för slutpunktsresursen. Om den inte tillhandahålls används IoT Hub-prenumerationen.

--endpoint-uri

URI för slutpunktsresursen.

--ff --file-name-format

Filnamnsformat för bloben. Filnamnsformatet måste innehålla fälten {iothub}, {partition}, {YYYY}, {MM}, {DD}, {HH} och {mm}. Alla parametrar är obligatoriska men kan ordnas om med eller utan avgränsare.

--identity

Använd en systemtilldelad eller användartilldelad hanterad identitet för slutpunktsautentisering. Använd "[system]" för att referera till den systemtilldelade identiteten eller ett resurs-ID för att referera till en användartilldelad identitet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.