az synapse workspace key
Administrar las claves del área de trabajo.
Comandos
| Nombre | Description | Tipo | Estado |
|---|---|---|---|
| az synapse workspace key create |
Cree la clave de un área de trabajo. |
Core | GA |
| az synapse workspace key delete |
Elimine la clave de un área de trabajo. No se puede eliminar la clave con el estado activo. |
Core | GA |
| az synapse workspace key list |
Enumera las claves en el área de trabajo especificada. |
Core | GA |
| az synapse workspace key show |
Mostrar la clave de un área de trabajo por nombre. |
Core | 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. |
Core | GA |
az synapse workspace key create
Cree la clave de un área de trabajo.
az synapse workspace key create --key-identifier
--name
--resource-group
--workspace-name
[--no-wait]
Ejemplos
Cree la clave de un área de trabajo.
az synapse workspace key create --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}.
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/".
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Nombre del área de trabajo.
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.
No espere a que finalice la operación de ejecución prolongada.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
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 del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az synapse workspace key delete
Elimine la clave de un área de trabajo. No se puede eliminar la clave con el estado activo.
az synapse workspace key delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--workspace-name]
[--yes]
Ejemplos
Elimine la clave de un área de trabajo.
az synapse workspace key delete --name newkey --workspace-name testsynapseworkspace \
--resource-group rg
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.
Uno o varios identificadores de recursos (delimitados por espacio). 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".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
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/".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
No espere a que finalice la operación de ejecución prolongada.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre del área de trabajo.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
No solicita confirmación.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az synapse workspace key list
Enumera las claves en el área de trabajo especificada.
az synapse workspace key list --resource-group
--workspace-name
Ejemplos
Enumera las claves en el área de trabajo especificada.
az synapse workspace key list --workspace-name testsynapseworkspace --resource-group rg
Parámetros requeridos
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Nombre del área de trabajo.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
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 del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az synapse workspace key show
Mostrar la clave de un área de trabajo por nombre.
az synapse workspace key show [--ids]
[--name]
[--resource-group]
[--subscription]
[--workspace-name]
Ejemplos
Mostrar la clave de un área de trabajo.
az synapse workspace key show --name newkey --workspace-name testsynapseworkspace \
--resource-group rg
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.
Uno o varios identificadores de recursos (delimitados por espacio). 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".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
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/".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre del área de trabajo.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
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.
az synapse workspace key wait --key-name
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--workspace-name]
Parámetros requeridos
Nombre de la clave del área de trabajo.
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.
Espere hasta que se cree con "provisioningState" en "Succeeded".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Wait Condition Arguments |
| Valor predeterminado: | False |
Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Wait Condition Arguments |
Espere hasta que se elimine.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Wait Condition Arguments |
| Valor predeterminado: | False |
Espere hasta que exista el recurso.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Wait Condition Arguments |
| Valor predeterminado: | False |
Uno o varios identificadores de recursos (delimitados por espacio). 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".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Intervalo de sondeo en segundos.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Wait Condition Arguments |
| Valor predeterminado: | 30 |
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Espera máxima en segundos.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Wait Condition Arguments |
| Valor predeterminado: | 3600 |
Espere hasta que se actualice con provisioningState en "Succeeded".
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Wait Condition Arguments |
| Valor predeterminado: | False |
Nombre del área de trabajo.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Resource Id Arguments |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |