az synapse workspace
Administrar áreas de trabajo de Synapse.
Comandos
Nombre | Description | Tipo | Estado |
---|---|---|---|
az synapse workspace activate |
Activa un área de trabajo y cambia el estado de pendiente al estado correcto cuando el área de trabajo se aprovisiona por primera vez y el cifrado doble está habilitado. |
Principal | GA |
az synapse workspace check-name |
Compruebe si hay un nombre de área de trabajo de Synapse disponible o no. |
Principal | GA |
az synapse workspace create |
Creación de un área de trabajo de Synapse. |
Principal | GA |
az synapse workspace delete |
Elimine un área de trabajo de Synapse. |
Principal | GA |
az synapse workspace firewall-rule |
Administrar las reglas de firewall de un área de trabajo. |
Principal | GA |
az synapse workspace firewall-rule create |
Cree una regla de firewall. |
Principal | GA |
az synapse workspace firewall-rule delete |
Elimina una regla de firewall. |
Principal | GA |
az synapse workspace firewall-rule list |
Enumera todas las reglas de firewall. |
Principal | GA |
az synapse workspace firewall-rule show |
Obtenga una regla de firewall. |
Principal | GA |
az synapse workspace firewall-rule update |
Actualice una regla de firewall. |
Principal | GA |
az synapse workspace firewall-rule wait |
Coloque la CLI en un estado de espera hasta que se cumpla una condición de una regla de firewall. |
Principal | GA |
az synapse workspace key |
Administrar las claves del área de trabajo. |
Principal | GA |
az synapse workspace key create |
Cree la clave de un área de trabajo. |
Principal | GA |
az synapse workspace key delete |
Elimine la clave de un área de trabajo. No se puede eliminar la clave con el estado activo. |
Principal | GA |
az synapse workspace key list |
Enumera las claves en el área de trabajo especificada. |
Principal | GA |
az synapse workspace key show |
Mostrar la clave de un área de trabajo por nombre. |
Principal | GA |
az synapse workspace key wait |
Coloque la CLI en un estado de espera hasta que se cumpla una condición de una clave de área de trabajo. |
Principal | GA |
az synapse workspace list |
Enumerar todas las áreas de trabajo de Synapse. |
Principal | GA |
az synapse workspace managed-identity |
Administrar la identidad administrada del área de trabajo. |
Principal | GA |
az synapse workspace managed-identity grant-sql-access |
Conceda al área de trabajo el acceso sql a la identidad administrada. |
Principal | GA |
az synapse workspace managed-identity revoke-sql-access |
Revocar el acceso sql del área de trabajo a la identidad administrada. |
Principal | GA |
az synapse workspace managed-identity show-sql-access |
Mostrar el estado de acceso sql del área de trabajo a la identidad administrada. |
Principal | GA |
az synapse workspace managed-identity wait |
Coloque la CLI en un estado de espera hasta que se cumpla una condición de estado de acceso sql a la identidad administrada. |
Principal | GA |
az synapse workspace show |
Obtenga un área de trabajo de Synapse. |
Principal | GA |
az synapse workspace update |
Actualice un área de trabajo de Synapse. |
Principal | GA |
az synapse workspace wait |
Coloque la CLI en un estado de espera hasta que se cumpla una condición del área de trabajo. |
Principal | GA |
az synapse workspace activate
Activa un área de trabajo y cambia el estado de pendiente al estado correcto cuando el área de trabajo se aprovisiona por primera vez y el cifrado doble está habilitado.
Al crear un área de trabajo de Azure Synapse Analytics, puede elegir cifrar todos los datos en reposo en el área de trabajo con una clave administrada por el cliente que proporcionará cifrado doble al área de trabajo. Es posible que tenga que configurar primero el entorno de cifrado, como crear un almacén de claves con la protección de purga habilitada y especificar directivas de acceso al almacén de claves. A continuación, use este cmdlet para activar el nuevo área de trabajo de Azure Synapse Analytics que habilita el cifrado doble mediante una clave administrada por el cliente.
az synapse workspace activate --key-identifier
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--workspace-name]
Ejemplos
activar un área de trabajo.
az synapse workspace activate --name newkey --workspace-name testsynapseworkspace \
--resource-group rg --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname}
Parámetros requeridos
Dirección URL de Key Vault de la clave de cifrado del área de trabajo. debe tener el formato de: https://{keyvaultname}.vault.azure.net/keys/{keyname}.
Parámetros opcionales
Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Nombre para mostrar de la clave administrada por el cliente del área de trabajo. Todas las claves existentes se pueden encontrar mediante el cmdlet /"az synapse workspace key list/".
No espere hasta que finalice la operación de ejecución prolongada.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Nombre del área de trabajo.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az synapse workspace check-name
Compruebe si hay un nombre de área de trabajo de Synapse disponible o no.
az synapse workspace check-name --name
Ejemplos
Compruebe si hay un nombre de área de trabajo de Synapse disponible o no.
az synapse workspace check-name --name testsynapseworkspace
Parámetros requeridos
El nombre que quería comprobar.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az synapse workspace create
Creación de un área de trabajo de Synapse.
az synapse workspace create --file-system
--name
--resource-group
--sql-admin-login-password
--sql-admin-login-user
--storage-account
[--account-name]
[--allowed-tenant-ids]
[--cmk]
[--collaboration-branch]
[--enable-managed-virtual-network {false, true}]
[--host-name]
[--key-name]
[--last-commit-id]
[--location]
[--managed-rg-name]
[--no-wait]
[--prevent-data-exfiltration {false, true}]
[--project-name]
[--repository-name]
[--repository-type {AzureDevOpsGit, GitHub}]
[--root-folder]
[--tags]
[--tenant-id]
[--uami-id]
[--uami-id-in-encrypt]
[--use-sami-in-encrypt]
Ejemplos
Crear espacio de trabajo Synapse
az synapse workspace create --name testworkspace --resource-group rg \
--storage-account testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"
Creación de un área de trabajo de Synapse con el identificador de recurso de almacenamiento
az synapse workspace create --name testworkspace --resource-group rg \
--storage-account /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"
Creación de un área de trabajo de Synapse mediante la clave administrada por el cliente
az synapse workspace create --name testworkspace --resource-group rg \
--storage-account testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
--key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname} --key-name testcmk \
--use-sami-in-encrypt True
Creación de un área de trabajo de Synapse que se conecta a azure devops
az synapse workspace create --name testworkspace --resource-group rg \
--storage-account testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
--repository-type AzureDevOpsGit --account-name testuser --project-name testprj \
--repository-name testrepo --collaboration-branch main --last-commit-id 000000
Creación de un área de trabajo de Synapse con un grupo de recursos administrado
az synapse workspace create --name testworkspace --resource-group rg \
--managed-rg-name managedrg \
--storage-account testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"
Creación de un área de trabajo de Synapse con la identidad administrada asignada por el usuario
az synapse workspace create --name testworkspace --resource-group rg \
--storage-account testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
--uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Parámetros requeridos
Sistema de archivos de la cuenta de almacenamiento de Data Lake.
Nombre del área de trabajo.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Contraseña de inicio de sesión del administrador de SQL.
Nombre de usuario de inicio de sesión del administrador de SQL.
El nombre de la cuenta de almacenamiento de Data Lake o el identificador de recurso.
Parámetros opcionales
Nombre de la cuenta de GitHub que se usa para el repositorio o el nombre de la organización de Azure devops.
Los inquilinos de Azure AD aprobados a los que se permite el tráfico de datos saliente. El inquilino de Azure AD del usuario actual se incluirá de forma predeterminada. Use ('' en PowerShell) para deshabilitar todos los identificadores de inquilino permitidos.
Clave administrada por el cliente que se usa para cifrar todos los datos en reposo en el área de trabajo. El identificador de clave debe estar en el formato de: https://{keyvaultname}.vault.azure.net/keys/{keyname}.
El nombre de la rama donde colaborará con otros usuarios y desde el que publicará.
La marca indica si habilita la red virtual administrada.
Si usa github Enterprise Server, proporcione una dirección URL inversa como https://github.mydomain.com.Do no use esta opción con GitHub Enterprise Cloud.
Nombre para mostrar de la clave administrada por el cliente del área de trabajo. Todas las claves existentes se pueden encontrar mediante el cmdlet "az synapse workspace key list".
El último identificador de confirmación.
Location. Los valores de: az account list-locations
. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>
.
Grupo de recursos administrados del área de trabajo. El nombre del grupo de recursos identifica de forma única el grupo de recursos dentro del identificador de suscripción de usuario.
No espere hasta que finalice la operación de ejecución prolongada.
La marca indica si habilita la filtración de datos.
Nombre del proyecto al que se va a conectar.
Nombre del repositorio al que se va a conectar.
Tipo de configuración del repositorio.
Se importa el nombre de la carpeta en la ubicación de los recursos JSON de Azure Synapse. El valor predeterminado es /.
Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.
Identificador de inquilino que se usa para conectar Azure devops.
Lista de identificadores de identidad administrada asignadas por el usuario para el área de trabajo.
Identificador de recurso de identidad asignado por el usuario que se usa en el cifrado del área de trabajo.
Si usa la identidad asignada por el sistema en el cifrado del área de trabajo. Si usa uami, establezca True.If not, establezca False.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az synapse workspace delete
Elimine un área de trabajo de Synapse.
az synapse workspace delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--yes]
Ejemplos
Elimine un área de trabajo de Synapse.
az synapse workspace delete --name testsynapseworkspace --resource-group rg
Parámetros opcionales
Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Nombre del área de trabajo.
No espere hasta que finalice la operación de ejecución prolongada.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
No solicita confirmación.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az synapse workspace list
Enumerar todas las áreas de trabajo de Synapse.
az synapse workspace list [--resource-group]
Ejemplos
Enumeración de todas las áreas de trabajo de Synapse en una suscripción
az synapse workspace list
Enumeración de todas las áreas de trabajo de Synapse en un grupo de recursos específico
az synapse workspace list --resource-group rg
Parámetros opcionales
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az synapse workspace show
Obtenga un área de trabajo de Synapse.
az synapse workspace show [--ids]
[--name]
[--resource-group]
[--subscription]
Ejemplos
Obtenga un área de trabajo de Synapse.
az synapse workspace show --name testsynapseworkspace --resource-group rg
Parámetros opcionales
Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Nombre del área de trabajo.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az synapse workspace update
Actualice un área de trabajo de Synapse.
az synapse workspace update [--account-name]
[--allowed-tenant-ids]
[--collaboration-branch]
[--host-name]
[--ids]
[--key-name]
[--last-commit-id]
[--name]
[--no-wait]
[--project-name]
[--repository-name]
[--repository-type {AzureDevOpsGit, GitHub}]
[--resource-group]
[--root-folder]
[--sql-admin-login-password]
[--subscription]
[--tags]
[--tenant-id]
[--uami-action {Add, Remove, Set}]
[--uami-id]
[--uami-id-in-encrypt]
[--use-sami-in-encrypt]
Ejemplos
Actualización de un área de trabajo de Synapse
az synapse workspace update --name fromcli4 --resource-group rg \
--tags key1=value1
Actualización de un área de trabajo de Synapse, adición de una identidad administrada asignada por el usuario
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Add --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Actualización de un área de trabajo de Synapse, eliminación de la identidad administrada asignada por el usuario
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Remove --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Actualización de un área de trabajo de Synapse, reescritura de la identidad administrada asignada por el usuario
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Set --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Actualización de un área de trabajo de Synapse, establecimiento del cifrado de área de trabajo uami
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-id-in-encrypt "{your-encrytion-uami-resourceid}" --use-sami-in-encrypt False
Parámetros opcionales
Nombre de la cuenta de GitHub que se usa para el repositorio o el nombre de la organización de Azure devops.
Los inquilinos de Azure AD aprobados a los que se permite el tráfico de datos saliente. El inquilino de Azure AD del usuario actual se incluirá de forma predeterminada. Use ('' en PowerShell) para deshabilitar todos los identificadores de inquilino permitidos.
El nombre de la rama donde colaborará con otros usuarios y desde el que publicará.
Si usa github Enterprise Server, proporcione una dirección URL inversa como https://github.mydomain.com.Do no use esta opción con GitHub Enterprise Cloud.
Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Nombre para mostrar de la clave administrada por el cliente del área de trabajo. Todas las claves existentes se pueden encontrar mediante el cmdlet "az synapse workspace key list".
El último identificador de confirmación.
Nombre del área de trabajo.
No espere hasta que finalice la operación de ejecución prolongada.
Nombre del proyecto al que se va a conectar.
Nombre del repositorio al que se va a conectar.
Tipo de configuración del repositorio.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Se importa el nombre de la carpeta en la ubicación de los recursos JSON de Azure Synapse. El valor predeterminado es /.
Contraseña de inicio de sesión del administrador de SQL.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.
Identificador de inquilino que se usa para conectar Azure devops.
La acción debe especificarse al agregar, quitar o establecer identidades administradas asignadas por el usuario para el área de trabajo. Las acciones admitidas son:Add,Remove,Set.Add significa agregar identidades administradas asignadas por el usuario para el área de trabajo, Quitar significa quitar identidades administradas asignadas por el usuario del área de trabajo, Set se puede usar cuando quiera agregar y quitar identidades administradas asignadas por el usuario al mismo tiempo, las identidades actuales se cubrirán mediante las especificadas.
Lista de identificadores de identidad administrada asignadas por el usuario para el área de trabajo.
Identificador de recurso de identidad asignado por el usuario que se usa en el cifrado del área de trabajo.
Si usa la identidad asignada por el sistema en el cifrado del área de trabajo. Si usa uami, establezca True.If not, establezca False.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
az synapse workspace wait
Coloque la CLI en un estado de espera hasta que se cumpla una condición del área de trabajo.
az synapse workspace wait --resource-group
--workspace-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Parámetros requeridos
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
El nombre del área de trabajo.
Parámetros opcionales
Espere hasta que se cree con "provisioningState" en "Succeeded".
Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Espere hasta que se elimine.
Espere hasta que exista el recurso.
Intervalo de sondeo en segundos.
Espera máxima en segundos.
Espere hasta que se actualice con provisioningState en "Succeeded".
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.