Runtime local e referência de ferramentas do Azure Functions

Este artigo fornece documentação de referência para o runtime local e ferramentas que suportam o Azure Functions. Use essas ferramentas para desenvolver, gerenciar e rodar projetos Azure Functions a partir do seu computador local. O nome binário é func (ou func.exe em Windows).

Duas versões do CLI estão disponíveis. Use o seletor de versões para escolher qual versão visualizar.

Importante

A CLI do Azure Functions (v5) está atualmente em versão prévia. Esta versão prévia ainda não suporta Java e PowerShell. Para trabalhar com linguagens atualmente não suportadas, continue usando o Azure Functions Core Tools v4.

Há duas versões de func.exe usadas para desenvolvimento de Azure Functions local:

v4 v5
Nome da API Ferramentas principais do Azure Functions Azure Functions CLI
Nível de suporte Disponibilidade geral (GA) Preview
Instalar o volume Binário completo que inclui todos os comandos e funcionalidades para todos os idiomas nativos. Instalação base pequena, mais cargas de trabalho por idioma e outros recursos que você adiciona conforme necessário. O host é fornecido como sua própria carga de trabalho, para que você obtenha a versão mais recente do host sem baixar novamente a CLI.
Usar quando... Você precisa de suporte total de GA para todos os fluxos de trabalho de desenvolvimento. Você deseja uma experiência leve e baseada em carga de trabalho com novos recursos, como modelos de início rápido e perfis que mantêm seu ambiente local em sincronia com sua configuração de plano de hospedagem Azure.

Para saber mais sobre como usar as Ferramentas Principais, consulte Work with Azure Functions Core Tools.

Os comandos do Core Tools são organizados nos contextos a seguir, cada um fornecendo um conjunto exclusivo de ações.

Contexto de comando Descrição
func Comandos para criar e executar funções em seu computador local.
func azure Comandos para trabalhar com recursos Azure, incluindo publicação.
func azurecontainerapps Comandos para implantar um aplicativo de funções em contêineres para Aplicativos de Contêiner do Azure.
func bundles Comandos para gerenciar pacotes de extensão.
func durable Comandos para trabalhar com Durable Functions.
func extensions Comandos para instalar e gerenciar extensões.
func kubernetes Comandos para trabalhar com Kubernetes e Azure Functions.
func settings Comandos para gerenciar as configurações de ambiente para o host local do Functions.
func templates Comandos para listar modelos de função disponíveis.

Antes de usar os comandos neste artigo, instale as Ferramentas Principais.

Importante

A CLI do Azure Functions (v5) está atualmente em versão prévia. Esta versão prévia ainda não suporta Java e PowerShell. Para trabalhar com linguagens atualmente não suportadas, continue usando o Azure Functions Core Tools v4.

Para saber mais sobre o uso da CLI, incluindo instalação e cargas de trabalho, veja Desenvolva Azure Functions localmente usando a Azure Functions CLI.

Os seguintes comandos embutidos vêm com a instalação CLI base:

Command Descrição
func init Inicialize um novo projeto Azure Functions.
func new Crie uma nova função a partir de um template.
func run Inicie localmente o runtime host do Azure Functions. func start é um apelido retrocompatível.
func quickstart Navegue e apoie aplicativos completos de funções do catálogo de modelos de início rápido.
func profile Inspecionar e gerenciar perfis CLI do Azure Functions.
func setup Prepare dependências locais de CLI do Azure Functions (runtime do host, trabalhadores de linguagem, pacotes de extensão).
func workload Gerencie as cargas de trabalho instaladas na CLI.

Cargas de trabalho podem contribuir com comandos adicionais de nível superior. Esses comandos só aparecem depois que você instala a carga de trabalho que contribui.

func init

Cria um novo projeto do Functions em uma linguagem específica.

func init [<PROJECT_FOLDER>]

Quando você fornece <PROJECT_FOLDER>, o comando cria o projeto em uma nova pasta com esse nome. Caso contrário, ele usa a pasta atual.

O func init comando suporta estas opções, que dependem da versão:

Opção Descrição
--bundles-channel, -c Canal de versão do pacote de extensão. Os valores com suporte são: GA (padrão) Previewe Experimental. Aplicável somente para projetos não .NET.
--configuration-profile Inicializa um projeto com um perfil de configuração de host. A --configuration-profile opção está atualmente em versão prévia. Para obter mais informações, consulte Perfis de configuração.
--csx Cria .NET funciona como script C#. Válido somente com --worker-runtime dotnet.
--docker Cria um Dockerfile para um container usando uma imagem base baseada no arquivo escolhido --worker-runtime. Use essa opção quando planejar implantar um aplicativo de funções em contêineres.
--docker-only Adiciona um Dockerfile a um projeto existente. Solicita o tempo de execução do trabalho se não for especificado ou definido em local.settings.json. Use essa opção quando planejar implantar um aplicativo de funções em contêineres e o projeto já existir.
--force Inicializa o projeto mesmo quando há arquivos existentes no projeto. Essa configuração substitui os arquivos existentes pelo mesmo nome. Os outros arquivos na pasta do projeto não serão afetados.
--language, -l Inicializa um projeto específico de uma linguagem. Atualmente, há suporte quando --worker-runtime é definido como node. As opções são typescript e javascript. Você também pode usar --worker-runtime javascript ou --worker-runtime typescript.
--managed-dependencies Instala dependências gerenciadas. Atualmente, somente o runtime de trabalho do PowerShell dá suporte a esse recurso.
--model, -m Define o modelo de programação para um idioma de destino quando mais de um modelo está disponível. As opções com suporte são V1 e V2 para Python e V3 e V4 para Node.js. Para obter mais informações, consulte o guia do desenvolvedor Python e o guia do desenvolvedor Node.js.
--no-bundle Não configure o pacote de extensão no host.json. Aplicável somente para projetos não .NET.
--no-docs Ignora a geração dos arquivos de documentação "Introdução". Aplicável a projetos Python.
--skip-npm-install Ignore a execução npm install após a criação do projeto. Aplicável a projetos Node.js.
--source-control Controla se um repositório Git é criado. Por padrão, não é criado um repositório. Quando true, um repositório é criado.
--worker-runtime Define o runtime de linguagem para o projeto. Os valores com suporte são: csharp, , dotnet, dotnet-isolated, javascript( node JavaScript), powershelle pythontypescript. Para Java, use Maven. Para gerar um projeto independente de linguagem com apenas os arquivos de projeto, use custom. Quando não estiver definido, será solicitado que você escolha seu runtime durante a inicialização.
--target-framework Define a estrutura de destino para o projeto do aplicativo de funções. Válido somente com --worker-runtime dotnet-isolated. Os valores com suporte são: net10.0 (versão prévia), net9.0, net8.0 (padrão), net6.0 e net48 (.NET Framework 4.8).

Observação

Quando você usa a opção --docker ou --docker-only, o Core Tools cria automaticamente o Dockerfile para funções C#, JavaScript, Python e PowerShell. Para Java funções, você deve criar manualmente o Dockerfile. Para mais informações, consulte Criação de aplicativos de funções em contêineres.

Perfis de configuração

Importante

O suporte para perfis de configuração está atualmente em versão prévia.

Quando você usa essa --configuration-profile opção, cria um conjunto pré-definido de configurações e configurações de projeto. Quando você especifica um perfil de configuração, a inicialização pode ignorar todas as outras etapas de inicialização.

Valor do perfil Descrição Ações específicas
mcp-custom-handler Cria um projeto que usa manipuladores personalizados para hospedar um servidor MCP (Protocolo de Contexto de Modelo) ao qual os agentes de IA e outros clientes MCP podem se conectar. • Configura o "configurationProfile": "mcp-custom-handler" elemento no arquivo host.json com configurações de manipulador personalizadas específicas.
• Define MCP_EXTENSION_ENABLED para true em local.settings.json.		 
func init [<PATH>] [options]

Quando você fornece <PATH>, o projeto é criado nessa pasta. Caso contrário, será usada a pasta atual.

O func init comando suporta estas opções embutidas:

Opção Descrição
--stack, -s A pilha a ser usada no projeto (por exemplo, python, node, dotnet, go). Corra func workload list para ver as pilhas que você contribuiu com suas cargas de trabalho instaladas.
--name, -n O nome do projeto do aplicativo de funções.
--language, -l A linguagem de programação (por exemplo, C#, F#, JavaScript, TypeScript, Python). Usado quando uma pilha suporta mais de uma linguagem. Os valores suportados são calculados a partir das cargas de trabalho instaladas na pilha.
--force Reinicie mesmo quando a pasta de destino não estiver vazia. Limpa a pasta (exceto .git) antes de montar a estrutura.

As cargas de trabalho contribuem com opções adicionais que são agrupadas sob o nome da carga em func init --help. Veja opções específicas de carga de trabalho para as opções por stack.

Se nenhuma carga de trabalho fornecer a pilha solicitada, a CLI imprime uma dica apontando e func workload install sai com um código de saída diferente de zero.

Opções específicas para carga de trabalho

O init comando se expande quando você instala uma ou mais dessas cargas de trabalho:

Opção Descrição
--target-framework, -tfm O alvo .NET framework para o projeto (por exemplo, net10.0). Padrão: net10.0.

O inicializador .NET não escreve um bloco de bundle de extensão, então --no-bundles e --bundles-channel não são aplicáveis.

Quando mais de uma carga de trabalho instalada contribui com a mesma opção, a opção aparece uma vez em func init --help.

Opções compartilhadas

Atualmente, as opções compartilhadas são --no-bundles e --bundles-channel. O ID padrão do pacote de extensões no qual você escrevehost.json depende do canal selecionado:

Canal ID do pacote
GA (padrão) Microsoft.Azure.Functions.ExtensionBundle
Preview Microsoft.Azure.Functions.ExtensionBundle.Preview
Experimental Microsoft.Azure.Functions.ExtensionBundle.Experimental

A faixa padrão de versões é [4.*, 5.0.0).

func new

Cria uma nova função no projeto atual com base em um modelo.

func new

O func new comando suporta estas opções, que dependem da versão:

Opção Descrição
--authlevel, -a Define o nível de autorização de um gatilho HTTP. Os valores com suporte são: function, anonymous e admin. A autorização não é imposta durante a execução local. Para obter mais informações, confira Nível de autorização.
--csx Gera os mesmos templates de script C# (.csx) usados na versão 1 e no portal.
--file, -f O arquivo de destino para a nova função. Para projetos Python v2, especifica o arquivo ao qual adicionar a função (o padrão é function_app.py). Para projetos Node.js v4, especifica o nome do arquivo de saída na src/functions pasta. Não aplicável a projetos de .NET compilados.
--name, -n O nome da função.
--template, -t Use o func templates list comando para ver a lista completa de modelos disponíveis para cada idioma com suporte.

Para obter mais informações, confira Criar uma função.

func new [<PATH>] [options]

Importante

func new atualmente é um esboço de prévia. Ele imprime uma dica de instalação da carga de trabalho e sai com um código de saída diferente de zero até que uma carga de trabalho modelo seja instalada e conectada por cabo. Opções específicas de template são hidratadas dinamicamente a partir dos metadados do template, então adicionar uma nova opção de template não exige uma release da CLI.

O func new comando suporta estas opções embutidas:

Opção Descrição
--name, -n O nome da função.
--template, -t O nome do modelo de função. Os templates disponíveis vêm da carga de trabalho instalada <stack>-templates para a pilha do projeto.
--force Sobrescrever arquivos existentes.

Opções adicionais são contribuídas dinamicamente pelo modelo selecionado. Corra func new --template <name> --help para ver as opções de um modelo específico.

Se nenhuma carga de trabalho de templates for instalada para o projeto atual, a CLI imprime uma dica apontando para func workload install.

func logs

Obtém logs para funções em execução em um cluster do Kubernetes.

func logs --platform kubernetes --name <APP_NAME>

O func logs comando dá suporte a estas opções:

Opção Descrição
--platform A plataforma de hospedagem do aplicativo de funções. Opções válidas: kubernetes.
--name Nome do aplicativo de funções no Azure.

Para obter mais informações, consulte Azure Functions no Kubernetes com KEDA.

func pack

Cria um pacote de implantação que contém o código do projeto em um estado executável. Use esse método quando precisar criar manualmente um pacote de implantação para seu aplicativo em seu computador local fora do func azure functionapp publish comando. Por padrão, func pack cria seu projeto quando necessário.

Para aplicativos de função Go, func pack constrói um pacote de implantação Linux x64 que você pode implantar usando o comando CLI do Azure az functionapp deployment source config-zip.

func pack [<FOLDER_PATH>]

Por padrão, func pack empacota o diretório atual e a saída .zip arquivo tem o mesmo nome da pasta raiz do seu projeto. Execute func pack no diretório que contém o arquivo de projetohost.json . Se você precisar executar func pack em outro diretório, defina <FOLDER_PATH> como o caminho para a raiz do projeto, como func pack ./myprojectroot. Se o arquivo .zip específico já existir, ele será primeiro excluído e substituído por uma versão atualizada.

O func pack comando dá suporte a estas opções:

Opção Descrição
--output, -o Define o caminho para o local em que a implantação .zip arquivo de pacote é criada.
--no-build Project não é criada antes de empacotar. Para aplicativos C#, use somente quando você já tiver gerado seus binários. Para Node.js aplicativos, ambos npm install e npm run build são ignorados. Para apps Go, use apenas quando bin/app já contiver um binário Linux x64.
--skip-install Ignora a execução npm install ao empacotar Node.jsaplicativo de funções baseado. Usado para evitar a substituição de módulos npm personalizados.
--build-native-deps Instala Python dependências localmente usando uma imagem que corresponde ao ambiente usado em Azure. Quando habilitado, o Core Tools inicia um contêiner do Docker, cria o aplicativo dentro desse contêiner e cria um arquivo .zip com todas as dependências restauradas em .python_packages. Use essa opção ao executar em Windows para evitar possíveis problemas de biblioteca ao implantar no Linux no Azure.

func run (apenas v1)

Observação

Este comando se aplica apenas à versão 1 do Core Tools e está obsoleto. Para a versão 4, use func start e chame diretamente o endpoint da função.

Invoca uma função diretamente, de forma semelhante a executar uma função usando a aba Test no portal Azure.

func run

O func run comando dá suporte a estas opções:

Opção Descrição
--content Conteúdo em linha passado para a função.
--debug Anexe um depurador ao processo de host antes de executar a função.
--file O nome do arquivo a ser usado como conteúdo.
--no-interactive Não solicita entrada, o que é útil para cenários de automação.
--timeout Tempo de espera (em segundos) até que o host local de funções esteja pronto.

Por exemplo, para chamar uma função disparada por HTTP e passar o corpo do conteúdo, execute este comando:

func run MyHttpTrigger --content '{\"name\": \"Azure\"}'

func start

Inicia o host de runtime local e carrega o projeto de função na pasta atual.

O comando específico depende da versão de runtime.

func start

O func start comando dá suporte a estas opções:

Opção Descrição
--cert O caminho para um arquivo .pfx que contém uma chave privada. Só há suporte com --useHttps.
--cors Uma lista separada por vírgulas de origens CORS, sem espaços.
--cors-credentials Permite solicitações autenticadas entre origens que usam cookies e o cabeçalho autenticação.
--dotnet-isolated-debug Quando definido como true, pausa o processo de trabalho .NET até que um depurador seja anexado do projeto isolado .NET sendo depurado.
--enable-json-output Emite logs de console como JSON quando possível.
--enableAuth Habilita o pipeline de tratamento de autenticação completo com requisitos de autorização.
--functions Uma lista separada por espaços de funções a serem carregadas.
--json-output-file Se fornecido, um caminho para o arquivo usado para gravar a saída ao usar --enable-json-output.
--language-worker Argumentos para configurar o trabalhador de idioma. Por exemplo, você pode habilitar a depuração para o trabalho de idioma fornecendo debug port e outros argumentos necessários.
--no-build Não compile o projeto atual antes da execução. Somente para projetos de classe .NET. O padrão é false.
--password A senha ou um arquivo que contém a senha para um arquivo .pfx. Usado somente com --cert.
--port, -p A porta local na qual escutar. Valor Padrão: 7071.
--runtime Define qual versão do host será iniciada. Os valores permitidos são: inproc6, inproc8e default (que executa o host fora de processo).
--timeout, -t O tempo limite para o host de funções ser iniciado, em segundos. Padrão: 20 segundos.
--useHttps Associar a https://localhost:{port} em vez de http://localhost:{port}. Por padrão, essa opção cria um certificado confiável no computador.
--user-log-level Define o nível mínimo de log para logs de usuário. Os valores válidos são: Trace, , Debug, Information, Warning, Error, , Criticale None. Essa configuração não afeta os logs do sistema. Para .NET projetos isolados, também defina o nível mínimo em Program.cs usando builder.Logging.SetMinimumLevel(LogLevel.Debug) para que essa opção entre em vigor.

Com o projeto em execução, verifique os pontos de extremidade de função individuais.

func run

Inicia o tempo de execução do host Functions e carrega o projeto na pasta atual.

func run [<PATH>] [options]

func start é preservado como um alias retrocompatível e aceita os mesmos argumentos e opções.

O func run comando dá suporte a estas opções:

Opção Descrição
--port, -p A porta local na qual escutar. Padrão: 7071.
--cors Uma lista separada por vírgulas de origens CORS, sem espaços.
--cors-credentials Permita requisições autenticadas de origem cruzada que usem cookies e o Authentication cabeçalho.
--functions Uma lista separada por espaços de funções a serem carregadas.
--no-build Não construa o projeto antes de correr.
--enable-auth Ativem todo o pipeline de gerenciamento de autenticação, incluindo os requisitos de autorização.
--host-version, -v A versão em tempo de execução do host a ser usada (por exemplo, 4.1049.0).
--profile O perfil Azure Functions para aplicar ao resolver versões host, worker e bundle. Consulte func profile.
--offline Use apenas cargas de trabalho instaladas localmente e pule as instalações de rede.
--output Modo de saída: compact (TUI interativo), plain (CI / não-TTY) ou json (NDJSON para consumidores programáticos e agentes de IA). O padrão é autodetectado com base no terminal.
--no-tui Alias para --output=plain. Desativa a TUI interativa.
--log-file Espelhe todos os eventos host no arquivo de log especificado.
--no-azurite Desative Azurita gerenciada. O host começa sem sondar ou iniciar um emulador local.

Quando o projeto estiver em execução, chame diretamente os endpoints de função para verificar o comportamento.

Azurita Gerenciada

Quando seu projeto usa armazenamento local (por exemplo, AzureWebJobsStorage=UseDevelopmentStorage=true), func run ele automaticamente verifica se há um emulador de Azurite em execução e inicia um se não encontrar um. O emulador para quando func run sai. Passe --no-azurite para optar por não participar e gerenciar a Azurite você mesmo.

Modos de saída

func run seleciona automaticamente um modo de saída baseado no terminal:

Condition Mode
Terminal interativo (TTY) compact
Stdout não interativo, saída redirecionada ou CI conjunto de variáveis de ambiente plain
Explícito --output=json json

A CLI nunca seleciona jsonautomaticamente . Se compact for solicitado mas o STDOUT não for um TTY, o CLI rebaixa para plain e escreve um aviso de uma linha para o stderr. O json modo emite JSON delimitado por nova linha (NDJSON), um objeto por linha, com um schema_version de 1.

func quickstart

Navega e andaimes completam aplicativos de funções do catálogo de modelos de início rápido do Azure Functions. Modelos de início rápido são aplicativos completos de amostra, como uma API HTTP, um worker acionado pela fila ou uma orquestração Durable Functions. Cargas de trabalho de pilha contribuem com resolvers específicos de linguagem. O catálogo é buscado no momento da invocação de comando.

func quickstart [<PATH>] [options]

Quando você fornece <PATH>, o projeto é criado nessa pasta. Caso contrário, será usada a pasta atual.

O func quickstart comando dá suporte a estas opções:

Opção Descrição
--stack, -s A pilha a usar, como python, node, ou dotnet.
--language, -l A linguagem de programação. Os valores suportados vêm de provedores de quickstart instalados.
--template, -t ID de modelo do catálogo, como http-trigger-python-azd. Pula todos os prompts interativos.
--resource, -r Filtrar por recurso de gatilho ou vinculação, como http, timer, blob, eventhub, servicebuscosmos, sql, mcp, , ou durable.
--iac Filtrar por tipo infraestrutura como código, como bicep, terraform, ou none.
--search Filtro de substrings insensíveis a maiúsculas minúsculas aplicado a nomes e descrições de templates.
--fetch Estratégia de busca de catálogo: auto (padrão), git, ou http. auto sonda para git e retorna para HTTP.
--force Suporte o andaime mesmo quando a pasta de destino não está vazia. Limpa a pasta (exceto .git) antes de montar a estrutura.

Subcomandos:

Subcommand Descrição
func quickstart list Liste os modelos disponíveis no catálogo.
func quickstart info Mostre detalhes sobre um modelo específico.

func quickstart list

Listas de modelos disponíveis do catálogo, opcionalmente filtrados.

func quickstart list [options]
Opção Descrição
--stack, -s A pilha a usar, como python, node, ou dotnet.
--language, -l A linguagem de programação. Os valores suportados vêm de provedores de quickstart instalados.
--resource, -r Filtre por trigger ou recurso de ligação.
--iac Filtre por tipo de infraestrutura como código.
--search Substrings insensíveis a maiúsculas minúsculas correspondem a IDs, nomes de modelos, tipo de recurso, tipo de Infraestrutura como Código e descrições.
--json Emita JSON legível por máquina em vez de uma tabela.

func quickstart info

Exibe informações detalhadas sobre um modelo específico.

func quickstart info <ID> [options]

<ID> é o ID modelo do catálogo. Use func quickstart list para descobrir os documentos disponíveis.

Opção Descrição
--json Emita JSON legível por máquina em vez de saída formatada.

func profile

Inspeciona e gerencia perfis CLI do Azure Functions. Perfis codificam restrições de versão, como o intervalo de versões do host, o intervalo de versões do pacote de extensões e os intervalos de versões de trabalho. Eles também definem herança a partir de outros perfis. As fontes de perfil incluem projeto-local (.func/profiles/), user-global (~/.azure-functions/profiles/) e perfis embutidos. Use a func run --profile <name> opção para selecionar quais restrições de perfil se aplicam ao iniciar o host.

func profile <subcommand>

Subcomandos:

Subcommand Descrição
func profile list Liste os perfis disponíveis de projetos, usuários e fontes integradas.
func profile show Mostre os detalhes para um perfil.
func profile set Defina o perfil padrão de um projeto.

func profile list

Lista perfis disponíveis de projetos, usuários e fontes integradas. Renderiza uma tabela com nome, fonte, versão do host, pacote de extensões e status.

func profile list [<PATH>] [options]
Opção Descrição
--source Lista de fontes separadas por vírgulas incluindo: project, user, built-in. Padrão para todas as fontes.
--json Emita JSON legível por máquina em vez de uma tabela.

func profile show

Mostra detalhes para um único perfil, seja resolvido (com valores herdados aplicados) ou bruto (definição conforme escrita, sem expansão de herança).

func profile show <NAME> [<PATH>] [options]
Opção Descrição
--raw Mostre a definição bruto do perfil sem valores herdados.

func profile set

Define o perfil padrão para um projeto de Funções escrevendo o nome do perfil no .func/config.jsonarquivo . Se o perfil ainda não estiver na lista de perfis do projeto, adicione-o.

func profile set <NAME> [<PATH>]

func setup

Prepara a máquina local para executar projetos do Azure Functions. Instala ou verifica o runtime do host, trabalhadores da linguagem, pacotes de extensão e templates para as pilhas que você especificar. Suporta restrições de versão baseadas em perfil, seleção pré-lançamento, modo CI não interativo e modo apenas de verificação.

func setup [<PATH>] [options]

--features Seleciona o que instalar ou verificar. As funcionalidades e as cargas de trabalho que cada um resolve são:

Característica Cargas de trabalho instaladas
node host, bundles, node, , node-workernode-templates
python host, bundles, python, , python-workerpython-templates
go host, bundles, , gogo-worker
dotnet host, , dotnetdotnet-templates
runtime host, bundles
host host somente

--features é repetível e aceita valores separados por vírgulas, então você pode combinar características em uma única chamada (por exemplo, func setup --features node,python). dotnet-isolated é aceito como um alias para dotnet.

Opção Descrição
--features Componentes para instalar ou verificar. Repetível ou separado por vírgula. Veja a tabela acima para as cargas de trabalho que cada recurso instala.
--profile Perfil Azure Functions para usar com restrições de versão. Repetível. Fundido com --profiles.
--profiles Lista separada por vírgulas de perfis do Azure Functions para usar como restrições de versão.
--install-policy Política de instalação: latest-compatible (padrão) ou if-needed.
--source Código fonte de pacotes NuGet para usar na resolução e instalação da carga de trabalho.
--prerelease Permita versões pré-lançamento da carga de trabalho ao resolver a partir do catálogo. Padrão: ativado enquanto as cargas de trabalho estão em prévia.
--non-interactive Não peça opinião.
--yes, -y Responda sim para os prompts de configuração.
--check Verifique se as dependências selecionadas estão instaladas, sem fazer alterações.
--output Modo de saída: plain (padrão) ou json (NDJSON).

func workload

Gerencia cargas de trabalho instaladas para a CLI do Azure Functions.

func workload <subcommand>

Subcomandos:

Subcommand Descrição
func workload list Liste as cargas de trabalho instaladas.
func workload search Pesquise no catálogo de carga de trabalho.
func workload install Instale uma carga de trabalho.
func workload update Atualize uma carga de trabalho instalada no lugar.
func workload uninstall Desinstalar uma carga de trabalho.
func workload prune Remova as instalações inativas de carga de trabalho lado a lado.

func workload list

Lista cargas de trabalho instaladas. Por padrão, o comando mostra apenas a versão carregada (o maior número instalado de semver) de cada carga de trabalho. Costumo --all-versions ver todas as instalações lado a lado.

func workload list [options]
Opção Descrição
--all-versions, -a Liste todas as versões instaladas de cada carga de trabalho. Padrão: apenas versão carregada.
--json Emita JSON legível por máquina em vez de uma tabela.

Pesquisa no catálogo de cargas de trabalho configuradas por pacotes de carga de trabalho disponíveis.

func workload search [<QUERY>] [options]

Quando você omite <QUERY>, o comando lista todas as cargas de trabalho no catálogo.

Opção Descrição
--source URL de origem do catálogo para buscar. O padrão é o catálogo configurado.
--prerelease Inclua versões pré-lançamento nos resultados. Padrão: ativado enquanto as cargas de trabalho estão em prévia.
--json Emita JSON legível por máquina em vez de uma tabela.

func workload install

Resolve um ID de pacote de carga de trabalho (ou alias) através do catálogo configurado e o instala.

func workload install <ID> [options]

<ID> pode ser um ID de pacote de carga de trabalho, um alias (por exemplo, python), ou um caminho para um arquivo de pacote de carga de trabalho local.

Opção Descrição
--version, -v Versão específica para instalar. Padrão: a versão estável mais recente do catálogo.
--source URL de origem do catálogo ou diretório local para resolver. Padrão: o catálogo configurado.
--prerelease Permita versões pré-lançamento ao resolver a partir do catálogo. Padrão: ativado enquanto as cargas de trabalho estão em prévia.
--force, -f Sobrescreva uma instalação existente com o mesmo ID e versão. Também pula o prompt "use update em vez disso".
--exact, -e Desative a correspondência de alias. <ID> Deve ser o ID literal do pacote.

Se uma versão da carga de trabalho já estiver instalada, a CLI orienta você a usar func workload update em seu lugar. Contextos não interativos tratam o prompt como um declínio.

func workload update

Realiza uma troca de versão atômica no local para uma carga de trabalho instalada. As atualizações não são lado a lado; Para instalações lado a lado, use func workload install --force.

func workload update [<ID>] [options]

Passe um <ID> para atualizar uma única carga de trabalho, ou --all para atualizar toda carga instalada. Especifique exatamente uma dessas duas opções.

Opção Descrição
--version, -v Versão instalada para substituir. Padrão: a versão mais instalada.
--all Atualize toda carga de trabalho instalada. Mutuamente excludente com <ID>.
--major Permitir cruzar um limite de versão maior. Padrão: apenas o mesmo curso.
--source URL de origem do catálogo ou diretório local para resolver. Padrão: o catálogo configurado.
--prerelease Permita versões pré-lançamento ao resolver a partir do catálogo. Padrão: ativado enquanto as cargas de trabalho estão em prévia.
--exact, -e Desative a correspondência de alias. <ID> Deve ser o ID literal do pacote.

func workload uninstall

Remove uma ou todas as versões instaladas de uma carga de trabalho.

func workload uninstall <ID> [options]
Opção Descrição
--version, -v Versão específica para desinstalar. Padrão: a única versão instalada.
--all-versions, -a Desinstale todas as versões instaladas da carga de trabalho. Mutuamente excludente com --version.
--exact, -e Desative a correspondência de alias. <ID> Deve ser o ID literal do pacote.

func workload prune

Remove instalações de carga de trabalho lado a lado inativas. Para cada ID de pacote dentro do escopo, o comando mantém a versão instalada mais alta e desinstala versões antigas. Esse comando é apenas local e nunca toca no catálogo.

func workload prune [<ID>] [options]

Quando você omite <ID>, o comando elimina todas as cargas de trabalho instaladas.

Opção Descrição
--exact, -e Desative a correspondência de alias. <ID> Deve ser o ID literal do pacote.

func azure functionapp

O func azure functionapp contexto contém os seguintes comandos:

Todos os func azure functionapp comandos dão suporte a estas opções:

Opção Descrição
--slot Direciona um slot de implantação nomeado específico, se configurado.
--access-token Fornece um token de acesso, diferente do token padrão, a ser usado para executar ações autenticadas em Azure.
--access-token-stdin Lê um token de acesso específico da entrada padrão. Use essa opção ao ler o token diretamente de um comando anterior, como az account get-access-token.
--management-url Define a URL de gerenciamento para a nuvem Azure, que usa como padrão https://management.azure.com. Use essa opção quando seu aplicativo de funções for executado em uma nuvem soberana.
--subscription Define a assinatura de Azure padrão.

func azure functionapp fetch-app-settings

Obtém as configurações de um aplicativo de funções específico.

func azure functionapp fetch-app-settings <APP_NAME>

Para obter mais informações, confira Baixar as configurações de aplicativo.

O comando baixa as configurações no arquivolocal.settings.json do projeto. Os valores na tela são mascarados por segurança. Você pode proteger as configurações no arquivolocal.settings.jsonativando a criptografia local.

func azure functionapp list-functions

Lista as funções no aplicativo de funções especificado.

func azure functionapp list-functions <APP_NAME>

O func azure functionapp list-functions comando dá suporte a esta opção:

Opção Descrição
--show-keys Inclua valores de chave de acesso no nível da função nas URLs de ponto de extremidade de função retornadas.

func azure functionapp logstream

Conecta o prompt de comando local aos logs de streaming do aplicativo de funções no Azure.

func azure functionapp logstream <APP_NAME>

O tempo limite padrão para a conexão é de 2 horas. Altere o tempo limite adicionando uma configuração de aplicativo chamada SCM_LOGSTREAM_TIMEOUT, com um valor de tempo limite em segundos. Ainda não há suporte para Linux em um plano deconsumo ou consumo flex. Para esses aplicativos, use a opção --browser para exibir logs no Portal.

O func azure functionapp logstream comando dá suporte a esta opção:

Opção Descrição
--browser Abra Aplicativo Azure Insights Live Stream para o aplicativo de funções no navegador padrão.

Para obter mais informações, consulte Enable streaming logs de execução em Azure Functions.

func azure functionapp publish

Implanta um projeto do Functions em um recurso de aplicativo de funções existente no Azure.

func azure functionapp publish <APP_NAME>

Para obter mais informações, consulte Implantar arquivos de projeto.

As seguintes opções de publicação se aplicam, com base na versão:

Opção Descrição
--additional-packages Lista de pacotes para instalar ao compilar dependências nativas. Por exemplo: python3-dev libevent-dev.
--build, -b Executa uma ação de build ao implantar em um aplicativo de funções do Linux. Aceita: remote e local.
--build-native-deps Ignora a geração da pasta .wheels ao publicar Python aplicativos de funções.
--csx Publicar um projeto de script (.csx) C#.
--dotnet-cli-params Quando você publica funções C# compiladas (.csproj), as ferramentas principais chamam dotnet build --output bin/publish. Todos os parâmetros passados para essa opção são acrescentados à linha de comando.
--dotnet-version Para dotnet-isolated aplicativos, especifica a versão de .NET de destino (por exemplo, 8.0).
--force Ignora a verificação de pré-publicação em determinados cenários.
--list-ignored-files Exibe uma lista de arquivos ignorados durante a publicação, com base no arquivo .funcignore .
--list-included-files Exibe uma lista de arquivos que são publicados, que se baseia no arquivo .funcignore .
--no-build Project não é criado durante a publicação. Para Python, pip install não é executado.
--nozip Transforma o padrão de Run-From-Package modo desativado. Extrai arquivos para a wwwroot pasta no servidor em vez de executá-los diretamente do pacote de implantação.
--overwrite-settings, -y Suprime o prompt para substituir as configurações do aplicativo quando você usa --publish-local-settings -i.
--publish-local-settings, -i Publica configurações em local.settings.json para Azure, solicitando a substituição se a configuração já existir. Se você estiver usando um emulador de armazenamento local, primeiro altere a configuração do aplicativo para uma conexão de armazenamento real.
--publish-settings-only, -o Publica apenas as configurações e ignora o conteúdo. O padrão é solicitado.
--show-keys Adiciona chaves de função às URLs exibidas nos logs.

func azure storage fetch-connection-string

Obtém o cadeia de conexão da conta de Armazenamento do Azure especificada.

func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>

Para obter mais informações, consulte acar um cadeia de conexão.

func azurecontainerapps deploy

Implanta um aplicativo de funções em contêineres em um ambiente Aplicativos de Contêiner do Azure. A conta padrão de armazenamento do host, o aplicativo de função e o ambiente já devem existir. Para obter mais informações, consulte Aplicativos de Contêiner do Azure hospedagem de Azure Functions.

func azurecontainerapps deploy --name <APP_NAME> --environment <ENVIRONMENT_NAME> --storage-account <STORAGE_CONNECTION> --resource-group <RESOURCE_GROUP> --image-name <IMAGE_NAME> --registry-server <REGISTRY_SERVER> --registry-username <USERNAME> --registry-password <PASSWORD>

As seguintes opções de implantação se aplicam:

Opção Descrição
--environment O nome de um ambiente de Aplicativos de Contêiner existente.
--image-build Defina para true ignorar o build local do Docker.
--image-name O nome de uma imagem de contêiner existente em um registro de contêiner, incluindo o nome da marca.
--location Região para a implantação. Idealmente, essa região é a mesma que os recursos de conta de ambiente e armazenamento.
--name O nome usado para a implantação do aplicativo de funções no ambiente de Aplicativos de Contêiner. Esse nome também aparece ao gerenciar o aplicativo de funções no portal. O nome deve ser exclusivo no ambiente.
--registry Quando definido, um build do Docker é executado e a imagem é enviada por push para o conjunto de registros em --registry. Não é possível usar --registry com --image-name. Para Docker Hub, use também --registry-username.
--registry-password A senha ou token usado para recuperar a imagem de um registro privado.
--registry-username O nome de usuário usado para recuperar a imagem de um registro privado.
--resource-group O grupo de recursos no qual criar os recursos relacionados a funções.
--storage-account O cadeia de conexão da conta de armazenamento a ser usada pelo aplicativo de funções.
--worker-runtime Define a linguagem de runtime do aplicativo de funções. Esse parâmetro é usado apenas com --image-name e --image-build; caso contrário, o idioma é determinado durante o build local. Os valores com suporte são: dotnet, , dotnetIsolated, node, python, powershelle custom (para manipuladores personalizados).

Importante

Cadeias de conexão de armazenamento e outras credenciais de serviço são segredos importantes. Armazene com segurança todos os arquivos de script que usam func azurecontainerapps deploy e não os armazenem em nenhum controle do código-fonte acessível publicamente.

func deploy

O func deploy comando foi preterido. Em vez disso, use func kubernetes deploy.

func bundles add

Adiciona a configuração do pacote de extensão ao arquivo host.json .

func bundles add

O func bundles add comando dá suporte a estas opções:

Opção Descrição
--force, -f Substituirá a configuração do pacote de extensão existente, se presente.
--channel, -c Canal de versão do pacote de extensão. Os valores com suporte são: GA (padrão) Previewe Experimental.

func bundles download

Baixa o pacote de extensão configurado no host.json.

func bundles download

O func bundles download comando dá suporte a estas opções:

Opção Descrição
--force, -f Força um redownload do pacote de extensão mesmo que ele já esteja presente.

func bundles list

Lista os pacotes de extensão baixados.

func bundles list

func bundles path

Obtém o caminho para o pacote de extensão baixado.

func bundles path

func durable delete-task-hub

Exclui todos os artefatos de armazenamento no hub de tarefas Durable Functions.

func durable delete-task-hub

O func durable delete-task-hub comando dá suporte a estas opções:

Opção Descrição
--connection-string-setting Nome da configuração que contém o cadeia de conexão de armazenamento a ser usado.
--task-hub-name Nome do hub de tarefas durável a ser usado.

Para obter mais informações, consulte a documentação Durable Functions.

func durable get-history

Retorna o histórico de uma instância de orquestração especificada.

func durable get-history --id <INSTANCE_ID>

O func durable get-history comando dá suporte a estas opções:

Opção Descrição
--id ID de uma instância de orquestração. (Obrigatória)
--connection-string-setting Nome da configuração que tem o cadeia de conexão de armazenamento a ser usado.
--task-hub-name Nome do hub de tarefas durável a ser usado.

Para obter mais informações, consulte a documentação Durable Functions.

func durable get-instances

Retorna o status de todas as instâncias de orquestração. Este comando suporta paginação usando o top parâmetro.

func durable get-instances

O func durable get-instances comando dá suporte a estas opções:

Opção Descrição
--continuation-token Token que indica uma página ou seção específica das solicitações a serem retornadas.
--connection-string-setting Nome da configuração do aplicativo que contém o cadeia de conexão de armazenamento a ser usado.
--created-after Obtenha as instâncias criadas após essa data e hora (UTC). Todos os datetimes no formato ISO 8601 são aceitos.
--created-before Obtenha as instâncias criadas antes de uma data e hora específicas (UTC). Todos os datetimes no formato ISO 8601 são aceitos.
--runtime-status Obtenha as instâncias cujo status corresponde a um status específico, incluindo running, completede failed. Você pode fornecer um ou mais status separados por espaço.
--top Limite o número de registros retornados em uma determinada solicitação.
--task-hub-name Nome do hub de tarefas Durable Functions a ser usado.

Para obter mais informações, consulte Durable Functions documentação.

func durable get-runtime-status

Retorna o status de uma instância de orquestração especificada.

func durable get-runtime-status --id <INSTANCE_ID>

O func durable get-runtime-status comando dá suporte a estas opções:

Opção Descrição
--connection-string-setting Nome da configuração que contém o cadeia de conexão de armazenamento a ser usado.
--id ID de uma instância de orquestração. (Obrigatória)
--show-input Quando definida, a resposta inclui a entrada da função.
--show-output Quando definido, a resposta inclui o histórico de execução.
--task-hub-name Nome do hub de tarefas Durable Functions a ser usado.

Para obter mais informações, consulte Durable Functions documentação.

func durable purge-history

Limpa o estado, o histórico e o armazenamento de blobs da instância de orquestração para orquestrações mais antigas do que o limite especificado.

func durable purge-history

O func durable purge-history comando dá suporte a estas opções:

Opção Descrição
--connection-string-setting Nome da configuração que contém o cadeia de conexão de armazenamento a ser usado.
--created-after Exclua o histórico de instâncias criadas após essa data/hora (UTC). Todos os valores de datetimes no formato ISO 8601 são aceitos.
--created-before Exclua o histórico de instâncias criadas antes desta data/hora (UTC). Todos os valores de datetimes no formato ISO 8601 são aceitos.
--runtime-status Exclua o histórico de instâncias cujo status corresponde a um status específico, incluindo completed, terminatede canceledfailed. Forneça um ou mais status separados por espaço. Se você não incluir --runtime-status, o histórico de instâncias será excluído, independentemente do status.
--task-hub-name Nome do hub de tarefas Durable Functions a ser usado.

Para obter mais informações, consulte a documentação Durable Functions.

func durable raise-event

Gera um evento para a instância de orquestração especificada.

func durable raise-event --event-name <EVENT_NAME> --event-data <DATA>

O func durable raise-event comando dá suporte a estas opções:

Opção Descrição
--connection-string-setting Nome da configuração que contém o cadeia de conexão de armazenamento a ser usado.
--event-data Dados a serem passados para o evento, embutidos ou de um arquivo JSON. Para arquivos, prefixe o caminho para o arquivo com um sinal (@), como @path/to/file.json. (Obrigatória)
--event-name Nome do evento a ser gerado. (Obrigatória)
--id ID de uma instância de orquestração. (Obrigatória)
--task-hub-name Nome do hub de tarefas Durable Functions a ser usado.

Para obter mais informações, consulte Durable Functions documentação.

func durable rewind

Retrocede a instância de orquestração especificada.

func durable rewind --id <INSTANCE_ID> --reason <REASON>

O func durable rewind comando dá suporte a estas opções:

Opção Descrição
--connection-string-setting Nome da configuração que contém o cadeia de conexão de armazenamento a ser usado.
--id ID de uma instância de orquestração. (Obrigatória)
--reason Motivo para retroceder a orquestração. (Obrigatória)
--task-hub-name Nome do hub de tarefas Durable Functions a ser usado.

Para obter mais informações, consulte Durable Functions documentação.

func durable start-new

Inicia uma nova instância de uma função de orquestrador especificada.

func durable start-new --id <INSTANCE_ID> --function-name <FUNCTION_NAME> --input <INPUT>

O func durable start-new comando dá suporte a estas opções:

Opção Descrição
--connection-string-setting Nome da configuração que contém o cadeia de conexão de armazenamento a ser usado.
--function-name Nome da função de orquestrador a ser iniciada. (Obrigatória)
--id Especifica a ID de uma instância de orquestração. (Obrigatória)
--input Entrada para a função de orquestrador, embutida ou de um arquivo JSON. Para arquivos, prefixe o caminho para o arquivo com um e comercial (@), como @path/to/file.json. (Obrigatória)
--task-hub-name Nome do hub de tarefas Durable Functions a ser usado.

Para obter mais informações, consulte Durable Functions documentação.

func durable terminate

Encerra a instância de orquestração especificada.

func durable terminate --id <INSTANCE_ID> --reason <REASON>

O func durable terminate comando dá suporte a estas opções:

Opção Descrição
--connection-string-setting Nome da configuração que contém o cadeia de conexão de armazenamento a ser usado.
--id Especifica a ID de uma instância de orquestração. (Obrigatória)
--reason Motivo para encerrar a orquestração. (Obrigatória)
--task-hub-name Nome do hub de tarefas Durable Functions a ser usado.

Para obter mais informações, consulte a documentação Durable Functions.

func extensions install

Instala manualmente as extensões do Functions em um projeto não .NET ou em um projeto de script C#.

func extensions install --package Microsoft.Azure.WebJobs.Extensions.<EXTENSION> --version <VERSION>

O func extensions install comando dá suporte a estas opções:

Opção Descrição
--configPath, -c Caminho do diretório que contém o arquivo extensions.csproj.
--csx Suporte a projetos de script C# (.csx).
--force, -f Atualize as versões das extensões existentes.
--output, -o Caminho de saída para as extensões.
--package, -p Identificador para um pacote de extensão específico. Quando não especificado, todas as extensões referenciadas são instaladas, como com func extensions sync.
--source, -s Fonte de feed do NuGet quando não estiver usando NuGet.org.
--version, -v Versão do pacote de extensão.

O exemplo a seguir instala a versão 5.0.1 da extensão dos Hubs de Eventos no projeto local:

func extensions install --package Microsoft.Azure.WebJobs.Extensions.EventHubs --version 5.0.1

Essas considerações se aplicam ao usar func extensions install:

  • Para projetos C# compilados (processo de trabalho em processo e isolado), use métodos de instalação padrão do pacote NuGet, como dotnet add package.

  • Para instalar manualmente as extensões usando o Core Tools, você deve ter o SDK .NET instalado.

  • Quando possível, você deve usar os pacotes de extensão. Aqui estão alguns motivos pelos quais talvez seja necessário instalar extensões manualmente:

    • Você precisa acessar uma versão específica de uma extensão não disponível em um pacote.
    • Você precisa acessar uma extensão personalizada não disponível em um pacote.
    • Você precisa acessar uma combinação específica de extensões não disponíveis em um único pacote.

  • Antes de instalar manualmente as extensões, primeiro você deve remover o extensionBundle objeto do arquivo host.json que define o pacote. Nenhuma ação é tomada quando um pacote de extensão já está definido em seu arquivo dehost.json .

  • Na primeira vez que você instala explicitamente uma extensão, um arquivo de projeto .NET chamado extensions.csproj é adicionado à raiz do projeto do aplicativo. Este arquivo define o conjunto de pacotes NuGet exigidos por suas funções. Embora você possa trabalhar com as referências do pacote NuGet neste arquivo, o Core Tools permite que você instale extensões sem ter que editar manualmente esse arquivo de projeto C#.

func extensions sync

Instala todas as extensões exigidas pelo seu aplicativo de funções.

O func extensions sync comando dá suporte a estas opções:

Opção Descrição
--configPath, -c Caminho do diretório que contém o extensions.csproj arquivo.
--csx Dá suporte a projetos de script C# (.csx).
--output, -o Caminho de saída para as extensões.

Regenera um arquivo faltante extensions.csproj . Não toma nenhuma ação quando um pacote de extensões é definido no seu host.json arquivo.

func kubernetes deploy

Implanta um projeto do Functions como um contêiner personalizado do Docker em um cluster do Kubernetes.

func kubernetes deploy

Este comando cria seu projeto como um contêiner personalizado e o publica em um cluster do Kubernetes. Os contêineres personalizados precisam ter um Dockerfile. Para criar um aplicativo com um Dockerfile, use a opção --docker com o comando func init.

O func kubernetes deploy comando dá suporte a estas opções:

Opção Descrição
--dry-run Exibe o modelo de implantação, sem execução.
--config-map-name Nome de um mapa de configuração existente com configurações de aplicativo de funções a serem usadas na implantação. Requer --use-config-map. O comportamento padrão é criar configurações com base no Values objeto no arquivo local.settings.json .
--cooldown-period O período de resfriamento (em segundos) depois que todos os gatilhos não estiverem mais ativos antes que a implantação seja redimensionada para zero, com um padrão de 300 s.
--ignore-errors Continue a implantação depois que um recurso retornar um erro. O comportamento padrão é parar mediante um erro.
--image-name O nome da imagem a ser usada para a implantação de pod e a partir do qual as funções são lidas.
--keda-version Defina a versão do KEDA a ser instalada. As opções válidas são: v1 e v2 (padrão).
--keys-secret-name O nome de uma coleção de segredos do Kubernetes a ser usada para armazenar chaves de acesso.
--max-replicas Defina a contagem máxima de réplicas para a qual o HPA (Dimensionador Automático de Pod Horizontal) é dimensionado.
--min-replicas Defina a contagem mínima de réplicas abaixo da qual o HPA não será dimensionado.
--mount-funckeys-as-containervolume Monte as chaves de acesso como um volume de contêiner.
--name O nome usado para a implantação e outros artefatos no Kubernetes.
--namespace Defina o namespace do Kubernetes para o qual implantar. O padrão é o namespace padrão.
--no-docker Leia funções do diretório atual em vez de de uma imagem. Requer a montagem do sistema de arquivos de imagem.
--registry Quando definido, um build do Docker é executado e a imagem é enviada por push para um registro desse nome. Não é possível usar --registry com --image-name. Para o Docker, use seu nome de usuário.
--polling-interval O intervalo de sondagem (em segundos) para verificação de gatilhos não-HTTP, com um padrão de 30s.
--pull-secret O segredo usado para acessar credenciais de registro particular.
--secret-name O nome de uma coleção de Segredos do Kubernetes existente que tem configurações de aplicativo de funções a serem usadas na implantação. O comportamento padrão é criar configurações com base no Values objeto no arquivo local.settings.json .
--show-service-fqdn Exiba as URLs de gatilhos HTTP com o FQDN do Kubernetes em vez do comportamento padrão de usar um endereço IP.
--service-type Defina o tipo de Serviço kubernetes. Os valores com suporte são ClusterIP, NodePort e LoadBalancer (padrão).
--use-config-map Use um objeto ConfigMap (v1) em vez de um objeto Secret (v1) para definir as configurações do aplicativo de funções. O nome do mapa é definido usando-se --config-map-name.
--use-git-hash-version Use o hash do Git como a versão para a imagem de contêiner.
--write-configs Gere as configurações do Kubernetes como arquivos YAML em vez de implantar.
--config-file Caminho do arquivo de saída ao usar --write-configs. Padrão: functions.yaml.
--hash-files Arquivos para hash para determinar a versão da imagem.
--image-build Quando definido como false, ignora o build do Docker.
--key-secret-annotations Anotações a serem adicionadas ao segredo de chaves, em key1=val1,key2=val2 formato.

O Core Tools usa a CLI do Docker local para criar e publicar a imagem. Verifique se o Docker já está instalado localmente. Execute o comando docker login para se conectar à sua conta.

Azure Functions dá suporte à hospedagem de suas funções em contêineres em Aplicativos de Contêiner do Azure ou em Azure Functions. Azure Functions não dá suporte oficialmente à execução de seus contêineres diretamente em um cluster do Kubernetes ou em AKS (Serviço de Kubernetes do Azure). Para obter mais informações, consulte Linux container support in Azure Functions.

func kubernetes delete

Exclui uma implantação do Functions de um cluster do Kubernetes.

func kubernetes delete --name <APP_NAME>

O func kubernetes delete comando dá suporte a estas opções:

Opção Descrição
--name O nome da implantação e outros artefatos no Kubernetes. (Obrigatória)
--namespace Defina o namespace do Kubernetes. O padrão é o default namespace.
--registry O nome do registro de contêiner.
--image-name A imagem a ser usada para a implantação do pod.
--keda-version Defina a versão do KEDA. As opções válidas são v1 e v2 (padrão).

func kubernetes install

Instala o KEDA em um cluster do Kubernetes

func kubernetes install

Instala o KEDA no cluster definido no arquivo de configuração kubectl.

O func kubernetes install comando dá suporte a estas opções:

Opção Descrição
--dry-run Exibe o modelo de implantação sem execução.
--keda-version Define a versão do KEDA a ser instalada. As opções válidas são: v1 e v2 (padrão).
--namespace Instala-se em um namespace específico do Kubernetes. Quando não definido, é usado o namespace padrão.

Para obter mais informações, consulte Gerenciamento de KEDA e funções no Kubernetes.

func kubernetes remove

Remove KEDA do cluster kubernetes definido no kubectl arquivo de configuração.

func kubernetes remove

Remove KEDA do cluster definido no kubectl arquivo de configuração.

O func kubernetes remove comando dá suporte a esta opção:

Opção Descrição
--namespace Desinstala de um namespace específico do Kubernetes. Quando não definido, é usado o namespace padrão.

Para obter mais informações, consulte Desinstalar o KEDA do Kubernetes.

func settings add

Adiciona uma nova configuração à coleção Values no arquivo local.settings.json.

func settings add <SETTING_NAME> <VALUE>

Substitua <SETTING_NAME> pelo nome da configuração do aplicativo.

O func settings add comando dá suporte a esta opção:

Opção Descrição
--connectionString Adiciona o par nome-valor à coleção ConnectionStrings em vez de à coleção Values. Use a ConnectionStrings coleção somente quando determinadas estruturas exigirem. Para obter mais informações, consulte local.settings.json arquivo.

func settings decrypt

Descriptografa valores criptografados na Values coleção no arquivo local.settings.json .

func settings decrypt

Esse comando também descriptografa cadeia de conexão valores na coleção ConnectionStrings. Em local.settings.json, o comando define IsEncrypted para false. Criptografe configurações locais para reduzir o risco de expor informações sensíveis de local.settings.json. Em Azure, as configurações do aplicativo são sempre armazenadas criptografadas.

func settings delete

Remove uma configuração existente da coleção Values no arquivo local.settings.json.

func settings delete <SETTING_NAME>

Substitua <SETTING_NAME> pelo nome da configuração do aplicativo e <VALUE> pelo valor da configuração.

O func settings delete comando dá suporte a esta opção:

Opção Descrição
--connectionString Remove o par nome-valor da ConnectionStrings coleção em vez da Values coleção.

func settings encrypt

Criptografa os valores de itens individuais na coleção Values no arquivo local.settings.json.

func settings encrypt

O comando também criptografa valores de cadeia de conexão na ConnectionStrings coleção. Em local.settings.json, o comando define IsEncrypted para true, que especifica que o tempo de execução local descriptografa as configurações antes de usá-las. Criptografe configurações locais para reduzir o risco de expor informações sensíveis de local.settings.json. Em Azure, as configurações do aplicativo são sempre armazenadas como criptografadas.

func settings list

Produz como saída uma lista de configurações à coleção Values no arquivo local.settings.json.

func settings list

A saída também inclui cadeias de conexão da ConnectionStrings coleção. Por padrão, o comando mascara valores para segurança. Use a opção --showValue para exibir o valor real.

O func settings list comando dá suporte a esta opção:

Opção Descrição
--showValue, -a Mostrar os valores reais desmascarados na saída.

func templates list

Lista os modelos de função (gatilho) disponíveis.

O func templates list comando dá suporte a esta opção:

Opção Descrição
--language, -l Linguagem para a qual filtrar os modelos retornados. Retorna todos os idiomas por padrão.

Opções globais

A maioria dos comandos Core Tools suporta estas opções:

Opção Descrição
--script-root Define o diretório raiz do aplicativo de funções e altera o diretório de trabalho do comando.
--verbose Habilita a saída detalhada para registro em log detalhado. Nem todos os comandos suportam essa opção.
--offline É executado no modo offline, sem fazer chamadas de rede externas. Os func startcomandos , func init, e func new suportam essa opção. Você também pode configurá-lo através da FUNCTIONS_CORE_TOOLS_OFFLINE variável ambiente.
--version, -v Exibe a versão do Azure Functions Core Tools.
--help, -h Exibe informações de ajuda.
--pause-on-error Pausa para entrada adicional antes de sair do processo. Essa opção é útil quando você inicia as Ferramentas Centrais a partir de um ambiente de desenvolvimento integrado (IDE).

A maioria dos comandos suporta estas opções:

Opção Descrição
--help, -h Exiba ajuda para o comando.
--version Exiba a versão CLI do Azure Functions. Use --verbose para --version obter informações detalhadas sobre a construção.
--verbose Habilite a saída detalhada. Propaga-se para todos os subcomandos. Quando passado pela raiz sem subcomando, imprime informações detalhadas de build, runtime, sistema operacional e arquitetura.

Cargas de trabalho disponíveis

Corra func workload search para ver o catálogo atual. As seguintes cargas de trabalho estão atualmente disponíveis:

Name Descrição
host O tempo de execução Azure Functions host usado por func run.
bundles Instale pacotes de extensões, que permitem todas as extensões de binding. Use essa carga de trabalho para qualquer stack que não seja .NET. Projetos .NET não usam essa carga de trabalho. Em vez disso, eles referenciam extensões diretamente em seus projetos.
dotnet Ferramentas CLI do Azure Functions para projetos .NET (C#, F#). Também contribui com templates para func quickstart. .NET não requer uma carga de trabalho separada para o trabalhador, porque o trabalhador faz parte do próprio projeto compilado.
dotnet-templates Modelos de andaimes de funções para projetos de trabalhadores isolados em .NET.
python Ferramentas de CLI do Azure Functions para projetos em Python. Também contribui com templates para func quickstart.
python-worker O worker da linguagem Python usado pelo host de Functions.
python-templates Modelos de andaime de funções para Python (modelos de programação v1 e v2).
node Azure Functions ferramentas de CLI para projetos Node.js (JavaScript, TypeScript). Também contribui com templates para func quickstart.
node-worker O trabalhador da linguagem Node.js usado pelo host de Funções.
node-templates Modelos de andaime de funções para Node.js (JavaScript, TypeScript).
go Ferramentas de CLI do Azure Functions para projetos Go. Também contribui com templates para func quickstart.
go-worker O worker da linguagem Go usado pelo host de Funções.

Observação

Nem todas as pilhas de linguagem de Functions estão atualmente disponíveis como cargas de trabalho. As pilhas de Java e PowerShell atualmente não são suportadas na CLI do Azure Functions.

  • Last updated on