Partilhar via

az iot hub message-endpoint update

  • Pré-visualizar
  • Referência

Nota

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.46.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot hub message-endpoint update . Saiba mais sobre extensões.

O grupo de comandos 'iot hub message-endpoint' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize as propriedades de um ponto de extremidade existente para um Hub IoT.

Comandos

Name Description Tipo Status
az iot hub message-endpoint update cosmosdb-container

Atualize as propriedades de um ponto de extremidade de contêiner do Cosmos DB existente para um Hub IoT.

 Extensão Pré-visualizar
az iot hub message-endpoint update eventhub

Atualize as propriedades de um ponto de extremidade existente do Hub de Eventos para um Hub IoT.

 Extensão Pré-visualizar
az iot hub message-endpoint update servicebus-queue

Atualize as propriedades de um ponto de extremidade existente da Fila do Service Bus para um Hub IoT.

 Extensão Pré-visualizar
az iot hub message-endpoint update servicebus-topic

Atualize as propriedades de um ponto de extremidade existente do Tópico do Service Bus para um Hub IoT.

 Extensão Pré-visualizar
az iot hub message-endpoint update storage-container

Atualize as propriedades de um ponto de extremidade de Contêiner de Armazenamento existente para um Hub IoT.

 Extensão Pré-visualizar

az iot hub message-endpoint update cosmosdb-container

Pré-visualizar

O grupo de comandos 'iot hub message-endpoint' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize as propriedades de um ponto de extremidade de contêiner do Cosmos DB existente para um Hub IoT.

Se estiver atualizando o tipo de autenticação de um ponto de extremidade de contêiner do Cosmos DB baseado em chave para um ponto de extremidade baseado em identidade, você deverá fornecer a identidade (via --identity) e o uri do ponto de extremidade (via --endpoint-uri). A chave primária antiga e a chave secundária serão anuladas.

Se estiver atualizando o tipo de autenticação de um ponto de extremidade de contêiner do Cosmos DB baseado em identidade para chave, você deverá fornecer a cadeia de conexão (via --connection-string), a chave primária (via --primary-key) ou a chave secundária (via --secondary-key).

O nome do contêiner para o ponto de extremidade não pode ser alterado. Os nomes de conta só podem ser alterados se existirem contêineres com o mesmo nome em ambas as contas.

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]

Exemplos

Atualize um ponto de extremidade de contêiner do Cosmos DB baseado em chave ou identidade para um Hub IoT para usar uma nova cadeia de conexão especificada.

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

Atualize um ponto de extremidade de contêiner do Cosmos DB para um Hub IoT para usar uma chave primária e uma chave secundária especificadas.

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

Atualize um ponto de extremidade de contêiner do Cosmos DB para um Hub IoT para usar a identidade atribuída ao sistema e um nome de chave de partição. O modelo de chave de partição será o padrão.

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

Atualize um ponto de extremidade de contêiner do Cosmos DB baseado em chave para um Hub IoT para usar a identidade atribuída pelo usuário (você pode omitir --endpoint-uri se o ponto de extremidade já for baseado em identidade).

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

Parâmetros Obrigatórios

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--connection-string -c

Cadeia de conexão do ponto de extremidade de roteamento.

--database-name --db

O nome do banco de dados do cosmos DB na conta do cosmos DB.

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

Grupo de recursos do recurso Endpoint resoure. Se não for fornecido, o grupo de recursos do Hub IoT será usado.

--endpoint-subscription-id -s

ID de assinatura do recurso Endpoint. Se não for fornecida, a assinatura do Hub IoT será usada.

--endpoint-uri

O uri do recurso de ponto de extremidade.

--identity

Use uma identidade gerenciada atribuída pelo sistema ou pelo usuário para autenticação de ponto de extremidade. Use "[sistema]" para se referir à identidade atribuída ao sistema ou a um ID de recurso para se referir a uma identidade atribuída pelo usuário.

--partition-key-name --pkn

O nome da chave de partição associada a este contêiner SQL do Cosmos DB, se existir. Para limpar esta propriedade, defina-a como "".

--partition-key-template --pkt

O modelo para gerar um valor de chave de partição sintética para uso com este contêiner SQL do Cosmos DB. O modelo deve incluir pelo menos um dos seguintes espaços reservados: {iothub}, {deviceid}, {DD}, {MM} e {YYYY}. Qualquer espaço reservado pode ser especificado no máximo uma vez, mas os componentes de ordem e não espaço reservado são arbitrários. Se o nome da chave de partição for fornecido, o modelo de chave de partição assume como padrão {deviceid}-{YYYY}-{MM}. Para limpar esta propriedade, defina-a como "".

--pk --primary-key

A chave primária da conta do cosmos DB.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--secondary-key --sk

A chave secundária da conta do cosmos DB.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot hub message-endpoint update eventhub

Pré-visualizar

O grupo de comandos 'iot hub message-endpoint' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize as propriedades de um ponto de extremidade existente do Hub de Eventos para um Hub IoT.

Se estiver atualizando o tipo de autenticação de um ponto de extremidade do Hub de Eventos baseado em chave para um ponto de extremidade baseado em identidade, você deverá fornecer a identidade (via --identity), o uri do ponto de extremidade (via --endpoint-uri) e o caminho da entidade (via --entity-path). A cadeia de conexão antiga será anulada.

Se estiver atualizando o tipo de autenticação de um ponto de extremidade do Hub de Eventos baseado em identidade para chave, você deverá fornecer a cadeia de conexão (via --connection-string). O uri do ponto de extremidade antigo e o caminho da entidade serão anulados.

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]

Exemplos

Atualize um ponto de extremidade do Hub de Eventos baseado em chave ou identidade para um Hub IoT para usar uma nova cadeia de conexão especificada.

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

Atualize um ponto de extremidade do Hub de Eventos para um Hub IoT para usar a identidade atribuída ao sistema e um caminho de entidade diferente.

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

Atualize um ponto de extremidade do Hub de Eventos baseado em chave para um Hub IoT para usar a identidade atribuída pelo usuário (você pode omitir --endpoint-uri se o ponto de extremidade já for baseado em identidade).

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}

Parâmetros Obrigatórios

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--connection-string -c

Cadeia de conexão do ponto de extremidade de roteamento.

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

Grupo de recursos do recurso Endpoint resoure. Se não for fornecido, o grupo de recursos do Hub IoT será usado.

--endpoint-subscription-id -s

ID de assinatura do recurso Endpoint. Se não for fornecida, a assinatura do Hub IoT será usada.

--endpoint-uri

O uri do recurso de ponto de extremidade.

--entity-path

O caminho da entidade do recurso de ponto de extremidade.

--identity

Use uma identidade gerenciada atribuída pelo sistema ou pelo usuário para autenticação de ponto de extremidade. Use "[sistema]" para se referir à identidade atribuída ao sistema ou a um ID de recurso para se referir a uma identidade atribuída pelo usuário.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot hub message-endpoint update servicebus-queue

Pré-visualizar

O grupo de comandos 'iot hub message-endpoint' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize as propriedades de um ponto de extremidade existente da Fila do Service Bus para um Hub IoT.

Se estiver atualizando o tipo de autenticação de um ponto de extremidade de fila do Service Bus baseado em chave para baseado em identidade, você deverá fornecer a identidade (via --identity), o uri do ponto de extremidade (via --endpoint-uri) e o caminho da entidade (via --entity-path). A cadeia de conexão antiga será anulada.

Se estiver atualizando o tipo de autenticação de um ponto de extremidade de fila do Service Bus baseado em identidade para um ponto de extremidade baseado em chave, você deverá fornecer a cadeia de conexão (via --connection-string). O uri do ponto de extremidade antigo e o caminho da entidade serão anulados.

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]

Exemplos

Atualize um ponto de extremidade de fila do Service Bus baseado em chave ou identidade para um Hub IoT para usar uma nova cadeia de conexão especificada.

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

Atualize um ponto de extremidade da Fila do Service Bus para um Hub IoT para usar a identidade atribuída ao sistema e um caminho de entidade diferente.

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

Atualize um ponto de extremidade da Fila do Service Bus baseado em chave para um Hub IoT para usar a identidade atribuída pelo usuário (você pode omitir --endpoint-uri se o ponto de extremidade já for baseado em identidade).

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}

Parâmetros Obrigatórios

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--connection-string -c

Cadeia de conexão do ponto de extremidade de roteamento.

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

Grupo de recursos do recurso Endpoint resoure. Se não for fornecido, o grupo de recursos do Hub IoT será usado.

--endpoint-subscription-id -s

ID de assinatura do recurso Endpoint. Se não for fornecida, a assinatura do Hub IoT será usada.

--endpoint-uri

O uri do recurso de ponto de extremidade.

--entity-path

O caminho da entidade do recurso de ponto de extremidade.

--identity

Use uma identidade gerenciada atribuída pelo sistema ou pelo usuário para autenticação de ponto de extremidade. Use "[sistema]" para se referir à identidade atribuída ao sistema ou a um ID de recurso para se referir a uma identidade atribuída pelo usuário.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot hub message-endpoint update servicebus-topic

Pré-visualizar

O grupo de comandos 'iot hub message-endpoint' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize as propriedades de um ponto de extremidade existente do Tópico do Service Bus para um Hub IoT.

Se estiver atualizando o tipo de autenticação de um ponto de extremidade de Tópico do Service Bus baseado em chave para um ponto de extremidade baseado em identidade, você deverá fornecer a identidade (via --identity), o uri do ponto de extremidade (via --endpoint-uri) e o caminho da entidade (via --entity-path). A cadeia de conexão antiga será anulada.

Se estiver atualizando o tipo de autenticação de um ponto de extremidade de Tópico do Service Bus baseado em identidade para um ponto de extremidade de Tópico do Service Bus baseado em chave, você deverá fornecer a cadeia de conexão (via --connection-string). O uri do ponto de extremidade antigo e o caminho da entidade serão anulados.

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]

Exemplos

Atualize um ponto de extremidade de Tópico do Service Bus baseado em chave ou identidade para um Hub IoT para usar uma nova cadeia de conexão especificada.

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

Atualize um ponto de extremidade de Tópico do Service Bus para um Hub IoT para usar a identidade atribuída ao sistema e um caminho de entidade diferente.

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

Atualize um ponto de extremidade do Service Bus Topic baseado em chave para um Hub IoT para usar a identidade atribuída pelo usuário (você pode omitir --endpoint-uri se o ponto de extremidade já for baseado em identidade).

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}

Parâmetros Obrigatórios

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--connection-string -c

Cadeia de conexão do ponto de extremidade de roteamento.

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

Grupo de recursos do recurso Endpoint resoure. Se não for fornecido, o grupo de recursos do Hub IoT será usado.

--endpoint-subscription-id -s

ID de assinatura do recurso Endpoint. Se não for fornecida, a assinatura do Hub IoT será usada.

--endpoint-uri

O uri do recurso de ponto de extremidade.

--entity-path

O caminho da entidade do recurso de ponto de extremidade.

--identity

Use uma identidade gerenciada atribuída pelo sistema ou pelo usuário para autenticação de ponto de extremidade. Use "[sistema]" para se referir à identidade atribuída ao sistema ou a um ID de recurso para se referir a uma identidade atribuída pelo usuário.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot hub message-endpoint update storage-container

Pré-visualizar

O grupo de comandos 'iot hub message-endpoint' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize as propriedades de um ponto de extremidade de Contêiner de Armazenamento existente para um Hub IoT.

Se estiver atualizando o tipo de autenticação de um ponto de extremidade de contêiner de armazenamento baseado em chave para um ponto de extremidade baseado em identidade, você deverá fornecer a identidade (via --identity) e o uri do ponto de extremidade (via --endpoint-uri). A cadeia de conexão antiga será anulada.

Se estiver atualizando o tipo de autenticação de um ponto de extremidade de contêiner de armazenamento baseado em identidade para um ponto de extremidade de contêiner de armazenamento baseado em chave, você deverá fornecer a cadeia de conexão (via --connection-string).

O nome do contêiner e a codificação do ponto de extremidade não podem ser alterados. Os nomes de conta só podem ser alterados se existirem contêineres com o mesmo nome em ambas as contas.

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]

Exemplos

Atualize um ponto de extremidade de Contêiner de Armazenamento baseado em chave ou identidade para um Hub IoT para usar uma nova cadeia de conexão especificada.

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

Atualize um ponto de extremidade de Contêiner de Armazenamento para um Hub IoT para usar a identidade atribuída ao sistema com a frequência de lote, o tamanho do bloco e o formato de nome de arquivo fornecidos.

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]

Atualize um ponto de extremidade de Contêiner de Armazenamento baseado em chave para um Hub IoT para usar a identidade atribuída ao usuário (você pode omitir --endpoint-uri se o ponto de extremidade já for baseado em identidade).

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

Parâmetros Obrigatórios

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--batch-frequency -b

Solicite a frequência do lote em segundos. A quantidade máxima de tempo que pode decorrer antes que os dados sejam gravados em um blob, entre 60 e 720 segundos.

--chunk-size -w

Solicite o tamanho do bloco em megabytes (MB). O tamanho máximo dos blobs, entre 10 e 500 MB.

--connection-string -c

Cadeia de conexão do ponto de extremidade de roteamento.

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

Grupo de recursos do recurso Endpoint resoure. Se não for fornecido, o grupo de recursos do Hub IoT será usado.

--endpoint-subscription-id -s

ID de assinatura do recurso Endpoint. Se não for fornecida, a assinatura do Hub IoT será usada.

--endpoint-uri

O uri do recurso de ponto de extremidade.

--ff --file-name-format

Formato de nome de arquivo para o blob. O formato de nome de arquivo deve conter campos {iothub}, {partition}, {AAAA}, {MM}, {DD}, {HH} e {mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados com ou sem delimitadores.

--identity

Use uma identidade gerenciada atribuída pelo sistema ou pelo usuário para autenticação de ponto de extremidade. Use "[sistema]" para se referir à identidade atribuída ao sistema ou a um ID de recurso para se referir a uma identidade atribuída pelo usuário.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.