Partilhar via

az ml online-endpoint

  • Referência

Observação

Essa referência faz parte da extensão de de 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 online-endpoint. Saiba mais sobre extensões.

Gerencie pontos de extremidade online do Azure ML.

Os pontos de extremidade do Azure ML fornecem uma interface simples para criar e gerenciar implantações de modelo. Cada ponto de extremidade pode ter uma ou mais implantações, permitindo que o tráfego de um único ponto de extremidade de pontuação seja servido para várias implantações, se necessário. Isso é útil para cenários como a distribuição controlada.

O Azure ML dá suporte a dois tipos de pontos de extremidade: online e em lote. Os pontos de extremidade on-line suportam inferência em tempo real, enquanto os pontos de extremidade em lote são usados para pontuação em lote offline.

Comandos

Name Description Tipo Status
az ml online-endpoint create

Crie um ponto de extremidade.

 Extensão GA
az ml online-endpoint delete

Exclua um ponto de extremidade.

 Extensão GA
az ml online-endpoint get-credentials

Liste o token/chaves para um ponto de extremidade online.

 Extensão GA
az ml online-endpoint invoke

Invoque um ponto de extremidade.

 Extensão GA
az ml online-endpoint list

Listar pontos de extremidade em um espaço de trabalho.

 Extensão GA
az ml online-endpoint regenerate-keys

Regenere as chaves de um ponto de extremidade online.

 Extensão GA
az ml online-endpoint show

Mostrar detalhes de um ponto de extremidade.

 Extensão GA
az ml online-endpoint update

Atualize um ponto de extremidade.

 Extensão GA

az ml online-endpoint create

Crie um ponto de extremidade.

Para criar um ponto de extremidade, forneça um arquivo YAML com configuração de ponto de extremidade online. Se o ponto de extremidade já existir, ele falhará. Se você quiser atualizar o endpoint existente, use az ml online-endpoint update.

az ml online-endpoint create --resource-group
                             --workspace-name
                             [--auth-mode]
                             [--file]
                             [--local {false, true}]
                             [--name]
                             [--no-wait]
                             [--set]
                             [--web]

Exemplos

Criar um ponto de extremidade a partir de um arquivo de especificação YAML

az ml online-endpoint create --file endpoint.yml --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Obrigatórios

--resource-group -g

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

--workspace-name -w

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

Parâmetros Opcionais

--auth-mode

Método de autenticação para o ponto de extremidade. Valores permitidos: chave, aml_token. Padrão: chave.

--file -f

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

--local

Crie pontos de extremidade localmente. Nota: o tráfego e a autenticação não são suportados localmente. Você pode usar 'az ml online-deployment create --local' diretamente. Ele criará um ponto de extremidade se ele não existir.

Valores aceites: false, true
Default value: False
--name -n

Nome do ponto de extremidade online.

--no-wait

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

Default value: False
--set

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

--web -e

Mostrar os detalhes do ponto de extremidade no estúdio do Azure ML em um navegador da Web.

Default value: 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
Default value: json
--query

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

--subscription

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

--verbose

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

az ml online-endpoint delete

Exclua um ponto de extremidade.

az ml online-endpoint delete --name
                             --resource-group
                             --workspace-name
                             [--local {false, true}]
                             [--no-wait]
                             [--yes]

Exemplos

Excluir um ponto de extremidade online, incluindo todas as suas implantações

az ml online-endpoint delete --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Obrigatórios

--name -n

Nome do ponto de extremidade online.

--resource-group -g

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

--workspace-name -w

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

Parâmetros Opcionais

--local

Exclua o ponto de extremidade local.

Valores aceites: false, true
Default value: False
--no-wait

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

Default value: False
--yes -y

Não solicite confirmação.

Default value: 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
Default value: json
--query

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

--subscription

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

--verbose

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

az ml online-endpoint get-credentials

Liste o token/chaves para um ponto de extremidade online.

az ml online-endpoint get-credentials --name
                                      --resource-group
                                      --workspace-name

Exemplos

Listar as chaves para um ponto de extremidade online

az ml online-endpoint get-credentials --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Obrigatórios

--name -n

Nome do ponto de extremidade online.

--resource-group -g

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

--workspace-name -w

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

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
Default value: json
--query

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

--subscription

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

--verbose

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

az ml online-endpoint invoke

Invoque um ponto de extremidade.

Você pode invocar um ponto de extremidade online com alguns dados de solicitação. Esta será uma inferência em tempo real, e os resultados da pontuação serão devolvidos imediatamente.

az ml online-endpoint invoke --name
                             --resource-group
                             --workspace-name
                             [--deployment-name]
                             [--local {false, true}]
                             [--request-file]

Exemplos

Invoque um ponto de extremidade online com alguns dados de solicitação

az ml online-endpoint invoke --name my-online-endpoint --request-file sample_request.json --resource-group my-resource-group --workspace-name my-workspace

Invoque um ponto de extremidade online, visando uma implantação específica

az ml online-endpoint invoke --name my-online-endpoint --deployment my-deployment --request-file sample_request.json --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Obrigatórios

--name -n

Nome do ponto de extremidade online.

--resource-group -g

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

--workspace-name -w

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

Parâmetros Opcionais

--deployment-name -d

Nome da implantação a ser direcionada.

--local

Invoque o ponto de extremidade local. Isso só funcionará se uma implantação local tiver sido criada para esse ponto de extremidade.

Valores aceites: false, true
Default value: False
--request-file -r

Caminho local para o arquivo JSON que contém os dados da solicitação.

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
Default value: json
--query

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

--subscription

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

--verbose

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

az ml online-endpoint list

Listar pontos de extremidade em um espaço de trabalho.

az ml online-endpoint list --resource-group
                           --workspace-name
                           [--local {false, true}]

Exemplos

Listar todos os pontos de extremidade online em um espaço de trabalho

az ml online-endpoint list --resource-group my-resource-group --workspace-name my-workspace

Listar todos os pontos de extremidade em lote em um espaço de trabalho

az ml online-endpoint list  --resource-group my-resource-group --workspace-name my-workspace

Liste todos os pontos de extremidade online em um espaço de trabalho usando o argumento --query para executar uma consulta JMESPath nos resultados dos comandos.

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

Parâmetros Obrigatórios

--resource-group -g

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

--workspace-name -w

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

Parâmetros Opcionais

--local

Liste todos os pontos de extremidade locais.

Valores aceites: false, true
Default value: 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
Default value: json
--query

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

--subscription

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

--verbose

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

az ml online-endpoint regenerate-keys

Regenere as chaves de um ponto de extremidade online.

az ml online-endpoint regenerate-keys --name
                                      --resource-group
                                      --workspace-name
                                      [--key-type]
                                      [--no-wait]

Exemplos

Regenerar as chaves para um ponto de extremidade online

az ml online-endpoint regenerate-keys --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Obrigatórios

--name -n

Nome do ponto de extremidade online.

--resource-group -g

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

--workspace-name -w

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

Parâmetros Opcionais

--key-type

O tipo de chave para regenerar. Valores permitidos: primário, secundário.

Default value: primary
--no-wait

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

Default value: 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
Default value: json
--query

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

--subscription

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

--verbose

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

az ml online-endpoint show

Mostrar detalhes de um ponto de extremidade.

az ml online-endpoint show --name
                           --resource-group
                           --workspace-name
                           [--local {false, true}]
                           [--web]

Exemplos

Mostrar os detalhes de um ponto de extremidade em lote

az ml online-endpoint show --name my-online-endpoint  --resource-group my-resource-group --workspace-name my-workspace

Mostrar o estado de provisionamento de um ponto de extremidade usando o argumento --query para executar uma consulta JMESPath nos resultados dos comandos.

az ml online-endpoint show -n my-endpoint --query "{Name:name,State:provisioning_state}"  --output table --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Obrigatórios

--name -n

Nome do ponto de extremidade online.

--resource-group -g

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

--workspace-name -w

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

Parâmetros Opcionais

--local

Mostrar ponto de extremidade local.

Valores aceites: false, true
Default value: False
--web -e

Mostrar os detalhes do ponto de extremidade no estúdio do Azure ML em um navegador da Web.

Default value: 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
Default value: json
--query

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

--subscription

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

--verbose

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

az ml online-endpoint update

Atualize um ponto de extremidade.

As propriedades 'description', 'tags' e 'traffic' de um endpoint podem ser atualizadas. Além disso, novas implantações podem ser adicionadas a um ponto de extremidade e implantações existentes podem ser atualizadas.

az ml online-endpoint update --resource-group
                             --workspace-name
                             [--add]
                             [--file]
                             [--force-string]
                             [--local {false, true}]
                             [--mirror-traffic]
                             [--name]
                             [--no-wait]
                             [--remove]
                             [--set]
                             [--traffic]
                             [--web]

Exemplos

Atualizar um ponto de extremidade a partir de um arquivo de especificação YAML

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

Atualizar as configurações de tráfego para um ponto de extremidade

az ml online-endpoint update --name my-online-endpoint  --traffic "my-new-deployment=100" --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Obrigatórios

--resource-group -g

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

--workspace-name -w

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

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

Default value: []
--file -f

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

--force-string

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

Default value: False
--local

Atualize o ponto de extremidade local.

Valores aceites: false, true
Default value: False
--mirror-traffic

Direciona uma porcentagem duplicada do tráfego ao vivo para uma implantação de trem.

--name -n

Nome do ponto de extremidade online.

--no-wait

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

Default value: False
--remove

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

Default value: []
--set

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

Default value: []
--traffic -r

Pares chave-valor separados por espaço, entre aspas, para as configurações de tráfego para o ponto de extremidade.

--web -e

Mostrar os detalhes do ponto de extremidade no estúdio do Azure ML em um navegador da Web.

Default value: 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
Default value: json
--query

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

--subscription

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

--verbose

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