Compartilhar via


az iot ops schema

Observação

Essa referência faz parte da extensão azure-iot-ops para a CLI do Azure (versão 2.53.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot ops schema . 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

Gerenciamento de esquema e registro.

Esquemas são documentos que descrevem dados para permitir o processamento e a contextualização. Os esquemas de mensagem descrevem o formato de uma mensagem e seu conteúdo. Um registro de esquema é necessário para criar e gerenciar esquemas.

Comandos

Nome Description Tipo Status
az iot ops schema create

Crie um esquema dentro de um registro de esquema.

Extensão Visualizar
az iot ops schema delete

Exclua um esquema de destino em um registro de esquema.

Extensão Visualizar
az iot ops schema list

Listar esquemas em um registro de esquema.

Extensão Visualizar
az iot ops schema registry

Gerenciamento de registro de esquema.

Extensão Visualizar
az iot ops schema registry create

Criar um registro de esquema

Extensão Visualizar
az iot ops schema registry delete

Exclua um registro de esquema de destino.

Extensão Visualizar
az iot ops schema registry list

Listar registros de esquema em um grupo de recursos ou assinatura.

Extensão Visualizar
az iot ops schema registry show

Mostrar detalhes de um registro de esquema.

Extensão Visualizar
az iot ops schema show

Mostrar detalhes de um esquema em um registro de esquema.

Extensão Visualizar
az iot ops schema show-dataflow-refs

Mostre as referências de esquema usadas para fluxos de dados.

Extensão Experimental
az iot ops schema version

Gerenciamento de versão de esquema.

Extensão Visualizar
az iot ops schema version add

Adicione uma versão de esquema a um esquema.

Extensão Visualizar
az iot ops schema version list

Listar versões de esquema para um esquema específico.

Extensão Visualizar
az iot ops schema version remove

Remova uma versão do esquema de destino.

Extensão Visualizar
az iot ops schema version show

Mostrar detalhes de uma versão do esquema.

Extensão Visualizar

az iot ops schema create

Versão Prévia

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

Crie um esquema dentro de um registro de esquema.

Essa operação requer um registro de esquema pré-criado e adicionará uma versão de esquema. Para criar o esquema e adicionar uma versão, a conta de armazenamento associada precisará ter o acesso à rede pública habilitado. Para obter mais informações sobre o formato de arquivo delta, consulte aka.ms/lakehouse-delta-sample.

az iot ops schema create --format {delta, json}
                         --name
                         --registry
                         --resource-group
                         --type {message}
                         --vc
                         [--desc]
                         [--display-name]
                         [--vd]
                         [--ver]

Exemplos

Crie um esquema chamado 'myschema' no registro 'myregistry' com entradas mínimas. A versão 1 do esquema será criada para esse esquema com o conteúdo do arquivo.

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content myschema.json

Crie um esquema chamado 'myschema' com personalização adicional. A versão 14 do esquema será criada para esse esquema. O conteúdo embutido é um exemplo de sintaxe do PowerShell.

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format delta --type message --desc "Schema for Assets" --display-name myassetschema --version-content '{\"hello\": \"world\"}' --ver 14 --vd "14th version"

Crie um esquema chamado 'myschema'. A versão 1 do esquema será criada para esse esquema. O conteúdo embutido é um exemplo de sintaxe cmd.

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content "{\"hello\": \"world\"}"

Crie um esquema chamado 'myschema'. A versão 1 do esquema será criada para esse esquema. O conteúdo embutido é um exemplo de sintaxe bash.

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content '{"hello": "world"}'

Parâmetros Exigidos

--format

Formato do esquema.

Valores aceitos: delta, json
--name -n

Nome do esquema.

--registry

Nome do registro do esquema.

--resource-group -g

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

--type

Tipo de esquema.

Valores aceitos: message
--vc --version-content

Caminho do arquivo contendo ou conteúdo embutido para a versão.

Parâmetros Opcionais

--desc

Descrição do esquema.

--display-name

Nome de exibição do esquema.

--vd --version-desc

Descrição da versão.

--ver --version

Nome da versão do esquema.

Valor padrão: 1
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 ops schema delete

Versão Prévia

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

Exclua um esquema de destino em um registro de esquema.

az iot ops schema delete --name
                         --registry
                         --resource-group
                         [--yes {false, true}]

Exemplos

Exclua um esquema de destino 'myschema' dentro de um registro de esquema 'myregistry'.

az iot ops schema delete --name myschema --registry myregistry -g myresourcegroup

Parâmetros Exigidos

--name -n

Nome do esquema.

--registry

Nome do registro do esquema.

--resource-group -g

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

Parâmetros Opcionais

--yes -y

Confirme [y] es sem um aviso. Útil para cenários de CI e automação.

Valores aceitos: false, true
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 ops schema list

Versão Prévia

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

Listar esquemas em um registro de esquema.

az iot ops schema list --registry
                       --resource-group

Exemplos

Listar registros de esquema no registro de esquema 'myregistry'.

az iot ops schema list -g myresourcegroup --registry myregistry

Parâmetros Exigidos

--registry

Nome do registro do esquema.

--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 ops schema show

Versão Prévia

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

Mostrar detalhes de um esquema em um registro de esquema.

az iot ops schema show --name
                       --registry
                       --resource-group

Exemplos

Mostre detalhes do esquema de destino 'myschema' em um registro de esquema 'myregistry'.

az iot ops schema show --name myschema --registry myregistry -g myresourcegroup

Parâmetros Exigidos

--name -n

Nome do esquema.

--registry

Nome do registro do esquema.

--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 ops schema show-dataflow-refs

Habilitação

Esse comando é experimental e está em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Mostre as referências de esquema usadas para fluxos de dados.

az iot ops schema show-dataflow-refs --registry
                                     --resource-group
                                     [--latest {false, true}]
                                     [--schema]
                                     [--ver]

Exemplos

Mostrar referência de esquema para o esquema "myschema" e a versão 1.

az iot ops schema show-dataflow-refs --version 1 --schema myschema --registry myregistry -g myresourcegroup

Mostrar referência de esquema para todas as versões no esquema "myschema".

az iot ops schema show-dataflow-refs --schema myschema --registry myregistry -g myresourcegroup

Mostrar referência de esquema para todas as versões e esquemas no registro de esquema "myregistry".

az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup

Mostrar referência de esquema para todos os esquemas, mas apenas as versões mais recentes no registro de esquema "myregistry".

az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup --latest

Parâmetros Exigidos

--registry

Nome do registro do esquema.

--resource-group -g

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

Parâmetros Opcionais

--latest

Sinalize para mostrar apenas a(s) versão(ões) mais recente(s).

Valores aceitos: false, true
--schema

Nome do esquema. Obrigatório se estiver usando --version.

--ver --version

Nome da versão do esquema. Se usado, --latest será ignorado.

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.