Справочные материалы по Azure Functions Core Tools
Эта статья содержит справочную документацию по инструментам Azure Functions Core Tools, с помощью которых можно разрабатывать, администрировать и развертывать проекты Функций Azure на локальном компьютере. Дополнительные сведения о Core Tools см. в статье Работа с Azure Functions Core Tools.
Команды Core Tools организованы по приведенным ниже контекстам, каждый из которых предоставляет уникальный набор действий.
Контекст команд | Description |
---|---|
func |
Команды, используемые для создания и запуска функций на локальном компьютере. |
func azure |
Команды для работы с ресурсами Azure, включая их публикацию. |
func azurecontainerapps |
Разверните контейнерное приложение-функцию в приложениях контейнеров Azure. |
func durable |
Команды для работы с Устойчивыми функциями. |
func extensions |
Команды для установки расширений и управления ими. |
func kubernetes |
Команды для работы с Kubernetes и Функциями Azure. |
func settings |
Команды управления параметрами среды для локального узла Функций. |
func templates |
Команды для вывода списка доступных шаблонов функций. |
Перед использованием команд, описанных в этой статье, необходимо установить Core Tools.
func init
Создает новый проект Функций на определенном языке.
func init <PROJECT_FOLDER>
При указании <PROJECT_FOLDER>
проект создается в новой папке с таким именем. В противном случае используется текущая папка.
func init
поддерживает следующие параметры, которые не поддерживают версию 1.x, если не указано иное:
Вариант | Описание |
---|---|
--csx |
Создает функции .NET в формате скрипта C#, что является стандартным поведением для версии 1.x. Допустимо только с --worker-runtime dotnet . |
--docker |
Создает Dockerfile для контейнера с базовым образом на основе выбранного значения --worker-runtime . Используйте этот параметр при планировании развертывания контейнерного приложения-функции. |
--docker-only |
Добавляет Dockerfile в существующий проект. Предлагает указать рабочую среду выполнения, если она не указана в команде и не задана в файле local.settings.js. Используйте этот параметр, когда планируется развернуть контейнерное приложение-функцию и проект уже существует. |
--force |
Инициализирует проект, даже если в нем уже есть файлы. Этот параметр перезаписывает имеющиеся файлы, используя те же имена. Это не влияет на другие файлы в папке проекта. |
--language |
Инициализирует проект для конкретного языка. Сейчас поддерживается, только если для --worker-runtime задано значение node . Возможные значения: typescript и javascript . Кроме того, можно использовать --worker-runtime javascript или --worker-runtime typescript . |
--managed-dependencies |
Устанавливает управляемые зависимости. Сейчас эта возможность поддерживается только в среде выполнения рабочей роли PowerShell. |
--model |
Задает нужную модель программирования для целевого языка, если доступно несколько моделей. Поддерживаемые параметры предназначены V1 для V2 Python и V3 V4 для Node.js. Дополнительные сведения см. в руководстве разработчика Python и руководстве разработчика по Node.js соответственно. |
--source-control |
Определяет, создается ли репозиторий Git. По умолчанию репозиторий не создается. Если задано значение true , репозиторий создается. |
--worker-runtime |
Задает языковую среду выполнения для проекта. Поддерживаемые значения: csharp , dotnet , dotnet-isolated , javascript , node (JavaScript), powershell , python и typescript . Для Java следует использовать Maven. Чтобы создать проект, не зависящий от языка, только с файлами проекта, используйте custom . Если этот параметр не задан, вам будет предложено выбрать среду выполнения во время инициализации. |
--target-framework |
Задает целевую платформу для проекта приложения-функции. Допустимо только с --worker-runtime dotnet-isolated . Поддерживаемые значения: net9.0 (предварительная версия), net8.0 (по умолчанию) net6.0 и net48 (платформа .NET Framework 4.8). |
Примечание.
При использовании параметра --docker
или --docker-only
инструменты Core Tools автоматически создают Dockerfile для функций C#, JavaScript, Python и PowerShell. Для функций Java необходимо вручную создать Dockerfile. Дополнительные сведения см. в разделе "Создание контейнерных приложений-функций".
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 |
Позволяет задать уровень авторизации для триггера HTTP. Поддерживаемые значения: function , anonymous и admin . Авторизация не применяется принудительно при локальном запуске. Дополнительные сведения см . на уровне авторизации. |
--csx |
(Версия 2.x и выше.) Создаются те же шаблоны скриптов C# (.csx), которые используются в версии 1.x и на портале. |
--language , -l |
Язык программирования шаблона, например C#, F# или JavaScript. Этот параметр необходим в версии 1.x. В версии 2.x и более поздних версиях этот параметр не используется, так как язык определяется рабочей средой выполнения. |
--name , -n |
имя функции. |
--template , -t |
Используйте команду func templates list , чтобы просмотреть полный список доступных шаблонов для каждого поддерживаемого языка. |
Дополнительные сведения см. в разделе Создание функции.
func run
Только версия 1.x.
Позволяет вызвать функцию напрямую, что аналогично выполнению функции с помощью вкладки Тест на портале 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 |
Список загружаемых функций, разделенных пробелами. |
--language-worker |
Аргументы для настройки обработчика языка. Например, можно включить отладку для рабочей роли языка, предоставив порт отладки и другие обязательные аргументы. |
--no-build |
Сборка текущего проекта перед запуском не выполняется. Только для проектов классов .NET. Значение по умолчанию — false . |
--password |
Пароль или файл, содержащий пароль для PFX-файла. Используется только с --cert . |
--port |
Локальный порт для прослушивания. Значение по умолчанию: 7071. |
--timeout |
Время ожидания для запуска узла службы "Функции" в секундах. Значение по умолчанию — 20 секунд. |
--useHttps |
Привязка к https://localhost:{port} , а не к http://localhost:{port} . По умолчанию этот параметр создает доверенный сертификат на компьютере. |
После запуска проекта можно проверить отдельные конечные точки функций.
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 logstream
Подключает локальную командную строку к потоку журналов для приложения-функции в Azure.
func azure functionapp logstream <APP_NAME>
Время ожидания подключения по умолчанию составляет 2 часа. Время ожидания можно изменить, добавив параметр приложения SCM_LOGSTREAM_TIMEOUT со значением времени ожидания в секундах. Пока не поддерживается для приложений Linux в плане потребления. Для этих приложений используйте параметр --browser
для просмотра журналов на портале.
Действие deploy
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--browser |
Открытие Live Stream Azure Application Insights для приложения-функции в браузере по умолчанию. |
Дополнительные сведения см. в разделе "Включение журналов выполнения потоковой передачи" в Функции Azure.
func azure functionapp publish
Развертывает проект Функций в существующем ресурсе приложения-функции в Azure.
func azure functionapp publish <APP_NAME>
Дополнительные сведения см. в разделе Развертывание файлов проекта.
Применяются приведенные ниже параметры публикации, которые зависят от версии.
Вариант | Описание |
---|---|
--access-token |
Позволяет использовать определенный маркер доступа при выполнении прошедших проверку подлинности azure действий. |
--access-token-stdin |
Считывает определенный маркер доступа из стандартного входного данных. Используйте это при чтении маркера непосредственно из предыдущей команды, например az account get-access-token . |
--additional-packages |
Создает список пакетов установки при создании собственных зависимостей. Например: python3-dev libevent-dev . |
--build , -b |
Выполняет действие сборки при развертывании в приложении-функции Linux. Принимает значения remote и local . |
--build-native-deps |
Позволяет пропустить создание папки .wheels при публикации приложений-функций Python. |
--csx |
Публикует проект скрипта C# (CSX). |
--dotnet-cli-params |
При публикации скомпилированных функций C# (CSPROJ-файл) инструменты Core Tools вызывают dotnet build --output bin/publish . Все параметры, передаваемые этому параметру, добавляются в командную строку. |
--force |
Игнорировать предварительную публикацию проверки в определенных сценариях. |
--list-ignored-files |
Отображает основанный на файле .funcignore список файлов, которые будут проигнорированы во время публикации. |
--list-included-files |
Отображает основанный на файле .funcignore список файлов, которые будут опубликованы. |
--management-url |
Задает URL-адрес управления для облака. Используйте это при работе в суверенном облаке. |
--no-build |
При публикации сборка проекта не выполняется. Для Python pip install не выполняется. |
--nozip |
Выключает режим по умолчанию Run-From-Package . |
--overwrite-settings -y |
Отключите запрос на перезапись параметров приложения при использовании --publish-local-settings -i . |
--publish-local-settings -i |
Публикация параметров из файла local.settings.json в Azure с запросом на перезапись, если параметр уже существует. Если вы используете локальный эмулятор хранилища, сначала измените параметр приложения на фактическое подключение к хранилищу. |
--publish-settings-only , -o |
Только публикует параметры и пропускает содержимое. Значение по умолчанию — запрос. |
--slot |
Необязательное имя определенного слота для публикации. |
--subscription |
Задает используемую подписку по умолчанию. |
func azure storage fetch-connection-string
Задает строку подключения для указанной учетной записи хранения Azure.
func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>
Дополнительные сведения см. в разделе "Скачать строка подключения хранилища".
func azurecontainerapps deploy
Развертывает контейнерное приложение-функцию в среде Azure Container Apps. Учетная запись хранения, используемая приложением-функцией, и среда уже должны существовать. Дополнительные сведения см. в статье "Приложения контейнеров 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>
Применяются следующие варианты развертывания:
Вариант | Описание |
---|---|
--access-token |
Позволяет использовать определенный маркер доступа при выполнении прошедших проверку подлинности azure действий. |
--access-token-stdin |
Считывает определенный маркер доступа из стандартного входного данных. Используйте это при чтении маркера непосредственно из предыдущей команды, например az account get-access-token . |
--environment |
Имя существующей среды приложений контейнеров. |
--image-build |
Если задано значение true , пропускает локальную сборку Docker. |
--image-name |
Имя образа существующего контейнера в реестре контейнеров. Имя изображения содержит имя тега. |
--location |
Регион развертывания. В идеале это тот же регион, что и ресурсы среды и учетной записи хранения. |
--management-url |
Задает URL-адрес управления для облака. Используйте это при работе в суверенном облаке. |
--name |
Имя, используемое для развертывания приложения-функции в среде "Приложения контейнеров". Это же имя также используется при управлении приложением-функцией на портале. Имя должно быть уникальным в среде. |
--registry |
При установке выполняется сборка Docker и образ отправляется в --registry набор реестра. Невозможно использовать --registry с --image-name . Для Docker Hub также используется --registry-username . |
--registry-password |
Пароль или маркер, используемый для извлечения образа из частного реестра. |
--registry-username |
Имя пользователя, используемое для извлечения образа из частного реестра. |
--resource-group |
Группа ресурсов, в которой создаются ресурсы, связанные с функциями. |
--storage-account |
Строка подключения для учетной записи хранения, используемой приложением-функцией. |
--subscription |
Задает используемую подписку по умолчанию. |
--worker-runtime |
Задает язык среды выполнения приложения-функции. Этот параметр используется только с --image-name и --image-build , в противном случае язык определяется во время локальной сборки. Поддерживаемые значения: dotnet , , node powershell dotnetIsolated python и custom (для обработчиков клиентов). |
Внимание
Строка подключения хранилища и другие учетные данные службы являются важными секретами. Не забудьте безопасно хранить файлы скриптов с помощью func azurecontainerapps deploy
и не хранить их в общедоступном элементе управления версиями.
func deploy
Команда func deploy
устарела. Вместо него используйте func kubernetes deploy
.
func durable delete-task-hub
Удаляет все артефакты хранилища в центре задач Устойчивых функций.
func durable delete-task-hub
Действие delete-task-hub
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--connection-string-setting |
Необязательное имя параметра, содержащего используемую строку подключения к хранилищу. |
--task-hub-name |
Необязательное имя используемого центра устойчивых задач. |
Дополнительные сведения см. в документации по Устойчивым функциям.
func durable get-history
Возвращает журнал указанного экземпляра оркестрации.
func durable get-history --id <INSTANCE_ID>
Действие get-history
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--id |
Указывает идентификатор экземпляра оркестрации (обязательно). |
--connection-string-setting |
Необязательное имя параметра, содержащего используемую строку подключения к хранилищу. |
--task-hub-name |
Необязательное имя используемого центра устойчивых задач. |
Дополнительные сведения см. в документации по Устойчивым функциям.
func durable get-instances
Возвращает состояние всех экземпляров оркестрации. Поддерживает разбиение на страницы с помощью параметра top
.
func durable get-instances
Действие 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>
Действие get-runtime-status
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--connection-string-setting |
Необязательное имя параметра, содержащего используемую строку подключения к хранилищу. |
--id |
Указывает идентификатор экземпляра оркестрации (обязательно). |
--show-input |
Если этот параметр задан, ответ будет содержать входные данные функции. |
--show-output |
Если этот параметр задан, ответ будет содержать журнал выполнения. |
--task-hub-name |
Необязательное имя используемого центра задач Устойчивых функций. |
Дополнительные сведения см. в документации по Устойчивым функциям.
func durable purge-history
Очистка состояния экземпляра оркестрации, журнала и хранилища BLOB-объектов для оркестраций старше указанного порога.
func durable purge-history
Действие purge-history
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--connection-string-setting |
Необязательное имя параметра, содержащего используемую строку подключения к хранилищу. |
--created-after |
(Необязательно.) Удаление из журнала экземпляров, созданных после этой даты и времени в формате UTC. Принимаются любые значения даты и времени в формате ISO 8601. |
--created-before |
(Необязательно.) Удаление из журнала экземпляров, созданных до этой даты и времени в формате UTC. Принимаются любые значения даты и времени в формате ISO 8601. |
--runtime-status |
(Необязательно.) Удаление экземпляров, состояние которых соответствует определенному состоянию, включая completd , terminated , canceled и failed . Можно указать одно или несколько разделенных пробелами состояний. Если не указать --runtime-status , то журнал экземпляра удаляется независимо от состояния. |
--task-hub-name |
Необязательное имя используемого центра задач Устойчивых функций. |
Дополнительные сведения см. в документации по Устойчивым функциям.
func durable raise-event
Порождает событие в указанном экземпляре оркестрации.
func durable raise-event --event-name <EVENT_NAME> --event-data <DATA>
Действие 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>
Действие 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>
Действие 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>
Действие terminate
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--connection-string-setting |
Необязательное имя параметра, содержащего используемую строку подключения к хранилищу. |
--id |
Указывает идентификатор экземпляра оркестрации (обязательно). |
--reason |
Причина остановки оркестрации (обязательно). |
--task-hub-name |
Необязательное имя используемого центра задач Устойчивых функций. |
Дополнительные сведения см. в документации по Устойчивым функциям.
func extensions install
Вручную устанавливает расширения функций в проекте non-.NET или в проекте скрипта C#.
func extensions install --package Microsoft.Azure.WebJobs.Extensions.<EXTENSION> --version <VERSION>
Действие install
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--configPath |
Путь к каталогу, содержащему файл extensions.csproj. |
--csx |
Поддерживает проекты со сценариями C# (CSX-файлы). |
--force |
Обновление версий существующих расширений. |
--output |
Путь вывода для расширений. |
--package |
Идентификатор определенного пакета расширений. Если этот параметр не указан, устанавливаются все указанные расширения, как при выполнении func extensions sync . |
--source |
Исходный веб-канал NuGet, если не используется NuGet.org. |
--version |
Версия пакета расширений |
В следующем примере устанавливается расширение Центров событий версии 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 6.0.
По возможности следует использовать пакеты расширений. Ниже приведены некоторые причины, по которым может потребоваться установить расширения вручную:
- Вам нужно получить доступ к определенной версии расширения, которая недоступна в пакете.
- Вам нужно получить доступ к пользовательскому расширению, недоступному в пакете.
- Вам нужно получить доступ к конкретной комбинации расширений, которая недоступна в одном пакете.
Прежде чем вручную установить расширения, необходимо сначала удалить
extensionBundle
объект из файла host.json, который определяет пакет. Действие не выполняется, если пакет расширений уже установлен в файле host.json.При первой установке расширения файл проекта .NET с именем extensions.csproj добавляется в корневой каталог проекта приложения. Этот файл определяет набор пакетов NuGet, необходимых для ваших функций. Несмотря на то, что в этом файле можно работать со ссылками на пакеты NuGet, Core Tools позволяют устанавливать расширения, не прибегая к редактированию этого файла проекта C# вручную.
func extensions sync
Устанавливает все расширения, добавленные в приложение-функцию.
Действие sync
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--configPath |
Путь к каталогу, содержащему файл extensions.csproj. |
--csx |
Поддерживает проекты со сценариями C# (CSX-файлы). |
--output |
Путь вывода для расширений. |
Повторно создает отсутствующий файл extensions.csproj. Если пакет расширений определен в файле host.json, то никакие действия не выполняются.
func kubernetes deploy
Развертывает проект Функций в качестве пользовательского контейнера Docker в кластере Kubernetes.
func kubernetes deploy
Эта команда создает проект в качестве пользовательского контейнера и публикует его в кластере Kubernetes. В пользовательских контейнерах должен быть файл Docker. Чтобы создать приложение с dockerfile, используйте --dockerfile
параметр с func init
помощью команды.
Доступны следующие параметры развертывания Kubernetes.
Вариант | Описание |
---|---|
--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 с полным доменным именем Kubernetes, а не IP-адреса, которые отображаются по умолчанию. |
--service-type |
Задает тип службы Kubernetes. Поддерживаемые значения: ClusterIP , NodePort и LoadBalancer (по умолчанию). |
--use-config-map |
Используйте объект ConfigMap (версия 1) вместо объекта Secret (версия 1) для настройки параметров приложения-функции. Имя сопоставления задается с помощью --config-map-name . |
Инструменты Core Tools используют Docker CLI для создания и публикации образа. Убедитесь, что компонент Docker уже установлен в локальной среде. С помощью команды docker login
подключитесь к своей учетной записи.
Функции Azure поддерживает размещение контейнерных функций в приложениях контейнеров Azure или в Функции Azure. Запуск контейнеров непосредственно в кластере Kubernetes или в Служба Azure Kubernetes (AKS) официально не поддерживается Функции Azure. Дополнительные сведения см. в статье о поддержке контейнеров Linux в Функции Azure.
func kubernetes install
Устанавливает KEDA в кластер Kubernetes.
func kubernetes install
Устанавливает KEDA в кластер, определенный в файле конфигурации kubectl.
Действие install
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--dry-run |
Отображает шаблон развертывания без его выполнения. |
--keda-version |
Задает устанавливаемую версию KEDA. Допустимые параметры: v1 и v2 (по умолчанию). |
--namespace |
Поддерживает установку в определенное пространство имен Kubernetes. Если этот параметр не задан, используется пространство имен по умолчанию. |
Дополнительные сведения см. в разделе Управление KEDA и функциями в Kubernetes.
func kubernetes remove
Удаляет KEDA из кластера Kubernetes, определенного в файле конфигурации kubectl.
func kubernetes remove
Удаляет KEDA из кластера, определенного в файле конфигурации kubectl.
Действие remove
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--namespace |
Поддерживает удаление из определенного пространства имен Kubernetes. Если этот параметр не задан, используется пространство имен по умолчанию. |
Дополнительные сведения см. в разделе Удаление KEDA из Kubernetes.
func settings add
Добавляет новую строку в коллекцию Values
в файле local.settings.json.
func settings add <SETTING_NAME> <VALUE>
Замените <SETTING_NAME>
именем параметра приложения, а <VALUE>
— значением этого параметра.
Действие 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>
— значением этого параметра.
Действие 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
.
Действие list
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--showValue |
Отображает фактические незамаскированные значения в выходных данных. |
func templates list
Выводит список доступных шаблонов функций (триггеров).
Действие list
поддерживает следующие параметры.
Вариант | Описание |
---|---|
--language |
Язык, для которого нужно отфильтровать возвращаемые шаблоны. По умолчанию возвращаются шаблоны для всех языков. |