tenant
Importante
Esta es la documentación de Azure Sphere (heredado). Azure Sphere (heredado) se retira el 27 de septiembre de 2027 y los usuarios deben migrar a Azure Sphere (integrado) en este momento. Use el selector de versiones situado encima de la TOC para ver la documentación de Azure Sphere (integrado).
Administra un inquilino de Azure Sphere.
Importante
Los comandos azsphere tenant download-ca-certificate, azsphere tenant download-ca-certificate-chainy azsphere tenant download-validation-certificate están obsoletos. En su lugar, use azsphere ca-certificate download, azsphere ca-certificate download-chain, azsphere ca-certificate download-proof y azsphere ca-certificate list.
En la CLI de Azure Sphere, el inquilino predeterminado no se selecciona automáticamente cuando se crea un inquilino. Debe ejecutar el comando azsphere tenant select para seleccionar el inquilino predeterminado que se va a usar para el usuario actual en el equipo. Esto es para asegurarse de que el inquilino predeterminado es el correcto que se va a usar al realizar una operación única que no se puede deshacer, como reclamar el dispositivo.
| Operación | Descripción |
|---|---|
| create | Crea un nuevo inquilino. |
| download-error-report | Devuelve información de error para los dispositivos dentro del inquilino actual. |
| list | Enumera los inquilinos de Azure Sphere disponibles. |
| select | Selecciona el inquilino de Azure Sphere predeterminado que se va a usar en este equipo. |
| show-selected | Muestra el inquilino de Azure Sphere predeterminado para este equipo. |
| update | Actualiza los detalles del inquilino, como el nombre del inquilino. |
create
Crea un nuevo inquilino de Azure Sphere. Se requiere un dispositivo conectado para ejecutar este comando. Para más información, consulte Creación de un inquilino de Azure Sphere.
Si ya tiene un inquilino y está seguro de que necesita otro, use el parámetro --force-additional. Tenga en cuenta que, actualmente, no se puede eliminar un inquilino de Azure Sphere.
Una vez creado el inquilino, ejecute azsphere tenant select to select the default tenant to use for the current user on this PC ( Ejecutar azsphere tenant select to select the default tenant to use for the current user on this PC. Puede agregar roles para los usuarios en el inquilino actual de Azure Sphere mediante el comando azsphere role add .
El comando azsphere tenant create funciona con un dispositivo de Azure Sphere conectado localmente. Si intenta el comando sin un dispositivo conectado, se producirá un error. El identificador de dispositivo se registra cuando se crea un inquilino, y solo se puede crear un inquilino por dispositivo.
Parámetros obligatorios
| Parámetro | Tipo | Descripción |
|---|---|---|
| -n,--name | Cadena | Especifica un nombre para el inquilino. Al asignar un nombre a su inquilino, utilice caracteres alfanuméricos. No se aceptan caracteres especiales. El nombre no debe superar los 50 caracteres y distingue mayúsculas de minúsculas. |
Parámetros opcionales
| Parámetro | Tipo | Descripción |
|---|---|---|
| -d, --device | Cadena | Especifica el dispositivo en el que se va a ejecutar el comando cuando se conectan varios dispositivos. Este parámetro es necesario cuando se conectan varios dispositivos. El dispositivo conectado actualmente se usa de forma predeterminada. Puede especificar el identificador de dispositivo, la dirección IP o el identificador de conexión local del dispositivo conectado. La CLI de Azure Sphere admite varios dispositivos MT3620 en Windows, pero solo puede conectar un dispositivo a la vez en Linux. Por este motivo, este parámetro es compatible con Windows, pero no para Linux. Se devuelve un error si usa este parámetro con el comando en Linux. |
| --force-additional | Booleano | Fuerza la creación de un inquilino de Azure Sphere. Use este comando solo si está seguro de que desea usar la cuenta actual para crear un nuevo inquilino de Azure Sphere mediante el dispositivo conectado. |
| --disable-confirm-prompt | Booleano | Deshabilita el mensaje de confirmación del usuario. |
Parámetros globales
Los siguientes parámetros globales están disponibles para la CLI de Azure Sphere:
| Parámetro | Descripción |
|---|---|
| --debug | Aumenta el nivel de detalle del registro para mostrar todos los registros de depuración. Si encuentra un error, proporcione la salida que se genera con la marca --debug activada al enviar un informe de errores. |
| -h, --help | Imprime información de referencia de la CLI sobre los comandos y sus argumentos y enumera los subgrupos y comandos disponibles. |
| --only-show-errors | Muestra solo errores, supresión de advertencias. |
| -o, --output | Cambia el formato de salida. Los formatos de salida disponibles son json, jsonc (JSON coloreado), tsv (valores separados por tabulaciones), tabla (tablas ASCII legibles) y yaml. De forma predeterminada, la CLI genera table. Para más información sobre los formatos de salida disponibles, consulte Formato de salida para comandos de la CLI de Azure Sphere. |
| --query | Usa el lenguaje de consulta JMESPath para filtrar la salida devuelta desde Servicios de seguridad de Azure Sphere. Consulte el tutorial de JMESPath y consulta la salida del comando de la CLI de Azure para obtener más información y ejemplos. |
| --verbose | Imprime información sobre los recursos creados en Azure Sphere durante una operación y otra información útil. Use --debug para los registros de depuración completos. |
Nota:
Si usa la CLI clásica de Azure Sphere, consulte Parámetros globales para más información sobre las opciones disponibles.
Ejemplo
azsphere tenant create --name MyTenant
Use los --force-additional parámetros y --disable-confirm-prompt si está seguro de que desea usar esta cuenta para crear un nuevo inquilino de Azure Sphere mediante el dispositivo conectado. Un dispositivo que se ha usado anteriormente para crear un inquilino de Azure Sphere no se puede usar para crear un nuevo inquilino.
azsphere tenant create --name MyTenant --force-additional
You have logged in with the following account:
bob@contoso.com
Do you want to use this account to create a new Azure Sphere tenant using the attached device?
You cannot change the tenant name 'MyTenant1' once it has been created.
Enter 'yes' to continue. Enter anything else to exit.
yes
> verbose: TraceId: c761ba73-761e-4df2-94f5-3f87384d71b7
Created a new Azure Sphere tenant:
--> Tenant Name: MyTenant1
--> Tenant ID: 768c2cd6-059a-49ad-9f53-89f5271cea15
Please use 'azsphere tenant select --tenant MyTenant' to select the created tenant.
Sugerencia
Una vez que haya creado un inquilino, asegúrese de ejecutar azsphere tenant select (azsphere tenant) para seleccionar el inquilino predeterminado que se usará para el usuario actual en este equipo.
download-error-report
Devuelve información sobre los errores detectados por los dispositivos del inquilino actual.
Este comando extrae datos de eventos desde la nube del servicio de seguridad de Azure Sphere y no requiere ninguna conexión física a un dispositivo determinado. El comando azsphere tenant download-error-report funciona en el contexto del inquilino actual y devuelve informes de errores para todos los dispositivos de ese inquilino.
Nota:
Los eventos notificados recientemente pueden tardar hasta 24 horas en estar disponibles para su descarga. Para obtener más información, consulte Recopilación e interpretación de datos de error.
Parámetros opcionales
| Parámetro | Tipo | Descripción |
|---|---|---|
| --destino | Cadena | Especifica la ruta de acceso y el nombre de archivo del archivo de salida. |
| -t, --tenant | GUID o nombre | Especifica el inquilino en el que se va a realizar esta operación. Invalida el inquilino seleccionado predeterminado. Puede especificar el identificador de inquilino o el nombre del inquilino. |
Parámetros globales
Los siguientes parámetros globales están disponibles para la CLI de Azure Sphere:
| Parámetro | Descripción |
|---|---|
| --debug | Aumenta el nivel de detalle del registro para mostrar todos los registros de depuración. Si encuentra un error, proporcione la salida que se genera con la marca --debug activada al enviar un informe de errores. |
| -h, --help | Imprime información de referencia de la CLI sobre los comandos y sus argumentos y enumera los subgrupos y comandos disponibles. |
| --only-show-errors | Muestra solo errores, supresión de advertencias. |
| -o, --output | Cambia el formato de salida. Los formatos de salida disponibles son json, jsonc (JSON coloreado), tsv (valores separados por tabulaciones), tabla (tablas ASCII legibles) y yaml. De forma predeterminada, la CLI genera table. Para más información sobre los formatos de salida disponibles, consulte Formato de salida para comandos de la CLI de Azure Sphere. |
| --query | Usa el lenguaje de consulta JMESPath para filtrar la salida devuelta desde Servicios de seguridad de Azure Sphere. Consulte el tutorial de JMESPath y consulta la salida del comando de la CLI de Azure para obtener más información y ejemplos. |
| --verbose | Imprime información sobre los recursos creados en Azure Sphere durante una operación y otra información útil. Use --debug para los registros de depuración completos. |
Nota:
Si usa la CLI clásica de Azure Sphere, consulte Parámetros globales para más información sobre las opciones disponibles.
Ejemplo
azsphere tenant download-error-report --destination c:\error-report.csv --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
list
Muestra los inquilinos de Azure Sphere.
Parámetros globales
Los siguientes parámetros globales están disponibles para la CLI de Azure Sphere:
| Parámetro | Descripción |
|---|---|
| --debug | Aumenta el nivel de detalle del registro para mostrar todos los registros de depuración. Si encuentra un error, proporcione la salida que se genera con la marca --debug activada al enviar un informe de errores. |
| -h, --help | Imprime información de referencia de la CLI sobre los comandos y sus argumentos y enumera los subgrupos y comandos disponibles. |
| --only-show-errors | Muestra solo errores, supresión de advertencias. |
| -o, --output | Cambia el formato de salida. Los formatos de salida disponibles son json, jsonc (JSON coloreado), tsv (valores separados por tabulaciones), tabla (tablas ASCII legibles) y yaml. De forma predeterminada, la CLI genera table. Para más información sobre los formatos de salida disponibles, consulte Formato de salida para comandos de la CLI de Azure Sphere. |
| --query | Usa el lenguaje de consulta JMESPath para filtrar la salida devuelta desde Servicios de seguridad de Azure Sphere. Consulte el tutorial de JMESPath y consulta la salida del comando de la CLI de Azure para obtener más información y ejemplos. |
| --verbose | Imprime información sobre los recursos creados en Azure Sphere durante una operación y otra información útil. Use --debug para los registros de depuración completos. |
Nota:
Si usa la CLI clásica de Azure Sphere, consulte Parámetros globales para más información sobre las opciones disponibles.
Ejemplo
azsphere tenant list
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
select
Selecciona el inquilino de Azure Sphere predeterminado que se va a usar para el usuario actual en este equipo.
Para mostrar el inquilino predeterminado actual, use iazsphere tenant show-selected.
Parámetros obligatorios
| Parámetro | Tipo | Descripción |
|---|---|---|
| -t, --tenant | GUID o nombre | Especifica el inquilino en el que se va a realizar esta operación. Invalida el inquilino seleccionado predeterminado. Puede especificar el identificador de inquilino o el nombre del inquilino. |
Parámetros globales
Los siguientes parámetros globales están disponibles para la CLI de Azure Sphere:
| Parámetro | Descripción |
|---|---|
| --debug | Aumenta el nivel de detalle del registro para mostrar todos los registros de depuración. Si encuentra un error, proporcione la salida que se genera con la marca --debug activada al enviar un informe de errores. |
| -h, --help | Imprime información de referencia de la CLI sobre los comandos y sus argumentos y enumera los subgrupos y comandos disponibles. |
| --only-show-errors | Muestra solo errores, supresión de advertencias. |
| -o, --output | Cambia el formato de salida. Los formatos de salida disponibles son json, jsonc (JSON coloreado), tsv (valores separados por tabulaciones), tabla (tablas ASCII legibles) y yaml. De forma predeterminada, la CLI genera table. Para más información sobre los formatos de salida disponibles, consulte Formato de salida para comandos de la CLI de Azure Sphere. |
| --query | Usa el lenguaje de consulta JMESPath para filtrar la salida devuelta desde Servicios de seguridad de Azure Sphere. Consulte el tutorial de JMESPath y consulta la salida del comando de la CLI de Azure para obtener más información y ejemplos. |
| --verbose | Imprime información sobre los recursos creados en Azure Sphere durante una operación y otra información útil. Use --debug para los registros de depuración completos. |
Nota:
Si usa la CLI clásica de Azure Sphere, consulte Parámetros globales para más información sobre las opciones disponibles.
Ejemplo
azsphere tenant select --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
show-selected
Muestra los detalles del inquilino de Azure Sphere predeterminado para el usuario actual en este equipo.
Este es el inquilino seleccionado con el comando azsphere tenant select.
Parámetros globales
Los siguientes parámetros globales están disponibles para la CLI de Azure Sphere:
| Parámetro | Descripción |
|---|---|
| --debug | Aumenta el nivel de detalle del registro para mostrar todos los registros de depuración. Si encuentra un error, proporcione la salida que se genera con la marca --debug activada al enviar un informe de errores. |
| -h, --help | Imprime información de referencia de la CLI sobre los comandos y sus argumentos y enumera los subgrupos y comandos disponibles. |
| --only-show-errors | Muestra solo errores, supresión de advertencias. |
| -o, --output | Cambia el formato de salida. Los formatos de salida disponibles son json, jsonc (JSON coloreado), tsv (valores separados por tabulaciones), tabla (tablas ASCII legibles) y yaml. De forma predeterminada, la CLI genera table. Para más información sobre los formatos de salida disponibles, consulte Formato de salida para comandos de la CLI de Azure Sphere. |
| --query | Usa el lenguaje de consulta JMESPath para filtrar la salida devuelta desde Servicios de seguridad de Azure Sphere. Consulte el tutorial de JMESPath y consulta la salida del comando de la CLI de Azure para obtener más información y ejemplos. |
| --verbose | Imprime información sobre los recursos creados en Azure Sphere durante una operación y otra información útil. Use --debug para los registros de depuración completos. |
Nota:
Si usa la CLI clásica de Azure Sphere, consulte Parámetros globales para más información sobre las opciones disponibles.
Ejemplo
azsphere tenant show-selected
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
update
Actualiza los detalles de un inquilino, como el nombre del inquilino.
Parámetros obligatorios
| Parámetro | Tipo | Descripción |
|---|---|---|
| -n, --new-name | Cadena | Especifica un nuevo nombre para el inquilino. Al asignar un nombre a su inquilino, utilice caracteres alfanuméricos. No se aceptan caracteres especiales. El nombre no debe superar los 50 caracteres y distingue mayúsculas de minúsculas. |
Parámetros opcionales
| Parámetro | Tipo | Descripción |
|---|---|---|
| -t, --tenant | GUID o nombre | Especifica el inquilino en el que se va a realizar esta operación. Invalida el inquilino seleccionado predeterminado. Puede especificar el identificador de inquilino o el nombre del inquilino. |
Parámetros globales
Los siguientes parámetros globales están disponibles para la CLI de Azure Sphere:
| Parámetro | Descripción |
|---|---|
| --debug | Aumenta el nivel de detalle del registro para mostrar todos los registros de depuración. Si encuentra un error, proporcione la salida que se genera con la marca --debug activada al enviar un informe de errores. |
| -h, --help | Imprime información de referencia de la CLI sobre los comandos y sus argumentos y enumera los subgrupos y comandos disponibles. |
| --only-show-errors | Muestra solo errores, supresión de advertencias. |
| -o, --output | Cambia el formato de salida. Los formatos de salida disponibles son json, jsonc (JSON coloreado), tsv (valores separados por tabulaciones), tabla (tablas ASCII legibles) y yaml. De forma predeterminada, la CLI genera table. Para más información sobre los formatos de salida disponibles, consulte Formato de salida para comandos de la CLI de Azure Sphere. |
| --query | Usa el lenguaje de consulta JMESPath para filtrar la salida devuelta desde Servicios de seguridad de Azure Sphere. Consulte el tutorial de JMESPath y consulta la salida del comando de la CLI de Azure para obtener más información y ejemplos. |
| --verbose | Imprime información sobre los recursos creados en Azure Sphere durante una operación y otra información útil. Use --debug para los registros de depuración completos. |
Nota:
Si usa la CLI clásica de Azure Sphere, consulte Parámetros globales para más información sobre las opciones disponibles.
Ejemplo
azsphere tenant update --tenant a323c263-2aa3-2559-aabb-a3fc32631900 --new-name Tenant2
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
a323c263-2aa3-2559-aabb-a3fc32631900 Tenant2 Administrator
Contributor
------------------------------------ --------------------- -------------
Sugerencia
Si no ha seleccionado un inquilino predeterminado, se muestra una lista de inquilinos disponibles. Establezca el inquilino predeterminado seleccionando una de las opciones.