Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
В этой статье представлена справочная документация по локальной среде выполнения и инструментам, поддерживающим Функции Azure. Используйте эти инструменты для разработки, управления и запуска проектов Функции Azure с вашего локального компьютера. Бинарное название — func (или func.exe на Windows).
Доступны две версии CLI. Используйте селектор версий, чтобы выбрать, какую версию просматривать.
Внимание
В настоящее время Функции Azure CLI (v5) находится в предварительном просмотре. Эта предварительная версия пока не поддерживает Java и PowerShell. Чтобы работать с неподдерживаемых языков, продолжайте использовать Функции Azure Core Tools версии 4.
Существует две версии func.exe, используемые для разработки локальных Функции Azure:
| версия 4 | v5 | |
|---|---|---|
| Название API | Основные инструменты Функций Azure | Функции Azure CLI |
| Уровень поддержки | Общедоступность (GA) | Preview |
| Установка следа | Полный двоичный файл, включающий все команды и возможности для всех собственных языков. | Небольшая базовая установка, а также рабочие нагрузки для каждого языка и другие функции, которые вы добавляете по мере необходимости. Узел поставляется в качестве собственной рабочей нагрузки, поэтому вы получаете последнюю версию узла без повторного скачивания интерфейса командной строки. |
| Используйте, когда... | Вам нужна полная поддержка общедоступной версии для всех рабочих процессов разработки. | Вам нужен упрощенный интерфейс на основе рабочей нагрузки с новыми функциями, такими как шаблоны и профили быстрого запуска, которые поддерживают синхронизацию локальной среды с конфигурацией плана размещения Azure. |
Дополнительные сведения об использовании основных инструментов см. в статье Work с помощью основных средств Функции Azure.
Команды Core Tools организованы по приведенным ниже контекстам, каждый из которых предоставляет уникальный набор действий.
| Контекст команд | Описание |
|---|---|
func |
Команды для создания и запуска функций на локальном компьютере. |
func azure |
Команды для работы с ресурсами Azure, включая публикацию. |
func azurecontainerapps |
Команды для развертывания контейнерного приложения-функции в Контейнеры приложений Azure. |
func bundles |
Команды для управления пакетами расширений. |
func durable |
Команды для работы с Устойчивые функции. |
func extensions |
Команды для установки расширений и управления ими. |
func kubernetes |
Команды для работы с Kubernetes и Функции Azure. |
func settings |
Команды для управления параметрами среды для локального узла Функций. |
func templates |
Команды для перечисления доступных шаблонов функций. |
Прежде чем использовать команды в этой статье, установите основные средства.
Внимание
В настоящее время Функции Azure CLI (v5) находится в предварительном просмотре. Эта предварительная версия пока не поддерживает Java и PowerShell. Чтобы работать с неподдерживаемых языков, продолжайте использовать Функции Azure Core Tools версии 4.
Чтобы узнать больше об использовании CLI, включая установку и рабочие нагрузки, смотрите Develop Функции Azure локально с использованием Функции Azure CLI.
Следующие встроенные команды поставляются с базовой установкой CLI:
| Command | Описание |
|---|---|
func init |
Initialize a new Функции Azure project. |
func new |
Создайте новую функцию из шаблона. |
func run |
Запустите локальное время выполнения Функции Azure host.
func start является обратно совместимым псевдонимом. |
func quickstart |
Просматривайте и подбирайте полные функциональные приложения из каталога шаблонов быстрого запуска. |
func profile |
Inspect and manage Функции Azure CLI profiles. |
func setup |
Подготовьте локальные зависимости Функции Azure CLI (host runtime, language workers, extension bundles). |
func workload |
Управление установленными CLI-нагрузками. |
Рабочие нагрузки могут добавлять дополнительные команды верхнего уровня. Эти команды появляются только после установки соответствующей рабочей нагрузки.
func init
Создает новый проект Функций на определенном языке.
func init [<PROJECT_FOLDER>]
Когда вы вводите <PROJECT_FOLDER>, команда создаёт проект в новой папке с этим именем. В противном случае используется текущая папка.
func init Команда поддерживает следующие параметры, которые зависят от версии:
| Вариант | Описание |
|---|---|
--bundles-channel, -c |
Канал выпуска пакета расширений. Поддерживаемые значения: GA (по умолчанию) Previewи Experimental. Применимо только для проектов, отличных от .NET. |
--configuration-profile |
Инициализирует проект с профилем конфигурации узла. В настоящее время параметр --configuration-profile находится в предварительной версии. Дополнительные сведения см. в разделе "Профили конфигурации". |
--csx |
Создаёт .NET функции как C#script. Допустимо только с --worker-runtime dotnet. |
--docker |
Создаёт Dockerfile для контейнера, используя базовый образ на основе выбранного --worker-runtime. Используйте этот параметр при планировании развертывания контейнерного приложения-функции. |
--docker-only |
Добавляет Dockerfile в существующий проект. Запрашивает рабочую среду выполнения, если она не указана или задана в local.settings.json. Используйте этот параметр, когда планируется развернуть контейнерное приложение-функцию и проект уже существует. |
--force |
Инициализирует проект даже при наличии существующих файлов в проекте. Этот параметр перезаписывает имеющиеся файлы, используя те же имена. Это не влияет на другие файлы в папке проекта. |
--language, -l |
Инициализирует проект для конкретного языка. В настоящее время поддерживается, если --worker-runtime задано значение node. Возможные значения: typescript и javascript. Кроме того, можно использовать --worker-runtime javascript или --worker-runtime typescript. |
--managed-dependencies |
Устанавливает управляемые зависимости. В настоящее время только среда выполнения рабочей роли PowerShell поддерживает эту функцию. |
--model, -m |
Задает модель программирования для целевого языка, если доступно несколько моделей. Поддерживаемые параметры: V1 и V2 для Python и V3 и V4 для Node.js. Дополнительные сведения см. в руководстве разработчика Python и руководстве разработчика Node.js. |
--no-bundle |
Не настраивайте пакет расширений в host.json. Применимо только для проектов, отличных от .NET. |
--no-docs |
Пропускает создание файлов документации "Начало работы". Применимо для Python проектов. |
--skip-npm-install |
Пропустите выполнение npm install после создания проекта. Применимо для Node.js проектов. |
--source-control |
Определяет, создается ли репозиторий Git. По умолчанию репозиторий не создается. Если задано значение true, репозиторий создается. |
--worker-runtime |
Задает языковую среду выполнения для проекта. Поддерживаемые значения: csharp, dotnet, , dotnet-isolatedjavascript, node (JavaScript), powershell, pythonи typescript. Для Java используйте Maven. Чтобы создать проект, не зависящий от языка, только с файлами проекта, используйте custom. Если этот параметр не задан, вам будет предложено выбрать среду выполнения во время инициализации. |
--target-framework |
Задает целевую платформу для проекта приложения-функции. Допустимо только с --worker-runtime dotnet-isolated. Поддерживаемые значения: net10.0 (предварительная версия), net9.0, net8.0 (по умолчанию), net6.0 и net48 (.NET Framework 4.8). |
Примечание.
При использовании параметра --docker или --docker-only core Tools автоматически создает Dockerfile для C#, JavaScript, Python и функций PowerShell. Для функций Java необходимо вручную создать Dockerfile. Дополнительные сведения см. в разделе "Создание контейнерных приложений-функций".
Профили конфигурации
Внимание
Поддержка профилей конфигурации в настоящее время доступна в предварительной версии.
Когда вы используете эту --configuration-profile опцию, вы создаёте заранее определённый набор конфигураций и настроек проекта. При указании профиля конфигурации инициализация может пропустить все остальные шаги инициализации.
| Значение профиля | Описание | Конкретные действия |
|---|---|---|
mcp-custom-handler |
Создает проект, использующий пользовательские обработчики для размещения сервера MCP (протокол контекста модели), к которому могут подключаться агенты ИИ и другие клиенты MCP. | • Настраивает "configurationProfile": "mcp-custom-handler" элемент в файле host.json с определенными параметрами пользовательского обработчика.• Задает MCP_EXTENSION_ENABLED значение true в local.settings.json. |
func init [<PATH>] [options]
Когда вы предоставляете <PATH>, проект создаётся в этой папке. В противном случае используется текущая папка.
Команда func init поддерживает следующие встроенные опции:
| Вариант | Описание |
|---|---|
--stack, -s |
Стек для проекта (например, python, node, dotnet, go). Проверьте func workload list стеки, которые вносят ваши установленные рабочие нагрузки. |
--name, -n |
Название проекта функционального приложения. |
--language, -l |
Язык программирования (например, C#, F#, JavaScript, TypeScript, Python). Используется, когда стек поддерживает более одного языка. Поддерживаемые значения вычисляются из установленных рабочих нагрузок. |
--force |
Переинициализируйте даже тогда, когда целевая папка не пуста. Очищает папку (кроме .git) перед установкой строительных лесов. |
Рабочие нагрузки добавляют дополнительные опции, которые сгруппированы под названием рабочей нагрузки в func init --help. Смотрите параметры для конкретных нагрузок для каждого стека.
Если ни одна рабочая нагрузка не предоставляет запрошенный стек, CLI печатает подсказку, указывающую на func workload install и выходящую с ненулевой кодом выхода.
Опции, зависящие от нагрузки
init Команда расширяется при установке одной или нескольких из следующих задач:
| Вариант | Описание |
|---|---|
--target-framework, -tfm |
Целевой .NET фреймворк проекта (например, net10.0). По умолчанию: net10.0. |
Инициализатор .NET не пишет блок расширения bundle, поэтому --no-bundles и --bundles-channel не применимы.
Когда более одной установленной рабочей нагрузки добавляют одну и ту же опцию, эта опция появляется при .func init --help
Общие варианты
В настоящее время общие опции — это --no-bundles и --bundles-channel. Идентификатор пакета расширения по умолчанию, в который вы записываетеhost.json , зависит от выбранного канала:
| Канал | Идентификатор пакета |
|---|---|
GA (по умолчанию) |
Microsoft.Azure.Functions.ExtensionBundle |
Preview |
Microsoft.Azure.Functions.ExtensionBundle.Preview |
Experimental |
Microsoft.Azure.Functions.ExtensionBundle.Experimental |
Стандартный диапазон версий — [4.*, 5.0.0).
func new
Создает функцию в текущем проекте на основе шаблона.
func new
func new Команда поддерживает следующие параметры, которые зависят от версии:
| Вариант | Описание |
|---|---|
--authlevel, -a |
Задает уровень авторизации для триггера HTTP. Поддерживаемые значения: function, anonymous и admin. Авторизация не применяется принудительно при локальном запуске. Для получения дополнительной информации см. Уровень авторизации. |
--csx |
Генерирует те же шаблоны скриптов C# (.csx), что и в версии 1 и в портале. |
--file, -f |
Целевой файл для новой функции. Для проектов Python версии 2 указывает файл, в который необходимо добавить функцию (по умолчанию используется значение function_app.py). Для Node.js проектов версии 4 укажите имя выходного файла в папке src/functions . Неприменимо для скомпилированных .NET проектов. |
--name, -n |
имя функции. |
--template, -t |
Используйте команду func templates list, чтобы просмотреть полный список доступных шаблонов для каждого поддерживаемого языка. |
Дополнительные сведения см. в статье Создание функции.
func new [<PATH>] [options]
Внимание
func new в настоящее время является предварительной заготовкой. Он печатает подсказку для установки рабочей нагрузки и выходит с ненулевой кодом выхода, пока не будет установлена и подключена шаблонная нагрузка. Параметры, специфичные для шаблона, динамически увлажняются из метаданных шаблона, поэтому добавление новой опции шаблона не требует выпуска CLI.
Команда func new поддерживает следующие встроенные опции:
| Вариант | Описание |
|---|---|
--name, -n |
имя функции. |
--template, -t |
Название шаблона функции. Доступные шаблоны берутся из установленной <stack>-templates рабочей нагрузки для стека проекта. |
--force |
Перезаписать существующие файлы. |
Дополнительные опции динамически вносятся выбранным шаблоном. Побегите func new --template <name> --help посмотреть варианты конкретного шаблона.
Если для текущего проекта не установлена рабочая нагрузка шаблонов, CLI печатает подсказку, указывающую на func workload install.
func logs
Возвращает журналы для функций, выполняемых в кластере Kubernetes.
func logs --platform kubernetes --name <APP_NAME>
Эта func logs команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--platform |
Платформа размещения для приложения-функции. Допустимые параметры: kubernetes. |
--name |
Имя приложения-функции в Azure. |
Дополнительные сведения см. в разделе Функции Azure на Kubernetes с KEDA.
func pack
Создает пакет развертывания, содержащий код проекта в состоянии запуска. Используйте этот метод, если необходимо вручную создать пакет развертывания для приложения на локальном компьютере за пределами func azure functionapp publish команды. По умолчанию выполняет сборку func pack проекта по мере необходимости.
Для приложений функции Go func pack создает пакет развертывания Linux x64, который можно развернуть с помощью команды Azure CLI az functionapp deployment source config-zip.
func pack [<FOLDER_PATH>]
По умолчанию func pack пакеты текущего каталога и выходные данные .zip файла имеют то же имя, что и корневая папка проекта. Запустите func pack в каталоге, который содержит файл проекта host.json . Если вам нужно запустить func pack в другом каталоге, задайте <FOLDER_PATH> путь к корневому каталогу проекта, например func pack ./myprojectroot. Если конкретный файл .zip уже существует, он сначала удаляется, а затем заменяется обновленной версией.
Эта func pack команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--output, -o |
Задает путь к расположению, в котором создается файл пакета .zip развертывания. |
--no-build |
Project не создается перед упаковкой. Для приложений C# используйте только в том случае, если вы уже создали двоичные файлы. Для Node.js приложений npm install оба и npm run build пропускаются. Для Go-приложений используйте только тогда, когда bin/app уже содержит бинарный файл Linux x64. |
--skip-install |
Пропускает выполнение npm install при упаковке приложения-функции на основе Node.js. Используется для предотвращения перезаписи пользовательских модулей npm. |
--build-native-deps |
Устанавливает Python зависимости локально с помощью образа, соответствующего среде, используемой в Azure. При включении Core Tools запускает контейнер Docker, создает приложение внутри этого контейнера и создает файл .zip со всеми зависимостями, восстановленными в .python_packages. Используйте этот параметр при выполнении Windows, чтобы избежать потенциальных проблем с библиотекой при развертывании в Linux в Azure. |
func run (только v1)
Примечание.
Эта команда применяется только к версии 1 Core Tools и является устаревшей. Для версии 4 используйте func start и вызывайте конечную точку функции напрямую.
Вызывает функцию напрямую, аналогично запуску функции с помощью вкладки Test в портале Azure.
func run
Эта func run команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--content |
Встроенное содержимое, передаваемое функции. |
--debug |
Подключение отладчика к хост-процессу перед выполнением функции. |
--file |
Имя файла для использования в качестве содержимого. |
--no-interactive |
Не запрашивает входные данные, что удобно для сценариев автоматизации. |
--timeout |
Время ожидания (в секундах), пока не будет готов локальный узел службы "Функции". |
Например, чтобы вызвать функцию с триггером HTTP и передать текст содержимого, выполните следующую команду:
func run MyHttpTrigger --content '{\"name\": \"Azure\"}'
func start
Запускает локальный узел среды выполнения и загружает проект функции в текущей папке.
Конкретная команда зависит от версии среды выполнения.
func start
Эта func start команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--cert |
Путь к PFX-файлу, который содержит закрытый ключ. Поддерживается только с --useHttps. |
--cors |
Список разрешенных источников CORS, разделенный запятыми без пробелов. |
--cors-credentials |
Разрешает запросы, прошедшие проверку подлинности между источниками, использующие файлы cookie и заголовок проверки подлинности. |
--dotnet-isolated-debug |
Если задано значение true, приостанавливает рабочий процесс .NET до подключения отладчика из изолированного проекта .NET. |
--enable-json-output |
По возможности выводит журналы консоли в формате JSON. |
--enableAuth |
Включает полный конвейер обработки проверки подлинности с требованиями авторизации. |
--functions |
Список загружаемых функций, разделенных пробелами. |
--json-output-file |
Если он указан, путь к файлу, используемому для записи выходных данных при использовании --enable-json-output. |
--language-worker |
Аргументы для настройки обработчика языка. Например, можно включить отладку для рабочей роли языка, предоставив порт debug и другие обязательные аргументы. |
--no-build |
Сборка текущего проекта перед запуском не выполняется. Только для проектов классов .NET. По умолчанию — false. |
--password |
Пароль или файл, содержащий пароль для PFX-файла. Используется только с --cert. |
--port, -p |
Локальный порт для прослушивания. Значение по умолчанию: 7071. |
--runtime |
Задает версию узла, которую нужно запустить. Допустимые значения: inproc6, inproc8и default (который выполняет узел вне процесса). |
--timeout, -t |
Время ожидания для запуска узла службы "Функции" в секундах. Значение по умолчанию — 20 секунд. |
--useHttps |
Привязка к https://localhost:{port}, а не к http://localhost:{port}. По умолчанию этот параметр создает доверенный сертификат на компьютере. |
--user-log-level |
Задает минимальный уровень журнала для журналов пользователей. Допустимые значения: Trace, Debug, Information, Warning, Error, Criticalи None. Этот параметр не влияет на системные журналы. Для изолированных проектов .NET также задайте минимальный уровень в Program.cs с помощью builder.Logging.SetMinimumLevel(LogLevel.Debug) для этого параметра. |
При выполнении проекта проверьте отдельные конечные точки функций.
func run
Запускает время выполнения Functions и загружает проект в текущую папку.
func run [<PATH>] [options]
func start сохраняется как обратно совместимый псевдоним и принимает те же аргументы и опции.
Эта func run команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--port, -p |
Локальный порт для прослушивания. По умолчанию: 7071. |
--cors |
Список разрешенных источников CORS, разделенный запятыми без пробелов. |
--cors-credentials |
Разрешить кросс-оригинальные аутентифицированные запросы с использованием файлов cookie и заголовка Authentication . |
--functions |
Список загружаемых функций, разделенных пробелами. |
--no-build |
Не стройте проект до запуска. |
--enable-auth |
Включить полный конвейер обработки аутентификации, включая требования авторизации. |
--host-version, -v |
Версия выполнения хоста для использования (например, 4.1049.0). |
--profile |
Профиль Функции Azure для применения при разрешении версий host, worker и bundle. См. func profile. |
--offline |
Используйте только локально установленные рабочие нагрузки и пропускайте сетевые установки. |
--output |
Режим вывода: compact (интерактивный TUI), plain (CI / не TTY) или json (NDJSON для программных потребителей и агентов ИИ). По умолчанию автоматическое обнаружение зависит от терминала. |
--no-tui |
Псевдоним для --output=plain. Отключает интерактивный TUI. |
--log-file |
Зеркализуйте все события хоста в указанный файл журнала. |
--no-azurite |
Отключил управляемый Азурит. Ведущий запускается без зонда и запуска локального эмулятора. |
Когда проект запущен, вызовите конечные точки функции напрямую для проверки поведения.
Управляемый Azurite
Когда ваш проект использует локальное хранилище (например, AzureWebJobsStorage=UseDevelopmentStorage=true), func run автоматически проверяет наличие запущенного эмулятора Azurite и запускает его, если не найдёт его. Эмулятор останавливается при func run выходе. Пропустите --no-azurite возможность отказаться и управлять Azurite самостоятельно.
Режимы вывода
func run Автоматически выбирает выходной режим на основе клеммы:
| Состояние | Mode |
|---|---|
| Интерактивный терминал (TTY) | compact |
Неинтерактивный stdout, перенаправленный выход или CI набор переменных среды |
plain |
Явные --output=json |
json |
CLI никогда не выбирает автоматически json. Если compact запрашивают, но stdout не является TTY, CLI понижает статус plain и пишет однострочное уведомление stderr. Режим json излучает JSON с новострочным ограничением (NDJSON), один объект на строку с элементом schema_version .1
func quickstart
Browses and scaffolds complete function apps из каталога шаблонов Функции Azure quickstart. Шаблоны быстрого запуска — это полноценные примеры приложений, такие как HTTP-API, worker, триггерируемый очередью, или оркестрация Устойчивые функции. Нагрузки стека вносят вклад в языкоспецифические резольверы. Каталог загружается во время команды-вызова.
func quickstart [<PATH>] [options]
Когда вы предоставляете <PATH>, проект создаётся в этой папке. В противном случае используется текущая папка.
Эта func quickstart команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--stack, -s |
Стек для использования, например python, node, или dotnet. |
--language, -l |
Язык программирования. Поддерживаемые значения поступают от установленных провайдеров быстрого запуска. |
--template, -t |
Идентификатор шаблона из каталога, например http-trigger-python-azd. Пропускает все интерактивные подсказки. |
--resource, -r |
Фильтруйте по триггеру или связывающему ресурсу, такому httpкак , timer, blobeventhubservicebuscosmossqlmcpили .durable |
--iac |
Фильтруйте по типу инфраструктуры как кода, например bicep, , terraformили none. |
--search |
Фильтр подстрок без регистра, применяемый к названиям шаблонов и описаниям. |
--fetch |
Стратегия поиска из каталога: auto (по умолчанию), git, или http.
auto проверяет git HTTP и возвращается к нему. |
--force |
Строительные леса даже если папка с целями не пуста. Очищает папку (кроме .git) перед установкой строительных лесов. |
Подкоманды:
| Subcommand | Описание |
|---|---|
func quickstart list |
Перечислите доступные шаблоны в каталоге. |
func quickstart info |
Покажите детали конкретного шаблона. |
func quickstart list
Список доступных шаблонов из каталога, по желанию отфильтрованных.
func quickstart list [options]
| Вариант | Описание |
|---|---|
--stack, -s |
Стек для использования, например python, node, или dotnet. |
--language, -l |
Язык программирования. Поддерживаемые значения поступают от установленных провайдеров быстрого запуска. |
--resource, -r |
Фильтруйте по триггеру или ресурсу связывания. |
--iac |
Фильтруйте по типу инфраструктуры как кода. |
--search |
Сопоставление подстрок без регистра с идентификаторами, названиями шаблонов, типом ресурса, типом инфраструктуры как кода и описаниями. |
--json |
Излучайте машиночитаемый JSON вместо таблицы. |
func quickstart info
Отображает подробную информацию о конкретном шаблоне.
func quickstart info <ID> [options]
<ID> — это идентификатор шаблона из каталога. Используйте func quickstart list для поиска доступных удостоверений личности.
| Вариант | Описание |
|---|---|
--json |
Излучайте машиночитаемый JSON вместо форматированного вывода. |
func profile
Inspects and manages Функции Azure CLI profiles. Профили кодируют ограничения версии, такие как диапазон версий хоста, диапазон версий расширения и диапазоны версий рабочих. Они также определяют наследование от других профилей. Источники профиля включают project-local (.func/profiles/), user-global (~/.azure-functions/profiles/), и встроенные профили. Используйте func run --profile <name> опцию, чтобы выбрать, какие ограничения профиля применяются при запуске хоста.
func profile <subcommand>
Подкоманды:
| Subcommand | Описание |
|---|---|
func profile list |
Список профилей, доступных из проектных, пользовательских и встроенных источников. |
func profile show |
Покажите детали для профиля. |
func profile set |
Установите профиль по умолчанию для проекта. |
func profile list
Перечисляет профили, доступные из проектных, пользовательских и встроенных источников. Отображается таблица имени, исходного кода, версии хоста, расширения и статуса.
func profile list [<PATH>] [options]
| Вариант | Описание |
|---|---|
--source |
Список источников с разделёнными запятыми включает: project, user, . built-in По умолчанию используется все источники. |
--json |
Излучайте машиночитаемый JSON вместо таблицы. |
func profile show
Показывает детали для одного профиля, либо разрешённого (с применением наследуемых значений), либо в исходном виде (определение как написано, без расширения наследования).
func profile show <NAME> [<PATH>] [options]
| Вариант | Описание |
|---|---|
--raw |
Покажите исходное определение профиля без унаследованных значений. |
func profile set
Устанавливает профиль по умолчанию для проекта Functions, вводя имя профиля в .func/config.json. Если профиль ещё нет в списке профилей проекта, добавляйте его.
func profile set <NAME> [<PATH>]
func setup
Готовит локальную машину для запуска проектов Функции Azure. Устанавливает или проверяет сервер выполнения хоста, языковые рабочие, пакеты расширений и шаблоны для выбранных вами стеков. Поддерживает ограничения версии на основе профиля, выбор предрелиза, неинтерактивный режим CI и режим только проверки.
func setup [<PATH>] [options]
--features Выбирает, что устанавливать или проверять. Функции и нагрузки, которые решает каждый из них, следующие:
| Функция | Установленные рабочие нагрузки |
|---|---|
node |
host, , bundlesnode, node-workernode-templates |
python |
host, , bundlespython, python-workerpython-templates |
go |
host, , bundlesgogo-worker |
dotnet |
host, , dotnetdotnet-templates |
runtime |
host, bundles |
host |
Только host |
--features повторяется и принимает значения с разделёнными запятыми, поэтому можно объединять признаки в одном вызове (например, func setup --features node,python).
dotnet-isolated принимается как псевдоним для dotnet.
| Вариант | Описание |
|---|---|
--features |
Компоненты для установки или проверки. Повторяется или разделяется по запятым. Смотрите таблицу выше с нагрузками, которые устанавливает каждая функция. |
--profile |
Функции Azure profile to use for version constraints. Повторяемые. Объединён с --profiles. |
--profiles |
Comma-separated list of Функции Azure profiles to use for version constraints. |
--install-policy |
Политика установки: latest-compatible (по умолчанию) или if-needed. |
--source |
NuGet — исходный код пакета для разрешения и установки рабочей нагрузки. |
--prerelease |
Разрешить версии рабочей нагрузки до релиза при разрешении из каталога. По умолчанию: включено, пока рабочие нагрузки находятся в предварительном просмотре. |
--non-interactive |
Не спрашивайте вводные советы. |
--yes, -y |
Ответьте «да» на подсказки по настройке. |
--check |
Проверьте, установлены ли выбранные зависимости, без изменений. |
--output |
Режим вывода: plain (по умолчанию) или json (NDJSON). |
func workload
Управляет рабочими нагрузками, установленными для Функции Azure CLI.
func workload <subcommand>
Подкоманды:
| Subcommand | Описание |
|---|---|
func workload list |
Перечислите установленные нагрузки. |
func workload search |
Ищите в каталоге рабочей нагрузки. |
func workload install |
Установите рабочую нагрузку. |
func workload update |
Обновите установленную рабочую нагрузку. |
func workload uninstall |
Удалить рабочую нагрузку. |
func workload prune |
Удалите неактивные установки рабочих нагрузок рядом с ними. |
func workload list
Выводит список установленных рабочих нагрузок. По умолчанию команда показывает только загруженную версию (самая высокая установленная семвер) каждой рабочей нагрузки. Используйте --all-versions для просмотра каждой установки бок о бок.
func workload list [options]
| Вариант | Описание |
|---|---|
--all-versions, -a |
Перечислите все установленные версии каждой рабочей нагрузки. По умолчанию: только загруженная версия. |
--json |
Излучайте машиночитаемый JSON вместо таблицы. |
func workload search
Ищет в каталоге настроенных рабочих нагрузок доступные пакеты рабочих нагрузок.
func workload search [<QUERY>] [options]
Когда вы опускаете <QUERY>, команда перечисляет все рабочие нагрузки в каталоге.
| Вариант | Описание |
|---|---|
--source |
Используйте URL источника каталога для поиска. По умолчанию настроен на настроенный каталог. |
--prerelease |
Включайте версии до релиза в результаты. По умолчанию: включено, пока рабочие нагрузки находятся в предварительном просмотре. |
--json |
Излучайте машиночитаемый JSON вместо таблицы. |
func workload install
Разрешает идентификатор пакета рабочей нагрузки (или псевдоним) через настроенный каталог и устанавливает его.
func workload install <ID> [options]
<ID> может быть идентификатор пакета рабочей нагрузки, псевдоним (например python), или путь к локальному файлу пакета рабочей нагрузки.
| Вариант | Описание |
|---|---|
--version, -v |
Конкретная версия для установки. По умолчанию: последняя стабильная версия в каталоге. |
--source |
Используйте URL источника каталога или локальный каталог для разрешения. По умолчанию: настроенный каталог. |
--prerelease |
Разрешить версии с пререлизом при разрешении из каталога. По умолчанию: включено, пока рабочие нагрузки находятся в предварительном просмотре. |
--force, -f |
Перезапишите существующую установку того же ID и версии. Также пропускает запрос «использовать обновление вместо этого». |
--exact, -e |
Отключите сопоставление псевдонимов.
<ID> должно быть буквально идентификатором посылки. |
Если версия рабочей нагрузки уже установлена, CLI предлагает использовать func workload update её её. Неинтерактивные контексты рассматривают запрос как отказ.
func workload update
Выполняет замену атомарной версии на месте для установленной рабочей нагрузки. Обновления не идут рядом; Для установок рядом с ним используйте func workload install --force.
func workload update [<ID>] [options]
Передайте <ID> AN для обновления одной рабочей нагрузки или --all для обновления всех установленных нагрузок. Укажите ровно один из этих двух вариантов.
| Вариант | Описание |
|---|---|
--version, -v |
Установленная версия для замены. По умолчанию: самая высокая установленная версия. |
--all |
Обновляйте каждую установленную нагрузку. Взаимоисключающ с <ID>. |
--major |
Разрешить пересечение границы основной версии. По умолчанию: только одна и та же специальность. |
--source |
Используйте URL источника каталога или локальный каталог для разрешения. По умолчанию: настроенный каталог. |
--prerelease |
Разрешить версии с пререлизом при разрешении из каталога. По умолчанию: включено, пока рабочие нагрузки находятся в предварительном просмотре. |
--exact, -e |
Отключите сопоставление псевдонимов.
<ID> должно быть буквально идентификатором посылки. |
func workload uninstall
Удаляет одну или все установленные версии рабочей нагрузки.
func workload uninstall <ID> [options]
| Вариант | Описание |
|---|---|
--version, -v |
Конкретная версия для удаления. По умолчанию: единственная установленная версия. |
--all-versions, -a |
Удалите все установленные версии рабочей нагрузки. Взаимоисключающ с --version. |
--exact, -e |
Отключите сопоставление псевдонимов.
<ID> должно быть буквально идентификатором посылки. |
func workload prune
Удаляет неактивные установки рабочей нагрузки бок о бок. Для каждого идентификатора пакета в области действия команда сохраняет самую высокую установленную версию и удаляет старые версии. Эта команда работает только локально и никогда не касается каталога.
func workload prune [<ID>] [options]
Когда вы его <ID>опускаете, команда обрезает все установленные задачи.
| Вариант | Описание |
|---|---|
--exact, -e |
Отключите сопоставление псевдонимов.
<ID> должно быть буквально идентификатором посылки. |
func azure functionapp
Контекст func azure functionapp содержит следующие команды:
func azure functionapp fetch-app-settingsfunc azure functionapp list-functionsfunc azure functionapp logstreamfunc azure functionapp publish
Все func azure functionapp команды поддерживают следующие параметры:
| Вариант | Описание |
|---|---|
--slot |
Предназначен для определенного именованного слота развертывания, если настроено. |
--access-token |
Предоставляет маркер доступа, отличный от маркера по умолчанию, чтобы использовать для выполнения прошедших проверку подлинности действий в Azure. |
--access-token-stdin |
Считывает определенный маркер доступа из стандартных входных данных. Используйте этот параметр при чтении маркера непосредственно из предыдущей команды, например az account get-access-token. |
--management-url |
Задает URL-адрес управления для облака Azure, который по умолчанию используется для https://management.azure.com. Используйте этот параметр, если приложение-функция работает в национальном облаке. |
--subscription |
Задает подписку по умолчанию Azure. |
func azure functionapp fetch-app-settings
Возвращает параметры из конкретного приложения-функции.
func azure functionapp fetch-app-settings <APP_NAME>
Дополнительные сведения см. в разделе "Скачать параметры приложения".
Команда загружает настройки в файлlocal.settings.json проекта. Значения на экране маскируются для обеспечения безопасности. Вы можете защитить настройки в файлеlocal.settings.json , включив локальное шифрование.
func azure functionapp list-functions
Выводит список функций в указанном приложении-функции.
func azure functionapp list-functions <APP_NAME>
Эта func azure functionapp list-functions команда поддерживает следующий параметр:
| Вариант | Описание |
|---|---|
--show-keys |
Включите значения ключей доступа уровня функций в URL-адреса возвращаемой конечной точки функции. |
func azure functionapp logstream
Подключает локальную командную строку к журналам потоковой передачи приложения-функции в Azure.
func azure functionapp logstream <APP_NAME>
Время ожидания подключения по умолчанию составляет 2 часа. Измените время ожидания, добавив параметр приложения с именем SCM_LOGSTREAM_TIMEOUT с значением времени ожидания в секундах. Пока не поддерживается для Linux в плане потребления или потребления Flex. Для этих приложений используйте параметр --browser для просмотра журналов на портале.
Эта func azure functionapp logstream команда поддерживает следующий параметр:
| Вариант | Описание |
|---|---|
--browser |
Откройте приложение Azure Insights Live Stream для приложения-функции в браузере по умолчанию. |
Дополнительные сведения см. в журналах выполнения потоковой передачи Enable в Функции Azure.
func azure functionapp publish
Развертывает проект Функций в существующем ресурсе приложения-функции в Azure.
func azure functionapp publish <APP_NAME>
Дополнительные сведения см. в разделе Развертывание файлов проекта.
В зависимости от версии применяются следующие параметры публикации:
| Вариант | Описание |
|---|---|
--additional-packages |
Создает список пакетов установки при создании собственных зависимостей. Например: python3-dev libevent-dev. |
--build, -b |
Выполняет действие сборки при развертывании в приложении-функции Linux. Принимает значения remote и local. |
--build-native-deps |
Пропускает создание папки .wheels при публикации приложений-функций Python. |
--csx |
Публикует проект скрипта C# (CSX). |
--dotnet-cli-params |
При публикации скомпилированных функций C# (CSPROJ) вызываются dotnet build --output bin/publishосновные средства. Все параметры, передаваемые этому параметру, добавляются в командную строку. |
--dotnet-version |
Для приложений dotnet-isolated указывает целевую версию .NET (например, 8.0). |
--force |
Игнорирует предварительную проверку подлинности в определенных сценариях. |
--list-ignored-files |
Отображает список файлов, которые игнорируются во время публикации на основе файла funcignore . |
--list-included-files |
Отображает список опубликованных файлов, основанных на файле funcignore . |
--no-build |
Project не создается во время публикации. Для Python pip install не выполняется. |
--nozip |
Выключает режим по умолчанию Run-From-Package. Извлекает файлы wwwroot в папку на сервере, а не запускает их непосредственно из пакета развертывания. |
--overwrite-settings, -y |
Подавляет запрос на перезапись параметров приложения при использовании --publish-local-settings -i. |
--publish-local-settings, -i |
Публикует параметры в local.settings.json в Azure, запрашивая перезаписать, если параметр уже существует. Если вы используете локальный эмулятор хранилища, сначала измените параметр приложения на фактическое подключение к хранилищу. |
--publish-settings-only, -o |
Публикует только параметры и пропускает содержимое. Значение по умолчанию — запрос. |
--show-keys |
Добавляет ключи функций в URL-адреса, отображаемые в журналах. |
func azure storage fetch-connection-string
Возвращает строка подключения для указанной учетной записи служба хранилища Azure.
func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>
Дополнительные сведения см. в разделе download a storage строка подключения.
func azurecontainerapps deploy
Развертывает контейнерное приложение-функцию в среде Контейнеры приложений Azure. Аккаунт хранения по умолчанию, функциональное приложение и среда должны уже существовать. Дополнительные сведения см. в разделе Контейнеры приложений Azure размещения Функции 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>
Применяются следующие варианты развертывания:
| Вариант | Описание |
|---|---|
--environment |
Имя существующей среды приложений контейнеров. |
--image-build |
Установите для true пропуска локальной сборки Docker. |
--image-name |
Имя существующего образа контейнера в реестре контейнеров, включая имя тега. |
--location |
Регион развертывания. В идеале этот регион совпадает с ресурсами среды и учетной записи хранения. |
--name |
Имя, используемое для развертывания приложения-функции в среде "Приложения контейнеров". Это имя также отображается при управлении приложением-функцией на портале. Имя должно быть уникальным в среде. |
--registry |
При установке сборка Docker выполняется и образ отправляется в --registryнабор реестра. Невозможно использовать --registry с --image-name. Для Docker Hub также используйте --registry-username. |
--registry-password |
Пароль или маркер, используемый для извлечения образа из частного реестра. |
--registry-username |
Имя пользователя, используемое для извлечения образа из частного реестра. |
--resource-group |
Группа ресурсов, в которой создаются ресурсы, связанные с функциями. |
--storage-account |
Connection string для учетной записи хранения, используемой приложением-функцией. |
--worker-runtime |
Задает язык среды выполнения приложения-функции. Этот параметр используется только с --image-name и --image-build; в противном случае язык определяется во время локальной сборки. Поддерживаемые значения: dotnet, , dotnetIsolatednode, pythonpowershellи custom (для пользовательских обработчиков). |
Внимание
Строка подключения хранилища и другие учетные данные службы являются важными секретами. Безопасно храните файлы скриптов, которые используют func azurecontainerapps deploy и не хранят их в общедоступном элементе управления версиями.
func deploy
Команда func deploy устарела. Вместо этого используйте func kubernetes deploy.
func bundles add
Добавляет конфигурацию пакета расширений в файл host.json .
func bundles add
Эта func bundles add команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--force, -f |
При наличии перезаписывает существующую конфигурацию пакета расширений. |
--channel, -c |
Канал выпуска пакета расширений. Поддерживаемые значения: GA (по умолчанию) Previewи Experimental. |
func bundles download
Загружает пакет расширений, настроенный в host.json.
func bundles download
Эта func bundles download команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--force, -f |
Принудительно перезагрузить пакет расширений, даже если он уже присутствует. |
func bundles list
Перечисляет скачанные пакеты расширений.
func bundles list
func bundles path
Возвращает путь к скачанной пакету расширений.
func bundles path
func durable delete-task-hub
Удаляет все артефакты хранилища в центре задач Устойчивые функции.
func durable delete-task-hub
Эта func durable delete-task-hub команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--connection-string-setting |
Имя параметра, содержащего используемый строка подключения хранилища. |
--task-hub-name |
Имя концентратора устойчивых задач для использования. |
Дополнительные сведения см. в документации Устойчивые функции.
func durable get-history
Возвращает журнал указанного экземпляра оркестрации.
func durable get-history --id <INSTANCE_ID>
Эта func durable get-history команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--id |
Идентификатор экземпляра оркестрации. (Обязательно) |
--connection-string-setting |
Имя параметра, имеющего хранилище строка подключения для использования. |
--task-hub-name |
Имя концентратора устойчивых задач для использования. |
Дополнительные сведения см. в документации Устойчивые функции.
func durable get-instances
Возвращает состояние всех экземпляров оркестрации. Эта команда поддерживает пейджинг с помощью параметра top .
func durable get-instances
Эта func durable get-instances команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--continuation-token |
Маркер, указывающий определенную страницу или раздел возвращаемых запросов. |
--connection-string-setting |
Имя параметра приложения, содержащего используемое хранилище строка подключения. |
--created-after |
Получите экземпляры, созданные после этой даты и времени (UTC). Принимаются любые значения даты и времени в формате ISO 8601. |
--created-before |
Получите экземпляры, созданные до определенной даты и времени (UTC). Принимаются любые значения даты и времени в формате ISO 8601. |
--runtime-status |
Получение экземпляров, состояние которых соответствует определенному состоянию, включая running, completedи failed. Можно указать одно или несколько состояний, разделенных пробелами. |
--top |
Ограничение количества записей, возвращаемых в заданном запросе. |
--task-hub-name |
Имя используемого центра задач Устойчивые функции. |
Дополнительные сведения см. в документации Устойчивые функции.
func durable get-runtime-status
Возвращает состояние указанного экземпляра оркестрации.
func durable get-runtime-status --id <INSTANCE_ID>
Эта func durable get-runtime-status команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--connection-string-setting |
Имя параметра, содержащего используемый строка подключения хранилища. |
--id |
Идентификатор экземпляра оркестрации. (Обязательно) |
--show-input |
При установке ответ включает входные данные функции. |
--show-output |
При установке ответ включает журнал выполнения. |
--task-hub-name |
Имя используемого центра задач Устойчивые функции. |
Дополнительные сведения см. в документации Устойчивые функции.
func durable purge-history
Очищает состояние экземпляра оркестрации, журнал и хранилище BLOB-объектов для оркестрации старше указанного порогового значения.
func durable purge-history
Эта func durable purge-history команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--connection-string-setting |
Имя параметра, содержащего используемый строка подключения хранилища. |
--created-after |
Удалите журнал экземпляров, созданных после этой даты и времени (UTC). Принимаются любые значения даты и времени в формате ISO 8601. |
--created-before |
Удалите журнал экземпляров, созданных до этой даты и времени (UTC). Принимаются любые значения даты и времени в формате ISO 8601. |
--runtime-status |
Удалите журнал экземпляров, состояние которых соответствует определенному состоянию, включая completed, terminatedcanceledи failed. Укажите одно или несколько состояний, разделенных пробелами. Если не указать --runtime-status, то журнал экземпляра удаляется независимо от состояния. |
--task-hub-name |
Имя используемого центра задач Устойчивые функции. |
Дополнительные сведения см. в документации Устойчивые функции.
func durable raise-event
Порождает событие в указанном экземпляре оркестрации.
func durable raise-event --event-name <EVENT_NAME> --event-data <DATA>
Эта func durable raise-event команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--connection-string-setting |
Имя параметра, содержащего используемый строка подключения хранилища. |
--event-data |
Данные для передачи в событие либо в виде встроенного, либо из JSON-файла. Для файлов префикс путь к файлу с помощью знака (@), например @path/to/file.json. (Обязательно) |
--event-name |
Имя создаваемого события. (Обязательно) |
--id |
Идентификатор экземпляра оркестрации. (Обязательно) |
--task-hub-name |
Имя используемого центра задач Устойчивые функции. |
Дополнительные сведения см. в документации Устойчивые функции.
func durable rewind
Перематывает назад указанный экземпляр оркестрации.
func durable rewind --id <INSTANCE_ID> --reason <REASON>
Эта func durable rewind команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--connection-string-setting |
Имя параметра, содержащего используемый строка подключения хранилища. |
--id |
Идентификатор экземпляра оркестрации. (Обязательно) |
--reason |
Причина перемотки оркестрации. (Обязательно) |
--task-hub-name |
Имя используемого центра задач Устойчивые функции. |
Дополнительные сведения см. в документации Устойчивые функции.
func durable start-new
Запускает новый экземпляр указанной функции оркестратора.
func durable start-new --id <INSTANCE_ID> --function-name <FUNCTION_NAME> --input <INPUT>
Эта func durable start-new команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--connection-string-setting |
Имя параметра, содержащего используемый строка подключения хранилища. |
--function-name |
Имя запуска функции оркестратора. (Обязательно) |
--id |
Указывает идентификатор экземпляра оркестрации. (Обязательно) |
--input |
Входные данные в функцию оркестратора либо встроенные, либо из JSON-файла. Для файлов префикс путь к файлу с амперсандом (@), например @path/to/file.json. (Обязательно) |
--task-hub-name |
Имя используемого центра задач Устойчивые функции. |
Дополнительные сведения см. в документации Устойчивые функции.
func durable terminate
Заканчивает указанный экземпляр оркестрации.
func durable terminate --id <INSTANCE_ID> --reason <REASON>
Эта func durable terminate команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--connection-string-setting |
Имя параметра, содержащего используемый строка подключения хранилища. |
--id |
Указывает идентификатор экземпляра оркестрации. (Обязательно) |
--reason |
Причина завершения оркестрации. (Обязательно) |
--task-hub-name |
Имя используемого центра задач Устойчивые функции. |
Дополнительные сведения см. в документации Устойчивые функции.
func extensions install
Вручную устанавливает расширения функций в проекте, отличном от .NET, или в проекте скрипта C#.
func extensions install --package Microsoft.Azure.WebJobs.Extensions.<EXTENSION> --version <VERSION>
Эта func extensions install команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--configPath, -c |
Путь к каталогу, содержаму файл extensions.csproj. |
--csx |
Поддержка проектов сценариев C# (CSX). |
--force, -f |
Обновление версий существующих расширений. |
--output, -o |
Путь вывода для расширений. |
--package, -p |
Идентификатор определенного пакета расширений. Если этот параметр не указан, устанавливаются все указанные расширения, как при выполнении func extensions sync. |
--source, -s |
Исходный веб-канал NuGet, если не используется NuGet.org. |
--version, -v |
Версия пакета расширений |
В следующем примере устанавливается расширение Центров событий версии 5.0.1 в локальном проекте:
func extensions install --package Microsoft.Azure.WebJobs.Extensions.EventHubs --version 5.0.1
Эти рекомендации применяются при использовании func extensions install:
Для скомпилированных проектов C# (как внутрипроцессных, так и изолированных рабочих процессов) используйте стандартные методы установки пакетов NuGet, например
dotnet add package.Чтобы вручную установить расширения с помощью основных средств, необходимо установить пакет SDK .NET.
По возможности следует использовать пакеты расширений. Ниже приведены некоторые причины, по которым может потребоваться установить расширения вручную:
- Вам нужно получить доступ к определенной версии расширения, которая недоступна в пакете.
- Вам нужно получить доступ к пользовательскому расширению, недоступному в пакете.
- Вам нужно получить доступ к конкретной комбинации расширений, которая недоступна в одном пакете.
Прежде чем вручную установить расширения, необходимо сначала удалить
extensionBundleобъект из файла host.json , определяющего пакет. Действие не выполняется, если пакет расширений уже установлен в файлеhost.json .При первом установке расширения файл проекта .NET с именем extensions.csproj добавляется в корневой каталог проекта приложения. Этот файл определяет набор пакетов NuGet, необходимых для ваших функций. Несмотря на то, что в этом файле можно работать со ссылками на пакеты NuGet, Core Tools позволяют устанавливать расширения, не прибегая к редактированию этого файла проекта C# вручную.
func extensions sync
Устанавливает все расширения, требуемые для вашего функционального приложения.
Эта func extensions sync команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--configPath, -c |
Путь каталога, содержащего extensions.csproj файл. |
--csx |
Поддерживает проекты со сценариями C# (CSX-файлы). |
--output, -o |
Путь вывода для расширений. |
Восстанавливает пропавший extensions.csproj файл. Не выполняет никаких действий, когда в вашем host.json файле определен расширенный пакет.
func kubernetes deploy
Развертывает проект Функций в качестве настраиваемого контейнера Docker в кластере Kubernetes.
func kubernetes deploy
Эта команда создает проект в качестве пользовательского контейнера и публикует его в кластере Kubernetes. В пользовательских контейнерах должен быть файл Docker. Чтобы создать приложение с dockerfile, используйте --docker параметр с func init помощью команды.
Эта func kubernetes deploy команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--dry-run |
Отображает шаблон развертывания без его выполнения. |
--config-map-name |
Имя существующей карты конфигурации с параметрами приложения-функции для использования в развертывании. Требует использования --use-config-map. Поведение по умолчанию заключается в создании параметров на Values основе объекта в файлеlocal.settings.json . |
--cooldown-period |
Период охлаждения (в секундах) после того, как все триггеры больше не активируются, прежде чем развертывание масштабируется до нуля, при этом значение по умолчанию равно 300 с. |
--ignore-errors |
Продолжайте развертывание после того, как ресурс возвращает ошибку. Поведение по умолчанию: остановка при обнаружении ошибки. |
--image-name |
Имя образа, используемого для развертывания pod и чтения функций. |
--keda-version |
Задайте для установки версию KEDA. Допустимые параметры: v1 и v2 (по умолчанию). |
--keys-secret-name |
Имя коллекции секретов Kubernetes, используемой для хранения ключей доступа. |
--max-replicas |
Задайте максимальное число реплик, для которых масштабируется горизонтальное автомасштабирование pod (HPA). |
--min-replicas |
Задайте минимальное число реплик, ниже которого HPA не будет масштабироваться. |
--mount-funckeys-as-containervolume |
Подключите ключи доступа в виде тома контейнера. |
--name |
Имя, используемое для развертывания и других артефактов в Kubernetes. |
--namespace |
Задайте для развертывания пространство имен Kubernetes. По умолчанию используется пространство имен по умолчанию. |
--no-docker |
Чтение функций из текущего каталога вместо изображения. Требуется подключение файловой системы образа. |
--registry |
При установке сборка Docker выполняется и образ отправляется в реестр этого имени. Невозможно использовать --registry с --image-name. Для Docker используйте имя пользователя. |
--polling-interval |
Интервал опроса (в секундах) для проверки триггеров, отличных от HTTP. Значение по умолчанию — 30 секунд. |
--pull-secret |
Секрет, используемый для доступа к учетным данным частного реестра. |
--secret-name |
Имя существующей коллекции секретов Kubernetes с параметрами приложения-функции, используемыми в развертывании. Поведение по умолчанию заключается в создании параметров на Values основе объекта в файлеlocal.settings.json . |
--show-service-fqdn |
Отображение URL-адресов триггеров HTTP с помощью FQDN Kubernetes вместо поведения по умолчанию с использованием IP-адреса. |
--service-type |
Задайте тип службы Kubernetes. Поддерживаемые значения: ClusterIP, NodePort и LoadBalancer (по умолчанию). |
--use-config-map |
Используйте объект ConfigMap (версия 1) вместо объекта Secret (версия 1) для настройки параметров приложения-функции. Имя сопоставления задается с помощью --config-map-name. |
--use-git-hash-version |
Используйте хэш Git в качестве версии для образа контейнера. |
--write-configs |
Выводит конфигурации Kubernetes в виде файлов YAML вместо развертывания. |
--config-file |
Выходной путь к файлу при использовании --write-configs. По умолчанию: functions.yaml. |
--hash-files |
Файлы для хэша, чтобы определить версию образа. |
--image-build |
Если задано значение false, пропускает сборку Docker. |
--key-secret-annotations |
Заметки для добавления в секрет ключей в key1=val1,key2=val2 формате. |
Инструменты Core Tools используют Docker CLI для создания и публикации образа. Убедитесь, что Docker уже установлен локально. С помощью команды docker login подключитесь к своей учетной записи.
Функции Azure поддерживает размещение контейнерных функций в Контейнеры приложений Azure или в Функции Azure. Функции Azure официально не поддерживает запуск контейнеров непосредственно в кластере Kubernetes или в Azure Kubernetes Service (AKS). Дополнительные сведения см. в разделе Поддержка контейнеровLinux в Функции Azure.
func kubernetes delete
Удаляет развертывание Функций из кластера Kubernetes.
func kubernetes delete --name <APP_NAME>
Эта func kubernetes delete команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--name |
Имя развертывания и других артефактов в Kubernetes. (Обязательно) |
--namespace |
Задайте пространство имен Kubernetes. По умолчанию используется default пространство имен. |
--registry |
Имя реестра контейнеров. |
--image-name |
Образ, используемый для развертывания pod. |
--keda-version |
Задайте версию KEDA. Допустимые параметры: v1 и v2 (по умолчанию). |
func kubernetes install
Установка KEDA в кластере Kubernetes
func kubernetes install
Устанавливает KEDA в кластер, определенный в файле конфигурации kubectl.
Эта func kubernetes install команда поддерживает следующие параметры:
| Вариант | Описание |
|---|---|
--dry-run |
Отображает шаблон развертывания без выполнения. |
--keda-version |
Задает устанавливаемую версию KEDA. Допустимые параметры: v1 и v2 (по умолчанию). |
--namespace |
Устанавливает в определенное пространство имен Kubernetes. Если этот параметр не задан, используется пространство имен по умолчанию. |
Дополнительные сведения см. в разделе "Управление KEDA и функциями в Kubernetes".
func kubernetes remove
Удаляет KEDA из кластера Kubernetes, определенного kubectl в файле конфигурации.
func kubernetes remove
Удаляет KEDA из кластера, определенного kubectl в файле конфигурации.
Эта func kubernetes remove команда поддерживает следующий параметр:
| Вариант | Описание |
|---|---|
--namespace |
Удаляется из определенного пространства имен Kubernetes. Если этот параметр не задан, используется пространство имен по умолчанию. |
Дополнительные сведения см. в статье об удалении KEDA из Kubernetes.
func settings add
Добавляет новую строку в коллекцию Values в файле local.settings.json.
func settings add <SETTING_NAME> <VALUE>
Замените <SETTING_NAME> именем параметра приложения.
Эта func settings add команда поддерживает следующий параметр:
| Вариант | Описание |
|---|---|
--connectionString |
Добавляет пару имя-значение в коллекцию ConnectionStrings, а не в коллекцию Values. Используйте коллекцию ConnectionStrings только в том случае, если для определенных платформ требуется его. Дополнительные сведения см. в local.settings.json файле. |
func settings decrypt
Расшифровывает зашифрованные значения в коллекции в Values файлеlocal.settings.json .
func settings decrypt
Эта команда также расшифровывает значения строка подключения в коллекции ConnectionStrings. В local.settings.jsonкоманда устанавливается IsEncrypted на false. Шифруйте локальные настройки, чтобы снизить риск раскрытия конфиденциальной информации local.settings.json. В Azure параметры приложения всегда хранятся в зашифрованном виде.
func settings delete
Удаляет параметр из коллекции Values в файле local.settings.json.
func settings delete <SETTING_NAME>
Замените <SETTING_NAME> именем параметра приложения, а <VALUE> — значением этого параметра.
Эта func settings delete команда поддерживает следующий параметр:
| Вариант | Описание |
|---|---|
--connectionString |
Удаляет пару "имя-значение" из ConnectionStrings коллекции вместо Values коллекции. |
func settings encrypt
Зашифровывает значения отдельных элементов в коллекции Values в файле local.settings.json.
func settings encrypt
Команда также шифрует значения строки подключения в ConnectionStrings коллекции. В local.settings.json, команда устанавливается IsEncrypted на true, что указывает, что локальное время выполнения расшифровывает настройки перед их использованием. Шифруйте локальные настройки, чтобы снизить риск раскрытия конфиденциальной информации local.settings.json. В Azure параметры приложения всегда хранятся в зашифрованном виде.
func settings list
Выводит список параметров в коллекции Values в файле local.settings.json.
func settings list
Выходные данные также включают строки подключения из ConnectionStrings коллекции. По умолчанию команда маскирует значения для безопасности.
--showValue Используйте параметр для отображения фактического значения.
Эта func settings list команда поддерживает следующий параметр:
| Вариант | Описание |
|---|---|
--showValue, -a |
Отображение фактических несмеченных значений в выходных данных. |
func templates list
Выводит список доступных шаблонов функций (триггеров).
Эта func templates list команда поддерживает следующий параметр:
| Вариант | Описание |
|---|---|
--language, -l |
Язык, для которого нужно отфильтровать возвращаемые шаблоны. Возвращает все языки по умолчанию. |
Глобальные опции
Большинство команд Core Tools поддерживают следующие опции:
| Вариант | Описание |
|---|---|
--script-root |
Задает корневой каталог приложения-функции и изменяет рабочий каталог для команды. |
--verbose |
Включает подробные выходные данные для подробного ведения журнала. Не все команды поддерживают эту опцию. |
--offline |
Выполняется в автономном режиме, не выполняя вызовы внешней сети.
func startКоманды , func initи func new поддерживают эту опцию. Вы также можете задать его через переменную FUNCTIONS_CORE_TOOLS_OFFLINE окружения. |
--version, -v |
Отображает версию Функции Azure Core Tools. |
--help, -h |
Отображает сведения о справке. |
--pause-on-error |
Приостанавливается для получения дополнительных входных данных перед выходом из процесса. Эта опция полезна, когда вы запускаете Core Tools из интегрированной среды разработки (IDE). |
Большинство команд поддерживают следующие варианты:
| Вариант | Описание |
|---|---|
--help, -h |
Покажите помощь команде. |
--version |
Display the Функции Azure CLI version. Используйте --verbose вместе --version для получения подробной информации о сборке. |
--verbose |
Включите подробный вывод. Распространяется на все подкоманды. При передаче в корень без подкоманды печатает подробную информацию о сборке, среде выполнения, операционной системе и архитектуре. |
Доступные рабочие нагрузки
Бегите func workload search посмотреть текущий каталог. В настоящее время доступны следующие рабочие нагрузки:
| Name | Описание |
|---|---|
host |
Время выполнения Функции Azure хоста, используемое func run. |
bundles |
Установите расширения, которые включают все расширения связываний. Используйте эту нагрузку для любого стека, не относящегося к .NET. .NET-проекты не используют такую нагрузку. Вместо этого они напрямую ссылаются на расширения в своих проектах. |
dotnet |
Функции Azure CLI tooling for .NET (C#, F#) projects. Также добавляет шаблоны для func quickstart. .NET не требует отдельной рабочей нагрузки, потому что рабочий является частью самого скомпилированного проекта. |
dotnet-templates |
Шаблоны функциональных каркасов для .NET-изолированных рабочих проектов. |
python |
Функции Azure CLI tooling for Python projects. Также добавляет шаблоны для func quickstart. |
python-worker |
Рабочий язык Python, используемый хостом Functions. |
python-templates |
Шаблоны функциональных каркасов для Python (модели программирования v1 и v2). |
node |
Функции Azure CLI-инструменты для Node.js проектов (JavaScript, TypeScript). Также добавляет шаблоны для func quickstart. |
node-worker |
Рабочий Node.js языка, используемый хостом Functions. |
node-templates |
Шаблоны функциональных каркасов для Node.js (JavaScript, TypeScript). |
go |
Функции Azure CLI tooling for Go projects. Также добавляет шаблоны для func quickstart. |
go-worker |
Работник языка Go, используемый хостом Functions. |
Примечание.
Не все стеки языков Functions в настоящее время доступны в виде рабочих нагрузок. Стеки Java и PowerShell в настоящее время не поддерживаются в Функции Azure CLI.