Compartilhar via

Referência para o Azure Functions Core Tools

Este artigo fornece documentação de referência para as Ferramentas Principais do Azure Functions. Com esse runtime local e ferramentas de linha de comando, você pode desenvolver, gerenciar e implantar projetos do Azure Functions do computador local. Para saber mais sobre o uso do Core Tools, confira Trabalhar com o 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 do Azure, incluindo a publicação.
func azurecontainerapps Implante o aplicativo de funções em contêiner nos Aplicativos de Contêiner do Azure.
func durable Comandos para trabalhar com o Durable Functions.
func extensions Comandos para instalar e gerenciar extensões.
func kubernetes Comandos para trabalhar com o Kubernetes e com o Azure Functions.
func settings Comandos para gerenciar configurações de ambiente para o host do Functions local.
func templates Comandos para listar modelos de função disponíveis.

Antes de usar os comandos neste artigo, você deve instalar o Core Tools.

func init

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

func init <PROJECT_FOLDER>

Quando você fornece <PROJECT_FOLDER>, o projeto é criado em uma nova pasta com esse nome. Caso contrário, será usada a pasta atual.

func init é compatível com as seguintes opções, que não são compatíveis com a versão 1.x, salvo indicação ao contrário:

Opção Descrição
--csx Cria funções do .NET como o script de C#, que é o comportamento da versão 1.x. Válido somente com --worker-runtime dotnet.
--docker Cria um Dockerfile para um contêiner usando uma imagem base que se baseia no --worker-runtime escolhido. 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 runtime de trabalho se não for especificado nem estiver 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 Inicializa um projeto específico de uma linguagem. Atualmente há suporte quando --worker-runtime está 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. No momento, somente o runtime de trabalho do PowerShell dá suporte a essa funcionalidade.
--model Define o modelo de programação desejado para uma linguagem 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, confira o Guia do desenvolvedor Python e o Guia do desenvolvedor Node.js, respectivamente.
--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(nodepadrões para JavaScript), powershelle pythontypescript. Para Java, use o 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.0e net48 (.NET Framework 4.8).

Observação

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

func logs

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

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

A ação func logs oferece suporte para as seguintes opções:

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

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

func new

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

func new

Ao executar func new sem a opção --template, você será solicitado a escolher um modelo. Na versão 1.x, você deve usar a opção --language para definir o idioma.

A ação func new oferece suporte para as seguintes opções:

Opção Descrição
--authlevel Defina o nível de autorização para 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, consulte Nível de autorização.
--csx Gera os mesmos modelos de script C# (.csx) usados pela versão 1.x e no editor do portal.
--language, -l Reguired somente na versão 1.x. Em todas as outras versões, o idioma é definido pelo --worker-runtime valor passado para func init.
--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 saber mais, consulte Criar uma função.

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.

func pack

Execute func pack no diretório que contém o host.json arquivo de projeto, que é o diretório raiz do seu aplicativo. O arquivo de saída gerado (.zip) tem o mesmo nome da pasta que você está empacotando. Se já existir um arquivo .zip com esse nome, ele será excluído primeiro e substituído por uma versão atualizada.

Por padrão, func pack compila e empacota o projeto functions no diretório no qual ele é executado. Você pode executar para empacotar func pack um diretório diferente definindo o caminho para a raiz do projeto após o comando, como func pack ./myprojectroot. Quando o diretório em que func pack as execuções não contêm um host.json arquivo, um erro é retornado.

Por padrão, func pack cria todos os projetos e instala dependências para todos os idiomas. Use o e --skip-install as --no-build opções para modificar esse comportamento.

Importante

Os pacotes de aplicativos Python criados em um computador Windows geralmente têm problemas ao serem implantados e executados no Linux no Azure Functions. Considere usar --no-build com um build remoto ou --build-native-deps ao executar func pack um aplicativo Python no Windows.

A func pack ação dá suporte a estas opções:

Opção Descrição
--output Define um caminho para o local no qual a implantação .zip arquivo de pacote é criada.
--no-build O projeto não é criado antes do empacotamento. 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. Você pode usar essa opção ao solicitar um build remoto no conteúdo do pacote.
--skip-install Ignora a execução npm install ao empacotar Node.jsaplicativo de funções baseado. Use essa opção para evitar a substituição de módulos npm personalizados.
--build-native-deps Instala as dependências do Python localmente usando uma imagem que corresponde ao ambiente usado no Azure, que requer ferramentas do Docker. 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 no Windows como uma maneira de evitar possíveis problemas de biblioteca quando implantado no Linux no Azure.

func run

Versão 1.x, somente.

Use este comando para invocar uma função diretamente. Esse comando funciona como executar uma função usando a guia Teste no portal do Azure. Esse comando funciona apenas na versão 1.x. Para versões posteriores, use func start e chame o ponto de extremidade de função diretamente.

func run

O func run comando dá suporte às seguintes 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 ativada por HTTP e passar o corpo do conteúdo, execute o seguinte 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

func start dá suporte para as seguintes 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 Permita solicitações autenticadas de origem cruzada usando cookies e cabeçalho de autenticação.
--dotnet-isolated-debug Quando definido como true, pausa o processo de trabalho do .NET até que um depurador seja anexado do projeto isolado do .NET que esteja sendo depurado.
--enable-json-output Emite logs do console como JSON, quando possível.
--enableAuth Habilite o pipeline de manipulação de autenticação completa, com requisitos de autorização.
--functions Uma lista separada por espaços de funções a serem carregadas.
--language-worker Argumentos para configurar o trabalhador de idioma. Por exemplo, você pode habilitar a depuração para o trabalho de linguagem fornecendo a porta de depuração e outros argumentos necessários.
--no-build Não compile o projeto atual antes da execução. Somente para projetos de classe do .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 A porta local na qual escutar. Valor Padrão: 7071.
--timeout 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.

Com o projeto em execução, você pode verificar pontos de extremidade de função individuais.

func azure functionapp opções globais

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

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

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 Download configurações de aplicativo.

O comando baixa as configurações no local.settings.json arquivo do projeto. O comando mascara valores na tela para segurança. Você pode proteger as configurações no arquivo habilitando alocal.settings.json criptografia local.

func azure functionapp list-functions

Retorna uma lista das funções no aplicativo de funções especificado.

func azure functionapp list-functions <APP_NAME>
Opção Descrição
--show-keys As URLs do ponto de extremidade de função retornadas incluem valores de chave de acesso no nível da função.

func azure functionapp logstream

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

func azure functionapp logstream <APP_NAME>

O tempo limite padrão para a conexão é de duas horas. Você pode alterar o tempo limite adicionando uma configuração de aplicativo chamada SCM_LOGSTREAM_TIMEOUT, com um valor de tempo limite em segundos. Esse recurso ainda não tem suporte para Linux em um plano deconsumo ou consumo flex. Para esses aplicativos, use a opção --browser para exibir logs no Portal.

A ação deploy oferece suporte para as seguintes opções:

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

Para obter mais informações, confira Habilitar logs de execução de streaming no Azure Functions.

func azure functionapp publish

Implanta um projeto do Functions em um recurso do aplicativo de função 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 a ação de build ao fazer a implantação em um aplicativo de funções do Linux. Aceita: remote e local.
--build-native-deps Ignora a geração da pasta .wheels durante a publicação de aplicativos de funções Python.
--csx Publicar um projeto de script (.csx) C#.
--dotnet-cli-params Ao publicar funções compiladas em C# (. csproj), as ferramentas principais chamam dotnet build --output bin/publish. Todos os parâmetros passados para ele serão acrescentados à linha de comando.
--force Ignorar verificação de pré-publicação em determinados cenários.
--list-ignored-files Exibe uma lista de arquivos que são ignorados durante a publicação, que é baseada no arquivo .funcignore.
--list-included-files Exibe uma lista de arquivos que são publicados, que é baseada no arquivo .funcignore.
--no-build O projeto 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.
--overwrite-settings -y Suprima o prompt para substituir as configurações do aplicativo quando --publish-local-settings -i for usado.
--publish-local-settings -i Configurações de publicação em local.settings.json do Azure, a solicitação para substituir se a configuração já existe. 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 Somente publicar as configurações e ignorar o conteúdo. O padrão é solicitado.

func azure storage fetch-connection-string

Define a cadeia de conexão para uma conta de Armazenamento do Azure especificada.

func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>

Para obter mais informações, confira Baixar uma cadeia de conexão de armazenamento.

func azurecontainerapps deploy

Implanta um aplicativo de funções em contêiner em um ambiente de Aplicativos de Contêiner do Azure. A conta de armazenamento usada pelo aplicativo de funções e pelo ambiente já deve existir. Para obter mais informações, consulte Aplicativos de Contêiner do Azure que hospedam o 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 Quando definido como true, ignora o build local do Docker.
--image-name O nome da imagem de um contêiner existente em um registro de contêiner. O nome da imagem inclui o nome da marca.
--location Região para a implantação. Idealmente, essa região é a mesma região 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 mesmo nome também é usado no gerenciamento do 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, também use --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 A cadeia de conexão para a 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 será determinado durante o build local. Os valores com suporte são: dotnet, dotnetIsolated, node, python, powershell e custom (para manipuladores de clientes).

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 armazene 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 durable delete-task-hub

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

func durable delete-task-hub

A ação delete-task-hub oferece suporte para as seguintes opções:

Opção Descrição
--connection-string-setting Nome opcional da configuração que contém a cadeia de caracteres de conexão de armazenamento a ser usada.
--task-hub-name Nome opcional do Hub de Tarefas do Durable a ser usado.

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

func durable get-history

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

func durable get-history --id <INSTANCE_ID>

A ação get-history oferece suporte para as seguintes opções:

Opção Descrição
--id Especifica a ID de uma instância de orquestração (obrigatória).
--connection-string-setting Nome opcional da configuração que contém a cadeia de caracteres de conexão de armazenamento a ser usada.
--task-hub-name Nome opcional do Hub de Tarefas do Durable a ser usado.

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

func durable get-instances

Retorna o status de todas as instâncias de orquestração. Dá suporte à paginação usando o top parâmetro.

func durable get-instances

A ação get-instances oferece suporte para as seguintes opções:

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

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

func durable get-runtime-status

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

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

A ação get-runtime-status oferece suporte para as seguintes opções:

Opção Descrição
--connection-string-setting Nome opcional da configuração que contém a cadeia de caracteres de conexão de armazenamento a ser usada.
--id Especifica a ID de uma instância de orquestração (obrigatória).
--show-input Quando definido, a resposta conterá a entrada da função.
--show-output Quando definido, a resposta contém o histórico de execução.
--task-hub-name Opcionalmente, forneça um nome ao hub de tarefas do Durable Functions a ser usado.

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

func durable purge-history

Limpe o estado da instância de orquestração, o histórico e o armazenamento de BLOBs para orquestrações anteriores ao limite especificado.

func durable purge-history

A ação purge-history oferece suporte para as seguintes opções:

Opção Descrição
--connection-string-setting Nome opcional da configuração que contém a cadeia de caracteres de conexão de armazenamento a ser usada.
--created-after Opcionalmente, 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 Opcionalmente, exclua o histórico de instâncias criadas antes dessa data/hora (UTC). Todos os valores de datetimes no formato ISO 8601 são aceitos.
--runtime-status Opcionalmente, exclua o histórico das instâncias cujo status corresponde a um status específico, incluindo completed, terminated, canceled e failed. Você pode fornecer 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 Opcionalmente, forneça um nome ao hub de tarefas do Durable Functions a ser usado.

Para saber mais, confira a Documentação do 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>

A ação raise-event oferece suporte para as seguintes opções:

Opção Descrição
--connection-string-setting Nome opcional da configuração que contém a cadeia de caracteres de conexão de armazenamento a ser usada.
--event-data Dados a serem passados para o evento, seja em linha ou de um arquivo JSON (obrigatório). Para arquivos, insira um prefixo no caminho para o arquivo com um “e” comercial (@), como @path/to/file.json.
--event-name Nome do evento a ser gerado (obrigatório).
--id Especifica a ID de uma instância de orquestração (obrigatória).
--task-hub-name Opcionalmente, forneça um nome ao hub de tarefas do Durable Functions a ser usado.

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

func durable rewind

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

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

A ação rewind oferece suporte para as seguintes opções:

Opção Descrição
--connection-string-setting Nome opcional da configuração que contém a cadeia de caracteres de conexão de armazenamento a ser usada.
--id Especifica a ID de uma instância de orquestração (obrigatória).
--reason O motivo para retroceder a orquestração (obrigatório).
--task-hub-name Opcionalmente, forneça um nome ao hub de tarefas do Durable Functions a ser usado.

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

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>

A ação start-new oferece suporte para as seguintes opções:

Opção Descrição
--connection-string-setting Nome opcional da configuração que contém a cadeia de caracteres de conexão de armazenamento a ser usada.
--function-name O nome da função de orquestrador a ser iniciada (obrigatório).
--id Especifica a ID de uma instância de orquestração (obrigatória).
--input Entrada para o orquestrador de função, seja em linha ou de um arquivo JSON (obrigatório). Para arquivos, insira um prefixo no caminho para o arquivo com um “e” comercial (@), como @path/to/file.json.
--task-hub-name Opcionalmente, forneça um nome ao hub de tarefas do Durable Functions a ser usado.

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

func durable terminate

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

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

A ação terminate oferece suporte para as seguintes opções:

Opção Descrição
--connection-string-setting Nome opcional da configuração que contém a cadeia de caracteres de conexão de armazenamento a ser usada.
--id Especifica a ID de uma instância de orquestração (obrigatória).
--reason O motivo para interromper a orquestração (obrigatório).
--task-hub-name Opcionalmente, forneça um nome ao hub de tarefas do Durable Functions a ser usado.

Para obter mais informações, consulte a documentação do 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>

A ação install oferece suporte para as seguintes opções:

Opção Descrição
--configPath Caminho do diretório que contém o arquivo extensions.csproj.
--csx Dá suporte a projetos de script C# (.csx).
--force Atualize as versões das extensões existentes.
--output Caminho de saída para as extensões.
--package 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 Fonte de feed do NuGet quando não estiver usando NuGet.org.
--version 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

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

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

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

  • Quando possível, use pacotes de extensão. Veja a seguir alguns motivos pelos quais você pode precisar instalar extensões manualmente:

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

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

  • Ao instalar pela primeira vez explicitamente uma extensão, um arquivo de projeto .NET denominado extensions.csproj é adicionado à raiz do projeto de 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 que você adiciona ao aplicativo de funções.

A ação sync oferece suporte para as seguintes opções:

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

Regenera um arquivo extensions.csproj ausente. Se você definir um pacote de extensão em seu arquivo de host.json, nenhuma ação será tomada.

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 --dockerfile com o comando func init.

As seguintes opções de implantação do Kubernetes estão disponíveis:

Opção Descrição
--dry-run Opcionalmente, exibe o modelo de implantação, sem execução.
--config-map-name Nome opcional de um mapa de configuração existente com configurações do aplicativo de funções para ser usado na implantação. Requer --use-config-map. O comportamento padrão é criar configurações com base no objeto Values no arquivo local.settings.json.
--cooldown-period O período de resfriamento (em segundos) depois que todos os gatilhos não estejam mais ativos antes de a implantação ser redimensionada novamente para zero, com um padrão de 300s.
--ignore-errors Continua a implantação depois que um recurso retorna 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 Define 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 Define a contagem máxima de réplicas para as quais o dimensionamento automático do Pod horizontal (HPA) é dimensionado.
--min-replicas Define a contagem mínima de réplicas abaixo da qual o HPA não dimensionará.
--mount-funckeys-as-containervolume Monta as teclas de acesso como um volume de contêiner.
--name O nome usado para a implantação e outros artefatos no Kubernetes.
--namespace Define o namespace do Kubernetes a ser implantado, cujo padrão é o namespace padrão.
--no-docker As funções são lidas do diretório atual em vez de uma imagem. Requer a montagem do sistema de arquivos de imagem.
--registry Quando definido, uma compilação do Docker é executada 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 existente de segredos do Kubernetes que contenha as configurações do aplicativo de funções a serem usadas na implantação. O comportamento padrão é criar configurações com base no objeto Values no arquivo local.settings.json.
--show-service-fqdn Exibe as URLs dos gatilhos HTTP com o FQDN do Kubernetes em vez do comportamento padrão de usar um endereço IP.
--service-type Define o tipo de serviço do 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.

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.

O Azure Functions dá suporte à hospedagem de suas funções em contêineres nos Aplicativos de Contêiner do Azure ou no Azure Functions. A execução de contêineres diretamente em um cluster do Kubernetes ou no AKS (Serviço de Kubernetes do Azure) não tem suporte oficial do Azure Functions. Para saber mais, confira Suporte a contêiner do Linux no Azure Functions.

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.

A ação install oferece suporte para as seguintes 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 Dá suporte à instalação em um namespace do Kubernetes específico. 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 o KEDA do cluster do Kubernetes definido no arquivo de configuração kubectl.

func kubernetes remove

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

A ação remove oferece suporte para as seguintes opções:

Opção Descrição
--namespace Dá suporte à desinstalação de um namespace do Kubernetes específico. Quando não definido, é usado o namespace padrão.

Para saber mais, confira Desinstalação do 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 e <VALUE> pelo valor da configuração.

A ação add oferece suporte para a seguinte opção:

Opção Descrição
--connectionString Adiciona o par nome-valor à coleção ConnectionStrings em vez de à coleção Values. Use apenas a coleção ConnectionStrings quando exigido por determinadas estruturas. Para saber mais, confira o arquivo local.settings.json.

func settings decrypt

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

func settings decrypt

O comando também descriptografa valores de cadeia de conexão na ConnectionStrings coleção. No local.settings.json, o comando define IsEncrypted como false. Criptografe as configurações locais para reduzir o risco de vazar informações valiosas do arquivo local.settings.json. No Azure, as configurações de aplicativo sempre são 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.

A ação delete oferece suporte para a seguinte opção:

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

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 é definido IsEncrypted como true, que especifica que o runtime local descriptografa as configurações antes de usá-las. Criptografe as configurações locais para reduzir o risco de vazar informações valiosas do arquivo local.settings.json. No Azure, as configurações de aplicativo sempre são armazenadas criptografadas.

func settings list

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

func settings list

As cadeias de conexão da coleção ConnectionStrings também são saídas. Por padrão, os valores são mascarados por segurança. Use a opção --showValue para exibir o valor real.

A ação list oferece suporte para a seguinte opção:

Opção Descrição
--showValue Mostra os valores reais não mascarados na saída.

func templates list

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

A ação list oferece suporte para a seguinte opção:

Opção Descrição
--language Linguagem para a qual filtrar os modelos retornados. O padrão é retornar todas as linguagens.
  • Last updated on