Compartilhar via

az iot ops connector opcua client

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 instalará automaticamente na primeira vez que você executar um comando az iot ops connector opcua client. Saiba mais sobre extensões.

Gerenciar o certificado da instância de aplicativo cliente de nível empresarial para o Agente de UA do OPC.

O conector para OPC UA usa um único certificado de instância de aplicativo OPC UA para todas as sessões estabelecidas para coletar dados de telemetria de servidores OPC UA. Para obter mais informações, consulte https://aka.ms/opcua-certificates.

Comandos

Nome Description Tipo Status
az iot ops connector opcua client add

Adicione um certificado de instância de aplicativo cliente de nível empresarial.

 Extension GA
az iot ops connector opcua client remove

Remova o certificado da instância do aplicativo cliente do OPC UA Broker.

 Extension GA
az iot ops connector opcua client show

Mostrar detalhes do recurso secretsync 'aio-opc-ua-broker-client-certificate'.

 Extension GA

az iot ops connector opcua client add

Adicione um certificado de instância de aplicativo cliente de nível empresarial.

A extensão de arquivo de chave pública deve ser .der e a extensão de arquivo de chave privada deve ser .pem. Use o mesmo nome de arquivo para chave pública e arquivo de chave privada. A secretproviderclass de recursos do Azure 'opc-ua-connector' e o secretsync 'aio-opc-ua-broker-client-certificate' serão criados se não forem encontrados. O certificado recém-adicionado substituirá o certificado existente se houver algum. Observação: o nome da entidade e o URI do aplicativo serão derivados automaticamente do certificado fornecido. Parâmetros opcionais podem ser usados para validar os respectivos valores que atendem às expectativas antes que a operação prossiga.

az iot ops connector opcua client add --instance
                                      --pkf --public-key-file
                                      --private-key-file --prkf
                                      --resource-group
                                      [--application-uri --au]
                                      [--overwrite-secret {false, true}]
                                      [--pks --public-key-secret-name]
                                      [--private-key-secret-name --prks]
                                      [--sn --subject-name]

Exemplos

Adicione um certificado de cliente.

az iot ops connector opcua client add --instance instance --resource-group instanceresourcegroup --public-key-file "newopc.der" --private-key-file "newopc.pem"

Adicione um certificado do cliente e ignore o prompt de confirmação de substituição quando o segredo já existir.

az iot ops connector opcua client add --instance instance --resource-group instanceresourcegroup --public-key-file "newopc.der" --private-key-file "newopc.pem" --overwrite-secret

Adicione um certificado de cliente com o nome de segredo de chave pública e privada personalizado.

az iot ops connector opcua client add --instance instance --resource-group instanceresourcegroup --public-key-file "newopc.der" --private-key-file "newopc.pem" --public-key-secret-name public-secret-name --private-key-secret-name private-secret-name

Adicione um certificado de cliente com o nome da entidade e o URI do aplicativo especificados. Os valores serão usados para validar os valores de certificado existentes.

az iot ops connector opcua client add --instance instance --resource-group instanceresourcegroup --public-key-file "newopc.der" --private-key-file "newopc.pem" --public-key-secret-name public-secret-name --private-key-secret-name private-secret-name --subject-name "aio-opc-opcuabroker" --application-uri "urn:microsoft.com:aio:opc:opcuabroker"

Parâmetros Exigidos

--instance -i -n

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

--pkf --public-key-file

Arquivo que contém a chave pública do certificado de instância de aplicativo de nível empresarial no formato .der. O nome do arquivo será usado para gerar o nome do segredo da chave pública.

--private-key-file --prkf

Arquivo que contém a chave privada do certificado de instância de aplicativo de nível empresarial no formato .pem. O nome do arquivo será usado para gerar o nome do segredo da chave privada.

--resource-group -g

Grupo de recursos da instância.

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.

--application-uri --au

O URI da instância do aplicativo inserido na instância do aplicativo. Pode ser encontrado no certificado de chave pública. Quando fornecido, o valor será usado para validar o URI do aplicativo do certificado.

--overwrite-secret

Confirme [y]es sem um prompt para substituir o segredo. se o nome do segredo existia no cofre de chaves do Azure. Útil para cenários de CI e automação.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--pks --public-key-secret-name

Nome do segredo da chave pública no Key Vault. Se não for fornecido, o nome do arquivo de certificado será usado para gerar o nome do segredo.

--private-key-secret-name --prks

Nome do segredo da chave privada no Key Vault. Se não for fornecido, o nome do arquivo de certificado será usado para gerar o nome do segredo.

--sn --subject-name

A cadeia de caracteres de nome da entidade inserida no certificado da instância do aplicativo. Pode ser encontrado no certificado de chave pública. Quando fornecido, o valor será usado para validar o nome da entidade do certificado.

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 connector opcua client remove

Remova o certificado da instância do aplicativo cliente do OPC UA Broker.

Observação: a remoção de todos os certificados do repositório de certificados cliente do Agente do OPC UA disparará a exclusão do recurso secretsync 'aio-opc-ua-broker-client-certificate'. E essa operação disparará o fallback para o certificado padrão (baseado em cert-manager). Esse fallback requer uma atualização de extensão do aio. Remova o par de certificados de chave public(.der) e private(.pem) para evitar o segredo órfão.

az iot ops connector opcua client remove --certificate-names --cn
                                         --instance
                                         --resource-group
                                         [--force {false, true}]
                                         [--include-secrets {false, true}]
                                         [--yes {false, true}]

Exemplos

Remova certificados de cliente do repositório de certificados do cliente do Agente de UA do OPC.

az iot ops connector opcua client remove --instance instance --resource-group instanceresourcegroup --certificate-names testcert.der testcert.pem

Remova os certificados do cliente do repositório de certificados do cliente, incluindo a remoção do segredo do keyvault relacionado.

az iot ops connector opcua client remove --instance instance --resource-group instanceresourcegroup --certificate-names testcert.der testcert.pem --include-secrets

Force a operação de remoção de certificados independentemente dos avisos. Pode levar a erros.

az iot ops connector opcua client remove --instance instance --resource-group instanceresourcegroup --certificate-names testcert.der testcert.pem --force

Remova os certificados do cliente do repositório de certificados do cliente e ignore o prompt de confirmação para remoção.

az iot ops connector opcua client remove --instance instance --resource-group instanceresourcegroup --certificate-names testcert.der testcert.pem --yes

Parâmetros Exigidos

--certificate-names --cn

Nomes de certificado separados por espaço a serem removidos. Observação: os nomes podem ser encontrados na propriedade de recurso secretsync correspondente 'targetKey'.

--instance -i -n

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

--resource-group -g

Grupo de recursos da instância.

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.

--force

Force a operação a ser executada.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--include-secrets

Indica que o comando deve remover os segredos do cofre de chaves associados aos certificados. Essa opção excluirá e limpará os segredos.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--yes -y

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

Propriedade Valor
Valor padrão: False
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 connector opcua client show

Mostrar detalhes do recurso secretsync 'aio-opc-ua-broker-client-certificate'.

az iot ops connector opcua client show --instance
                                       --resource-group

Exemplos

Mostrar detalhes do recurso de segredos do 'aio-opc-ua-broker-client-certificate'.

az iot ops connector opcua client show --instance instance --resource-group instanceresourcegroup

Parâmetros Exigidos

--instance -i -n

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

--resource-group -g

Grupo de recursos da instância.

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