Partilhar via

Referência ao Funções do Azure Core Tools

Este artigo fornece documentação de referência para as Funções do Azure Core Tools, que lhe permitem desenvolver, gerir e implementar projetos Funções do Azure a partir do seu computador local. Para saber mais sobre o uso das Ferramentas Core, veja Trabalhar com Funções do Azure Ferramentas Core.

Os comandos das Ferramentas Principais são organizados nos seguintes contextos, cada um fornecendo um conjunto exclusivo de ações.

Contexto do comando Descrição
func Comandos para criar e executar funções no seu computador local.
func azure Comandos para trabalhar com recursos do Azure, incluindo publicação.
func azurecontainerapps Comandos para implementar uma function app containerizada para Azure Container Apps.
func bundles Comandos para gerir pacotes de extensão.
func durable Comandos para trabalhar com Durable Functions.
func extensions Comandos para instalar e gerir extensões.
func kubernetes Comandos para trabalhar com Kubernetes e Funções do Azure.
func settings Comandos para gerir as definições de ambiente do anfitrião local das Funções.
func templates Comandos para listar modelos de funções disponíveis.

Antes de usar os comandos deste artigo, instale as Ferramentas Core.

func init

Cria um novo projeto 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, a pasta atual será usada.

O func init comando suporta estas opções, que não são suportadas na versão 1.x, salvo indicação em contrário:

Opção Descrição
--bundles-channel, -c Canal de libertação do pacote de extensão. Os valores suportados são: GA (por defeito), Preview, e Experimental. Aplicável apenas a projetos que não sejam .NET.
--configuration-profile Inicializa um projeto com um perfil de configuração de anfitrião. A --configuration-profile opção está atualmente em pré-visualização. Para mais informações, consulte Perfis de Configuração.
--csx Cria funções .NET como script C#, que é o comportamento da versão 1.x. Válido apenas com --worker-runtime dotnet.
--docker Cria um Dockerfile para um contentor usando uma imagem base baseada no .--worker-runtime Use essa opção quando planejar implantar um aplicativo de função em contêiner.
--docker-only Adiciona um Dockerfile a um projeto existente. Prompts para o worker-runtime, se não for especificado ou definido em local.settings.json. Use essa opção quando planejar implantar um aplicativo de função em contêiner e o projeto já existir.
--force Inicialize o projeto mesmo quando houver arquivos existentes no projeto. Essa configuração substitui arquivos existentes com o mesmo nome. Outros arquivos na pasta do projeto não são afetados.
--language, -l Inicializa um projeto específico do idioma. Atualmente suportado quando --worker-runtime está definido para 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, apenas o runtime worker do PowerShell suporta esta funcionalidade.
--model, -m Define o modelo de programação para uma língua-alvo quando há mais do que um modelo disponível. As opções suportadas são V1 e V2 para Python, e V3 e V4 para Node.js. Para mais informações, consulte o guia para desenvolvedores Python e o guia para desenvolvedores Node.js.
--no-bundle Não configures o pacote de extensões em host.json. Aplicável apenas a projetos que não sejam .NET.
--no-docs Ignora a geração dos ficheiros de documentação "Como Começar". Aplicável a projetos em Python.
--skip-npm-install Evita a corrida 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, um repositório não é criado. Quando trueo , um repositório é criado.
--worker-runtime Define o tempo de execução da linguagem para o projeto. Os valores suportados são: csharp, dotnet, dotnet-isolated, javascript, ( node JavaScript), powershell, python, e typescript. Para Java, usa Maven. Para gerar um projeto independente de linguagem apenas com os arquivos de projeto, use custom. Quando não estiver definido, você será solicitado a escolher seu tempo de execução durante a inicialização.
--target-framework Define a estrutura de destino para o projeto de aplicativo de função. Válido apenas com --worker-runtime dotnet-isolated. Os valores suportados são: net10.0 (pré-visualização), net9.0, net8.0 (padrão), net6.0 e net48 (.NET Framework 4.8).

Nota

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

Perfis de configuração

Importante

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

Quando usa a --configuration-profile opção, é criado um conjunto pré-definido de configurações e definições do projeto. Quando especifica um perfil de configuração, a inicialização pode saltar todas as outras etapas de inicialização.

Valor do perfil Descrição Ações específicas
mcp-custom-handler Cria um projeto que utiliza handlers personalizados para alojar um servidor MCP (Model Context Protocol) ao qual agentes de IA e outros clientes MCP podem ligar-se. • Configura o "configurationProfile": "mcp-custom-handler" elemento no ficheirohost.json com definições específicas de handler personalizados.
• 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 suporta estas opções:

Opção Descrição
--platform Plataforma de hospedagem para o aplicativo de função. Opções válidas: kubernetes.
--name Nome da aplicação de função no Azure.

Para mais informações, consulte Funções do Azure no Kubernetes com KEDA.

func new

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

func new

Quando você executa func new sem a --template opção, você é solicitado a escolher um modelo. Na versão 1.x, também tens de escolher a linguagem.

O func new comando suporta estas opções:

Opção Descrição
--authlevel, -a Define o nível de autorização para um gatilho HTTP. Os valores suportados são: function, anonymous, admin. A autorização não é imposta quando executada localmente. Para obter mais informações, consulte Nível de autorização.
--csx (Versão 2.x e versões posteriores.) Gera os mesmos modelos de script C# (.csx) usados na versão 1.x e no portal.
--file, -f O ficheiro alvo da nova função. Para Python projetos v2, especifica o ficheiro a adicionar a função (por defeito é function_app.py). Para Node.js projetos v4, especifica o nome do ficheiro de saída na src/functions pasta. Não aplicável a projetos .NET compilados.
--language, -l A linguagem de programação template, como C# ou JavaScript. Esta opção é necessária na versão 1.x. Na versão 2.x e versões posteriores, não use esta opção porque a linguagem é definida 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 suportado.

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

func pack

Cria um pacote de implementação que contém o código do seu projeto num estado executável. Use este método quando precisar de criar manualmente um pacote de deployment para a sua aplicação no seu computador local, fora do func azure functionapp publish comando. Por defeito, func pack constrói o teu projeto quando necessário.

func pack [<FOLDER_PATH>]

Por defeito, func pack embala o diretório atual, e o ficheiro de .zip de saída tem o mesmo nome da pasta raiz do teu projeto. Executa func pack no diretório que contém o teu ficheiro de projetohost.json . Se precisares de correr func pack noutro diretório, define <FOLDER_PATH> como caminho para a raiz do projeto, como func pack ./myprojectroot. Se o ficheiro .zip específico já existir, primeiro é eliminado e depois substituído por uma versão atualizada.

O func pack comando suporta estas opções:

Opção Descrição
--output, -o Define o caminho para o local onde o ficheiro de implementação .zip pacote é criado.
--no-build O Project não é construído antes de embalar. Para aplicações C#, usa apenas quando já geraste os teus binários. Para Node.js apps, tanto npm install como npm run build são ignorados.
--skip-install Ignora a corrida npm install ao empacotar Node.jsaplicação baseada em funções. Usado para evitar sobrescrever módulos npm personalizados.
--build-native-deps Instala dependências de Python localmente usando uma imagem que corresponde ao ambiente usado no Azure. Quando ativado, o Core Tools inicia um contentor Docker, constrói a aplicação dentro desse container e cria um ficheiro .zip com todas as dependências restauradas em .python_packages. Use esta opção ao correr no Windows para evitar potenciais problemas de biblioteca ao implementar para Linux no Azure.

func run

Apenas versão 1.x.

Permite invocar uma função diretamente, o que é semelhante a executar uma função usando o separador Test no portal Azure. Esta ação só é suportada na versão 1.x. Para versões posteriores, use func start e chame o ponto de extremidade da função diretamente.

func run

O func run comando suporta estas opções:

Opção Descrição
--content Conteúdo embutido passado para a função.
--debug Anexe um depurador ao processo do 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 para esperar (em segundos) até que o host local do Functions esteja pronto.

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

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

func start

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

O comando específico depende da versão do tempo de execução.

func start

O func start comando suporta estas opções:

Opção Descrição
--cert O caminho para um arquivo .pfx que contém uma chave privada. Suportado apenas com --useHttps.
--cors Uma lista separada por vírgulas das origens do CORS, sem espaços.
--cors-credentials Permite pedidos autenticados de origem cruzada que utilizam cookies e o cabeçalho de Autenticação.
--dotnet-isolated-debug Quando definido para true, pausa o processo .NET worker até que um depurador seja associado do projeto .NET isolado que está a ser depurado.
--enable-json-output Emite registos de consola como JSON sempre que possível.
--enableAuth Permite o pipeline completo de gestão de autenticação com requisitos de autorização.
--functions Uma lista separada por espaços de funções a carregar.
--json-output-file Se fornecido, um caminho para o ficheiro usado para escrever a saída ao usar --enable-json-output.
--language-worker Argumentos para configurar o trabalhador de linguagem. Por exemplo, pode ativar a depuração para language worker fornecendo a porta debug e outros argumentos necessários.
--no-build Não crie o projeto atual antes de ser executado. Apenas para projetos de classe .NET. A predefinição é false.
--password A senha ou um arquivo que contém a senha para um arquivo .pfx. Utilizado apenas com --cert.
--port, -p O porto local para ouvir. Valor padrão: 7071.
--runtime Define qual versão do host começar. Os valores permitidos são: inproc6, inproc8, e default (que executa o host fora do processo).
--timeout, -t O tempo limite para o host de funções iniciar, em segundos. Padrão: 20 segundos.
--useHttps Ligar ao https://localhost:{port} invés de http://localhost:{port}. Por padrão, essa opção cria um certificado confiável no seu computador.
--user-log-level Define o nível mínimo de log para os logs de utilizador. Os valores válidos são: Trace, Debug, Information, Warning, Error, Critical, , e None. Esta definição não afeta os registos do sistema. Para .NET projetos isolados, defina também o nível mínimo em Program.cs usando builder.Logging.SetMinimumLevel(LogLevel.Debug) para que esta opção tenha efeito.

Com o projeto a decorrer, verifique os endpoints individuais das funções.

func azure functionapp

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

Todos os func azure functionapp comandos suportam estas opções:

Opção Descrição
--slot Destina-se a um slot de implantação nomeado específico, se configurado.
--access-token Fornece um token de acesso, diferente do token padrão, para usar na realização de ações autenticadas no Azure.
--access-token-stdin Lê um token de acesso específico a partir da entrada padrão. Use esta opção ao ler o token diretamente de um comando anterior, como az account get-access-token.
--management-url Define o URL de gestão para a cloud Azure, que por defeito é https://management.azure.com. Use esta opção quando seu aplicativo de função for executado em uma nuvem soberana.
--subscription Define a subscrição padrão do Azure.

func azure functionapp fetch-app-settings

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

func azure functionapp fetch-app-settings <APP_NAME>

Para obter mais informações, consulte Baixar configurações do aplicativo.

As definições descarregam para o ficheirolocal.settings.json do projeto. Os valores na tela são mascarados para segurança. Pode proteger as definições no ficheiro local.settings.json ativando a encriptação local.

func azure functionapp list-functions

Lista as funções na aplicação de funções especificada.

func azure functionapp list-functions <APP_NAME>

O func azure functionapp list-functions comando suporta esta opção:

Opção Descrição
--show-keys Incluir valores-chave de acesso ao nível da função nos URLs dos endpoints de função retornados.

func azure functionapp logstream

Liga o prompt de comandos local aos logs de streaming da aplicação 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 timeout adicionando uma configuração de aplicação chamada SCM_LOGSTREAM_TIMEOUT, com um valor de timeout em segundos. Ainda não suportado para Linux em um plano Flex Consumption ou Consumption . Para esses aplicativos, use a --browser opção para exibir logs no portal.

O func azure functionapp logstream comando suporta esta opção:

Opção Descrição
--browser Abra o Aplicação Azure Insights Live Stream para a aplicação de funções no navegador predefinido.

Para mais informações, consulte Ative os registos de execução em streaming em Funções do Azure.

func azure functionapp publish

Implementa um projeto de Funções para um recurso de aplicação de funções existente no Azure.

func azure functionapp publish <APP_NAME>

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

Aplicam-se as seguintes opções de publicação, consoante a versão:

Opção Descrição
--additional-packages Lista de pacotes a serem instalados ao criar dependências nativas. Por exemplo: python3-dev libevent-dev.
--build, -b Executa uma ação de compilação ao ser implementado numa aplicação de funções Linux. Aceita: remote e local.
--build-native-deps Evita gerar a pasta .wheels quando publicas Python aplicações funcionais.
--csx Publique um projeto de script C# (.csx).
--dotnet-cli-params Quando publicas funções compiladas em C# (.csproj), as ferramentas principais chamam dotnet build --output bin/publish. Quaisquer parâmetros passados para esta opção são adicionados à linha de comandos.
--dotnet-version Para aplicações dotnet-isolated, especifica a versão .NET alvo (por exemplo, 8.0).
--force Ignora a verificação pré-publicação em certos cenários.
--list-ignored-files Apresenta uma lista de ficheiros que são ignorados durante a publicação, baseada no ficheiro .funcle.
--list-included-files Apresenta uma lista de ficheiros publicados, baseada no ficheiro .funcle.
--no-build O Project não é construído durante a publicação. Para Python, pip install não corre.
--nozip Desativa o modo padrão Run-From-Package . Extrai ficheiros para a wwwroot pasta no servidor em vez de os executar diretamente do pacote de implementação.
--overwrite-settings, -y Suprime o prompt para sobrescrever as definições da aplicação quando usas --publish-local-settings -i.
--publish-local-settings, -i Publica as definições em local.settings.json para Azure, sugerindo sobrescrever se a definiçã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 definições e ignora o conteúdo. O padrão é prompt.
--show-keys Adiciona chaves de função aos URLs apresentados nos registos.

func azure storage fetch-connection-string

Obtém a cadeia de ligação para a conta Armazenamento do Azure especificada.

func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>

Para mais informações, consulte download de um cadeia de ligação.

func azurecontainerapps deploy

Implementa uma aplicação de função containerizada para um ambiente Azure Container Apps. A conta de armazenamento usada pela aplicação de funções e pelo ambiente já deve existir. Para mais informações, consulte Azure Container Apps hospedagem de Funções do Azure.

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 saltar a versão local do Docker.
--image-name O nome de uma imagem de contentor existente num registo de contentores, incluindo o nome da etiqueta.
--location Região para a implantação. Idealmente, esta região é igual ao ambiente e aos recursos da conta de armazenamento.
--name O nome usado para a implantação do aplicativo de função no ambiente Container Apps. Este nome também aparece ao gerir a aplicação de funções no portal. O nome tem de ser único no ambiente.
--registry Quando definido, uma build Docker é executada e a imagem é enviada para o registo definido em --registry. Não é possível usar --registry com --image-nameo . 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 A cadeia de ligação para a conta de armazenamento a ser usada pela aplicação de funções.
--worker-runtime Define a linguagem de tempo de execução do aplicativo de função. Este parâmetro é usado apenas com --image-name e --image-build; caso contrário, a linguagem é determinada durante a construção local. Os valores suportados são: dotnet, dotnetIsolated, node, python, powershell, e custom (para manipuladores personalizados).

Importante

Cadeias de conexão de armazenamento e outras credenciais de serviço são segredos importantes. Armazene de forma segura quaisquer ficheiros de script que utilizem func azurecontainerapps deploy e não os guarde em nenhum controlo de versões público acessível.

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ões ao ficheirohost.json .

func bundles add

O func bundles add comando suporta estas opções:

Opção Descrição
--force, -f Sobrescreve a configuração existente do bundle de extensões, se existir.
--channel, -c Canal de libertação do pacote de extensão. Os valores suportados são: GA (por defeito), Preview, e Experimental.

func bundles download

Descarrega o pacote de extensões configurado emhost.json.

func bundles download

O func bundles download comando suporta estas opções:

Opção Descrição
--force, -f Força o download do pacote de extensões mesmo que já esteja presente.

func bundles list

Lista pacotes de extensões descarregados.

func bundles list

func bundles path

Obtém o caminho para o pacote de extensões descarregado.

func bundles path

func durable delete-task-hub

Elimina todos os artefactos de armazenamento no hub de tarefas Durable Functions.

func durable delete-task-hub

O func durable delete-task-hub comando suporta estas opções:

Opção Descrição
--connection-string-setting Nome da definição que contém a cadeia de ligação de armazenamento a usar.
--task-hub-name Nome do hub de tarefas duráveis a usar.

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

func durable get-history

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

func durable get-history --id <INSTANCE_ID>

O func durable get-history comando suporta estas opções:

Opção Descrição
--id ID de uma instância de orquestração. (Necessário)
--connection-string-setting Nome da definição que tem a cadeia de ligação de armazenamento a usar.
--task-hub-name Nome do hub de tarefas duráveis a usar.

Para 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 a paginação com o top parâmetro.

func durable get-instances

O func durable get-instances comando suporta estas opções:

Opção Descrição
--continuation-token Token que indica uma página ou secção específica dos pedidos a devolver.
--connection-string-setting Nome da definição da aplicação que contém a cadeia de ligação de armazenamento a usar.
--created-after Obtenha as instâncias criadas após esta data e hora (UTC). Todas as datas/datas formatadas ISO 8601 são aceitas.
--created-before Obtenha as instâncias criadas antes de uma data e hora específicas (UTC). Todas as datas/datas formatadas ISO 8601 são aceitas.
--runtime-status Obtenha as instâncias cujo estado corresponde a um estado específico, incluindo running, completed, e failed. Pode fornecer um ou mais estados separados no espaço.
--top Limite o número de registos devolvidos num determinado pedido.
--task-hub-name Nome do Durable Functions Task Hub a utilizar.

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

func durable get-runtime-status

Devolve o estado de uma instância de orquestração especificada.

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

O func durable get-runtime-status comando suporta estas opções:

Opção Descrição
--connection-string-setting Nome da definição que contém a cadeia de ligação de armazenamento a usar.
--id ID de uma instância de orquestração. (Necessário)
--show-input Quando definido, 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 Durable Functions Task Hub a utilizar.

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

func durable purge-history

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

func durable purge-history

O func durable purge-history comando suporta estas opções:

Opção Descrição
--connection-string-setting Nome da definição que contém a cadeia de ligação de armazenamento a usar.
--created-after Apague o histórico das instâncias criadas após esta data/hora (UTC). Todos os valores de data/hora formatados ISO 8601 são aceitos.
--created-before Apague o histórico das instâncias criadas antes desta data/hora (UTC). Todos os valores de data/hora formatados ISO 8601 são aceitos.
--runtime-status Apague o histórico de instâncias cujo estado corresponde a um estado específico, incluindo completed, terminated, canceled, e failed. Fornecer um ou mais estados separados no espaço. Se você não incluir --runtime-statuso , o histórico de instâncias será excluído independentemente do status.
--task-hub-name Nome do Durable Functions Task Hub a utilizar.

Para 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 suporta estas opções:

Opção Descrição
--connection-string-setting Nome da definição que contém a cadeia de ligação de armazenamento a usar.
--event-data Dados para passar ao evento, seja em linha ou a partir de um ficheiro JSON. Para ficheiros, prefixe o caminho do ficheiro com um sinal at (@), como @path/to/file.json. (Necessário)
--event-name Nome do evento a levantar. (Necessário)
--id ID de uma instância de orquestração. (Necessário)
--task-hub-name Nome do Durable Functions Task Hub a utilizar.

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

func durable rewind

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

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

O func durable rewind comando suporta estas opções:

Opção Descrição
--connection-string-setting Nome da definição que contém a cadeia de ligação de armazenamento a usar.
--id ID de uma instância de orquestração. (Necessário)
--reason Razão para rebobinar a orquestração. (Necessário)
--task-hub-name Nome do Durable Functions Task Hub a utilizar.

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

func durable start-new

Inicia uma nova instância da função orchestrator especificada.

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

O func durable start-new comando suporta estas opções:

Opção Descrição
--connection-string-setting Nome da definição que contém a cadeia de ligação de armazenamento a usar.
--function-name Nome da função do orquestrador para começar. (Necessário)
--id Especifica o ID de uma instância de orquestração. (Necessário)
--input Entrada para a função do orquestrador, seja em linha ou a partir de um ficheiro JSON. Para ficheiros, prefixe o caminho do ficheiro com um ampersand (@), tal como @path/to/file.json. (Necessário)
--task-hub-name Nome do Durable Functions Task Hub a utilizar.

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

func durable terminate

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

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

O func durable terminate comando suporta estas opções:

Opção Descrição
--connection-string-setting Nome da definição que contém a cadeia de ligação de armazenamento a usar.
--id Especifica o ID de uma instância de orquestração. (Necessário)
--reason Razão para terminar a orquestração. (Necessário)
--task-hub-name Nome do Durable Functions Task Hub a utilizar.

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

func extensions install

Instala manualmente extensões de Funções num projeto que não seja .NET ou num projeto de script C#.

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

O func extensions install comando suporta estas opções:

Opção Descrição
--configPath, -c Caminho do diretório que contém o ficheiro extensions.csproj.
--csx Apoia projetos de scripting 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 no 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 Hubs de Eventos no projeto local:

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

Estas considerações aplicam-se ao utilizar func extensions install:

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

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

  • Quando possível, você deve usar pacotes de extensão. Aqui estão algumas razões pelas quais pode precisar de 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 poderes instalar extensões manualmente, deves primeiro remover o extensionBundle objeto do ficheirohost.json que define o bundle. Não é tomada nenhuma ação quando um pacote de extensões já está definido no seu ficheirohost.json .

  • Na primeira vez que instalas explicitamente uma extensão, um ficheiro de projeto .NET chamado extensions.csproj é adicionado à raiz do teu projeto de aplicação. Esse 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 instalar extensões sem precisar editar manualmente esse arquivo de projeto C#.

func extensions sync

Instala todas as extensões adicionadas ao aplicativo de função.

O func extensions sync comando suporta estas opções:

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

Regenera um arquivo extensions.csproj ausente. Não toma qualquer ação quando um pacote de extensões está definido no teu ficheiro host.json.

func kubernetes deploy

Implanta um projeto do Functions como um contêiner docker personalizado em um cluster 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 devem ter um Dockerfile. Para criar um aplicativo com um Dockerfile, use a --dockerfile opção com o func init comando.

O func kubernetes deploy comando suporta 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 as definições da aplicação de funções para usar na implementação. Requer --use-config-map. O comportamento padrão é criar definições com base no Values objeto do ficheirolocal.settings.json .
--cooldown-period O período de recarga (em segundos) após todos os gatilhos deixarem de estar ativos antes da implantação reduzir novamente para zero, com um padrão de 300 s.
--ignore-errors Continue a implementação depois de um recurso devolver um erro. O comportamento padrão é parar no erro.
--image-name O nome da imagem a ser usada para a implantação do pod e a partir da qual ler funções.
--keda-version Defina a versão do KEDA para instalar. As opções válidas são: v1 e v2 (padrão).
--keys-secret-name O nome de uma coleção Kubernetes Secrets a ser usada para armazenar chaves de acesso.
--max-replicas Defina o número máximo de réplicas ao qual o Horizontal Pod Autoscaler (HPA) escala.
--min-replicas Defina o número mínimo de réplicas abaixo do qual o HPA não escala.
--mount-funckeys-as-containervolume Monte as chaves de acesso como um volume de contentor.
--name O nome usado para a implantação e outros artefatos no Kubernetes.
--namespace Defina o namespace Kubernetes para implementar. Por defeito, o namespace predefinido.
--no-docker Leia funções do diretório atual em vez de uma imagem. Requer a montagem do sistema de arquivos de imagem.
--registry Quando definido, uma build Docker corre e a imagem é enviada para um registo com esse nome. Não é possível usar --registry com --image-nameo . Para o Docker, use seu nome de usuário.
--polling-interval O intervalo de sondagem (em segundos) para verificar gatilhos não-HTTP, com um padrão de 30s.
--pull-secret O segredo usado para acessar credenciais de registro privado.
--secret-name O nome de uma coleção Kubernetes Secrets existente que tem definições de aplicação para usar na implementação. O comportamento padrão é criar definições com base no Values objeto do ficheirolocal.settings.json .
--show-service-fqdn Mostrar os URLs dos triggers HTTP com o Kubernetes FQDN em vez do comportamento padrão de usar um endereço IP.
--service-type Defina o tipo de Serviço Kubernetes. Os valores suportados são: ClusterIP, NodePorte LoadBalancer (padrão).
--use-config-map Use um ConfigMap objeto (v1) em vez de um Secret objeto (v1) para definir as configurações do aplicativo de função. O nome do mapa é definido usando --config-map-name.
--use-git-hash-version Use o hash Git como versão para a imagem do contentor.
--write-configs Produz as configurações do Kubernetes como ficheiros YAML em vez de serem implementados.
--config-file Caminho do ficheiro de saída ao usar --write-configs. Padrão: functions.yaml.
--hash-files Ficheiros para fazer hash e determinar a versão da imagem.
--image-build Quando definido para false, salta a build do Docker.
--key-secret-annotations Anotações para adicionar ao segredo das chaves, em key1=val1,key2=val2 formato.

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

O Funções do Azure suporta o alojamento das suas funções containerizadas quer no Azure Container Apps quer no Funções do Azure. O Funções do Azure não suporta oficialmente executar os seus contentores diretamente num cluster Kubernetes ou no Azure Kubernetes Service (AKS). Para mais informações, consulte o suporte a contentores Linux em Funções do Azure.

func kubernetes delete

Elimina uma implementação de Funções de um cluster Kubernetes.

func kubernetes delete --name <APP_NAME>

O func kubernetes delete comando suporta estas opções:

Opção Descrição
--name O nome para a implantação e outros artefactos em Kubernetes. (Necessário)
--namespace Define o espaço de nomes Kubernetes. Por defeito, o default namespace.
--registry O nome do registro de contêiner.
--image-name A imagem a usar para a implementação do pod.
--keda-version Define a versão do KEDA. As opções válidas são v1 e v2 (default).

func kubernetes install

Instala o KEDA num cluster Kubernetes

func kubernetes install

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

O func kubernetes install comando suporta estas opções:

Opção Descrição
--dry-run Mostra o modelo de implementaçã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 num namespace Kubernetes específico. Quando não está definido, o namespace padrão é usado.

Para mais informações, consulte Gestão do KEDA e funções no Kubernetes.

func kubernetes remove

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

func kubernetes remove

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

O func kubernetes remove comando suporta esta opção:

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

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

func settings add

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

func settings add <SETTING_NAME> <VALUE>

Substitui <SETTING_NAME> pelo nome da definição da aplicação.

O func settings add comando suporta esta opção:

Opção Descrição
--connectionString Adiciona o par nome-valor à ConnectionStrings coleção em vez da Values coleção. Use a ConnectionStrings coleção apenas quando certos frameworks assim o exigirem. Para mais informações, consulte local.settings.json ficheiro.

func settings decrypt

Descifra valores encriptados na Values coleção no ficheirolocal.settings.json .

func settings decrypt

Este comando também desencripta cadeia de ligação valores na coleção ConnectionStrings. Em local.settings.json, IsEncrypted também está definido para false. Criptografe as configurações locais para reduzir o risco de vazamento de informações valiosas do local.settings.json. No Azure, as definições de aplicação são sempre armazenadas encriptadas.

func settings delete

Remove uma configuração existente da Values coleção 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 suporta 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 Values coleção no arquivo local.settings.json.

func settings encrypt

Os valores da cadeia de conexão na ConnectionStrings coleção também são criptografados. No local.settings.json, IsEncrypted também é definido como true, que especifica que o tempo de execução local descriptografa as configurações antes de usá-las. Criptografe as configurações locais para reduzir o risco de vazamento de informações valiosas do local.settings.json. No Azure, as definições da aplicação são sempre armazenadas como encriptadas.

func settings list

Gera uma lista de configurações na Values coleção no arquivo local.settings.json.

func settings list

A saída inclui também cadeias de ligação da ConnectionStrings coleção. Por padrão, os valores são mascarados para segurança. Você pode usar a --showValue opção para exibir o valor real.

O func settings list comando suporta esta opção:

Opção Descrição
--showValue, -a Mostra os valores reais sem máscara na saída.

func templates list

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

O func templates list comando suporta esta opção:

Opção Descrição
--language, -l Idioma para o qual filtrar modelos retornados. Devolve todas as línguas por defeito.

Opções globais

Estas opções estão disponíveis para a maioria dos comandos das Ferramentas Core:

Opção Descrição
--script-root Define o diretório raiz da aplicação de funções e altera o diretório de trabalho do comando.
--verbose Permite uma saída detalhada para registos detalhados. Não é suportado por todos os comandos.
--offline Funciona em modo offline, sem fazer chamadas de rede externa. Suportado por func start, func init, e func new. Também pode ser definido através da FUNCTIONS_CORE_TOOLS_OFFLINE variável de ambiente.
--version, -v Mostra a versão do Funções do Azure Core Tools.
--help, -h Apresenta informação de ajuda.
--pause-on-error Pausa para entrada adicional antes de sair do processo. Útil quando se inicia as Ferramentas Centrais a partir de um ambiente de desenvolvimento integrado (IDE).
  • Last updated on