Compartir a través de

az iot ops secretsync

Note

Esta referencia forma parte de la extensión azure-iot-ops para la CLI de Azure (versión 2.67.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az iot ops secretsync . Obtenga más información sobre las extensiones.

Administración de sincronización de secretos de instancia.

Comandos

Nombre Description Tipo Estado
az iot ops secretsync disable

Deshabilite la sincronización de secretos para una instancia.

 Extension GA
az iot ops secretsync enable

Habilite la sincronización de secretos para una instancia.

 Extension GA
az iot ops secretsync list

Enumere las configuraciones de sincronización de secretos asociadas a una instancia.

 Extension GA

az iot ops secretsync disable

Deshabilite la sincronización de secretos para una instancia.

Se eliminarán todas las clases de proveedor de secretos asociadas a la instancia y se eliminarán todas las sincronizaciones de secretos asociadas a las clases de proveedor de secretos.

az iot ops secretsync disable --instance
                              --resource-group
                              [--yes {false, true}]

Ejemplos

Deshabilite la sincronización de secretos para una instancia.

az iot ops secretsync disable --instance myinstance -g myresourcegroup

Parámetros requeridos

--instance -i -n

Nombre de instancia de IoT Operations.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--yes -y

Confirme [y]es sin un mensaje. Útil para escenarios de CI y automatización.

Propiedad Valor
Valores aceptados: false, true
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az iot ops secretsync enable

Habilite la sincronización de secretos para una instancia.

La operación controla la federación de identidades, la creación de una clase de proveedor de secretos predeterminada y asignaciones de roles (Lector de Key Vault, Usuario de secretos de Key Vault) de la identidad administrada en el almacén de claves de destino.

El flujo comienza con la garantía de que las asignaciones de roles de Key Vault las apliquen si no existen. Se producirá un error si no se pueden realizar las asignaciones de roles. Si es necesario, se puede usar un rol personalizado a través de --custom-role-id en lugar de los roles integrados. O bien, se puede usar la marca --skip-ra para omitir las asignaciones de roles.

az iot ops secretsync enable --instance
                             --kv-resource-id
                             --mi-user-assigned
                             --resource-group
                             [--custom-role-id]
                             [--self-hosted-issuer {false, true}]
                             [--skip-ra {false, true}]
                             [--spc]
                             [--tags]

Ejemplos

Habilite la instancia de destino para la sincronización de secretos de Key Vault.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID

Habilite la sincronización de secretos y aplique etiquetas al crear la clase de proveedor de secretos predeterminada.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --tags a=b c=d

Habilite la sincronización de secretos con el identificador de rol personalizado en Key Vault.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --custom-role-id $CUSTOM_ROLE_ID

Uso de la marca para omitir las asignaciones de roles de Key Vault.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --skip-ra

Parámetros requeridos

--instance -i -n

Nombre de instancia de IoT Operations.

--kv-resource-id

Id. de recurso de ARM de Key Vault.

--mi-user-assigned

Identificador de recurso de la identidad administrada asignada por el usuario deseada que se va a usar con la instancia.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--custom-role-id

Identificador de definición de roles completo en el siguiente formato: /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId}.

Propiedad Valor
Grupo de parámetros: Role Assignment Arguments
--self-hosted-issuer

Use el emisor oidc autohospedado para la federación.

Propiedad Valor
Valores aceptados: false, true
--skip-ra

Cuando se usa el paso de asignación de roles de la operación, se omitirá.

Propiedad Valor
Grupo de parámetros: Role Assignment Arguments
Valores aceptados: false, true
--spc

Nombre de clase de proveedor de secretos predeterminado para la habilitación de sincronización de secretos. El patrón predeterminado es "spc-ops-{hash}".

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az iot ops secretsync list

Enumere las configuraciones de sincronización de secretos asociadas a una instancia.

az iot ops secretsync list --instance
                           --resource-group

Ejemplos

Enumere las configuraciones de sincronización de secretos asociadas a una instancia.

az iot ops secretsync list --instance myinstance -g myresourcegroup

Parámetros requeridos

--instance -i -n

Nombre de instancia de IoT Operations.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False