Referencia de Azure Functions Core Tools
En este artículo se proporciona documentación de referencia para Azure Functions Core Tools, que le permite desarrollar, administrar e implementar proyectos de Azure Functions desde el equipo local. Para más información sobre Core Tools, consulte Uso de Azure Functions Core Tools.
Los comandos de Core Tools se organizan en los contextos siguientes y cada uno de ellos proporciona un conjunto único de acciones.
Contexto de comando | Descripción |
---|---|
func |
Comandos que se usan para crear y ejecutar funciones en el equipo local. |
func azure |
Comandos para usar los recursos de Azure, incluida la publicación. |
func azurecontainerapps |
Implementación de la aplicación de funciones en contenedor en Azure Container Apps. |
func durable |
Comandos para usar Durable Functions. |
func extensions |
Comandos para instalar y administrar extensiones. |
func kubernetes |
Comandos para usar Kubernetes y Azure Functions. |
func settings |
Comandos para administrar la configuración del entorno para el host local de Functions. |
func templates |
Comandos para enumerar las plantillas de función disponibles. |
Antes de usar los comandos de este artículo, debe instalar Core Tools.
func init
Crea un nuevo proyecto de Functions en un lenguaje específico.
func init <PROJECT_FOLDER>
Cuando se proporciona <PROJECT_FOLDER>
, el proyecto se crea en una nueva carpeta con este nombre. En caso contrario, se utiliza la carpeta actual.
func init
admite las siguientes opciones, que no admiten la versión 1.x, a menos que se indique:
Opción | Descripción |
---|---|
--csx |
Crea funciones de .NET como script de C#, que es el comportamiento de la versión 1.x. Solo es válido con --worker-runtime dotnet . |
--docker |
Crea un archivo Dockerfile para un contenedor con una imagen base en función del elemento --worker-runtime elegido. Use esta opción al planear la implementación de una aplicación de funciones en contenedor. |
--docker-only |
Agrega un Dockerfile a un proyecto existente. Solicita el entorno de ejecución de trabajo si no se especifica o se establece en local.settings.json. Use esta opción cuando planee implementar una aplicación de funciones en contenedor y el proyecto ya exista. |
--force |
Inicializa el proyecto incluso cuando hay archivos existentes en el proyecto. Este valor sobrescribe los archivos existentes con el mismo nombre. Los otros archivos de la carpeta del proyecto no se ven afectados. |
--language |
Inicializa un proyecto específico del lenguaje. Se admite actualmente cuando --worker-runtime se establece en node . Las opciones son typescript y javascript . También puede usar --worker-runtime javascript o --worker-runtime typescript . |
--managed-dependencies |
Instala las dependencias administradas. Actualmente, solo admite esta funcionalidad el entorno de ejecución de trabajos de PowerShell. |
--model |
Establece el modelo de programación deseado para un lenguaje de destino cuando hay más de un modelo disponible. Las opciones admitidas son V1 y V2 para Python y V3 para V4 Node.js. Para obtener más información, consulte la guía para desarrolladores de Python y la guía para desarrolladores deNode.js, respectivamente. |
--source-control |
Controla si se crea un repositorio de git. De forma predeterminada, no se crea un repositorio. Cuando es true , se crea un repositorio. |
--worker-runtime |
Establece el entorno de ejecución del lenguaje del proyecto. Los valores admitidos son: csharp , dotnet , dotnet-isolated , javascript ,node (JavaScript), powershell , python y typescript . En el caso de Java, utilice Maven. Para generar un proyecto independiente del lenguaje con solo los archivos de proyecto, use custom . Si no se establece, deberá elegir el entorno de ejecución durante la inicialización. |
--target-framework |
Establece la plataforma de destino para el proyecto de aplicación de funciones. Solo es válido con --worker-runtime dotnet-isolated . Los valores admitidos son: net9.0 (versión preliminar), net8.0 (valor predeterminado), net6.0 y net48 (.NET Framework 4.8). |
Nota:
Cuando se usan las opciones --docker
o --docker-only
, Core Tools crea automáticamente el Dockerfile para las funciones de C#, JavaScript, Python y PowerShell. Para las funciones de Java, debe crear manualmente el Dockerfile. Para obtener más información, consulte Creación de aplicaciones de funciones en contenedor.
func logs
Obtiene los registros de las funciones que se ejecutan en un clúster de Kubernetes.
func logs --platform kubernetes --name <APP_NAME>
La acción func logs
admite las siguientes opciones:
Opción | Descripción |
---|---|
--platform |
Plataforma de hospedaje de la aplicación de función. Opciones admitidas: kubernetes . |
--name |
Nombre de la aplicación de funciones en Azure. |
Para obtener más información, consulte Azure Functions en Kubernetes con KEDA.
func new
Crea una nueva función en el proyecto actual basándose en una plantilla.
func new
Cuando se ejecuta func new
sin la opción --template
, se le pedirá que elija una plantilla. En la versión 1.x, también se le pedirá que elija el lenguaje.
La acción func new
admite las siguientes opciones:
Opción | Descripción |
---|---|
--authlevel |
Permite establecer el nivel de autorización para un desencadenador HTTP. Los valores admitidos son: function , anonymous y admin . La autorización no se aplica cuando se ejecuta localmente. Para obtener más información, consulte Nivel de autorización. |
--csx |
(Versión 2.x y posteriores). Genera las mismas plantillas de script de C# (.csx) que se usan en la versión 1.x y en el portal. |
--language , -l |
Lenguaje de programación de la plantilla, como C#, F# o JavaScript. Esta opción es obligatoria en la versión 1.x. En la versión 2.x y versiones posteriores, no se usa esta opción porque el lenguaje está definido por el tiempo de ejecución de trabajo. |
--name , -n |
Nombre de función. |
--template , -t |
Use el comando func templates list para ver la lista completa de plantillas disponibles para cada lenguaje compatible. |
Para obtener más información, consulte Creación de una función.
func run
Solo versión 1.x.
Permite invocar una función directamente, lo que es similar a ejecutar una función con la pestaña Prueba de Azure Portal. Esta acción solo se admite en la versión 1.x. Para versiones posteriores, use func start
y llame al punto de conexión de la función directamente.
func run
La acción func run
admite las siguientes opciones:
Opción | Descripción |
---|---|
--content |
Contenido en línea pasado a la función. |
--debug |
Se asocia un depurador al proceso de host antes de ejecutar la función. |
--file |
Nombre del archivo que se usa como contenido. |
--no-interactive |
No solicita la entrada, lo que resulta útil para escenarios de automatización. |
--timeout |
Tiempo de espera (en segundos) hasta que el host local de Functions está listo. |
Por ejemplo, para llamar a una función desencadenada por HTTP y pasar cuerpo del contenido, ejecute el siguiente comando:
func run MyHttpTrigger --content '{\"name\": \"Azure\"}'
func start
Inicia el host en tiempo de ejecución local y carga el proyecto de función en la carpeta actual.
El comando específico depende de la versión en tiempo de ejecución.
func start
func start
admite las siguientes opciones:
Opción | Descripción |
---|---|
--cert |
La ruta de acceso a un archivo .pfx que contiene una clave privada. Solo se admite con --useHttps . |
--cors |
Lista separada por comas de orígenes CORS, sin espacios en blanco. |
--cors-credentials |
Permite solicitudes autenticadas entre orígenes mediante cookies y el encabezado de autenticación. |
--dotnet-isolated-debug |
Cuando se establece en true , pausa el proceso de trabajo de .NET hasta que se adjunta un depurador desde el proyecto aislado de .NET que se está depurando. |
--enable-json-output |
Emite registros de consola como JSON, siempre que sea posible. |
--enableAuth |
Habilite la canalización de control de autenticación completa, con requisitos de autorización. |
--functions |
Lista separada por espacios de funciones que se cargarán. |
--language-worker |
Argumentos para configurar el trabajo del lenguaje. Por ejemplo, puede habilitar la depuración para el trabajo de lenguaje proporcionando el puerto de depuración y otros argumentos necesarios. |
--no-build |
El proyecto actual no se compila antes de su ejecución. Solo para proyectos de clase .NET. De manera predeterminada, es false . |
--password |
La contraseña o un archivo que contenga la contraseña de un archivo. pfx. Solo se usa con --cert . |
--port |
Puerto local en el que se escucha. Valor predeterminado: 7071. |
--timeout |
Tiempo de espera en segundos para que se inicie el host de Functions. Valor predeterminado: 20 segundos. |
--useHttps |
Enlace con https://localhost:{port} en lugar de con http://localhost:{port} . De forma predeterminada, esta opción crea un certificado de confianza en el equipo. |
Con el proyecto en ejecución, puede comprobar los puntos de conexión de función individuales.
func azure functionapp fetch-app-settings
Obtiene la configuración de una aplicación de funciones específica.
func azure functionapp fetch-app-settings <APP_NAME>
Para más información, vea Descargar la configuración de la aplicación.
La configuración se descarga en el archivo local.settings.json para el proyecto. Los valores en pantalla se enmascaran por motivos de seguridad. Puede proteger la configuración del archivo local.settings.json habilitando el cifrado local.
func azure functionapp list-functions
Devuelve una lista de las funciones de la aplicación de funciones especificada.
func azure functionapp list-functions <APP_NAME>
func azure functionapp logstream
Conecta el símbolo del sistema local a los registros de streaming de la aplicación de funciones en Azure.
func azure functionapp logstream <APP_NAME>
El tiempo de espera predeterminado para la conexión es de 2 horas. Puede cambiar el tiempo de espera agregando una configuración de la aplicación denominada SCM_LOGSTREAM_TIMEOUT, con un valor de tiempo de espera en segundos. Todavía no se admite para las aplicaciones de Linux en el plan de consumo. Para estas aplicaciones, use la opción --browser
para ver los registros en el portal.
La acción deploy
admite las siguientes opciones:
Opción | Descripción |
---|---|
--browser |
Abra Azure Application Insights Live Stream para la aplicación de funciones en el explorador predeterminado. |
Para más información, consulte Habilitar los registros de ejecución de streaming en Azure Functions.
func azure functionapp publish
Implementa un proyecto de Functions en un recurso de aplicación de funciones existente en Azure.
func azure functionapp publish <APP_NAME>
Para obtener más información, consulte Implementación de los archivos de proyecto.
Se aplican las siguientes opciones de publicación en función de la versión:
Opción | Descripción |
---|---|
--access-token |
Permite usar un token de acceso específico al realizar acciones autenticadas azure . |
--access-token-stdin |
Lee un token de acceso específico de una entrada estándar. Úselo al leer el token directamente desde un comando anterior, como az account get-access-token . |
--additional-packages |
Lista de paquetes para instalar al crear dependencias nativas. Por ejemplo: python3-dev libevent-dev . |
--build , -b |
Realiza la acción de compilación cuando se implementa en una aplicación de función de Linux. Acepta remote y local . |
--build-native-deps |
Omite la generación de la carpeta .wheels al publicar aplicaciones de funciones de Python. |
--csx |
Publica un proyecto de script de C# (.csx). |
--dotnet-cli-params |
Al publicar funciones compiladas de C# (.csproj), Core Tools llama a dotnet build --output bin/publish . Todos los parámetros pasados se anexarán a la línea de comandos. |
--force |
Omita la comprobación previa a la publicación en determinados escenarios. |
--list-ignored-files |
Muestra una lista de archivos que se omiten durante la publicación, según el archivo .funcignore . |
--list-included-files |
Muestra una lista de archivos que se publican, según el archivo .funcignore . |
--management-url |
Establece la dirección URL de administración de la nube. Úselo al ejecutar en una nube soberana. |
--no-build |
El proyecto no se compila durante la publicación. En el caso de Python, pip install no se ejecuta. |
--nozip |
Desactiva el modo Run-From-Package predeterminado. |
--overwrite-settings -y |
Suprime el mensaje de sobrescritura de la configuración de la aplicación cuando se utiliza --publish-local-settings -i . |
--publish-local-settings -i |
Se publica la configuración de local.settings.json en Azure, se pide que se sobrescriba si la configuración ya existe. Si usa el emulador del almacenamiento local, cambie primero la configuración de la aplicación a una conexión de almacenamiento real. |
--publish-settings-only , -o |
Solo se publica la configuración y se omite el contenido. El valor predeterminado es Preguntar. |
--slot |
Nombre opcional de una ranura específica en la que se va a publicar. |
--subscription |
Establece la suscripción predeterminada que desea usar. |
func azure storage fetch-connection-string
Obtiene la cadena de conexión de una cuenta de Azure Storage especificada.
func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>
Para más información, consulte Descarga de una cadena de conexión de almacenamiento.
func azurecontainerapps deploy
Implementa una aplicación de funciones en contenedor en un entorno de Azure Container Apps. La cuenta de almacenamiento usada por la aplicación de funciones y el entorno ya deben existir. Para más información, vea Hospedaje de Azure Functions en Azure Container Apps.
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>
Se aplican las siguientes opciones de implementación:
Opción | Descripción |
---|---|
--access-token |
Permite usar un token de acceso específico al realizar acciones autenticadas azure . |
--access-token-stdin |
Lee un token de acceso específico de una entrada estándar. Úselo al leer el token directamente desde un comando anterior, como az account get-access-token . |
--environment |
Nombre de un entorno de Container Apps existente. |
--image-build |
Cuando se establece en true , omite la compilación local de Docker. |
--image-name |
Nombre de imagen de un contenedor existente en un registro de contenedor. El nombre de la imagen incluye el nombre de la etiqueta. |
--location |
Región de la implementación. Idealmente, esta es la misma región que el entorno y los recursos de la cuenta de almacenamiento. |
--management-url |
Establece la dirección URL de administración de la nube. Úselo al ejecutar en la nube soberana. |
--name |
Nombre usado para la implementación de la aplicación de funciones en el entorno de Container Apps. Este mismo nombre también se usa al administrar la aplicación de funciones en el portal. El nombre debe ser único en el entorno. |
--registry |
Cuando se establece, se ejecuta una compilación de Docker y la imagen se envía al registro establecido en --registry . No se puede usar --registry con --image-name . Para Docker Hub, use --registry-username también. |
--registry-password |
Contraseña o token usado para recuperar la imagen de un registro privado. |
--registry-username |
Nombre de usuario usado para recuperar la imagen de un registro privado. |
--resource-group |
Grupo de recursos en el que se crean los recursos relacionados con las funciones. |
--storage-account |
Cadena de conexión de la cuenta de almacenamiento que va a usar la aplicación de funciones. |
--subscription |
Establece la suscripción predeterminada que desea usar. |
--worker-runtime |
Establece el lenguaje en tiempo de ejecución de la aplicación de funciones. Este parámetro solo se usa con --image-name y --image-build , de lo contrario, el lenguaje se determina durante la compilación local. Los valores admitidos son: dotnet , dotnetIsolated , node , python , powershell y custom (para los controladores de clientes). |
Importante
Las cadenas de conexión de almacenamiento y otras credenciales de servicio son secretos importantes. Asegúrese de almacenar de forma segura los archivos de script mediante func azurecontainerapps deploy
y no los almacene en ningún control de código fuente accesible públicamente.
func deploy
El comando func deploy
está en desuso. En su lugar, use func kubernetes deploy
.
func durable delete-task-hub
Elimina todos los artefactos de almacenamiento de la central de tareas de Durable Functions.
func durable delete-task-hub
La acción delete-task-hub
admite las siguientes opciones:
Opción | Descripción |
---|---|
--connection-string-setting |
Nombre opcional de la configuración que contiene la cadena de conexión de almacenamiento que se va a usar. |
--task-hub-name |
Nombre opcional de la central de tareas de Durable que se va a usar. |
Para obtener más información, consulte la documentación de Durable Functions.
func durable get-history
Devuelve el historial de la instancia de orquestación especificada.
func durable get-history --id <INSTANCE_ID>
La acción get-history
admite las siguientes opciones:
Opción | Descripción |
---|---|
--id |
Especifica el identificador de una instancia de orquestación (obligatorio). |
--connection-string-setting |
Nombre opcional de la configuración que contiene la cadena de conexión de almacenamiento que se va a usar. |
--task-hub-name |
Nombre opcional de la central de tareas de Durable que se va a usar. |
Para obtener más información, consulte la documentación de Durable Functions.
func durable get-instances
Devuelve el estado de todas las instancias de orquestación. Admite la paginación mediante el parámetro top
.
func durable get-instances
La acción get-instances
admite las siguientes opciones:
Opción | Descripción |
---|---|
--continuation-token |
Token opcional que indica una página o sección específica de las solicitudes que se devuelven. |
--connection-string-setting |
Nombre opcional de la configuración de la aplicación que contiene la cadena de conexión de almacenamiento que se va a usar. |
--created-after |
Opcionalmente, obtenga las instancias creadas después de esta fecha y hora (UTC). Se aceptan todos los valores datetime con formato ISO 8601. |
--created-before |
Opcionalmente, obtenga las instancias creadas antes de una fecha y hora (UTC) específicas. Se aceptan todos los valores datetime con formato ISO 8601. |
--runtime-status |
Opcionalmente, obtenga las instancias cuyo estado coincida con un estado específico, incluidos running , completed y failed . Puede proporcionar uno o varios estados separados por espacios. |
--top |
Opcionalmente, limite el número de registros devueltos en una solicitud determinada. |
--task-hub-name |
Nombre opcional de la central de tareas de Durable Functions que se va a usar. |
Para obtener más información, consulte la documentación de Durable Functions.
func durable get-runtime-status
Devuelve el estado de una instancia de orquestación especificada.
func durable get-runtime-status --id <INSTANCE_ID>
La acción get-runtime-status
admite las siguientes opciones:
Opción | Descripción |
---|---|
--connection-string-setting |
Nombre opcional de la configuración que contiene la cadena de conexión de almacenamiento que se va a usar. |
--id |
Especifica el identificador de una instancia de orquestación (obligatorio). |
--show-input |
Una vez establecida, la respuesta contiene la entrada de la función. |
--show-output |
Una vez establecida, la respuesta contiene el historial de ejecución. |
--task-hub-name |
Nombre opcional de la central de tareas de Durable Functions que se va a usar. |
Para obtener más información, consulte la documentación de Durable Functions.
func durable purge-history
Se purga el estado, el historial y el servicio Blob Storage de la instancia de orquestación para orquestaciones anteriores al umbral especificado.
func durable purge-history
La acción purge-history
admite las siguientes opciones:
Opción | Descripción |
---|---|
--connection-string-setting |
Nombre opcional de la configuración que contiene la cadena de conexión de almacenamiento que se va a usar. |
--created-after |
Opcionalmente, elimine el historial de instancias creadas después de esta fecha y hora (UTC). Se aceptan todos los valores datetime con formato ISO 8601. |
--created-before |
Opcionalmente, elimine el historial de instancias creadas antes de esta fecha y hora (UTC). Se aceptan todos los valores datetime con formato ISO 8601. |
--runtime-status |
Opcionalmente, elimine el historial de instancias cuyo estado coincida con un estado específico, incluidos completd , terminated , canceled y failed . Puede proporcionar uno o varios estados separados por espacios. Si no incluye --runtime-status , el historial de instancias se elimina independientemente del estado. |
--task-hub-name |
Nombre opcional de la central de tareas de Durable Functions que se va a usar. |
Para obtener más información, consulte la documentación de Durable Functions.
func durable raise-event
Genera un evento en la instancia de orquestación especificada.
func durable raise-event --event-name <EVENT_NAME> --event-data <DATA>
La acción raise-event
admite las siguientes opciones:
Opción | Descripción |
---|---|
--connection-string-setting |
Nombre opcional de la configuración que contiene la cadena de conexión de almacenamiento que se va a usar. |
--event-data |
Datos que se pasan al evento, ya sea en línea o desde un archivo JSON (obligatorio). En el caso de los archivos, prefije la ruta de acceso al archivo con una arroba (@ ), como @path/to/file.json . |
--event-name |
Nombre del evento que se va a generar (obligatorio). |
--id |
Especifica el identificador de una instancia de orquestación (obligatorio). |
--task-hub-name |
Nombre opcional de la central de tareas de Durable Functions que se va a usar. |
Para obtener más información, consulte la documentación de Durable Functions.
func durable rewind
Devuelve a un estado anterior a la instancia de orquestación especificada.
func durable rewind --id <INSTANCE_ID> --reason <REASON>
La acción rewind
admite las siguientes opciones:
Opción | Descripción |
---|---|
--connection-string-setting |
Nombre opcional de la configuración que contiene la cadena de conexión de almacenamiento que se va a usar. |
--id |
Especifica el identificador de una instancia de orquestación (obligatorio). |
--reason |
Motivo para devolver a un estado anterior a la orquestación (obligatorio). |
--task-hub-name |
Nombre opcional de la central de tareas de Durable Functions que se va a usar. |
Para obtener más información, consulte la documentación de Durable Functions.
func durable start-new
Inicia una nueva instancia de la función de orquestador especificada.
func durable start-new --id <INSTANCE_ID> --function-name <FUNCTION_NAME> --input <INPUT>
La acción start-new
admite las siguientes opciones:
Opción | Descripción |
---|---|
--connection-string-setting |
Nombre opcional de la configuración que contiene la cadena de conexión de almacenamiento que se va a usar. |
--function-name |
Nombre de la función de orquestador que se va a iniciar (obligatorio). |
--id |
Especifica el identificador de una instancia de orquestación (obligatorio). |
--input |
Entrada a la función de orquestador, ya sea en línea o desde un archivo JSON (obligatorio). En el caso de los archivos, prefije la ruta de acceso al archivo con una arroba (@ ), como @path/to/file.json . |
--task-hub-name |
Nombre opcional de la central de tareas de Durable Functions que se va a usar. |
Para obtener más información, consulte la documentación de Durable Functions.
func durable terminate
Detiene la instancia de orquestación especificada.
func durable terminate --id <INSTANCE_ID> --reason <REASON>
La acción terminate
admite las siguientes opciones:
Opción | Descripción |
---|---|
--connection-string-setting |
Nombre opcional de la configuración que contiene la cadena de conexión de almacenamiento que se va a usar. |
--id |
Especifica el identificador de una instancia de orquestación (obligatorio). |
--reason |
Motivo para detener la orquestación (obligatorio). |
--task-hub-name |
Nombre opcional de la central de tareas de Durable Functions que se va a usar. |
Para obtener más información, consulte la documentación de Durable Functions.
func extensions install
Instala manualmente extensiones de Functions en un proyecto de que no es de .NET o en un proyecto de script de C#.
func extensions install --package Microsoft.Azure.WebJobs.Extensions.<EXTENSION> --version <VERSION>
La acción install
admite las siguientes opciones:
Opción | Descripción |
---|---|
--configPath |
Ruta de acceso del directorio que contiene el archivo extensions.csproj. |
--csx |
Admite proyectos de scripting de C# (.csx). |
--force |
Actualice las versiones de las extensiones existentes. |
--output |
Ruta de acceso de salida para las extensiones. |
--package |
Identificador de un paquete de extensión específico. Cuando no se especifica, se instalan todas las extensiones a las que se hace referencia, como con func extensions sync . |
--source |
Origen de una fuente NuGet cuando no se usa NuGet.org. |
--version |
Versión del paquete de extensión. |
En el ejemplo siguiente se instala la versión 5.0.1 de la extensión de Event Hubs en el proyecto local:
func extensions install --package Microsoft.Azure.WebJobs.Extensions.EventHubs --version 5.0.1
Las siguientes consideraciones se aplican al usar func extensions install
:
Para proyectos C# compilados (tanto en proceso como en proceso de trabajador aislado), use en su lugar los métodos estándar de instalación de paquetes NuGet, como
dotnet add package
.Para instalar manualmente extensiones mediante Core Tools, debe tener instalado el SDK de .NET 6.0.
Cuando sea posible, en su lugar debe usar conjuntos de extensiones. Aquí tiene algunos motivos por los que es posible que deba instalar las extensiones manualmente:
- Debe tener acceso a una versión específica de una extensión que no está disponible en un conjunto.
- Debe tener acceso a una extensión personalizada que no está disponible en un conjunto.
- Debe tener acceso a una combinación específica de extensiones que no está disponible en un único conjunto.
Para poder instalar manualmente extensiones, primero debe quitar el objeto
extensionBundle
del archivo host.json que define la agrupación. No se realiza ninguna acción cuando un conjunto de extensiones ya está establecido en el archivo host.json.La primera vez que instala explícitamente una extensión, se agrega un archivo de proyecto .NET denominado extensions.csproj a la raíz del proyecto de aplicación. Este archivo define el conjunto de paquetes NuGet requeridos por las funciones. Aunque puede trabajar con las referencias de paquetes de NuGet en este archivo, las herramientas principales le permiten instalar extensiones sin tener que editar manualmente este archivo del proyecto C#.
func extensions sync
Instala todas las extensiones agregadas a la aplicación de funciones.
La acción sync
admite las siguientes opciones:
Opción | Descripción |
---|---|
--configPath |
Ruta de acceso del directorio que contiene el archivo extensions.csproj. |
--csx |
Admite proyectos de scripting de C# (.csx). |
--output |
Ruta de acceso de salida para las extensiones. |
Regenera un archivo extensions.csproj que falta. No se realiza ninguna acción cuando se define un conjunto de extensiones en el archivo host.json.
func kubernetes deploy
Implementa un proyecto de Functions como un contenedor de Docker personalizado en un clúster de Kubernetes.
func kubernetes deploy
Este comando compila el proyecto como un contenedor personalizado y lo publica en un clúster de Kubernetes. Los contenedores personalizados deben tener un archivo Dockerfile. Para crear una aplicación con un archivo Dockerfile, use la opción --dockerfile
con el comando func init
.
Están disponibles las siguientes opciones de implementación de Kubernetes:
Opción | Descripción |
---|---|
--dry-run |
Opcionalmente, muestra la plantilla de implementación, sin ejecución. |
--config-map-name |
Nombre opcional de una asignación de configuración existente con la configuración de la aplicación de funciones que se usará en la implementación. Se requiere --use-config-map . El comportamiento predeterminado es crear valores basados en el objeto Values en el archivo local.settings.json. |
--cooldown-period |
El período de recuperación (en segundos) después de que todos los desencadenadores ya no estén activos antes de que la implementación se vuelva a reducir verticalmente a cero, con un valor predeterminado de 300 s. |
--ignore-errors |
Continúa la implementación después de que un recurso devuelva un error. El comportamiento predeterminado es detenerse al encontrar un error. |
--image-name |
Nombre de la imagen que se va a usar para la implementación del pod y desde la que se leerán las funciones. |
--keda-version |
Establece la versión de KEDA que se va a instalar. Las opciones válidas son: v1 y v2 (predeterminado). |
--keys-secret-name |
Nombre de una colección de secretos de Kubernetes que se va a usar para almacenar claves de acceso. |
--max-replicas |
Establece el número máximo de réplicas para el que se escala Horizontal Pod Autoscaler (HPA). |
--min-replicas |
Establece el número mínimo de réplicas por debajo del cual HPA no se escala. |
--mount-funckeys-as-containervolume |
Monta las claves de acceso como un volumen de contenedor. |
--name |
Nombre usado para la implementación y otros artefactos en Kubernetes. |
--namespace |
Establece el espacio de nombres de Kubernetes en el que se va a implementar, que tiene como valor predeterminado el espacio de nombres predeterminado. |
--no-docker |
Las funciones se leen desde el directorio actual en lugar de desde una imagen. Requiere montar el sistema de archivos de imagen. |
--registry |
Una vez establecido, se ejecuta una compilación de Docker y la imagen se inserta en un registro con ese nombre. No se puede usar --registry con --image-name . Para Docker, use su nombre de usuario. |
--polling-interval |
Intervalo de sondeo (en segundos) para comprobar desencadenadores que no son HTTP, con un valor predeterminado de 30 segundos. |
--pull-secret |
Secreto que se usa para acceder a las credenciales del registro privado. |
--secret-name |
Nombre de una colección de secretos de Kubernetes existente que contiene la configuración de la aplicación de funciones que se usará en la implementación. El comportamiento predeterminado es crear valores basados en el objeto Values en el archivo local.settings.json. |
--show-service-fqdn |
Muestra las direcciones URL de los desencadenadores HTTP con el FQDN de Kubernetes en lugar del comportamiento predeterminado de usar una dirección IP. |
--service-type |
Establece el tipo de Kubernetes Service. Los valores admitidos son: ClusterIP , NodePort y LoadBalancer (predeterminado). |
--use-config-map |
Use un objeto ConfigMap (v1) en lugar de un objeto Secret (v1) para configurar la configuración de la aplicación de funciones. El nombre del mapa se establece mediante --config-map-name . |
Core Tools usa la CLI local de Docker para compilar y publicar la imagen. Asegúrese de que Docker ya esté instalado localmente. Ejecute el comando docker login
para conectarse a su cuenta.
Para obtener más información, consulte Implementación de una aplicación de funciones en Kubernetes.
func kubernetes install
Instala KEDA en un clúster de Kubernetes.
func kubernetes install
Instala KEDA en el clúster definido en el archivo de configuración kubectl.
La acción install
admite las siguientes opciones:
Opción | Descripción |
---|---|
--dry-run |
Muestra la plantilla de implementación, sin ejecución. |
--keda-version |
Establece la versión de KEDA que se va a instalar. Las opciones válidas son: v1 y v2 (predeterminado). |
--namespace |
Admite la instalación en un espacio de nombres de Kubernetes específico. Si no se establece, se usa el espacio de nombres predeterminado. |
Para obtener más información, consulte Administración de KEDA y Functions en Kubernetes.
func kubernetes remove
Quita KEDA del clúster de Kubernetes definido en el archivo de configuración kubectl.
func kubernetes remove
Quita KEDA del clúster definido en el archivo de configuración kubectl.
La acción remove
admite las siguientes opciones:
Opción | Descripción |
---|---|
--namespace |
Admite la desinstalación de un espacio de nombres de Kubernetes específico. Si no se establece, se usa el espacio de nombres predeterminado. |
Para obtener más información, consulte Desinstalación de KEDA de Kubernetes.
func settings add
Añade una nueva configuración a la colección Values
en el archivo local.settings.json.
func settings add <SETTING_NAME> <VALUE>
Reemplace <SETTING_NAME>
con el nombre de la configuración de la aplicación y <VALUE>
con el valor de la configuración.
La acción add
admite las siguientes opciones:
Opción | Descripción |
---|---|
--connectionString |
Añade el par nombre-valor a la colección ConnectionStrings en lugar de a la colección Values . Use solo la colección ConnectionStrings cuando lo requieran determinados marcos. Para obtener más información, consulte el archivo local.settings.json. |
func settings decrypt
Descifra los valores cifrados previamente en la colección Values
en el archivo local.settings.json.
func settings decrypt
También se descifran los valores de cadena de conexión de la colección ConnectionStrings
. En local.settings.json, IsEncrypted
también se establece en false
. Cifre la configuración local para reducir el riesgo de pérdida de información valiosa de local.settings.json. En Azure, las configuraciones de aplicación siempre se almacenan cifradas.
func settings delete
Quita una configuración existente de la colección Values
en el archivo local.settings.json.
func settings delete <SETTING_NAME>
Reemplace <SETTING_NAME>
con el nombre de la configuración de la aplicación y <VALUE>
con el valor de la configuración.
La acción delete
admite las siguientes opciones:
Opción | Descripción |
---|---|
--connectionString |
Quita el par nombre-valor de la colección ConnectionStrings en lugar de hacerlo de la colección Values . |
func settings encrypt
Cifra los valores de elementos individuales en la colección Values
en el archivo local.settings.json.
func settings encrypt
También se cifran los valores de cadena de conexión de la colección ConnectionStrings
. En local.settings.json, IsEncrypted
también se establece en true
, lo que especifica que el tiempo de ejecución local descifra la configuración antes de usarla. Cifre la configuración local para reducir el riesgo de pérdida de información valiosa de local.settings.json. En Azure, las configuraciones de aplicación siempre se almacenan cifradas.
func settings list
Genera una lista de opciones en la colección Values
en el archivo local.settings.json.
func settings list
También se generan las cadenas de conexión de la colección ConnectionStrings
. De forma predeterminada, los valores se enmascaran por motivos de seguridad. Puede usar la opción --showValue
para mostrar el valor real.
La acción list
admite las siguientes opciones:
Opción | Descripción |
---|---|
--showValue |
Muestra los valores reales sin máscara en la salida. |
func templates list
Enumera las plantillas de función (desencadenador) disponibles.
La acción list
admite las siguientes opciones:
Opción | Descripción |
---|---|
--language |
Lenguaje para el que filtrar las plantillas devueltas. El valor predeterminado es devolver todos los lenguajes. |