az iot central export

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 central export . Saiba mais sobre extensões.

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

Gerenciar e configurar exportações de dados do IoT Central.

Comandos

Nome	Description	Tipo	Status
az iot central export create	Crie uma exportação para um aplicativo do IoT Central.	Extensão	Visualizar
az iot central export delete	Exclua uma exportação de um aplicativo do IoT Central.	Extensão	Visualizar
az iot central export destination	Gerencie e configure destinos de exportação do IoT Central.	Extensão	Visualizar
az iot central export destination create	Crie um destino de exportação para um aplicativo do IoT Central.	Extensão	Visualizar
az iot central export destination delete	Exclua um destino de exportação para um aplicativo do IoT Central.	Extensão	Visualizar
az iot central export destination list	Obtenha a lista completa de destinos de exportação para um aplicativo do IoT Central.	Extensão	Visualizar
az iot central export destination show	Obtenha detalhes do destino de exportação.	Extensão	Visualizar
az iot central export destination update	Atualize um destino de exportação para um aplicativo do IoT Central.	Extensão	Visualizar
az iot central export list	Obtenha a lista completa de exportações para um aplicativo IoT Central.	Extensão	Visualizar
az iot central export show	Obtenha detalhes de exportação.	Extensão	Visualizar
az iot central export update	Atualizar uma exportação para um aplicativo IoT Central.	Extensão	Visualizar

az iot central export create

Versão Prévia

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

Crie uma exportação para um aplicativo do IoT Central.

az iot central export create --app-id
                             --destinations
                             --display-name
                             --export-id
                             --source {deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry}
                             [--api-version {2022-06-30-preview}]
                             [--central-api-uri]
                             [--en]
                             [--enabled {false, true}]
                             [--filter]
                             [--token]

Exemplos

Criar uma exportação com filtro, enriquecimentos, destinos

az iot central export create --app-id {appid} --export-id {exportid} --enabled {enabled} --display-name {displayname} --source {source} --filter "SELECT * FROM devices WHERE $displayName != "abc" AND $id = "a"" --enrichments '{
  "simulated": {
    "path": "$simulated"
  }
}' --destinations '[
  {
    "id": "{destinationid}",
    "transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }"
  }
]'

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--destinations --dests

A lista de destinos com transformação.

--display-name --name

O nome de exibição da exportação de dados.

--export-id --id

Identificador exclusivo para a exportação.

--source -s

A fonte de exportação de dados.

Valores aceitos: deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

A versão da API para a operação solicitada.

Valores aceitos: 2022-06-30-preview

Valor padrão: 2022-06-30-preview

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--en --enrichments

O enriquecimento de exportação de dados.

--enabled -e

O status habilitado para exportação de dados, True ou False.

Valores aceitos: false, true

Valor padrão: True

--filter -f

Filtro baseado em IoT Central Query Language, mais detalhes em: aka.ms/iotcquery.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 central export delete

Versão Prévia

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

Exclua uma exportação de um aplicativo do IoT Central.

az iot central export delete --app-id
                             --export-id
                             [--api-version {2022-06-30-preview}]
                             [--central-api-uri]
                             [--token]

Exemplos

Excluir uma exportação

az iot central export delete --app-id {appid} --export-id {exportid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--export-id --id

Identificador exclusivo para a exportação.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

A versão da API para a operação solicitada.

Valores aceitos: 2022-06-30-preview

Valor padrão: 2022-06-30-preview

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 central export list

Versão Prévia

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

Obtenha a lista completa de exportações para um aplicativo IoT Central.

az iot central export list --app-id
                           [--api-version {2022-06-30-preview}]
                           [--central-api-uri]
                           [--token]

Exemplos

Listar todas as exportações em um aplicativo

az iot central export list --app-id {appid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

A versão da API para a operação solicitada.

Valores aceitos: 2022-06-30-preview

Valor padrão: 2022-06-30-preview

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 central export show

Versão Prévia

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

Obtenha detalhes de exportação.

az iot central export show --app-id
                           --export-id
                           [--api-version {2022-06-30-preview}]
                           [--central-api-uri]
                           [--token]

Exemplos

Obter detalhes de exportação

az iot central export show --app-id {appid} --export-id {exportid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--export-id --id

Identificador exclusivo para a exportação.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

A versão da API para a operação solicitada.

Valores aceitos: 2022-06-30-preview

Valor padrão: 2022-06-30-preview

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 central export update

Versão Prévia

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

Atualizar uma exportação para um aplicativo IoT Central.

O código-fonte é imutável quando uma exportação é criada.

az iot central export update --app-id
                             --content
                             --export-id
                             [--api-version {2022-06-30-preview}]
                             [--central-api-uri]
                             [--token]

Exemplos

Atualizar uma exportação do arquivo

az iot central export update --app-id {appid} --export-id {exportid} --content './filepath/payload.json'

Atualizar o nome de exibição de uma exportação e habilitar a exportação da carga json

az iot central export update --app-id {appid} --export-id {exportid} --content "{'displayName': 'Updated Export Name', 'enabled': true}"

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--content -k

A definição de exportação parcial. Forneça caminho para o arquivo JSON ou JSON stringificado bruto. [Exemplo de caminho do arquivo:./path/to/file.json] [Exemplo de JSON stringificado:{}]. O corpo da solicitação deve conter conteúdo parcial de Exportar.

--export-id --id

Identificador exclusivo para a exportação.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

A versão da API para a operação solicitada.

Valores aceitos: 2022-06-30-preview

Valor padrão: 2022-06-30-preview

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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.