Compartilhar via

az ml workspace

  • Referência

Observação

Essa referência faz parte da extensão ml para a CLI do Azure (versão 2.15.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az ml workspace . Saiba mais sobre extensões.

Gerenciar workspaces do Azure ML.

Um workspace do Azure ML é o recurso de nível superior para o Azure Machine Learning. Ele fornece um local centralizado para rastrear os ativos e recursos usados em seus fluxos de trabalho de ML, juntamente com os logs e artefatos produzidos em seus trabalhos de treinamento.

Se você estiver atualizando da CLI v1 para a v2, precisará das duas alterações a seguir no escopo do gerenciamento do workspace:

  • Atualize az ml workspace private-endpoint os comandos para comandos equivalentes az network private-endpoint .
  • Além disso, atualize az ml workspace share os comandos para comandos equivalentes az role assignment create .

Comandos

Nome Description Tipo Status
az ml workspace create

Crie um workspace.

 Extensão GA
az ml workspace delete

Exclua um espaço de trabalho.

 Extensão GA
az ml workspace diagnose

Diagnostique problemas de configuração do espaço de trabalho.

 Extensão GA
az ml workspace list

Liste todos os workspaces em uma assinatura.

 Extensão GA
az ml workspace list-keys

Liste as chaves do workspace para recursos dependentes, como Armazenamento do Azure, Registro de Contêiner do Azure e Azure Application Insights.

 Extensão GA
az ml workspace outbound-rule

Gerencie regras de saída para a rede gerenciada de um workspace do Azure ML.

 Extensão GA
az ml workspace outbound-rule list

Liste todas as regras de saída de rede gerenciada para um workspace.

 Extensão GA
az ml workspace outbound-rule remove

Remova uma regra de saída da rede gerenciada para um workspace.

 Extensão GA
az ml workspace outbound-rule set

Adicione ou atualize uma regra de saída na rede gerenciada para um workspace.

 Extensão GA
az ml workspace outbound-rule show

Mostrar detalhes de uma regra de saída de rede gerenciada para um workspace.

 Extensão GA
az ml workspace provision-network

Provisione a rede gerenciada do workspace.

 Extensão GA
az ml workspace show

Mostrar detalhes de um espaço de trabalho.

 Extensão GA
az ml workspace sync-keys

Sincronize chaves de workspace para recursos dependentes, como Armazenamento do Azure, Registro de Contêiner do Azure e Azure Application Insights.

 Extensão GA
az ml workspace update

Atualize um espaço de trabalho.

 Extensão GA

az ml workspace create

Crie um workspace.

Quando um workspace é criado, vários recursos do Azure que serão usados pelo Azure ML também são criados por padrão: Armazenamento do Azure, Registro de Contêiner do Azure, Azure Key Vault e Azure Application Insights. Em vez disso, você pode usar instâncias de recursos existentes do Azure para elas ao criar o workspace especificando as IDs de recurso no arquivo YAML de configuração do workspace.

az ml workspace create --resource-group
                       [--allow-roleassignment-on-rg]
                       [--application-insights]
                       [--container-registry]
                       [--default-resource-group]
                       [--description]
                       [--display-name]
                       [--enable-data-isolation]
                       [--file]
                       [--hub-id]
                       [--image-build-compute]
                       [--key-vault]
                       [--kind]
                       [--location]
                       [--managed-network]
                       [--name]
                       [--no-wait]
                       [--primary-user-assigned-identity]
                       [--provision-network-now]
                       [--public-network-access]
                       [--set]
                       [--storage-account]
                       [--system-datastores-auth-mode]
                       [--tags]
                       [--update-dependent-resources]

Exemplos

Crie um workspace a partir de um arquivo de especificação YAML.

az ml workspace create --file workspace.yml --resource-group my-resource-group

Parâmetros Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--allow-roleassignment-on-rg -r
Versão Prévia

Um sinalizador para determinar se um workspace pode ter atribuições de função no nível do grupo de recursos.

Valor padrão: True
--application-insights -a

ID do ARM dos Application Insights associados a esse workspace.

--container-registry -c

ID do ARM do registro de contêiner associado a esse workspace.

--default-resource-group
Versão Prévia

Tipo de cubo apenas. Se definido, os projetos filho desse hub terão seu grupo de recursos definido por padrão.

--description

Descrição do workspace do Azure ML.

--display-name

Nome de exibição do espaço de trabalho.

--enable-data-isolation -e

Um sinalizador para determinar se um workspace tem o isolamento de dados habilitado. O sinalizador só pode ser definido no estágio de criação, não pode ser atualizado.

Valor padrão: False
--file -f

Caminho local para o arquivo YAML que contém a especificação do workspace do Azure ML. Os documentos de referência YAML para o workspace podem ser encontrados em: https://aka.ms/ml-cli-v2-workspace-yaml-reference.

--hub-id
Versão Prévia

Somente tipo de projeto: uma ID do ARM que define o hub pai deste projeto.

--image-build-compute -i

O nome do destino de computação a ser usado para criar imagens do Docker do ambiente quando o registro de contêiner estiver atrás de uma VNet.

--key-vault -k

ID do ARM do cofre de chaves associado a esse workspace.

--kind
Versão Prévia

Especifica os workspaces como um tipo específico, substituindo o valor atribuído no YAML, se ele estiver presente. O padrão é default. Os tipos válidos são: default, hub e project.

--location -l

O local a ser usado para o novo espaço de trabalho.

--managed-network -m

Modo de isolamento de rede gerenciado para o workspace.

--name -n

Nome do workspace do Azure ML.

--no-wait

Não espere a conclusão da criação do espaço de trabalho.

Valor padrão: False
--primary-user-assigned-identity -p

Identificador do ARM da identidade gerenciada atribuída pelo usuário principal, caso vários sejam especificados. Também a identidade gerenciada padrão para computação sem cluster.

--provision-network-now
Versão Prévia

Defina para disparar o provisionamento da rede gerenciada ao criar um workapce com a rede manged habilitada ou então ele não faz nada.

Valor padrão: False
--public-network-access

Permitir conectividade de ponto de extremidade público quando um workspace estiver habilitado para link privado.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=value.

--storage-account -s

ID do ARM da conta de armazenamento associada a esse workspace.

--system-datastores-auth-mode -d
Versão Prévia

Especifica o modo de autenticação para os armazenamentos de dados do sistema. Os modos válidos são: accesskey e identity.

--tags

Pares de valores-chave separados por espaço para as tags do objeto.

--update-dependent-resources -u

Especificar --update_dependent_resources dá seu consentimento para atualizar os recursos dependentes do workspace. Atualizar o recurso do Registro de Contêiner do Azure ou do Application Insights anexado ao workspace pode quebrar a linhagem de trabalhos anteriores, pontos de extremidade de inferência implantados ou sua capacidade de executar novamente trabalhos anteriores neste workspace.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml workspace delete

Exclua um espaço de trabalho.

Por padrão, os recursos dependentes associados ao workspace (Armazenamento do Azure, Registro de Contêiner do Azure, Azure Key Vault, Azure Application Insights) não são excluídos. Para excluí-los também, inclua --all-resources. Para excluir permanentemente o espaço de trabalho, inclua --permanently-delete.

az ml workspace delete --name
                       --resource-group
                       [--all-resources]
                       [--no-wait]
                       [--permanently-delete]
                       [--yes]

Parâmetros Exigidos

--name -n

Nome do workspace do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--all-resources

Exclua todos os recursos dependentes associados ao workspace (conta de Armazenamento do Azure, Registro de Contêiner do Azure, Azure Application Insights, Azure Key Vault).

Valor padrão: False
--no-wait

Não espere que a operação de longa duração termine. O padrão é Falso.

Valor padrão: False
--permanently-delete -p

Os espaços de trabalho são excluídos temporariamente por padrão para permitir a recuperação de dados do espaço de trabalho. Defina esse sinalizador para substituir o comportamento de exclusão reversível e excluir permanentemente seu espaço de trabalho.

Valor padrão: False
--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml workspace diagnose

Diagnostique problemas de configuração do espaço de trabalho.

Se o workspace não estiver funcionando conforme o esperado, você poderá executar esse diagnóstico para verificar se o workspace foi interrompido. Para o workspace de ponto de extremidade privado, também ajudará a verificar se a configuração de rede para esse workspace e seu recurso dependente tem problemas ou não.

az ml workspace diagnose --name
                         --resource-group
                         [--no-wait]

Exemplos

Diagnosticar um espaço de trabalho.

az ml workspace diagnose --name my-workspace-name --no-wait -g my-resource-group

Parâmetros Exigidos

--name -n

Nome do workspace do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--no-wait

Não espere que a operação de longa duração termine. O padrão é Falso.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml workspace list

Liste todos os workspaces em uma assinatura.

A lista de workspaces pode ser filtrada por grupo de recursos.

az ml workspace list [--filtered-kinds]
                     [--max-results]
                     [--resource-group]

Exemplos

Listar todos os workspaces em um grupo de recursos

az ml workspace list --resource-group my-resource-group

Liste toda a área de trabalho usando o argumento --query para executar uma consulta JMESPath nos resultados dos comandos.

az ml workspace list --query "[].{Name:name}"  --output table --resource-group my-resource-group

Parâmetros Opcionais

--filtered-kinds
Versão Prévia

Liste apenas os tipos especificados de áreas de trabalho, como uma lista separada por vírgulas. Os tipos válidos são: default, hub e project.

--max-results -r

Número máximo de resultados a serem retornados.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml workspace list-keys

Liste as chaves do workspace para recursos dependentes, como Armazenamento do Azure, Registro de Contêiner do Azure e Azure Application Insights.

az ml workspace list-keys --name
                          --resource-group

Parâmetros Exigidos

--name -n

Nome do workspace do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml workspace provision-network

Provisione a rede gerenciada do workspace.

Aciona o workspace para provisionar a rede gerenciada. Especificar o sinalizador habilitado para o Spark prepara a rede gerenciada do workspace para dar suporte ao Spark. O padrão é false se não for especificado, mas pode ser habilitado posteriormente executando esse comando novamente com esse sinalizador. Uma vez ativado, ele não pode ser desativado.

az ml workspace provision-network --name
                                  --resource-group
                                  [--include-spark]
                                  [--no-wait]

Exemplos

provisionar rede gerenciada.

az ml workspace provision-network --include-spark --name my-workspace-name --no-wait -g my-resource-group

Parâmetros Exigidos

--name -n

Nome do workspace do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--include-spark

Booleano [true/false] para se a rede gerenciada deve ser provisionada para contabilizar trabalhos do Spark. O padrão é false se o sinalizador não estiver definido. Ele pode ser habilitado posteriormente executando este comando novamente com este sinalizador.

Valor padrão: False
--no-wait

Não espere que a operação de longa duração termine. O padrão é Falso.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml workspace show

Mostrar detalhes de um espaço de trabalho.

az ml workspace show --name
                     --resource-group

Parâmetros Exigidos

--name -n

Nome do workspace do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml workspace sync-keys

Sincronize chaves de workspace para recursos dependentes, como Armazenamento do Azure, Registro de Contêiner do Azure e Azure Application Insights.

Se as chaves de qualquer recurso no workspace forem alteradas, pode levar cerca de uma hora para que elas sejam atualizadas automaticamente. Esse comando aciona o espaço de trabalho para sincronizar imediatamente as chaves. Um cenário possível é a necessidade de acesso imediato ao armazenamento após a regeneração das chaves de armazenamento.

az ml workspace sync-keys --name
                          --resource-group
                          [--no-wait]

Parâmetros Exigidos

--name -n

Nome do workspace do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--no-wait

Não espere que a operação de longa duração termine. O padrão é Falso.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml workspace update

Atualize um espaço de trabalho.

As propriedades 'description', 'tags' e 'friendly_name' podem ser atualizadas.

az ml workspace update --name
                       --resource-group
                       [--add]
                       [--allow-roleassignment-on-rg]
                       [--application-insights]
                       [--container-registry]
                       [--description]
                       [--display-name]
                       [--file]
                       [--force-string]
                       [--image-build-compute]
                       [--managed-network]
                       [--network-acls]
                       [--no-wait]
                       [--primary-user-assigned-identity]
                       [--public-network-access]
                       [--remove]
                       [--set]
                       [--system-datastores-auth-mode]
                       [--update-dependent-resources]

Exemplos

atualizar um espaço de trabalho de um arquivo de especificação YAML.

az ml workspace update --resource-group my-resource-group --name my-workspace-name --file workspace.yml

Parâmetros Exigidos

--name -n

Nome do workspace do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um par de caminho e um valor-chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Valor padrão: []
--allow-roleassignment-on-rg -r
Versão Prévia

Um sinalizador para determinar se um workspace pode ter atribuições de função no nível do grupo de recursos.

--application-insights -a

ID do ARM dos Application Insights associados a esse workspace.

--container-registry -c

ID do ARM do registro de contêiner associado a esse workspace.

--description

Descrição do workspace do Azure ML.

--display-name

Nome de exibição do espaço de trabalho.

--file -f

Caminho local para o arquivo YAML que contém a especificação do workspace do Azure ML. Os documentos de referência YAML para o workspace podem ser encontrados em: https://aka.ms/ml-cli-v2-workspace-yaml-reference.

--force-string

Ao usar 'set' ou 'add', preserve os literais de string em vez de tentar converter em JSON.

Valor padrão: False
--image-build-compute -i

O nome do destino de computação a ser usado para criar imagens do Docker do ambiente quando o registro de contêiner estiver atrás de uma VNet.

--managed-network -m

Modo de isolamento de rede gerenciado para o workspace.

--network-acls

Lista separada por vírgulas de endereços IP ou intervalos de IP na notação CIDR que têm permissão para acessar o workspace. Exemplo: 'XX.XX.XX.XX,XX.XX.XX.XX/32'. Para definir o acesso à rede pública como 'Enabled', passe networkAcls como 'none' (ou seja, isso redefinirá acls de rede) juntamente com o sinalizador PNA definido como 'Enabled'. Para desabilitar, defina o sinalizador PNA como 'Desabilitado'. Para definir o acesso à rede pública como "Habilitado de endereços IP selecionados", defina o sinalizador PNA como "Habilitado" e passe uma lista separada por vírgulas de IPs na notação CIDR em 'network-acls'.

--no-wait

Não espere que a operação de longa duração termine. O padrão é Falso.

Valor padrão: False
--primary-user-assigned-identity -p

ID do ARM da identidade atribuída pelo usuário primário associada a esse workspace.

--public-network-access

Permitir conectividade de ponto de extremidade público quando um workspace estiver habilitado para link privado.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

Valor padrão: []
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Valor padrão: []
--system-datastores-auth-mode -d
Versão Prévia

Especifica o modo de autenticação para os armazenamentos de dados do sistema. Os modos válidos são: accesskey e identity.

--update-dependent-resources -u

Especificar --update_dependent_resources dá seu consentimento para atualizar os recursos dependentes do workspace. Atualizar o recurso do Registro de Contêiner do Azure ou do Application Insights anexado ao workspace pode quebrar a linhagem de trabalhos anteriores, pontos de extremidade de inferência implantados ou sua capacidade de executar novamente trabalhos anteriores neste workspace.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.