az synapse workspace key

Manage workspace's keys.

Commands

az synapse workspace key create

Create a workspace's key.

az synapse workspace key delete

Delete a workspace's key. The key at active status can't be deleted.

az synapse workspace key list

List keys under specified workspace.

az synapse workspace key show

Show a workspace's key by name.

az synapse workspace key wait

Place the CLI in a waiting state until a condition of a workspace key is met.

az synapse workspace key create

Create a workspace's key.

az synapse workspace key create --key-identifier
                                --name
                                --resource-group
                                --workspace-name
                                [--no-wait]

Examples

Create a workspace's key.

az synapse workspace key create --name newkey --workspace-name testsynapseworkspace \
--resource-group rg --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname}

Required Parameters

--key-identifier

The Key Vault Url of the workspace encryption key. should be in the format of: https://{keyvaultname}.vault.azure.net/keys/{keyname}.

--name -n

The workspace customer-managed key display name. All existing keys can be found using /"az synapse workspace key list/" cmdlet.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az synapse workspace key delete

Delete a workspace's key. The key at active status can't be deleted.

az synapse workspace key delete [--ids]
                                [--name]
                                [--no-wait]
                                [--resource-group]
                                [--workspace-name]
                                [--yes]

Examples

Delete a workspace's key.

az synapse workspace key delete --name newkey --workspace-name testsynapseworkspace \
--resource-group rg

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The workspace customer-managed key display name. All existing keys can be found using /"az synapse workspace key list/" cmdlet.

--no-wait

Do not wait for the long-running operation to finish.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The workspace name.

--yes -y

Do not prompt for confirmation.

az synapse workspace key list

List keys under specified workspace.

az synapse workspace key list --resource-group
                              --workspace-name

Examples

List keys under specified workspace.

az synapse workspace key list --workspace-name testsynapseworkspace --resource-group rg

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The workspace name.

az synapse workspace key show

Show a workspace's key by name.

az synapse workspace key show [--ids]
                              [--name]
                              [--resource-group]
                              [--workspace-name]

Examples

Show a workspace's key.

az synapse workspace key show --name newkey --workspace-name testsynapseworkspace \
--resource-group rg

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The workspace customer-managed key display name. All existing keys can be found using /"az synapse workspace key list/" cmdlet.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The workspace name.

az synapse workspace key wait

Place the CLI in a waiting state until a condition of a workspace key is met.

az synapse workspace key wait --key-name
                              [--created]
                              [--custom]
                              [--deleted]
                              [--exists]
                              [--ids]
                              [--interval]
                              [--resource-group]
                              [--timeout]
                              [--updated]
                              [--workspace-name]

Required Parameters

--key-name

The name of the workspace key.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

--workspace-name

The workspace name.