az ml workspace

  • Referência

Nota

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 espaços de trabalho do Azure ML.

Um espaço de trabalho 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 a partir de seus trabalhos de treinamento.

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

  • Atualize az ml workspace private-endpoint 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

Name Description Tipo Estado
az ml workspace create

Crie um espaço de trabalho.

 Extensão GA
az ml workspace delete

Excluir um espaço de trabalho.

 Extensão GA
az ml workspace diagnose

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

 Extensão GA
az ml workspace list

Liste todos os espaços de trabalho em uma assinatura.

 Extensão GA
az ml workspace list-keys

Liste chaves de espaço de trabalho para recursos dependentes, como o Armazenamento do Azure, o Registro de Contêiner do Azure e o Azure Application Insights.

 Extensão GA
az ml workspace outbound-rule

Gerencie regras de saída para a rede gerenciada de um espaço de trabalho do Azure ML.

 Extensão GA
az ml workspace outbound-rule list

Liste todas as regras de saída de rede gerenciada para um espaço de trabalho.

 Extensão GA
az ml workspace outbound-rule remove

Remova uma regra de saída da rede gerenciada para um espaço de trabalho.

 Extensão GA
az ml workspace outbound-rule set

Adicione ou atualize uma regra de saída na rede gerenciada para um espaço de trabalho.

 Extensão GA
az ml workspace outbound-rule show

Mostrar detalhes de uma regra de saída de rede gerenciada para um espaço de trabalho.

 Extensão GA
az ml workspace provision-network

Rede gerenciada do espaço de trabalho de provisionamento.

 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 espaço de trabalho para recursos dependentes, como o Armazenamento do Azure, o Registro de Contêiner do Azure e o Azure Application Insights.

 Extensão GA
az ml workspace update

Atualizar um espaço de trabalho.

 Extensão GA

az ml workspace create

Crie um espaço de trabalho.

Quando um espaço de trabalho é 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, Cofre da Chave do Azure e Azure Application Insights. Em vez disso, você pode usar instâncias de recursos existentes do Azure para aquelas ao criar o espaço de trabalho especificando as IDs de recurso no arquivo YAML de configuração do espaço de trabalho.

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]
                       [--public-network-access]
                       [--set]
                       [--storage-account]
                       [--system-datastores-auth-mode]
                       [--tags]
                       [--update-dependent-resources]

Exemplos

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

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

Parâmetros Obrigatórios

--resource-group -g

o 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
Pré-visualizar

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

valor predefinido: True
--application-insights -a

ID ARM dos insights do aplicativo associados a este espaço de trabalho.

--container-registry -c

ID ARM do registo de contentor associado a esta área de trabalho.

--default-resource-group
Pré-visualizar

Apenas tipo de hub. Se definido, os projetos filho desse hub terão seu grupo de recursos definido por padrão.

--description

Descrição do espaço de trabalho do Azure ML.

--display-name

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

--enable-data-isolation -e

Um sinalizador para determinar se um espaço de trabalho tem o isolamento de dados habilitado. O sinalizador só pode ser definido na fase de criação, não pode ser atualizado.

valor predefinido: False
--file -f

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

--hub-id
Pré-visualizar

Somente tipo de projeto: uma ID 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 do contêiner estiver atrás de uma VNet.

--key-vault -k

ID ARM do cofre de chaves associado a este espaço de trabalho.

--kind
Pré-visualizar

Especifica os espaços de trabalho como um tipo específico, substituindo o valor atribuído em YAML, se ele estiver presente. O padrão é padrão. Os tipos válidos são: padrão, hub e projeto.

--location -l

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

--managed-network -m
Pré-visualizar

Modo de Isolamento de Rede Gerenciado para o espaço de trabalho.

--name -n

Nome do espaço de trabalho do Azure ML.

--no-wait

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

valor predefinido: False
--primary-user-assigned-identity -p

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

--public-network-access

Permita a conectividade de ponto de extremidade público quando um espaço de trabalho estiver habilitado para link privado.

--set

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

--storage-account -s

ID ARM da conta de armazenamento associada a este espaço de trabalho.

--system-datastores-auth-mode -d
Pré-visualizar

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

--tags

Pares chave-valor 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 espaço de trabalho. Atualizar o recurso Azure Container Registry ou Application Insights anexado ao espaço de trabalho pode quebrar a linhagem de trabalhos anteriores, pontos de extremidade de inferência implantados ou sua capacidade de executar novamente trabalhos anteriores neste espaço de trabalho.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml workspace delete

Excluir um espaço de trabalho.

Por padrão, os recursos dependentes associados ao espaço de trabalho (Armazenamento do Azure, Registro de Contêiner do Azure, Cofre da Chave do Azure, 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 Obrigatórios

--name -n

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

--resource-group -g

o 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 espaço de trabalho (conta de Armazenamento do Azure, Registro de Contêiner do Azure, Azure Application Insights, Cofre da Chave do Azure).

valor predefinido: False
--no-wait

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

valor predefinido: False
--permanently-delete -p

Os espaços de trabalho são excluídos suavemente 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 suave e excluir permanentemente seu espaço de trabalho.

valor predefinido: False
--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml workspace diagnose

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

Se o espaço de trabalho não estiver funcionando conforme o esperado, você poderá executar esse diagnóstico para verificar se o espaço de trabalho foi quebrado. Para o espaço de trabalho de ponto de extremidade privado, ele também ajudará a verificar se a configuração de rede para esse espaço de trabalho e seu recurso dependente tem problema 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 Obrigatórios

--name -n

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

--resource-group -g

o 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 é False.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml workspace list

Liste todos os espaços de trabalho em uma assinatura.

A lista de espaços de trabalho pode ser filtrada por grupo de recursos.

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

Exemplos

Listar todos os espaços de trabalho em um grupo de recursos

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

Liste todo o espaço 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
Pré-visualizar

Liste apenas os tipos especificados de espaços de trabalho, como uma lista separada por vírgula. Os tipos válidos são: padrão, hub e projeto.

--max-results -r

Número máximo de resultados a retornar.

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml workspace list-keys

Liste chaves de espaço de trabalho para recursos dependentes, como o Armazenamento do Azure, o Registro de Contêiner do Azure e o Azure Application Insights.

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

Parâmetros Obrigatórios

--name -n

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

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml workspace provision-network

Rede gerenciada do espaço de trabalho de provisionamento.

Aciona o espaço de trabalho para provisionar a rede gerenciada. A especificação do sinalizador habilitado para faísca prepara a rede gerenciada do espaço de trabalho para oferecer suporte ao Spark. O padrão é false se não for especificado, mas pode ser ativado posteriormente executando este comando novamente com este sinalizador. Uma vez ativado, 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 Obrigatórios

--name -n

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

--resource-group -g

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

Parâmetros Opcionais

--include-spark

Boolean [true/false] para se a rede gerenciada deve ser provisionada para levar em conta os trabalhos de faísca. O padrão é false se o sinalizador não estiver definido. Ele pode ser ativado mais tarde, executando este comando novamente com este sinalizador.

valor predefinido: False
--no-wait

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

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--name -n

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

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml workspace sync-keys

Sincronize chaves de espaço de trabalho para recursos dependentes, como o Armazenamento do Azure, o Registro de Contêiner do Azure e o Azure Application Insights.

Se as chaves de qualquer recurso no espaço de trabalho forem alteradas, pode levar cerca de uma hora para que elas sejam atualizadas automaticamente. Este comando aciona o espaço de trabalho para sincronizar imediatamente as chaves. Um cenário possível é precisar de acesso imediato ao armazenamento depois de regenerar as chaves de armazenamento.

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

Parâmetros Obrigatórios

--name -n

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

--resource-group -g

o 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 é False.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml workspace update

Atualizar 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]
                       [--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 a partir 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 Obrigatórios

--name -n

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

--resource-group -g

o 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 caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

valor predefinido: []
--allow-roleassignment-on-rg -r
Pré-visualizar

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

--application-insights -a

ID ARM dos insights do aplicativo associados a este espaço de trabalho.

--container-registry -c

ID ARM do registo de contentor associado a esta área de trabalho.

--description

Descrição do espaço de trabalho do Azure ML.

--display-name

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

--file -f

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

--force-string

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

valor predefinido: 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 do contêiner estiver atrás de uma VNet.

--managed-network -m
Pré-visualizar

Modo de Isolamento de Rede Gerenciado para o espaço de trabalho.

--no-wait

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

valor predefinido: False
--primary-user-assigned-identity -p

ID ARM da identidade atribuída ao usuário principal associada a este espaço de trabalho.

--public-network-access

Permita a conectividade de ponto de extremidade público quando um espaço de trabalho estiver habilitado para link privado.

--remove

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

valor predefinido: []
--set

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

valor predefinido: []
--system-datastores-auth-mode -d
Pré-visualizar

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

--update-dependent-resources -u

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

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.