Compartilhar via

az iot ops schema registry

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

Gerenciamento de registro de esquema.

Um registro de esquema é um repositório centralizado para gerenciar esquemas. O registro de esquema permite a geração e recuperação de esquemas na borda e na nuvem. Ele garante consistência e compatibilidade entre sistemas, fornecendo uma única fonte de verdade para definições de esquema.

Comandos

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

Criar um registro de esquema

Essa operação criará um registro de esquema com a identidade gerenciada pelo sistema habilitada.

Em seguida, ele atribuirá à identidade do sistema a função interna "Colaborador de Dados de Blob de Armazenamento" no escopo do contêiner da conta de armazenamento por padrão. Se necessário, você pode fornecer uma função personalizada por meio de --custom-role-id para usar.

Se o contêiner da conta de armazenamento indicado não existir, ele será criado com as configurações padrão.

Essa operação também registrará o provedor de recursos Microsoft.DeviceRegistry se ele não estiver registrado.

az iot ops schema registry create --name
                                  --registry-namespace --rn
                                  --resource-group
                                  --sa-resource-id
                                  [--custom-role-id]
                                  [--desc]
                                  [--display-name]
                                  [--location]
                                  [--sa-container]
                                  [--skip-ra {false, true}]
                                  [--tags]

Exemplos

Crie um registro de esquema chamado 'myregistry' com entradas mínimas.

az iot ops schema registry create -n myregistry -g myresourcegroup --registry-namespace myschemas --sa-resource-id $STORAGE_ACCOUNT_RESOURCE_ID

Crie um registro de esquema chamado 'myregistry' na região westus2 com personalização adicional.

az iot ops schema registry create -n myregistry -g myresourcegroup --registry-namespace myschemas --sa-resource-id $STORAGE_ACCOUNT_RESOURCE_ID --sa-container myschemacontainer -l westus2 --desc 'Contoso factory X1 schemas' --display-name 'Contoso X1' --tags env=prod

Parâmetros Exigidos

--name -n

Nome do registro do esquema.

--registry-namespace --rn

Namespace do registro de esquema. Identifica exclusivamente um registro de esquema dentro de um locatário.

--resource-group -g

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

--sa-resource-id

ID do recurso da conta de armazenamento a ser usada com o registro de esquema.

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.

--custom-role-id

ID de definição de função totalmente qualificada no seguinte formato: /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId}.

Propriedade Valor
Grupo de parâmetros: Role Assignment Arguments
--desc

Descrição do registro de esquema.

--display-name

Nome de exibição do registro de esquema.

--location -l

Região para criar o registro de esquema. Se nenhum local for fornecido, o local do grupo de recursos será usado.

--sa-container

Nome do contêiner da conta de armazenamento em que os esquemas serão armazenados.

Propriedade Valor
Valor padrão: schemas
--skip-ra

Quando usada, a etapa de atribuição de função da operação será ignorada.

Propriedade Valor
Grupo de parâmetros: Role Assignment Arguments
Valores aceitos: false, true
--tags

Marcas separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar marcas existentes.

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

Exclua um registro de esquema de destino.

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

Exemplos

Exclua o registro de esquema 'myregistry'.

az iot ops schema registry delete -n myregistry -g myresourcegroup

Parâmetros Exigidos

--name -n

Nome do registro do esquema.

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.

--resource-group -g

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

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

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

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

Exemplos

Listar registros de esquema no grupo de recursos 'myresourcegroup'.

az iot ops schema registry list -g myresourcegroup

Liste os registros de esquema na filtragem de assinatura padrão em uma tag específica.

az iot ops schema registry list --query "[?tags.env == 'prod']"

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.

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

Mostrar detalhes de um registro de esquema.

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

Exemplos

Mostre detalhes do registro de esquema de destino 'myregistry'.

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

Parâmetros Exigidos

--name -n

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