az iot central export destination

Versão Prévia

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

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

Gerencie e configure destinos de exportação do IoT Central.

Comandos

Nome	Description	Tipo	Status
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 destination create

Versão Prévia

O grupo de comandos 'iot central export destination' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

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

az iot central export destination create --app-id
                                         --dest-id
                                         --display-name --name
                                         --type {blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1}
                                         [--api-version --av {2022-06-30-preview}]
                                         [--au --authorization]
                                         [--central-api-uri --central-dns-suffix]
                                         [--cluster-url --cu]
                                         [--database]
                                         [--header]
                                         [--table]
                                         [--token]
                                         [--url]

Exemplos

Criar um destino de exportação de webhook com conteúdo json

az iot central export destination create --app-id {appid} --dest-id {destinationid} --name {displayname} --url {url} --type webhook@v1 --header '{"x-custom-region":{"value":"westus", "secret": false}}'

Criar um destino de exportação de armazenamento de blobs com conteúdo json

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type blobstorage@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString":"DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=[key];EndpointSuffix=core.windows.net",
  "containerName": "test"
}'

Criar um destino de exportação do Azure Data Explorer com conteúdo json

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type dataexplorer@v1 --name {displayname} --cluster-url {clusterurl} --database {database} --table {table} --authorization '{
  "type": "servicePrincipal",
  "clientId": "3b420743-2020-44c6-9b70-cc42f945db0x",
  "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
  "clientSecret": "[Secret]"
}'

Criar um destino de exportação do Hub de Eventos com conteúdo json

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type eventhubs@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=*****;EntityPath=entityPath1"
}'

Criar um destino de Fila do Barramento de Serviço com conteúdo json

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type servicebusqueue@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[namespance].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
}'

Criar um destino de Tópico do Barramento de Serviço com conteúdo json

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type servicebustopic@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
}'

Parâmetros Exigidos

--app-id -n

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.

--dest-id

Identificador exclusivo para o destino de exportação.

--display-name --name

O nome de exibição de destino.

--type -t

O tipo de destino.

Propriedade	Valor
Valores aceitos:	blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1

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.

--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
Valor padrão:	2022-06-30-preview
Valores aceitos:	2022-06-30-preview

--au --authorization

A configuração de autorização em json.

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--cluster-url --cu

A URL do cluster do Azure Data Explorer.

--database

O banco de dados do Azure Data Explorer.

--header

O destino do webhook custimized header collection in json.

--table

A tabela do Azure Data Explorer.

--token

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.

--url

A URL do webhook.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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 destination delete

Versão Prévia

O grupo de comandos 'iot central export destination' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

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

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

Exemplos

Excluir um destino de exportação

az iot central export destination delete --app-id {appid} --dest-id {destinationid}

Parâmetros Exigidos

--app-id -n

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.

--dest-id

Identificador exclusivo para o destino de 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.

--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
Valor padrão:	2022-06-30-preview
Valores aceitos:	2022-06-30-preview

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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 destination list

Versão Prévia

O grupo de comandos 'iot central export destination' 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 destinos de exportação para um aplicativo do IoT Central.

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

Exemplos

Listar todos os destinos de exportação em um aplicativo

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

Parâmetros Exigidos

--app-id -n

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.

--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
Valor padrão:	2022-06-30-preview
Valores aceitos:	2022-06-30-preview

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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 destination show

Versão Prévia

O grupo de comandos 'iot central export destination' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtenha detalhes de um destino de exportação.

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

Exemplos

Obter detalhes de destino de exportação

az iot central export destination show --app-id {appid} --dest-id {destinationid}

Parâmetros Exigidos

--app-id -n

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.

--dest-id

Identificador exclusivo para o destino de 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.

--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
Valor padrão:	2022-06-30-preview
Valores aceitos:	2022-06-30-preview

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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 destination update

Versão Prévia

O grupo de comandos 'iot central export destination' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

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

O tipo de destino é imutável depois de criado. Um novo destino deve ser criado com o novo tipo.

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

Exemplos

Atualizar um destino de exportação do arquivo

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

Atualizar um destino de exportação com conteúdo de patch json

az iot central export destination update --app-id {appid} --dest-id {destinationid} --content '{"displayName": "Web Hook Updated"}'

Parâmetros Exigidos

--app-id -n

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.

--content -k

A definição de destino 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:{JSON de dados de destino}]. O corpo da solicitação deve conter conteúdo parcial do Destino.

--dest-id

Identificador exclusivo para o destino de 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.

--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
Valor padrão:	2022-06-30-preview
Valores aceitos:	2022-06-30-preview

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

Comentários

Esta página foi útil?

Compartilhar via

az iot central export destination

Comandos

az iot central export destination create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central export destination delete

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central export destination list

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central export destination show

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central export destination update

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Comentários