Referência das Ferramentas Principais do Azure Functions

Este artigo fornece documentação de referência para as Ferramentas Principais do Azure Functions, que permitem desenvolver, gerenciar e implantar projetos do Azure Functions a partir do seu computador local. Para saber mais sobre como usar as Ferramentas Principais, consulte Trabalhar com as Ferramentas Principais do Azure Functions.

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

Contexto do comando	Description
func	Comandos usados para criar e executar funções no computador local.
func azure	Comandos para trabalhar com recursos do Azure, incluindo publicação.
func azurecontainerapps	Implante o aplicativo de função em contêiner nos Aplicativos de Contêiner do Azure.
func durable	Comandos para trabalhar com funções duráveis.
func extensions	Comandos para instalar e gerenciar extensões.
func kubernetes	Comandos para trabalhar com Kubernetes e Azure Functions.
func settings	Comandos para gerenciar 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, você deve instalar as Ferramentas Principais.

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.

func init suporta as seguintes opções, que não suportam a versão 1.x, salvo indicação em contrário:

Opção	Description
--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 contêiner usando uma imagem base baseada no arquivo --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. Solicita o tempo de execução do trabalhador 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	Inicializa um projeto específico do idioma. Atualmente suportado 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, apenas o tempo de execução do trabalhador 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 suportadas são V1 e para Python e V4V2V3 para Node.js. Para obter mais informações, consulte 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, 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, , , ,nodejavascript(JavaScript), powershell, pythondotnetdotnet-isolatede .typescript Para Java, use 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: net6.0 (padrão), net7.0, net8.0e net48 (.NET Framework 4.8).

Nota

Quando você usa uma ou --docker--dockerfile opções, as Ferramentas Principais criam automaticamente o Dockerfile para funções C#, JavaScript, Python e PowerShell. Para funções Java, você deve criar manualmente o Dockerfile. Para obter mais informações, consulte Criando aplicativos de função em contêiner.

logs func

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

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

A func logs ação suporta as seguintes opções:

Opção	Description
--platform	Plataforma de hospedagem para o aplicativo de função. Opções suportadas: kubernetes.
--name	Nome do aplicativo de função no Azure.

Para saber mais, consulte Azure Functions no Kubernetes com KEDA.

func novo

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

func new

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

A func new ação suporta as seguintes opções:

Opção	Description
--authlevel	Permite definir o nível de autorização para um gatilho HTTP. Os valores suportados são: function, , anonymousadmin. A autorização não é imposta quando executada localmente. Para obter mais informações, consulte o artigo de vinculação HTTP.
--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.
--language, -l	A linguagem de programação de modelo, como C#, F# ou JavaScript. Esta opção é necessária na versão 1.x. Na versão 2.x e versões posteriores, você não usa essa opção porque o idioma é definido pelo tempo de execução do trabalhador.
--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 saber mais, consulte Criar uma função.

Func Run

Apenas versão 1.x.

Permite que você invoque uma função diretamente, que é semelhante à execução de uma função usando a guia Teste no portal do 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

A func run ação suporta as seguintes opções:

Opção	Description
--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 acionada por HTTP e passar o corpo do conteúdo, execute o seguinte comando:

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

início func

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.

v2.x+

func start

func start suporta as seguintes opções:

Opção	Description
--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	Permitir solicitações autenticadas de origem cruzada usando cookies e o cabeçalho 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 está sendo depurado.
--enable-json-output	Emite logs de 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ço de funções a carregar.
--language-worker	Argumentos para configurar o trabalhador de linguagem. Por exemplo, você pode habilitar a depuração para o trabalhador de idiomas fornecendo porta de depuração 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	O porto local para ouvir. Valor padrão: 7071.
--timeout	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.

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

v1.x

func host start

func start suporta as seguintes opções:

Opção	Description
--cors	Uma lista separada por vírgulas das origens do CORS, sem espaços.
--port	O porto local para ouvir. Valor padrão: 7071.
--pause-on-error	Pause para mais entradas antes de sair do processo. Usado somente ao iniciar Core Tools a partir de um ambiente de desenvolvimento integrado (IDE).
--script-root	Usado para especificar o caminho para a raiz do aplicativo de função que deve ser executado ou implantado. Isso é usado para projetos compilados que geram arquivos de projeto em uma subpasta. Por exemplo, quando você cria um projeto de biblioteca de classes C#, os arquivos host.json, local.settings.json e function.json são gerados em uma subpasta raiz com um caminho como MyProject/bin/Debug/netstandard2.0. Nesse caso, defina o prefixo como --script-root MyProject/bin/Debug/netstandard2.0. Esta é a raiz do aplicativo de função quando executado no Azure.
--timeout	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.

Na versão 1.x, você também pode usar o func run comando para executar uma função específica e passar dados de teste para ela.

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 configurações são baixadas no arquivo local.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

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

func azure functionapp list-functions <APP_NAME>

func azure functionapp logstream

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

func azure functionapp logstream <APP_NAME>

O tempo limite padrão para a conexão é de 2 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. Ainda não suportado para aplicações Linux no plano de consumo. Para esses aplicativos, use a --browser opção para exibir logs no portal.

A deploy ação suporta as seguintes opções:

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

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

func azure functionapp publicar

Implanta um projeto do Functions em um recurso de aplicativo de função 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, com base na versão:

v2.x+

Opção	Description
--access-token	Permite que você use um token de acesso específico ao executar ações autenticadas do azure.
--access-token-stdin	Lê um token de acesso específico de uma entrada padrão. Use isso ao ler o token diretamente de um comando anterior, como az account get-access-token.
--additional-packages	Lista de pacotes a serem instalados ao criar dependências nativas. Por exemplo: python3-dev libevent-dev.
--build, -b	Executa a ação de compilação ao implantar em um aplicativo de função Linux. Aceita: remote e local.
--build-native-deps	Ignora a geração da .wheels pasta ao publicar aplicativos de função Python.
--csx	Publique um projeto de script C# (.csx).
--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 isso são anexados à linha de comando.
--force	Ignore a verificação de pré-publicação em determinados cenários.
--list-ignored-files	Exibe uma lista de arquivos que são ignorados durante a .funcignore publicação, que é baseada no arquivo.
--list-included-files	Exibe uma lista de arquivos publicados, que se baseia no .funcignore arquivo.
--management-url	Define o URL de gestão para a sua nuvem. Use isso ao executar em uma nuvem soberana.
--no-build	O Project não é construído durante a publicação. Para Python, pip install não é executado.
--nozip	Desativa o modo padrão Run-From-Package .
--overwrite-settings -y	Suprima o prompt para substituir as configurações do aplicativo quando --publish-local-settings -i for usado.
--publish-local-settings -i	Publique as configurações em local.settings.json no 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	Publique apenas as configurações e ignore o conteúdo. O padrão é prompt.
--slot	Nome opcional de um slot específico para o qual publicar.
--subscription	Define a assinatura padrão a ser usada.

v1.x

Opção	Description
--overwrite-settings -y	Suprima o prompt para substituir as configurações do aplicativo quando --publish-local-settings -i for usado.
--publish-local-settings -i	Publique as configurações em local.settings.json no Azure, solicitando a substituição se a configuração já existir. Se você estiver usando o Emulador de Armazenamento do Microsoft Azure, primeiro altere a configuração do aplicativo para uma conexão de armazenamento real.

func azure storage fetch-connection-string

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

func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>

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

func azurecontainerapps implantar

Implanta um aplicativo de função em contêiner em um ambiente de Aplicativos de Contêiner do Azure. Tanto a conta de armazenamento usada pelo aplicativo de função quanto o ambiente já devem existir. Para obter mais informações, consulte Aplicativos de contêiner do Azure hospedando 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	Description
--access-token	Permite que você use um token de acesso específico ao executar ações autenticadas do azure.
--access-token-stdin	Lê um token de acesso específico de uma entrada padrão. Use isso ao ler o token diretamente de um comando anterior, como az account get-access-token.
--environment	O nome de um ambiente de Aplicativos de Contêiner existente.
--image-build	Quando definido como true, ignora a compilação 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 tag.
--location	Região para a implantação. Idealmente, essa é a mesma região que o ambiente e os recursos da conta de armazenamento.
--management-url	Define o URL de gestão para a sua nuvem. Use isso ao executar em nuvem soberana.
--name	O nome usado para a implantação do aplicativo de função no ambiente Container Apps. Esse mesmo nome também é usado ao gerenciar o aplicativo de função no portal. O nome deve ser exclusivo no ambiente.
--registry	Quando definida, uma compilação do Docker é executada e a imagem é enviada por push para o conjunto de registro em --registry. Não é possível usar --registry com --image-nameo . Para o Docker Hub, use também --registry-usernameo .
--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ção.
--subscription	Define a assinatura padrão a ser usada.
--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, o idioma é determinado durante a compilação local. Os valores suportados são: dotnet, , , , pythonpowershelldotnetIsolatednodee custom (para manipuladores de clientes).

Importante

Cadeias de conexão de armazenamento e outras credenciais de serviço são segredos importantes. Certifique-se de armazenar com segurança todos os arquivos de script usando func azurecontainerapps deploy e não armazená-los em qualquer controle de origem acessível publicamente.

implantação func

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

func durável delete-task-hub

Exclui todos os artefatos de armazenamento no hub de tarefas Funções Duráveis.

func durable delete-task-hub

A delete-task-hub ação suporta as seguintes opções:

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

Para saber mais, consulte a documentação Durable Functions.

func durável get-history

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

func durable get-history --id <INSTANCE_ID>

A get-history ação suporta as seguintes opções:

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

Para saber mais, consulte a documentação Durable Functions.

Func Durable Get-instances

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

func durable get-instances

A get-instances ação suporta as seguintes opções:

Opção	Description
--continuation-token	Token opcional que indica uma página/seção específica das solicitações de retorno.
--connection-string-setting	Nome opcional da configuração do aplicativo que contém a cadeia de conexão de armazenamento a ser usada.
--created-after	Opcionalmente, obtenha as instâncias criadas após essa data/hora (UTC). Todas as datas/datas formatadas ISO 8601 são aceitas.
--created-before	Opcionalmente, obtenha as instâncias criadas antes de uma data/hora específica (UTC). Todas as datas/datas formatadas ISO 8601 são aceitas.
--runtime-status	Opcionalmente, obtenha as instâncias cujo status corresponde a um status específico, incluindo running, completede failed. Você pode fornecer uma ou mais estátuas separadas por espaço.
--top	Opcionalmente, limite o número de registros retornados em uma determinada solicitação.
--task-hub-name	Nome opcional do hub de tarefas Funções Duráveis a ser usado.

Para saber mais, consulte a documentação Durable Functions.

func durável get-runtime-status

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

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

A get-runtime-status ação suporta as seguintes opções:

Opção	Description
--connection-string-setting	Nome opcional da configuração que contém a cadeia de conexão de armazenamento a ser usada.
--id	Especifica a ID de uma instância de orquestração (obrigatório).
--show-input	Quando definida, a resposta contém a entrada da função.
--show-output	Quando definida, a resposta contém o histórico de execução.
--task-hub-name	Nome opcional do hub de tarefas Funções Duráveis a ser usado.

Para saber mais, consulte a documentação Durable Functions.

func durável purge-history

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

func durable purge-history

A purge-history ação suporta as seguintes opções:

Opção	Description
--connection-string-setting	Nome opcional da configuração que contém a cadeia 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 data/hora formatados 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 data/hora formatados ISO 8601 são aceitos.
--runtime-status	Opcionalmente, exclua o histórico de instâncias cujo status corresponda a um status específico, incluindo completd, terminated, cancelede failed. Você pode fornecer uma ou mais estátuas separadas por 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 opcional do hub de tarefas Funções Duráveis a ser usado.

Para saber mais, consulte a documentação Durable Functions.

func durável raise-evento

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

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

A raise-event ação suporta as seguintes opções:

Opção	Description
--connection-string-setting	Nome opcional da configuração que contém a cadeia de conexão de armazenamento a ser usada.
--event-data	Dados a serem passados para o evento, inline ou de um arquivo JSON (obrigatório). Para arquivos, prefixe o caminho para o arquivo com um E comercial (@), como @path/to/file.json.
--event-name	Nome do evento a ser levantado (obrigatório).
--id	Especifica a ID de uma instância de orquestração (obrigatório).
--task-hub-name	Nome opcional do hub de tarefas Funções Duráveis a ser usado.

Para saber mais, consulte a documentação Durable Functions.

rebobinagem durável func

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

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

A rewind ação suporta as seguintes opções:

Opção	Description
--connection-string-setting	Nome opcional da configuração que contém a cadeia de conexão de armazenamento a ser usada.
--id	Especifica a ID de uma instância de orquestração (obrigatório).
--reason	Motivo para rebobinar a orquestração (obrigatório).
--task-hub-name	Nome opcional do hub de tarefas Funções Duráveis a ser usado.

Para saber mais, consulte a documentação Durable Functions.

func durável 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>

A start-new ação suporta as seguintes opções:

Opção	Description
--connection-string-setting	Nome opcional da configuração que contém a cadeia de conexão de armazenamento a ser usada.
--function-name	Nome da função do orquestrador a iniciar (obrigatório).
--id	Especifica a ID de uma instância de orquestração (obrigatório).
--input	Entrada para a função orchestrator, em linha ou a partir de um arquivo JSON (obrigatório). Para arquivos, prefixe o caminho para o arquivo com um E comercial (@), como @path/to/file.json.
--task-hub-name	Nome opcional do hub de tarefas Funções Duráveis a ser usado.

Para saber mais, consulte a documentação Durable Functions.

func terminação durável

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

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

A terminate ação suporta as seguintes opções:

Opção	Description
--connection-string-setting	Nome opcional da configuração que contém a cadeia de conexão de armazenamento a ser usada.
--id	Especifica a ID de uma instância de orquestração (obrigatório).
--reason	Motivo para parar a orquestração (obrigatório).
--task-hub-name	Nome opcional do hub de tarefas Funções Duráveis a ser usado.

Para saber mais, consulte a documentação Durable Functions.

instalação de extensões func

Instala manualmente as extensões do Functions em um projeto non-.NET ou em um projeto de script C#.

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

A install ação suporta as seguintes opções:

Opção	Description
--configPath	Caminho do diretório que contém o arquivo extensions.csproj.
--csx	Suporta 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 no 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 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 (processo de trabalho isolado e em processo), use métodos de instalação de pacote NuGet padrão, como dotnet add package.

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

• Quando possível, você deve usar pacotes de extensão. A seguir estão algumas razões pelas quais você pode precisar 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 extensões, você deve primeiro 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 no seu arquivo host.json.

• Na primeira vez que você instala explicitamente uma extensão, um arquivo de projeto .NET chamado extensions.csproj é adicionado à raiz do seu projeto de aplicativo. 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#.

Sincronização de extensões func

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

A sync ação suporta as seguintes opções:

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

Regenera um arquivo extensions.csproj ausente. Nenhuma ação é tomada quando um pacote de extensão é definido no arquivo host.json.

func kubernetes implantar

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.

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

Opção	Description
--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 de aplicativo de função para usar 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 reduzida a zero, com um padrão de 300 s.
--ignore-errors	Continua a implantação depois que um recurso retorna 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	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 Kubernetes Secrets a ser usada para armazenar chaves de acesso de função.
--max-replicas	Define a contagem máxima de réplicas para a qual o Horizontal Pod Autoscaler (HPA) é dimensionado.
--min-replicas	Define a contagem mínima de réplicas abaixo da qual o HPA não será dimensionado.
--mount-funckeys-as-containervolume	Monta as teclas de acesso da função 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 para o qual implantar, que assume como padrão o namespace padrão.
--no-docker	As funções são lidas a partir do diretório atual em vez de uma imagem. Requer a montagem do sistema de arquivos de imagem.
--registry	Quando definida, uma compilação do Docker é executada e a imagem é enviada por push para um registro 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 existente do Kubernetes Secrets que contém configurações de aplicativo de função para usar na implantação. O comportamento padrão é criar configurações com base no Values objeto no arquivo local.settings.json.
--show-service-fqdn	Exibe as URLs de 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 Kubernetes. Os valores suportados são: ClusterIP, NodePorte LoadBalancer (padrão).
--use-config-map	Use um objeto (v1) em vez de um ConfigMapSecret objeto (v1) para definir as configurações do aplicativo de função. O nome do mapa é definido usando --config-map-name.

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

Para saber mais, consulte Implantando um aplicativo de função no Kubernetes.

func kubernetes instalar

Instala o KEDA em um cluster Kubernetes.

func kubernetes install 

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

A install ação suporta as seguintes opções:

Opção	Description
--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	Suporta a instalação em um namespace Kubernetes específico. Quando não está definido, o namespace padrão é usado.

Para saber mais, consulte Gerenciando KEDA e funções no Kubernetes.

func kubernetes remover

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

func kubernetes remove 

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

A remove ação suporta as seguintes opções:

Opção	Description
--namespace	Suporta a desinstalação de um namespace Kubernetes específico. Quando não está definido, o namespace padrão é usado.

Para saber mais, consulte Desinstalando o KEDA do Kubernetes.

configurações func adicionar

Adiciona uma nova configuração à Values coleção 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 add ação suporta a seguinte opção:

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

configurações func desencriptar

Desencripta valores previamente encriptados Values na coleção no ficheiro local.settings.json.

func settings decrypt

Os valores da cadeia de ConnectionStrings conexão na coleção também são descriptografados. Em local.settings.json, IsEncrypted também está definido como false. Criptografe as configurações locais para reduzir o risco de vazamento de informações valiosas de local.settings.json. No Azure, as configurações do aplicativo são sempre armazenadas criptografadas.

configurações func excluir

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.

A delete ação suporta a seguinte opção:

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

configurações func criptografar

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. Em local.settings.json, também é definido como true, IsEncrypted 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 de local.settings.json. No Azure, as configurações do aplicativo são sempre armazenadas criptografadas.

lista de configurações func

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

func settings list

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

A list ação suporta a seguinte opção:

Opção	Description
--showValue	Mostra os valores reais desmascarados na saída.

lista de modelos func

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

A list ação suporta a seguinte opção:

Opção	Description
--language	Idioma para o qual filtrar modelos retornados. O padrão é retornar todos os idiomas.