az iot ops connector template

Observação

Esta referência faz parte da extensão azure-iot-ops para o CLI do Azure (versão 2.70.0 ou superior). A extensão vai instalar-se automaticamente na primeira vez que executares um comando de template de conector IoT Ops do Arizona . Saiba mais sobre extensões.

Gestão de modelos de conectores.

Os modelos de conectores fornecem uma abordagem padronizada e orientada por metadados para a implementação de conectores. Os modelos são criados a partir de referências de metadados dos conectores (MCR para conectores de primeira parte, ACR para conectores de terceiros), preenchendo automaticamente a configuração específica de cada conector enquanto permite a personalização dos parâmetros de implementação pelo utilizador.

Comandos

Name Description Tipo Status
az iot ops connector template create

Crie um novo modelo de conector.

 Extensão disponibilidade geral
az iot ops connector template delete

Apaga um modelo de conector.

 Extensão disponibilidade geral
az iot ops connector template list

Liste todos os modelos de conectores.

 Extensão disponibilidade geral
az iot ops connector template show

Mostre um modelo de conector.

 Extensão disponibilidade geral
az iot ops connector template update

Atualize um modelo de conector existente.

 Extensão disponibilidade geral

az iot ops connector template create

Crie um novo modelo de conector.

Cria um modelo de conector a partir de metadados armazenados num registo de contentores. Os metadados preenchem automaticamente as definições específicas do conector, enquanto parâmetros de implementação como réplicas, níveis de registo e segredos podem ser personalizados.

az iot ops connector template create --connector-metadata-ref --ref
                                     --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--allocation-policy --ap]
                                     [--bs --bucket-size]
                                     [--cc --connector-config]
                                     [--change-reference]
                                     [--image-pull-policy --ipp]
                                     [--image-pull-secrets --ips]
                                     [--ll --log-level]
                                     [--replicas]
                                     [--secrets]
                                     [--storage-volumes --sv]
                                     [--trust-settings-secret-ref --tssr]

Exemplos

Crie um modelo para o conector REST com as definições predefinidas.

az iot ops connector template create --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.6

Crie um modelo com configuração personalizada.

az iot ops connector template create --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.6 --replicas 3 --log-level debug --image-pull-secrets acr-credentials

Crie um modelo para conector de terceiros a partir de um ACR privado.

az iot ops connector template create --name custom-plc-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref contoso.azurecr.io/connectors/plc-metadata:1.0.0 --image-pull-secrets acr-pull-secret

Parâmetros Obrigatórios

--connector-metadata-ref --ref

URL para o artefacto de metadados do conector do registo de contentores.

            1st-party connectors (MCR):
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/media-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/mqtt-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/sse-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/onvif-metadata:VERSION`

            3rd-party connectors:
            - `REGISTRY.azurecr.io/PATH-metadata:VERSION`

            To list available versions for 1st-party connectors:
            `curl https://mcr.microsoft.com/v2/azureiotoperations/akri-connectors/TYPE-metadata/tags/list`.
--instance -i

Nome da instância de Operações IoT.

--name -n

Nome do modelo.

--resource-group -g

Grupo de recursos de instância.

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.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--allocation-policy --ap

Política para alocação de endpoints de dispositivo entre instâncias de conectores (indistinta a maiúsculas minúsculas). Opções: Bucketized. Se não for fornecida, não será definida uma política de alocação.

--bs --bucket-size

Número de endpoints por bucket de instância do conector. É obrigatório quando a política de alocação é 'Bucketizada'.

--cc --connector-config

Configurações de chave-valor específicas de conectores separados por espaço. Formato: chave=valor. Pode fornecer múltiplos valores numa única chamada ou usar várias vezes. Exemplos: --cc brokerAddress=mqtt://broker:1883 qos=1 keepAlive=60 OU --cc brokerAddress=mqtt://broker:1883 --cc qos=1 --cc keepAlive=60. Use '' para limpar configurações existentes.

--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--image-pull-policy --ipp

Política de pull de imagens do Kubernetes. Opções: Sempre, SeNãoPresente, Nunca.

--image-pull-secrets --ips

Nomes secretos Kubernetes separados no espaço para extrair imagens de contentores de registos privados. Para conectores de terceiros que usam um registo privado de contentores, forneça o(s) segredo(s) que contêm credenciais do registo para permitir que o pod de conectores extraia a imagem. Use '' para limpar segredos de pull de imagem existentes.

--ll --log-level

Nível logarítmico para pods de conectores. Opções: rastreio, depuração, informação, aviso, erro. Padrão: informação.

--replicas -r

Número de réplicas de pods de ligação a implantar. O padrão é retirado de recommendedReplicas nos metadados, ou 1 se não especificado.

--secrets

Segredos de aplicação de conectores separados no espaço para montar em formato chave=valor. Cada segredo requer três campos: secretRef (nome do segredo a montar), secretKey (a chave do segredo a montar) e secretAlias (alias de aplicação). Exemplo: secretRef=mySecret secretKey=password secretAlias=dbPassword. Pode ser usado várias vezes para definir múltiplos segredos. O secretRef deve referenciar um secret sincronizado através da classe secret provider. Use '' para limpar segredos existentes.

--storage-volumes --sv

Referência de reivindicação de volume persistente separada em espaço em formato chave=valor. Chaves obrigatórias: claimName (nome do PVC existente), mountPath (mount path no contentor). Exemplo: claimName=myPVC mountPath=/data. Use '' para limpar volumes de armazenamento existentes.

--trust-settings-secret-ref --tssr

Referência secreta para certificados em quem se pode confiar. Isto especifica o nome do segredo Kubernetes que contém certificados de CA de confiança. Use '' para limpar as definições de confiança existentes.

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 de assinatura. 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 ops connector template delete

Apaga um modelo de conector.

Apaga um modelo de conector. Valida se o template está atualmente em uso pelos conectores implementados e solicita confirmação, a menos que --sim seja fornecido.

az iot ops connector template delete --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--change-reference]
                                     [--yes {false, true}]

Exemplos

Apagar o modelo com o pedido de confirmação.

az iot ops connector template delete --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance

Apagar o modelo sem confirmação.

az iot ops connector template delete --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --yes

Parâmetros Obrigatórios

--instance -i

Nome da instância de Operações IoT.

--name -n

Nome do modelo.

--resource-group -g

Grupo de recursos de instância.

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.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--yes -y

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

Propriedade Valor
Default value: False
Valores aceites: false, true
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 de assinatura. 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 ops connector template list

Liste todos os modelos de conectores.

Lista todos os modelos de conectores para uma instância específica do Operações IoT do Azure, com informações resumidas incluindo nome do modelo, tipo de conector, versão, réplicas e datas de criação/modificação.

az iot ops connector template list --instance
                                   --resource-group

Exemplos

Liste todos os modelos de uma instância.

az iot ops connector template list --resource-group myResourceGroup --instance myAIOInstance

Parâmetros Obrigatórios

--instance -i

Nome da instância de Operações IoT.

--resource-group -g

Grupo de recursos de instância.

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 de assinatura. 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 ops connector template show

Mostre um modelo de conector.

Mostra a configuração completa do modelo, incluindo metadados, informação do conector, configuração da imagem, definições de implementação, configuração de storage e definições de segurança.

az iot ops connector template show --instance
                                   --name
                                   --resource-group

Exemplos

Mostrar detalhes do modelo em formato JSON.

az iot ops connector template show --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance

Mostrar modelo em formato de tabela.

az iot ops connector template show --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --output table

Parâmetros Obrigatórios

--instance -i

Nome da instância de Operações IoT.

--name -n

Nome do modelo.

--resource-group -g

Grupo de recursos de instância.

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 de assinatura. 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 ops connector template update

Atualize um modelo de conector existente.

Atualiza um modelo de conector. Parâmetros de implementação como réplicas, níveis de log, segredos, definições de pull de imagem e definições de confiança podem ser modificados. Os metadados do conector podem ser atualizados apenas para atualizações de patches ou versões menores. As atualizações principais de versões exigem a criação de um novo modelo.

az iot ops connector template update --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--allocation-policy --ap]
                                     [--bs --bucket-size]
                                     [--cc --connector-config]
                                     [--change-reference]
                                     [--connector-metadata-ref --ref]
                                     [--image-pull-policy --ipp]
                                     [--image-pull-secrets --ips]
                                     [--ll --log-level]
                                     [--replicas]
                                     [--secrets]
                                     [--storage-volumes --sv]
                                     [--trust-settings-secret-ref --tssr]

Exemplos

Atualize o número de réplicas e o nível do log.

az iot ops connector template update --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --replicas 5 --log-level debug

Atualizar para uma versão mais recente do conector com patch.

az iot ops connector template update --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.7

Parâmetros Obrigatórios

--instance -i

Nome da instância de Operações IoT.

--name -n

Nome do modelo.

--resource-group -g

Grupo de recursos de instância.

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.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--allocation-policy --ap

Política para alocação de endpoints de dispositivo entre instâncias de conectores (indistinta a maiúsculas minúsculas). Opções: Bucketized. Se não for fornecida, não será definida uma política de alocação.

--bs --bucket-size

Número de endpoints por bucket de instância do conector. É obrigatório quando a política de alocação é 'Bucketizada'.

--cc --connector-config

Configurações de chave-valor específicas de conectores separados por espaço. Formato: chave=valor. Pode fornecer múltiplos valores numa única chamada ou usar várias vezes. Exemplos: --cc brokerAddress=mqtt://broker:1883 qos=1 keepAlive=60 OU --cc brokerAddress=mqtt://broker:1883 --cc qos=1 --cc keepAlive=60. Use '' para limpar configurações existentes.

--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--connector-metadata-ref --ref

URL para o artefacto de metadados do conector do registo de contentores.

            1st-party connectors (MCR):
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/media-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/mqtt-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/sse-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/onvif-metadata:VERSION`

            3rd-party connectors:
            - `REGISTRY.azurecr.io/PATH-metadata:VERSION`

            To list available versions for 1st-party connectors:
            `curl https://mcr.microsoft.com/v2/azureiotoperations/akri-connectors/TYPE-metadata/tags/list`.
--image-pull-policy --ipp

Política de pull de imagens do Kubernetes. Opções: Sempre, SeNãoPresente, Nunca.

--image-pull-secrets --ips

Nomes secretos Kubernetes separados no espaço para extrair imagens de contentores de registos privados. Para conectores de terceiros que usam um registo privado de contentores, forneça o(s) segredo(s) que contêm credenciais do registo para permitir que o pod de conectores extraia a imagem. Use '' para limpar segredos de pull de imagem existentes.

--ll --log-level

Nível logarítmico para pods de conectores. Opções: rastreio, depuração, informação, aviso, erro. Padrão: informação.

--replicas -r

Número de réplicas de pods de ligação a implantar. O padrão é retirado de recommendedReplicas nos metadados, ou 1 se não especificado.

--secrets

Segredos de aplicação de conectores separados no espaço para montar em formato chave=valor. Cada segredo requer três campos: secretRef (nome do segredo a montar), secretKey (a chave do segredo a montar) e secretAlias (alias de aplicação). Exemplo: secretRef=mySecret secretKey=password secretAlias=dbPassword. Pode ser usado várias vezes para definir múltiplos segredos. O secretRef deve referenciar um secret sincronizado através da classe secret provider. Use '' para limpar segredos existentes.

--storage-volumes --sv

Referência de reivindicação de volume persistente separada em espaço em formato chave=valor. Chaves obrigatórias: claimName (nome do PVC existente), mountPath (mount path no contentor). Exemplo: claimName=myPVC mountPath=/data. Use '' para limpar volumes de armazenamento existentes.

--trust-settings-secret-ref --tssr

Referência secreta para certificados em quem se pode confiar. Isto especifica o nome do segredo Kubernetes que contém certificados de CA de confiança. Use '' para limpar as definições de confiança existentes.

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