Partilhar via


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 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 de apoio: https://aka.ms/CLI_refstatus

Gerencie e configure as exportações de dados do IoT Central.

Comandos

Name 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 para 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 os detalhes do 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

Pré-visualizar

O grupo de comando 'iot central export' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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

Crie 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 Obrigatórios

--app-id -n

A ID do aplicativo 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.

Propriedade Valor
Valores aceites: deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade Valor
Default value: 2022-06-30-preview
Valores aceites: 2022-06-30-preview
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--en --enrichments

O enriquecimento da exportação de dados.

--enabled -e

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

Propriedade Valor
Default value: True
Valores aceites: false, 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ê pode 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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot central export delete

Pré-visualizar

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

Exclua uma exportação para 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 Obrigatórios

--app-id -n

A ID do aplicativo 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade Valor
Default value: 2022-06-30-preview
Valores aceites: 2022-06-30-preview
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot central export list

Pré-visualizar

O grupo de comando 'iot central export' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 Obrigatórios

--app-id -n

A ID do aplicativo 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade Valor
Default value: 2022-06-30-preview
Valores aceites: 2022-06-30-preview
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot central export show

Pré-visualizar

O grupo de comando 'iot central export' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 Obrigatórios

--app-id -n

A ID do aplicativo 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade Valor
Default value: 2022-06-30-preview
Valores aceites: 2022-06-30-preview
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot central export update

Pré-visualizar

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

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

A origem é imutável quando 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 da carga útil json

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

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo 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 stringified bruto. [Exemplo de caminho do arquivo:./path/to/file.json] [Exemplo de JSON stringificado:{Export Data JSON}]. O corpo da solicitação deve conter conteúdo parcial de Exportar.

--export-id --id

Identificador exclusivo para a exportação.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade Valor
Default value: 2022-06-30-preview
Valores aceites: 2022-06-30-preview
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False