Compartilhar via

Referência do Azure Functions Core Tools

Este artigo fornece documentação de referência para o Azure Functions Core Tools, que permite desenvolver, gerenciar e implantar projetos Azure Functions do computador local. 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.

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.

O func init comando dá suporte a essas opções, que não têm suporte na versão 1.x, a menos que indicado de outra forma:

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 funções como script 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 com base no 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 a opção --configuration-profile , um conjunto predefinido de configurações e configurações de projeto é criado. 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 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 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ê também precisa escolher o idioma.

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

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 (Versão 2.x e posteriores) Gera os mesmos modelos C# (.csx) de script usados na versão 1.x 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.
--language, -l A linguagem de programação de modelo, como C# ou JavaScript. Essa opção é necessária na versão 1.x. Na versão 2.x e versões posteriores, não use essa opção porque o idioma é definido pelo runtime de trabalho.
--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 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 [<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.
--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

Versão 1.x, somente.

Permite invocar uma função diretamente, que é semelhante à execução de uma função usando a guia Test no portal Azure. Essa ação só tem suporte 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 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 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.

As configurações são baixadas no arquivo local.settings.json do projeto. Os valores na tela são mascarados por segurança. Você pode proteger as configurações nos arquivo local.settings.json habilitando 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 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 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. 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. Esse comando dá suporte à paginação com 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 adicionadas ao 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 arquivo extensions.csproj.
--csx Dá suporte a projetos de script C# (.csx).
--output, -o Caminho de saída para as extensões.

Regenera um arquivo extensions.csproj ausente. Não executa nenhuma ação quando um pacote de extensão é definido em seu arquivo de host.json.

func kubernetes deploy

Implanta um projeto do Functions como um contêiner do Docker personalizado 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.

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. No local.settings.json, IsEncrypted também é definido como false. Criptografe as configurações locais para reduzir o risco de vazar informações valiosas do arquivo 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

Os valores de cadeia de conexão na coleção ConnectionStringstambém são criptografados. No local.settings.json, IsEncrypted também é definido como true, que especifica que o runtime local descriptografará 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. 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, os valores são mascarados por segurança. Você pode usar 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

Essas opções estão disponíveis para a maioria dos comandos do Core Tools:

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. Não há suporte para todos os comandos.
--offline É executado no modo offline, sem fazer chamadas de rede externas. Com suporte por func start, func inite func new. Também pode ser definido por meio da variável de FUNCTIONS_CORE_TOOLS_OFFLINE 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. Útil ao iniciar o Core Tools de um IDE (ambiente de desenvolvimento integrado).
  • Last updated on