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.	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 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

--key-identifier

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}.

--name -n

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/".

--resource-group -g

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

--workspace-name

Nombre del área de trabajo.

Parámetros opcionales

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False

Parámetros globales

--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

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

--ids

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".

--name -n

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-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False

--resource-group -g

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

--subscription

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

--workspace-name

Nombre del área de trabajo.

--yes -y

No solicita confirmación.

Valor predeterminado: False

Parámetros globales

--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

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

--resource-group -g

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

--workspace-name

Nombre del área de trabajo.

Parámetros globales

--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

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

--ids

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".

--name -n

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/".

--resource-group -g

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

--subscription

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

--workspace-name

Nombre del área de trabajo.

Parámetros globales

--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

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

--key-name

Nombre de la clave del área de trabajo.

Parámetros opcionales

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Valor predeterminado: False

--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

Valor predeterminado: False

--exists

Espere hasta que exista el recurso.

Valor predeterminado: False

--ids

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".

--interval

Intervalo de sondeo en segundos.

Valor predeterminado: 30

--resource-group -g

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

--subscription

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

--timeout

Espera máxima en segundos.

Valor predeterminado: 3600

--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Valor predeterminado: False

--workspace-name

Nombre del área de trabajo.

Parámetros globales

--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.