az iot central export
Note
Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.67.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando az iot central export. Saiba mais sobre extensões.
Esse grupo de comandos está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus
Gerencie e configure 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. |
Extension | Preview |
| az iot central export delete |
Exclua uma exportação de um aplicativo do IoT Central. |
Extension | Preview |
| az iot central export destination |
Gerencie e configure destinos de exportação do IoT Central. |
Extension | Preview |
| az iot central export destination create |
Crie um destino de exportação para um aplicativo do IoT Central. |
Extension | Preview |
| az iot central export destination delete |
Exclua um destino de exportação para um aplicativo do IoT Central. |
Extension | Preview |
| az iot central export destination list |
Obtenha a lista completa de destinos de exportação para um aplicativo do IoT Central. |
Extension | Preview |
| az iot central export destination show |
Obtenha detalhes de um destino de exportação. |
Extension | Preview |
| az iot central export destination update |
Atualize um destino de exportação para um aplicativo do IoT Central. |
Extension | Preview |
| az iot central export list |
Obtenha a lista completa de exportações para um aplicativo do IoT Central. |
Extension | Preview |
| az iot central export show |
Obtenha detalhes de exportação. |
Extension | Preview |
| az iot central export update |
Atualize uma exportação para um aplicativo do IoT Central. |
Extension | Preview |
az iot central export create
O grupo de comandos 'iot central export' está em versão prévia 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 --dests
--display-name --name
--export-id --id
--source {deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry}
[--api-version --av {2022-06-30-preview}]
[--central-api-uri --central-dns-suffix]
[--en --enrichments]
[--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
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A lista de destinos com transformação.
O nome de exibição de exportação de dados.
Identificador exclusivo para a exportação.
A fonte de exportação de dados.
| Propriedade | Valor |
|---|---|
| Valores aceitos: | deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry |
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
O argumento 'api_version' foi preterido e será removido em uma versão futura.
A versão da API para a operação solicitada.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-06-30-preview |
| Valores aceitos: | 2022-06-30-preview |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
O enriquecimento de exportação de dados.
O status habilitado para exportação de dados, True ou False.
| Propriedade | Valor |
|---|---|
| Valor padrão: | True |
| Valores aceitos: | false, true |
Filtro baseado em Linguagem de Consulta do IoT Central, mais detalhes de: aka.ms/iotcquery.
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot central export delete
O grupo de comandos 'iot central export' está em versão prévia 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 --id
[--api-version --av {2022-06-30-preview}]
[--central-api-uri --central-dns-suffix]
[--token]
Exemplos
Excluir uma exportação
az iot central export delete --app-id {appid} --export-id {exportid}
Parâmetros Exigidos
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
Identificador exclusivo para a exportação.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
O argumento 'api_version' foi preterido e será removido em uma versão futura.
A versão da API para a operação solicitada.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-06-30-preview |
| Valores aceitos: | 2022-06-30-preview |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot central export list
O grupo de comandos 'iot central export' está em versão prévia 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 do IoT Central.
az iot central export list --app-id
[--api-version --av {2022-06-30-preview}]
[--central-api-uri --central-dns-suffix]
[--token]
Exemplos
Listar todas as exportações em um aplicativo
az iot central export list --app-id {appid}
Parâmetros Exigidos
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
O argumento 'api_version' foi preterido e será removido em uma versão futura.
A versão da API para a operação solicitada.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-06-30-preview |
| Valores aceitos: | 2022-06-30-preview |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot central export show
O grupo de comandos 'iot central export' está em versão prévia 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 --id
[--api-version --av {2022-06-30-preview}]
[--central-api-uri --central-dns-suffix]
[--token]
Exemplos
Obter detalhes de exportação
az iot central export show --app-id {appid} --export-id {exportid}
Parâmetros Exigidos
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
Identificador exclusivo para a exportação.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
O argumento 'api_version' foi preterido e será removido em uma versão futura.
A versão da API para a operação solicitada.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-06-30-preview |
| Valores aceitos: | 2022-06-30-preview |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot central export update
O grupo de comandos 'iot central export' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus
Atualize uma exportação para um aplicativo do IoT Central.
Source é imutável depois que uma exportação é criada.
az iot central export update --app-id
--content
--export-id --id
[--api-version --av {2022-06-30-preview}]
[--central-api-uri --central-dns-suffix]
[--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 do conteúdo json
az iot central export update --app-id {appid} --export-id {exportid} --content "{'displayName': 'Updated Export Name', 'enabled': true}"
Parâmetros Exigidos
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A definição de exportação parcial. Forneça o caminho para o arquivo JSON ou JSON em cadeia de caracteres bruto. [Exemplo do caminho do arquivo:./path/to/file.json] [Exemplo de JSON com cadeia de caracteres:{Exportar JSON de Dados}]. O corpo da solicitação deve conter conteúdo parcial de Exportação.
Identificador exclusivo para a exportação.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
O argumento 'api_version' foi preterido e será removido em uma versão futura.
A versão da API para a operação solicitada.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-06-30-preview |
| Valores aceitos: | 2022-06-30-preview |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |