az iot ops schema

Note

Essa referência faz parte da extensão azure-iot-ops 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 ops schema . Saiba mais sobre extensões.

Registro de esquema e gerenciamento de esquema.

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 em um registro de esquema.	Extension	GA
az iot ops schema delete	Exclua um esquema de destino em um registro de esquema.	Extension	GA
az iot ops schema list	Listar esquemas em um registro de esquema.	Extension	GA
az iot ops schema registry	Gerenciamento de registro de esquema.	Extension	GA
az iot ops schema registry create	Criar um registro de esquema	Extension	GA
az iot ops schema registry delete	Exclua um registro de esquema de destino.	Extension	GA
az iot ops schema registry list	Listar registros de esquema em um grupo de recursos ou assinatura.	Extension	GA
az iot ops schema registry show	Mostrar detalhes de um registro de esquema.	Extension	GA
az iot ops schema show	Mostrar detalhes de um esquema em um registro de esquema.	Extension	GA
az iot ops schema show-dataflow-refs	Mostrar as referências de esquema usadas para fluxos de dados.	Extension	Experimental
az iot ops schema version	Gerenciamento de versão do esquema.	Extension	GA
az iot ops schema version add	Adicione uma versão de esquema a um esquema.	Extension	GA
az iot ops schema version list	Listar versões de esquema para um esquema específico.	Extension	GA
az iot ops schema version remove	Remova uma versão do esquema de destino.	Extension	GA
az iot ops schema version show	Mostrar detalhes de uma versão do esquema.	Extension	GA

az iot ops schema create

Crie um esquema em 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 --version-content
                         [--desc]
                         [--display-name]
                         [--vd --version-desc]
                         [--ver --version]

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 bash. Para obter mais exemplos, consulte https://aka.ms/inline-json-examples

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"

Parâmetros Exigidos

--format

Formato de esquema.

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

Propriedade	Valor
Valores aceitos:	message

--vc --version-content

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

Propriedade	Valor
Grupo de parâmetros:	Version Arguments

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.

--desc

Descrição do esquema.

--display-name

Nome de exibição do esquema.

--vd --version-desc

Descrição da versão.

Propriedade	Valor
Grupo de parâmetros:	Version Arguments

--ver --version

Nome da versão do esquema.

Propriedade	Valor
Grupo de parâmetros:	Version Arguments
Valor padrão:	1

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

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

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.

--yes -y

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

Propriedade	Valor
Valores aceitos:	false, true

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

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

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

Habilitação

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

Mostrar 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 --version]

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

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.

--latest

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

Propriedade	Valor
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 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 ops schema

Comandos

az iot ops schema create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot ops schema delete

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot ops schema list

Exemplos

Parâmetros Exigidos

az iot ops schema show

Exemplos

Parâmetros Exigidos

az iot ops schema show-dataflow-refs

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Comentários