az synapse workspace
Gerenciar workspaces do Synapse.
Comandos
Nome | Description | Tipo | Status |
---|---|---|---|
az synapse workspace activate |
Ativa um workspace e altera seu estado de pendente para o estado de êxito quando o workspace está sendo provisionado pela primeira vez e a criptografia dupla está habilitada. |
Núcleo | GA |
az synapse workspace check-name |
Verifique se um nome de workspace do Synapse está disponível ou não. |
Núcleo | GA |
az synapse workspace create |
Criar um workspace do Synapse. |
Núcleo | GA |
az synapse workspace delete |
Exclua um workspace do Synapse. |
Núcleo | GA |
az synapse workspace firewall-rule |
Gerencie as regras de firewall de um workspace. |
Núcleo | GA |
az synapse workspace firewall-rule create |
Crie uma regra de firewall. |
Núcleo | GA |
az synapse workspace firewall-rule delete |
Excluir uma regra de firewall. |
Núcleo | GA |
az synapse workspace firewall-rule list |
Liste todas as regras de firewall. |
Núcleo | GA |
az synapse workspace firewall-rule show |
Obtenha uma regra de firewall. |
Núcleo | GA |
az synapse workspace firewall-rule update |
Atualize uma regra de firewall. |
Núcleo | GA |
az synapse workspace firewall-rule wait |
Coloque a CLI em um estado de espera até que uma condição de uma regra de firewall seja atendida. |
Núcleo | GA |
az synapse workspace key |
Gerencie as chaves do espaço de trabalho. |
Núcleo | GA |
az synapse workspace key create |
Crie a chave de um espaço de trabalho. |
Núcleo | GA |
az synapse workspace key delete |
Exclua a chave de um workspace. A chave no status ativo não pode ser excluída. |
Núcleo | GA |
az synapse workspace key list |
Listar chaves no espaço de trabalho especificado. |
Núcleo | GA |
az synapse workspace key show |
Mostre a chave de um workspace por nome. |
Núcleo | GA |
az synapse workspace key wait |
Coloque a CLI em um estado de espera até que uma condição de uma chave de workspace seja atendida. |
Núcleo | GA |
az synapse workspace list |
Liste todos os workspaces do Synapse. |
Núcleo | GA |
az synapse workspace managed-identity |
Gerenciar a identidade gerenciada do workspace. |
Núcleo | GA |
az synapse workspace managed-identity grant-sql-access |
Conceda o acesso sql do workspace à identidade gerenciada. |
Núcleo | GA |
az synapse workspace managed-identity revoke-sql-access |
Revogue o acesso sql do workspace à identidade gerenciada. |
Núcleo | GA |
az synapse workspace managed-identity show-sql-access |
Mostrar o estado sql-access do workspace para managed-identity. |
Núcleo | GA |
az synapse workspace managed-identity wait |
Coloque a CLI em um estado de espera até que uma condição do estado sql-access para managed-identity seja atendida. |
Núcleo | GA |
az synapse workspace show |
Obtenha um workspace do Synapse. |
Núcleo | GA |
az synapse workspace update |
Atualize um workspace do Synapse. |
Núcleo | GA |
az synapse workspace wait |
Coloque a CLI em um estado de espera até que uma condição do workspace seja atendida. |
Núcleo | GA |
az synapse workspace activate
Ativa um workspace e altera seu estado de pendente para o estado de êxito quando o workspace está sendo provisionado pela primeira vez e a criptografia dupla está habilitada.
Ao criar um workspace do Azure Synapse Analytics, você pode optar por criptografar todos os dados em repouso no workspace com uma chave gerenciada pelo cliente que fornecerá criptografia dupla para o workspace. Talvez seja necessário configurar o ambiente de criptografia em primeiro lugar, como criar um cofre de chaves com a proteção contra limpeza, habilitar e especificar políticas de acesso para o cofre de chaves. Em seguida, use esse cmdlet para ativar o novo workspace do Azure Synapse Analytics, cuja criptografia dupla está habilitada usando uma chave gerenciada pelo cliente.
az synapse workspace activate --key-identifier
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--workspace-name]
Exemplos
Ative um espaço de trabalho.
az synapse workspace activate --name newkey --workspace-name testsynapseworkspace \
--resource-group rg --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname}
Parâmetros Exigidos
A URL do Key Vault da chave de criptografia do workspace. deve estar no formato de: https://{keyvaultname}.vault.azure.net/keys/{keyname}.
Parâmetros Opcionais
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".
O nome de exibição da chave gerenciada pelo cliente do workspace. Todas as chaves existentes podem ser encontradas usando o cmdlet /"az synapse workspace key list/".
Não aguarde a conclusão da operação de execução longa.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
O nome do espaço de trabalho.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az synapse workspace check-name
Verifique se um nome de workspace do Synapse está disponível ou não.
az synapse workspace check-name --name
Exemplos
Verifique se um nome de workspace do Synapse está disponível ou não.
az synapse workspace check-name --name testsynapseworkspace
Parâmetros Exigidos
O nome que você queria verificar.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az synapse workspace create
Criar um workspace do 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]
Exemplos
Criar um espaço de trabalho 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"
Criar um workspace do Synapse com a ID do recurso de armazenamento
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"
Criar um workspace do Synapse usando a chave gerenciada pelo 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
Criar um workspace do Synapse conectando-se ao 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
Criar um workspace do Synapse com o grupo de recursos gerenciado
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"
Criar um workspace do Synapse com a identidade gerenciada atribuída pelo usuário
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 Exigidos
O sistema de arquivos da conta de armazenamento do data lake.
O nome do espaço de trabalho.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
A senha de login do administrador do SQL.
O nome de usuário de logon do administrador do SQL.
O nome da conta do data lake storage ou a ID do recurso.
Parâmetros Opcionais
Nome da conta do GitHub usado para o repositório ou nome da organização do Azure DevOps.
Os locatários aprovados do Azure AD que o tráfego de dados de saída permitiu. O locatário do Azure AD do usuário atual será incluído por padrão. Use "" ou "" ('""" no PowerShell) para desabilitar todas as IDs de locatário permitidas.
A chave gerenciada pelo cliente usada para criptografar todos os dados em repouso no workspace. O identificador de chave deve estar no formato de: https://{keyvaultname}.vault.azure.net/keys/{keyname}.
O nome da ramificação onde você colaborará com outras pessoas e a partir do qual publicará.
O sinalizador indica se habilitar a rede virtual gerenciada.
Se estiver usando github Enterprise Server, forneça o URL do servidor. Não use essa opção com GitHub Enterprise Cloud.
O nome de exibição da chave gerenciada pelo cliente do workspace. Todas as chaves existentes podem ser encontradas usando o cmdlet "az synapse workspace key list".
A última ID de confirmação.
Local. Valores de: az account list-locations
. Você pode configurar o local padrão usando az configure --defaults location=<location>
.
Grupo de recursos gerenciados do workspace. O nome do grupo de recursos identifica exclusivamente o grupo de recursos dentro do subscriptionId do usuário.
Não aguarde a conclusão da operação de execução longa.
O sinalizador indica se habilita a exfiltração de dados.
O nome do projeto ao qual você está se conectando.
O nome do repositório ao qual você está se conectando.
O tipo de configuração do repositório.
O nome da pasta para o local dos recursos JSON do Azure synapse é importado. O padrão é /.
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.
A ID do locatário usada para conectar o Azure DevOps.
A lista de ID de Identidade Gerenciada atribuída pelo usuário para o workspace.
ID do recurso de identidade atribuída pelo usuário usada na Criptografia do Workspace.
Se usar a identidade atribuída pelo sistema no Workspace Encryption. Se usar uami, defina True.Caso contrário, defina False.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az synapse workspace delete
Exclua um workspace do Synapse.
az synapse workspace delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--yes]
Exemplos
Exclua um workspace do Synapse.
az synapse workspace delete --name testsynapseworkspace --resource-group rg
Parâmetros Opcionais
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".
O nome do espaço de trabalho.
Não aguarde a conclusão da operação de execução longa.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Não solicite confirmação.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az synapse workspace list
Liste todos os workspaces do Synapse.
az synapse workspace list [--resource-group]
Exemplos
Listar todos os workspaces do Synapse em uma assinatura
az synapse workspace list
Listar todos os workspaces do Synapse em um grupo de recursos específico
az synapse workspace list --resource-group rg
Parâmetros Opcionais
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az synapse workspace show
Obtenha um workspace do Synapse.
az synapse workspace show [--ids]
[--name]
[--resource-group]
[--subscription]
Exemplos
Obtenha um workspace do Synapse.
az synapse workspace show --name testsynapseworkspace --resource-group rg
Parâmetros Opcionais
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".
O nome do espaço de trabalho.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az synapse workspace update
Atualize um workspace do 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]
Exemplos
Atualizar um workspace do Synapse
az synapse workspace update --name fromcli4 --resource-group rg \
--tags key1=value1
Atualizar um workspace do Synapse, adicionar identidade gerenciada atribuída pelo usuário
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Add --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Atualizar um workspace do Synapse, remover a identidade gerenciada atribuída pelo usuário
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Remove --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Atualizar um workspace do Synapse, reescrever a identidade gerenciada atribuída pelo usuário
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Set --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Atualizar um workspace do Synapse, definir a criptografia do workspace 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 Opcionais
Nome da conta do GitHub usado para o repositório ou nome da organização do Azure DevOps.
Os locatários aprovados do Azure AD que o tráfego de dados de saída permitiu. O locatário do Azure AD do usuário atual será incluído por padrão. Use "" ou "" ('""" no PowerShell) para desabilitar todas as IDs de locatário permitidas.
O nome da ramificação onde você colaborará com outras pessoas e a partir do qual publicará.
Se estiver usando github Enterprise Server, forneça o URL do servidor. Não use essa opção com GitHub Enterprise Cloud.
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".
O nome de exibição da chave gerenciada pelo cliente do workspace. Todas as chaves existentes podem ser encontradas usando o cmdlet "az synapse workspace key list".
A última ID de confirmação.
O nome do espaço de trabalho.
Não aguarde a conclusão da operação de execução longa.
O nome do projeto ao qual você está se conectando.
O nome do repositório ao qual você está se conectando.
O tipo de configuração do repositório.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da pasta para o local dos recursos JSON do Azure synapse é importado. O padrão é /.
A senha de login do administrador do SQL.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.
A ID do locatário usada para conectar o Azure DevOps.
A ação deve ser especificada quando você adiciona/remove/define identidades gerenciadas atribuídas pelo usuário para o workspace. As ações com suporte são:Adicionar,Remover,Definir.Adicionar significa adicionar identidades gerenciadas atribuídas pelo usuário ao workspace, Remover significa remover identidades gerenciadas atribuídas pelo usuário do workspace, Definir pode ser usado quando você deseja adicionar e remover identidades gerenciadas atribuídas pelo usuário ao mesmo tempo, as identidades atuais serão cobertas por identidades especificadas.
A lista de ID de Identidade Gerenciada atribuída pelo usuário para o workspace.
ID do recurso de identidade atribuída pelo usuário usada na Criptografia do Workspace.
Se usar a identidade atribuída pelo sistema no Workspace Encryption. Se usar uami, defina True.Caso contrário, defina False.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az synapse workspace wait
Coloque a CLI em um estado de espera até que uma condição do workspace seja atendida.
az synapse workspace wait --resource-group
--workspace-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Parâmetros Exigidos
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome do workspace.
Parâmetros Opcionais
Aguarde até ser criado com 'provisioningState' em 'Succeeded'.
Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Aguarde até ser excluído.
Aguarde até que o recurso exista.
Intervalo de sondagem em segundos.
Espera máxima em segundos.
Aguarde até ser atualizado com provisioningState em 'Succeeded'.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.