az iot hub message-endpoint create

  • Versão Prévia
  • Referência

Observação

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 create . 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 suporte: https://aka.ms/CLI_refstatus

Adicione um ponto de extremidade a um Hub IoT.

Comandos

Nome Description Tipo Status
az iot hub message-endpoint create cosmosdb-container

Adicione um ponto de extremidade de contêiner do Cosmos DB para um Hub IoT.

 Extensão Visualizar
az iot hub message-endpoint create eventhub

Adicione um ponto de extremidade do Hub de Eventos para um Hub IoT.

 Extensão Visualizar
az iot hub message-endpoint create servicebus-queue

Adicione um ponto de extremidade da Fila do Barramento de Serviço para um Hub IoT.

 Extensão Visualizar
az iot hub message-endpoint create servicebus-topic

Adicione um ponto de extremidade do Tópico do Barramento de Serviço para um Hub IoT.

 Extensão Visualizar
az iot hub message-endpoint create storage-container

Adicione um ponto de extremidade de Contêiner de Armazenamento para um Hub IoT.

 Extensão Visualizar

az iot hub message-endpoint create cosmosdb-container

Versão Prévia

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

Adicione um ponto de extremidade de contêiner do Cosmos DB para um Hub IoT.

az iot hub message-endpoint create cosmosdb-container --container
                                                      --database-name
                                                      --en
                                                      --hub-name
                                                      [--connection-string]
                                                      [--endpoint-account]
                                                      [--endpoint-resource-group]
                                                      [--endpoint-subscription-id]
                                                      [--endpoint-uri]
                                                      [--identity]
                                                      [--partition-key-name]
                                                      [--partition-key-template]
                                                      [--pk]
                                                      [--resource-group]
                                                      [--secondary-key]

Exemplos

Crie um ponto de extremidade de contêiner do Cosmos DB baseado em chave para um Hub IoT.

az iot hub message-endpoint create cosmosdb-container -n {iothub_name} --en {endpoint_name} --container {container} --db {database} --endpoint-account {account_name}

Crie um ponto de extremidade de contêiner do Cosmos DB para um Hub IoT usando uma cadeia de conexão.

az iot hub message-endpoint create cosmosdb-container -n {iothub_name} --en {endpoint_name} -c {connection_string} --container {container} --db {database}

Crie um ponto de extremidade de contêiner do Cosmos DB para um Hub IoT usando a chave primária especificada e o uri do ponto de extremidade.

az iot hub message-endpoint create cosmosdb-container -n {iothub_name} --en {endpoint_name} --pk {primary_key} --endpoint-uri {endpoint_uri} --container {container} --db {database}

Crie um ponto de extremidade de contêiner do Cosmos DB para um Hub IoT usando 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 create cosmosdb-container -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --container {container} --db {database} --pkn {partition_key_name} --identity [system]

Crie um ponto de extremidade de contêiner do Cosmos DB para um Hub IoT usando identidade atribuída pelo usuário, nome de chave de partição e modelo de chave de partição.

az iot hub message-endpoint create cosmosdb-container -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --container {container} --db {database} --pkn {partition_key_name} --pkt {partition_key_template} --identity {user_identity_resource_id}

Parâmetros Exigidos

--container --container-name

O nome do Contêiner SQL do Cosmos DB no Banco de Dados do cosmos DB.

--database-name --db

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

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

O nome da conta para o recurso de ponto de extremidade.

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

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

--endpoint-subscription-id -s

ID de assinatura do recurso Ponto de extremidade. 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 "[system]" para se referir à identidade atribuída pelo sistema ou a uma 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 esse Contêiner SQL do Cosmos DB, se houver.

--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 assumirá como padrão {deviceid}-{YYYY}-{MM}.

--pk --primary-key

A chave primária da conta do cosmos DB.

--resource-group -g

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 Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub message-endpoint create eventhub

Versão Prévia

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

Adicione um ponto de extremidade do Hub de Eventos para um Hub IoT.

az iot hub message-endpoint create eventhub --en
                                            --hub-name
                                            [--connection-string]
                                            [--endpoint-namespace-name]
                                            [--endpoint-policy-name]
                                            [--endpoint-resource-group]
                                            [--endpoint-subscription-id]
                                            [--endpoint-uri]
                                            [--entity-path]
                                            [--identity]
                                            [--resource-group]

Exemplos

Crie um ponto de extremidade do Hub de Eventos baseado em chave para um Hub IoT.

az iot hub message-endpoint create eventhub -n {iothub_name} --en {endpoint_name} --namespace {namespace_name} --entity-path {entity_path} --policy {policy_name}

Crie um ponto de extremidade do Hub de Eventos para um Hub IoT usando uma cadeia de conexão. O uri do ponto de extremidade e o caminho da entidade são omitidos.

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

Crie um ponto de extremidade do Hub de Eventos para um Hub IoT usando a identidade atribuída pelo sistema. O ponto de extremidade e o caminho da entidade devem ser especificados.

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

Crie um ponto de extremidade do Hub de Eventos para um Hub IoT usando a identidade atribuída pelo usuário. O ponto de extremidade e o caminho da entidade devem ser especificados.

az iot hub message-endpoint create eventhub -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --entity-path {entity_path} --identity {user_identity_resource_id}

Parâmetros Exigidos

--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-namespace-name --namespace

O nome do namespace para o recurso de ponto de extremidade.

--endpoint-policy-name --policy

O nome da política para recuperação da cadeia de conexão.

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

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

--endpoint-subscription-id -s

ID de assinatura do recurso Ponto de extremidade. 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 "[system]" para se referir à identidade atribuída pelo sistema ou a uma ID de recurso para se referir a uma identidade atribuída pelo usuário.

--resource-group -g

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub message-endpoint create servicebus-queue

Versão Prévia

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

Adicione um ponto de extremidade da Fila do Barramento de Serviço para um Hub IoT.

az iot hub message-endpoint create servicebus-queue --en
                                                    --hub-name
                                                    [--connection-string]
                                                    [--endpoint-namespace-name]
                                                    [--endpoint-policy-name]
                                                    [--endpoint-resource-group]
                                                    [--endpoint-subscription-id]
                                                    [--endpoint-uri]
                                                    [--entity-path]
                                                    [--identity]
                                                    [--resource-group]

Exemplos

Crie um ponto de extremidade da Fila do Barramento de Serviço baseado em chave para um Hub IoT.

az iot hub message-endpoint create servicebus-queue -n {iothub_name} --en {endpoint_name} --namespace {namespace_name} --entity-path {entity_path} --policy {policy_name}

Crie um ponto de extremidade da Fila do Barramento de Serviço para um Hub IoT usando uma cadeia de conexão. O uri do ponto de extremidade e o caminho da entidade são omitidos.

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

Crie um ponto de extremidade da Fila do Barramento de Serviço para um Hub IoT usando a identidade atribuída pelo sistema. O ponto de extremidade e o caminho da entidade devem ser especificados.

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

Crie um ponto de extremidade da Fila do Barramento de Serviço para um Hub IoT usando a identidade atribuída pelo usuário. O ponto de extremidade e o caminho da entidade devem ser especificados.

az iot hub message-endpoint create servicebus-queue -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --entity-path {entity_path} --identity {user_identity_resource_id}

Parâmetros Exigidos

--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-namespace-name --namespace

O nome do namespace para o recurso de ponto de extremidade.

--endpoint-policy-name --policy

O nome da política para recuperação da cadeia de conexão.

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

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

--endpoint-subscription-id -s

ID de assinatura do recurso Ponto de extremidade. 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 "[system]" para se referir à identidade atribuída pelo sistema ou a uma ID de recurso para se referir a uma identidade atribuída pelo usuário.

--resource-group -g

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub message-endpoint create servicebus-topic

Versão Prévia

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

Adicione um ponto de extremidade do Tópico do Barramento de Serviço para um Hub IoT.

az iot hub message-endpoint create servicebus-topic --en
                                                    --hub-name
                                                    [--connection-string]
                                                    [--endpoint-namespace-name]
                                                    [--endpoint-policy-name]
                                                    [--endpoint-resource-group]
                                                    [--endpoint-subscription-id]
                                                    [--endpoint-uri]
                                                    [--entity-path]
                                                    [--identity]
                                                    [--resource-group]

Exemplos

Crie um ponto de extremidade de Tópico do Barramento de Serviço baseado em chave para um Hub IoT.

az iot hub message-endpoint create servicebus-topic -n {iothub_name} --en {endpoint_name} --namespace {namespace_name} --entity-path {entity_path} --policy {policy_name}

Crie um ponto de extremidade do Tópico do Barramento de Serviço para um Hub IoT usando uma cadeia de conexão. O uri do ponto de extremidade e o caminho da entidade são omitidos.

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

Crie um ponto de extremidade do Tópico do Barramento de Serviço para um Hub IoT usando a identidade atribuída ao sistema. O ponto de extremidade e o caminho da entidade devem ser especificados.

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

Crie um ponto de extremidade do Tópico do Barramento de Serviço para um Hub IoT usando a identidade atribuída pelo usuário. O ponto de extremidade e o caminho da entidade devem ser especificados.

az iot hub message-endpoint create servicebus-topic -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --entity-path {entity_path} --identity {user_identity_resource_id}

Parâmetros Exigidos

--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-namespace-name --namespace

O nome do namespace para o recurso de ponto de extremidade.

--endpoint-policy-name --policy

O nome da política para recuperação da cadeia de conexão.

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

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

--endpoint-subscription-id -s

ID de assinatura do recurso Ponto de extremidade. 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 "[system]" para se referir à identidade atribuída pelo sistema ou a uma ID de recurso para se referir a uma identidade atribuída pelo usuário.

--resource-group -g

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub message-endpoint create storage-container

Versão Prévia

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

Adicione um ponto de extremidade de Contêiner de Armazenamento para um Hub IoT.

az iot hub message-endpoint create storage-container --container
                                                     --en
                                                     --hub-name
                                                     [--batch-frequency]
                                                     [--chunk-size]
                                                     [--connection-string]
                                                     [--encoding {avro, json}]
                                                     [--endpoint-account]
                                                     [--endpoint-resource-group]
                                                     [--endpoint-subscription-id]
                                                     [--endpoint-uri]
                                                     [--ff]
                                                     [--identity]
                                                     [--resource-group]

Exemplos

Crie um ponto de extremidade de Contêiner de Armazenamento baseado em chave para um Hub IoT.

az iot hub message-endpoint create storage-container -n {iothub_name} --en {endpoint_name} --container {container_name} --endpoint-account {account_name}

Crie um ponto de extremidade de Contêiner de Armazenamento para um Hub IoT usando uma cadeia de conexão. O uri do ponto de extremidade é omitido.

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

Crie um ponto de extremidade do Contêiner de Armazenamento para um Hub IoT usando a identidade atribuída pelo sistema com a frequência de lote, o tamanho do bloco e o formato de nome de arquivo determinados. O ponto de extremidade deve ser especificado.

az iot hub message-endpoint create storage-container -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --container {container_name} -b {batch_frequency} -w {chunk_size} --ff {file_format} --identity [system]

Crie um ponto de extremidade de Contêiner de Armazenamento para um Hub IoT usando a identidade atribuída pelo usuário com codificação json. O ponto de extremidade deve ser especificado.

az iot hub message-endpoint create storage-container -n {iothub_name} --en {endpoint_name} --endpoint-uri {endpoint_uri} --container {container_name} --encoding json --identity {user_identity_resource_id}

Parâmetros Exigidos

--container --container-name

Nome do recipiente de armazenamento.

--en --endpoint --endpoint-name

Nome do ponto de extremidade de roteamento.

--hub-name -n

Nome do Hub IoT.

Parâmetros Opcionais

--batch-frequency -b

Frequência de lote de solicitação 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.

Valor padrão: 300
--chunk-size -w

Tamanho do bloco de solicitação em megabytes (MB). O tamanho máximo dos blobs, entre 10 e 500 MB.

Valor padrão: 300
--connection-string -c

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

--encoding

Formato de codificação para o contêiner.

Valores aceitos: avro, json
Valor padrão: avro
--endpoint-account

O nome da conta para o recurso de ponto de extremidade.

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

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

--endpoint-subscription-id -s

ID de assinatura do recurso Ponto de extremidade. 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 os campos {iothub}, {partition}, {YYYY}, {MM}, {DD}, {HH} e {mm}. Todos os parâmetros são obrigatórios, mas podem ser reordenados com ou sem delimitadores.

Valor padrão: {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}
--identity

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

--resource-group -g

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.