Поделиться через

Справочник по основным средствам Функции Azure

В этой статье приведена справочная документация по Функции Azure Core Tools, которая позволяет разрабатывать, управлять и развертывать проекты Функции 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 Команды для перечисления доступных шаблонов функций.

Прежде чем использовать команды в этой статье, установите основные средства.

func init

Создает новый проект Функций на определенном языке.

func init [<PROJECT_FOLDER>]

При указании <PROJECT_FOLDER> проект создается в новой папке с таким именем. В противном случае используется текущая папка.

Команда func init поддерживает эти параметры, которые не поддерживаются в версии 1.x, если иное не указано:

Вариант Описание
--bundles-channel, -c Канал выпуска пакета расширений. Поддерживаемые значения: GA (по умолчанию) Previewи Experimental. Применимо только для проектов, отличных от .NET.
--configuration-profile Инициализирует проект с профилем конфигурации узла. В настоящее время параметр --configuration-profile находится в предварительной версии. Дополнительные сведения см. в разделе "Профили конфигурации".
--csx Создает .NET функции как скрипт C#, который является поведением версии 1.x. Допустимо только с --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 logs

Возвращает журналы для функций, выполняемых в кластере Kubernetes.

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

Эта func logs команда поддерживает следующие параметры:

Вариант Описание
--platform Платформа размещения для приложения-функции. Допустимые параметры: kubernetes.
--name Имя приложения-функции в Azure.

Дополнительные сведения см. в разделе Функции Azure на Kubernetes с KEDA.

func new

Создает функцию в текущем проекте на основе шаблона.

func new

При запуске func new без --template параметра вам будет предложено выбрать шаблон. В версии 1.x также необходимо выбрать язык.

Эта func new команда поддерживает следующие параметры:

Вариант Описание
--authlevel, -a Задает уровень авторизации для триггера HTTP. Поддерживаемые значения: function, anonymous и admin. Авторизация не применяется принудительно при локальном запуске. Для получения дополнительной информации см. Уровень авторизации.
--csx (Версия 2.x и выше.) Создаются те же шаблоны скриптов C# (.csx), которые используются в версии 1.x и на портале.
--file, -f Целевой файл для новой функции. Для проектов Python версии 2 указывает файл, в который необходимо добавить функцию (по умолчанию используется значение function_app.py). Для Node.js проектов версии 4 укажите имя выходного файла в папке src/functions . Неприменимо для скомпилированных .NET проектов.
--language, -l Язык программирования шаблона, например C# или JavaScript. Этот параметр необходим в версии 1.x. В версии 2.x и более поздних версиях этот параметр не используется, так как язык определяется рабочей средой выполнения.
--name, -n имя функции.
--template, -t Используйте команду func templates list, чтобы просмотреть полный список доступных шаблонов для каждого поддерживаемого языка.

Дополнительные сведения см. в статье Создание функции.

func pack

Создает пакет развертывания, содержащий код проекта в состоянии запуска. Используйте этот метод, если необходимо вручную создать пакет развертывания для приложения на локальном компьютере за пределами func azure functionapp publish команды. По умолчанию выполняет сборку func pack проекта по мере необходимости.

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 пропускаются.
--skip-install Пропускает выполнение npm install при упаковке приложения-функции на основе Node.js. Используется для предотвращения перезаписи пользовательских модулей npm.
--build-native-deps Устанавливает Python зависимости локально с помощью образа, соответствующего среде, используемой в Azure. При включении Core Tools запускает контейнер Docker, создает приложение внутри этого контейнера и создает файл .zip со всеми зависимостями, восстановленными в .python_packages. Используйте этот параметр при выполнении Windows, чтобы избежать потенциальных проблем с библиотекой при развертывании в Linux в Azure.

func run

Только версия 1.x.

Позволяет вызывать функцию напрямую, которая аналогична выполнению функции с помощью вкладки Test на портале Azure. Это действие поддерживается только в версии 1.x. Для более поздних версий используйте func start и вызовите конечную точку функции напрямую.

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 azure functionapp

Контекст func azure functionapp содержит следующие команды:

Все 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, используйте --dockerfile параметр с 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 Приостанавливается для получения дополнительных входных данных перед выходом из процесса. Полезно при запуске основных средств из интегрированной среды разработки (IDE).
  • Last updated on