Определение ресурсов Bicep
Тип ресурса Spring/apps/deployments можно развернуть с помощью операций, предназначенных для следующих целей:
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.AppPlatform/Spring/apps/deployments, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.AppPlatform/Spring/apps/deployments@2024-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
active: bool
deploymentSettings: {
addonConfigs: {
{customized property}: any(...)
}
apms: [
{
resourceId: 'string'
}
]
containerProbeSettings: {
disableProbe: bool
}
environmentVariables: {
{customized property}: 'string'
}
livenessProbe: {
disableProbe: bool
failureThreshold: int
initialDelaySeconds: int
periodSeconds: int
probeAction: {
type: 'string'
// For remaining properties, see ProbeAction objects
}
successThreshold: int
timeoutSeconds: int
}
readinessProbe: {
disableProbe: bool
failureThreshold: int
initialDelaySeconds: int
periodSeconds: int
probeAction: {
type: 'string'
// For remaining properties, see ProbeAction objects
}
successThreshold: int
timeoutSeconds: int
}
resourceRequests: {
cpu: 'string'
memory: 'string'
}
scale: {
maxReplicas: int
minReplicas: int
rules: [
{
azureQueue: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
queueLength: int
queueName: 'string'
}
custom: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
metadata: {
{customized property}: 'string'
}
type: 'string'
}
http: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
metadata: {
{customized property}: 'string'
}
}
name: 'string'
tcp: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
metadata: {
{customized property}: 'string'
}
}
}
]
}
startupProbe: {
disableProbe: bool
failureThreshold: int
initialDelaySeconds: int
periodSeconds: int
probeAction: {
type: 'string'
// For remaining properties, see ProbeAction objects
}
successThreshold: int
timeoutSeconds: int
}
terminationGracePeriodSeconds: int
}
source: {
version: 'string'
type: 'string'
// For remaining properties, see UserSourceInfo objects
}
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
}
Объекты UserSourceInfo
Задайте свойство типа , чтобы указать тип объекта.
Для BuildResultиспользуйте:
{
buildResultId: 'string'
type: 'BuildResult'
}
Для контейнераиспользуйте:
{
customContainer: {
args: [
'string'
]
command: [
'string'
]
containerImage: 'string'
imageRegistryCredential: {
password: 'string'
username: 'string'
}
languageFramework: 'string'
server: 'string'
}
type: 'Container'
}
Для Jarиспользуйте:
{
jvmOptions: 'string'
relativePath: 'string'
runtimeVersion: 'string'
type: 'Jar'
}
Для NetCoreZipиспользуйте:
{
netCoreMainEntryPath: 'string'
relativePath: 'string'
runtimeVersion: 'string'
type: 'NetCoreZip'
}
Для источникаиспользуйте:
{
artifactSelector: 'string'
relativePath: 'string'
runtimeVersion: 'string'
type: 'Source'
}
Для войныиспользуйте:
{
jvmOptions: 'string'
relativePath: 'string'
runtimeVersion: 'string'
serverVersion: 'string'
type: 'War'
}
Объекты ProbeAction
Задайте свойство типа , чтобы указать тип объекта.
Для ExecActionиспользуйте:
{
command: [
'string'
]
type: 'ExecAction'
}
Для HTTPGetActionиспользуйте:
{
path: 'string'
scheme: 'string'
type: 'HTTPGetAction'
}
Для TCPSocketActionиспользуйте:
{
type: 'TCPSocketAction'
}
Значения свойств
ApmСправка
Имя |
Описание |
Ценность |
идентификатор ресурса |
Идентификатор ресурса APM |
строка (обязательно) |
BuildResultUserSourceInfo
Имя |
Описание |
Ценность |
buildResultId |
Идентификатор ресурса существующей успешной сборки приводит к тому же экземпляру Spring. |
струна |
тип |
Тип отправленного источника |
BuildResult (обязательно) |
ContainerProbeSettings (ContainerProbeSettings)
Имя |
Описание |
Ценность |
disableProbe |
Указывает, отключает ли проба активности и готовности |
булевая переменная (bool) |
CustomContainer
Имя |
Описание |
Ценность |
Аргументы |
Аргументы в точку входа. CMD образа Docker используется, если это не указано. |
строка[] |
команда |
Массив точек входа. Не выполняется в оболочке. Запись образа Docker используется, если это не указано. |
строка[] |
Изображение контейнера |
Образ контейнера пользовательского контейнера. Это должно быть в виде <репозитория>:<тег> без имени сервера реестра |
струна |
Учетные данные imageRegistryCredential |
Учетные данные реестра образов |
Учетные данные ImageRegistryCredential |
languageFramework |
Языковая платформа отправленного образа контейнера. Поддерживаемые значения: Springboot, "", null. |
струна |
сервер |
Имя реестра, содержащего образ контейнера |
струна |
CustomContainerUserSourceInfo
Имя |
Описание |
Ценность |
customContainer |
Полезные данные пользовательского контейнера |
CustomContainer |
тип |
Тип отправленного источника |
Container (обязательный) |
Пользовательское правило масштабирования
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для настраиваемого правила масштабирования. |
ScaleRuleAuth[] |
метаданные |
Свойства метаданных для описания настраиваемого правила масштабирования. |
CustomScaleRuleMetadata |
тип |
Тип настраиваемого правила масштабирования например: azure-servicebus, redis и т. д. |
струна |
DeploymentResourceProperties (DeploymentResourceProperties)
DeploymentSettings (Настройки развертывания)
Имя |
Описание |
Ценность |
addonConfigs |
Коллекция надстроек |
DeploymentSettingsAddonConfigs |
АПМ |
Коллекция ApmReferences |
Справка об Apm[] |
containerProbeSettings |
Параметры проверки активности и готовности контейнера |
ContainerProbeSettings (ContainerProbeSettings) |
переменные окружения |
Коллекция переменных среды |
DeploymentSettingsEnvironmentVariables |
livenessProbe |
Периодический зонд активности экземпляра приложения. Экземпляр приложения будет перезапущен, если проба завершается ошибкой. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
пробы |
готовностьProbe |
Периодическое проверка готовности службы экземпляра приложений. Экземпляр приложения будет удален из конечных точек службы, если проба завершается ошибкой. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
пробы |
resourceRequests |
Запрошенное количество ресурсов для требуемого ЦП и памяти. Рекомендуется использовать это поле для представления требуемого ЦП и памяти, старое поле ЦП и памятьInGB будут устарели позже. |
Запросы на ресурсы |
шкала |
Масштабирование свойств для экземпляра приложения Azure Spring Apps. |
масштаб |
startupProbe |
StartupProbe указывает, что экземпляр приложения успешно инициализирован. Если задано, другие пробы не выполняются до тех пор, пока это не завершится успешно. Если эта проба завершается ошибкой, модуль Pod будет перезапущен так же, как если бы livenessProbe произошел сбой. Это можно использовать для предоставления различных параметров пробы в начале жизненного цикла экземпляра приложения, когда может потребоваться много времени для загрузки данных или теплого кэша, чем во время операции с устойчивым состоянием. Это невозможно обновить. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
пробы |
terminationGracePeriodSeconds |
Необязательный период в секундах экземпляр приложения должен завершиться корректно. Может быть уменьшено в запросе на удаление. Значение должно быть неотрицательно целым числом. Нулевое значение указывает, что немедленно останавливается через сигнал убийства (нет возможности завершить работу). Если это значение равно nil, вместо этого будет использоваться льготный период по умолчанию. Льготный период — это длительность в секундах после того, как процессы, выполняемые в экземпляре приложения, отправляются сигнал о завершении и время принудительного прекращения процессов с помощью сигнала об убийстве. Задайте это значение дольше ожидаемого времени очистки для процесса. Значение по умолчанию — 90 секунд. |
инт |
DeploymentSettingsAddonConfigs
DeploymentSettingsEnvironmentVariables
ExecAction
Имя |
Описание |
Ценность |
команда |
Команда — это командная строка, выполняемая внутри контейнера, рабочий каталог команды является корневым ('/) в файловой системе контейнера. Команда не выполняется внутри оболочки, поэтому традиционные инструкции оболочки ('|' и т. д.) не будут работать. Чтобы использовать оболочку, необходимо явно вызвать эту оболочку. Состояние выхода 0 рассматривается как живое или работоспособное и ненулевое является неработоспособным. |
строка[] |
тип |
Тип действия, выполняемого для проверки работоспособности. |
ExecAction (обязательно) |
HttpGetAction (HttpGetAction)
Имя |
Описание |
Ценность |
путь |
Путь к доступу на HTTP-сервере. |
струна |
схема |
Схема, используемая для подключения к узлу. По умолчанию используется протокол HTTP.
Возможные значения перечисления:
-
"HTTP" означает, что используемая схема будет http://
-
"HTTPS" означает, что используемая схема будет https:// |
"HTTP" "HTTPS" |
тип |
Тип действия, выполняемого для проверки работоспособности. |
HTTPGetAction (обязательно) |
Правило httpScaleRule (Правило HttpScale)
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для настраиваемого правила масштабирования. |
ScaleRuleAuth[] |
метаданные |
Свойства метаданных для описания правила масштабирования HTTP. |
Метаданные HttpScaleRule |
Учетные данные ImageRegistryCredential
Имя |
Описание |
Ценность |
пароль |
Пароль учетных данных реестра образов |
струна |
имя пользователя |
Имя пользователя учетных данных реестра образов |
струна |
JarUploadedUserSourceInfo
Имя |
Описание |
Ценность |
Опции jvmOptions |
Параметр JVM |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия jar-файла среды выполнения |
струна |
тип |
Тип отправленного источника |
Jar (обязательно) |
NetCoreZipUploadedUserSourceInfo
Имя |
Описание |
Ценность |
netCoreMainEntryPath |
Путь к исполняемому файлу .NET относительно корневого zip-файла |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия среды выполнения файла .Net |
струна |
тип |
Тип отправленного источника |
NetCoreZip (обязательно) |
Зонд
Имя |
Описание |
Ценность |
disableProbe |
Укажите, отключена ли проба. |
bool (обязательно) |
Порог неудачи |
Минимальные последовательные сбои для проверки, которые будут считаться неудачными после успешного выполнения. Минимальное значение равно 1. |
инт |
initialDelaySeconds |
Количество секунд после запуска экземпляра приложения перед запуском проб. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
инт |
период в секундах |
Как часто (в секундах) выполнять пробу. Минимальное значение равно 1. |
инт |
probeAction |
Действие пробы. |
ProbeAction |
Порог успеха |
Минимальные последовательные успехи для пробы, которые будут считаться успешными после сбоя. Должно быть 1 для жизни и запуска. Минимальное значение равно 1. |
инт |
timeoutSeconds |
Количество секунд, после которого время ожидания пробы истекает. Минимальное значение равно 1. |
инт |
ProbeAction
Имя |
Описание |
Ценность |
тип |
Установите значение ExecAction для типа ExecAction. Установите значение HTTPGetAction для типа HttpGetAction. Установите значение "TCPSocketAction" для типа TCPSocketAction. |
«Исполнительное действие» "HTTPGetAction" TCPSocketAction (обязательный) |
Правило QueueScaleRule
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для правила масштабирования очереди. |
ScaleRuleAuth[] |
длина очереди |
Длина очереди. |
инт |
название очереди |
Имя очереди. |
струна |
Запросы на ресурсы
Имя |
Описание |
Ценность |
ЦПУ |
Обязательный ЦП. 1 ядро может быть представлено 1 или 1000 млн. Это должно быть 500 м или 1 для уровня "Базовый" и {500m, 1, 2, 3, 4} для уровня "Стандартный". |
струна |
память |
Требуемая память. 1 ГБ можно представить 1Gi или 1024Mi. Это должно быть {512Mi, 1Gi, 2Gi} для уровня "Базовый" и {512Mi, 1Gi, 2Gi, ..., 8Gi} для уровня "Стандартный". |
струна |
Шкала
Имя |
Описание |
Ценность |
maxReplicas |
Необязательный. Максимальное количество реплик контейнеров. Значение по умолчанию — 10, если не задано. |
инт |
minReplicas |
Необязательный. Минимальное количество реплик контейнеров. |
инт |
Правила |
Правила масштабирования. |
Правило масштабирования[] |
Правило масштабирования
ScaleRuleAuth (Масштабная аутентификация)
Имя |
Описание |
Ценность |
secretRef |
Имя секрета экземпляра приложения Azure Spring Apps, из которого необходимо извлечь парам проверки подлинности. |
струна |
triggerParameter |
Параметр триггера, использующий секрет |
струна |
Артикул
Имя |
Описание |
Ценность |
способность |
Текущая емкость целевого ресурса |
инт |
имя |
Имя SKU |
струна |
ярус |
Уровень SKU |
струна |
ИсточникЗагруженныйПользовательИсходная информация
Имя |
Описание |
Ценность |
артефактСелектор |
Селектор для артефакта, который будет использоваться для развертывания для проектов с несколькими модулями. Это должно быть относительный путь к целевому модулю или проекту. |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия исходного файла среды выполнения |
струна |
тип |
Тип отправленного источника |
Source (обязательный) |
Правило TcpScaleRule
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для правила масштабирования tcp. |
ScaleRuleAuth[] |
метаданные |
Свойства метаданных для описания правила масштабирования tcp. |
Метаданные TcpScaleRule |
TCPSocketAction
Имя |
Описание |
Ценность |
тип |
Тип действия, выполняемого для проверки работоспособности. |
TCPSocketAction (обязательный) |
Информация о пользователе
WarUploadedUserSourceInfo
Имя |
Описание |
Ценность |
Опции jvmOptions |
Параметр JVM |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия war file в среде выполнения |
струна |
версия сервера |
Версия сервера, в настоящее время поддерживается только Apache Tomcat |
струна |
тип |
Тип отправленного источника |
"Война" (обязательно) |
Примеры использования
Примеры быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.
Определение ресурса шаблона ARM
Тип ресурса Spring/apps/deployments можно развернуть с помощью операций, предназначенных для следующих целей:
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.AppPlatform/Spring/apps/deployments, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.AppPlatform/Spring/apps/deployments",
"apiVersion": "2024-05-01-preview",
"name": "string",
"properties": {
"active": "bool",
"deploymentSettings": {
"addonConfigs": {
"{customized property}": {}
},
"apms": [
{
"resourceId": "string"
}
],
"containerProbeSettings": {
"disableProbe": "bool"
},
"environmentVariables": {
"{customized property}": "string"
},
"livenessProbe": {
"disableProbe": "bool",
"failureThreshold": "int",
"initialDelaySeconds": "int",
"periodSeconds": "int",
"probeAction": {
"type": "string"
// For remaining properties, see ProbeAction objects
},
"successThreshold": "int",
"timeoutSeconds": "int"
},
"readinessProbe": {
"disableProbe": "bool",
"failureThreshold": "int",
"initialDelaySeconds": "int",
"periodSeconds": "int",
"probeAction": {
"type": "string"
// For remaining properties, see ProbeAction objects
},
"successThreshold": "int",
"timeoutSeconds": "int"
},
"resourceRequests": {
"cpu": "string",
"memory": "string"
},
"scale": {
"maxReplicas": "int",
"minReplicas": "int",
"rules": [
{
"azureQueue": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"queueLength": "int",
"queueName": "string"
},
"custom": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"metadata": {
"{customized property}": "string"
},
"type": "string"
},
"http": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"metadata": {
"{customized property}": "string"
}
},
"name": "string",
"tcp": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"metadata": {
"{customized property}": "string"
}
}
}
]
},
"startupProbe": {
"disableProbe": "bool",
"failureThreshold": "int",
"initialDelaySeconds": "int",
"periodSeconds": "int",
"probeAction": {
"type": "string"
// For remaining properties, see ProbeAction objects
},
"successThreshold": "int",
"timeoutSeconds": "int"
},
"terminationGracePeriodSeconds": "int"
},
"source": {
"version": "string",
"type": "string"
// For remaining properties, see UserSourceInfo objects
}
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
}
}
Объекты UserSourceInfo
Задайте свойство типа , чтобы указать тип объекта.
Для BuildResultиспользуйте:
{
"buildResultId": "string",
"type": "BuildResult"
}
Для контейнераиспользуйте:
{
"customContainer": {
"args": [ "string" ],
"command": [ "string" ],
"containerImage": "string",
"imageRegistryCredential": {
"password": "string",
"username": "string"
},
"languageFramework": "string",
"server": "string"
},
"type": "Container"
}
Для Jarиспользуйте:
{
"jvmOptions": "string",
"relativePath": "string",
"runtimeVersion": "string",
"type": "Jar"
}
Для NetCoreZipиспользуйте:
{
"netCoreMainEntryPath": "string",
"relativePath": "string",
"runtimeVersion": "string",
"type": "NetCoreZip"
}
Для источникаиспользуйте:
{
"artifactSelector": "string",
"relativePath": "string",
"runtimeVersion": "string",
"type": "Source"
}
Для войныиспользуйте:
{
"jvmOptions": "string",
"relativePath": "string",
"runtimeVersion": "string",
"serverVersion": "string",
"type": "War"
}
Объекты ProbeAction
Задайте свойство типа , чтобы указать тип объекта.
Для ExecActionиспользуйте:
{
"command": [ "string" ],
"type": "ExecAction"
}
Для HTTPGetActionиспользуйте:
{
"path": "string",
"scheme": "string",
"type": "HTTPGetAction"
}
Для TCPSocketActionиспользуйте:
{
"type": "TCPSocketAction"
}
Значения свойств
ApmСправка
Имя |
Описание |
Ценность |
идентификатор ресурса |
Идентификатор ресурса APM |
строка (обязательно) |
BuildResultUserSourceInfo
Имя |
Описание |
Ценность |
buildResultId |
Идентификатор ресурса существующей успешной сборки приводит к тому же экземпляру Spring. |
струна |
тип |
Тип отправленного источника |
BuildResult (обязательно) |
ContainerProbeSettings (ContainerProbeSettings)
Имя |
Описание |
Ценность |
disableProbe |
Указывает, отключает ли проба активности и готовности |
булевая переменная (bool) |
CustomContainer
Имя |
Описание |
Ценность |
Аргументы |
Аргументы в точку входа. CMD образа Docker используется, если это не указано. |
строка[] |
команда |
Массив точек входа. Не выполняется в оболочке. Запись образа Docker используется, если это не указано. |
строка[] |
Изображение контейнера |
Образ контейнера пользовательского контейнера. Это должно быть в виде <репозитория>:<тег> без имени сервера реестра |
струна |
Учетные данные imageRegistryCredential |
Учетные данные реестра образов |
Учетные данные ImageRegistryCredential |
languageFramework |
Языковая платформа отправленного образа контейнера. Поддерживаемые значения: Springboot, "", null. |
струна |
сервер |
Имя реестра, содержащего образ контейнера |
струна |
CustomContainerUserSourceInfo
Имя |
Описание |
Ценность |
customContainer |
Полезные данные пользовательского контейнера |
CustomContainer |
тип |
Тип отправленного источника |
Container (обязательный) |
Пользовательское правило масштабирования
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для настраиваемого правила масштабирования. |
ScaleRuleAuth[] |
метаданные |
Свойства метаданных для описания настраиваемого правила масштабирования. |
CustomScaleRuleMetadata |
тип |
Тип настраиваемого правила масштабирования например: azure-servicebus, redis и т. д. |
струна |
DeploymentResourceProperties (DeploymentResourceProperties)
DeploymentSettings (Настройки развертывания)
Имя |
Описание |
Ценность |
addonConfigs |
Коллекция надстроек |
DeploymentSettingsAddonConfigs |
АПМ |
Коллекция ApmReferences |
Справка об Apm[] |
containerProbeSettings |
Параметры проверки активности и готовности контейнера |
ContainerProbeSettings (ContainerProbeSettings) |
переменные окружения |
Коллекция переменных среды |
DeploymentSettingsEnvironmentVariables |
livenessProbe |
Периодический зонд активности экземпляра приложения. Экземпляр приложения будет перезапущен, если проба завершается ошибкой. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
пробы |
готовностьProbe |
Периодическое проверка готовности службы экземпляра приложений. Экземпляр приложения будет удален из конечных точек службы, если проба завершается ошибкой. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
пробы |
resourceRequests |
Запрошенное количество ресурсов для требуемого ЦП и памяти. Рекомендуется использовать это поле для представления требуемого ЦП и памяти, старое поле ЦП и памятьInGB будут устарели позже. |
Запросы на ресурсы |
шкала |
Масштабирование свойств для экземпляра приложения Azure Spring Apps. |
масштаб |
startupProbe |
StartupProbe указывает, что экземпляр приложения успешно инициализирован. Если задано, другие пробы не выполняются до тех пор, пока это не завершится успешно. Если эта проба завершается ошибкой, модуль Pod будет перезапущен так же, как если бы livenessProbe произошел сбой. Это можно использовать для предоставления различных параметров пробы в начале жизненного цикла экземпляра приложения, когда может потребоваться много времени для загрузки данных или теплого кэша, чем во время операции с устойчивым состоянием. Это невозможно обновить. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
пробы |
terminationGracePeriodSeconds |
Необязательный период в секундах экземпляр приложения должен завершиться корректно. Может быть уменьшено в запросе на удаление. Значение должно быть неотрицательно целым числом. Нулевое значение указывает, что немедленно останавливается через сигнал убийства (нет возможности завершить работу). Если это значение равно nil, вместо этого будет использоваться льготный период по умолчанию. Льготный период — это длительность в секундах после того, как процессы, выполняемые в экземпляре приложения, отправляются сигнал о завершении и время принудительного прекращения процессов с помощью сигнала об убийстве. Задайте это значение дольше ожидаемого времени очистки для процесса. Значение по умолчанию — 90 секунд. |
инт |
DeploymentSettingsAddonConfigs
DeploymentSettingsEnvironmentVariables
ExecAction
Имя |
Описание |
Ценность |
команда |
Команда — это командная строка, выполняемая внутри контейнера, рабочий каталог команды является корневым ('/) в файловой системе контейнера. Команда не выполняется внутри оболочки, поэтому традиционные инструкции оболочки ('|' и т. д.) не будут работать. Чтобы использовать оболочку, необходимо явно вызвать эту оболочку. Состояние выхода 0 рассматривается как живое или работоспособное и ненулевое является неработоспособным. |
строка[] |
тип |
Тип действия, выполняемого для проверки работоспособности. |
ExecAction (обязательно) |
HttpGetAction (HttpGetAction)
Имя |
Описание |
Ценность |
путь |
Путь к доступу на HTTP-сервере. |
струна |
схема |
Схема, используемая для подключения к узлу. По умолчанию используется протокол HTTP.
Возможные значения перечисления:
-
"HTTP" означает, что используемая схема будет http://
-
"HTTPS" означает, что используемая схема будет https:// |
"HTTP" "HTTPS" |
тип |
Тип действия, выполняемого для проверки работоспособности. |
HTTPGetAction (обязательно) |
Правило httpScaleRule (Правило HttpScale)
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для настраиваемого правила масштабирования. |
ScaleRuleAuth[] |
метаданные |
Свойства метаданных для описания правила масштабирования HTTP. |
Метаданные HttpScaleRule |
Учетные данные ImageRegistryCredential
Имя |
Описание |
Ценность |
пароль |
Пароль учетных данных реестра образов |
струна |
имя пользователя |
Имя пользователя учетных данных реестра образов |
струна |
JarUploadedUserSourceInfo
Имя |
Описание |
Ценность |
Опции jvmOptions |
Параметр JVM |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия jar-файла среды выполнения |
струна |
тип |
Тип отправленного источника |
Jar (обязательно) |
NetCoreZipUploadedUserSourceInfo
Имя |
Описание |
Ценность |
netCoreMainEntryPath |
Путь к исполняемому файлу .NET относительно корневого zip-файла |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия среды выполнения файла .Net |
струна |
тип |
Тип отправленного источника |
NetCoreZip (обязательно) |
Зонд
Имя |
Описание |
Ценность |
disableProbe |
Укажите, отключена ли проба. |
bool (обязательно) |
Порог неудачи |
Минимальные последовательные сбои для проверки, которые будут считаться неудачными после успешного выполнения. Минимальное значение равно 1. |
инт |
initialDelaySeconds |
Количество секунд после запуска экземпляра приложения перед запуском проб. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
инт |
период в секундах |
Как часто (в секундах) выполнять пробу. Минимальное значение равно 1. |
инт |
probeAction |
Действие пробы. |
ProbeAction |
Порог успеха |
Минимальные последовательные успехи для пробы, которые будут считаться успешными после сбоя. Должно быть 1 для жизни и запуска. Минимальное значение равно 1. |
инт |
timeoutSeconds |
Количество секунд, после которого время ожидания пробы истекает. Минимальное значение равно 1. |
инт |
ProbeAction
Имя |
Описание |
Ценность |
тип |
Установите значение ExecAction для типа ExecAction. Установите значение HTTPGetAction для типа HttpGetAction. Установите значение "TCPSocketAction" для типа TCPSocketAction. |
«Исполнительное действие» "HTTPGetAction" TCPSocketAction (обязательный) |
Правило QueueScaleRule
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для правила масштабирования очереди. |
ScaleRuleAuth[] |
длина очереди |
Длина очереди. |
инт |
название очереди |
Имя очереди. |
струна |
Запросы на ресурсы
Имя |
Описание |
Ценность |
ЦПУ |
Обязательный ЦП. 1 ядро может быть представлено 1 или 1000 млн. Это должно быть 500 м или 1 для уровня "Базовый" и {500m, 1, 2, 3, 4} для уровня "Стандартный". |
струна |
память |
Требуемая память. 1 ГБ можно представить 1Gi или 1024Mi. Это должно быть {512Mi, 1Gi, 2Gi} для уровня "Базовый" и {512Mi, 1Gi, 2Gi, ..., 8Gi} для уровня "Стандартный". |
струна |
Шкала
Имя |
Описание |
Ценность |
maxReplicas |
Необязательный. Максимальное количество реплик контейнеров. Значение по умолчанию — 10, если не задано. |
инт |
minReplicas |
Необязательный. Минимальное количество реплик контейнеров. |
инт |
Правила |
Правила масштабирования. |
Правило масштабирования[] |
Правило масштабирования
ScaleRuleAuth (Масштабная аутентификация)
Имя |
Описание |
Ценность |
secretRef |
Имя секрета экземпляра приложения Azure Spring Apps, из которого необходимо извлечь парам проверки подлинности. |
струна |
triggerParameter |
Параметр триггера, использующий секрет |
струна |
Артикул
Имя |
Описание |
Ценность |
способность |
Текущая емкость целевого ресурса |
инт |
имя |
Имя SKU |
струна |
ярус |
Уровень SKU |
струна |
ИсточникЗагруженныйПользовательИсходная информация
Имя |
Описание |
Ценность |
артефактСелектор |
Селектор для артефакта, который будет использоваться для развертывания для проектов с несколькими модулями. Это должно быть относительный путь к целевому модулю или проекту. |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия исходного файла среды выполнения |
струна |
тип |
Тип отправленного источника |
Source (обязательный) |
Правило TcpScaleRule
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для правила масштабирования tcp. |
ScaleRuleAuth[] |
метаданные |
Свойства метаданных для описания правила масштабирования tcp. |
Метаданные TcpScaleRule |
TCPSocketAction
Имя |
Описание |
Ценность |
тип |
Тип действия, выполняемого для проверки работоспособности. |
TCPSocketAction (обязательный) |
Информация о пользователе
WarUploadedUserSourceInfo
Имя |
Описание |
Ценность |
Опции jvmOptions |
Параметр JVM |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия war file в среде выполнения |
струна |
версия сервера |
Версия сервера, в настоящее время поддерживается только Apache Tomcat |
струна |
тип |
Тип отправленного источника |
"Война" (обязательно) |
Примеры использования
Шаблоны быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.
Тип ресурса Spring/apps/deployments можно развернуть с помощью операций, предназначенных для следующих целей:
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.AppPlatform/Spring/apps/deployments, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/apps/deployments@2024-05-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
active = bool
deploymentSettings = {
addonConfigs = {
{customized property} = ?
}
apms = [
{
resourceId = "string"
}
]
containerProbeSettings = {
disableProbe = bool
}
environmentVariables = {
{customized property} = "string"
}
livenessProbe = {
disableProbe = bool
failureThreshold = int
initialDelaySeconds = int
periodSeconds = int
probeAction = {
type = "string"
// For remaining properties, see ProbeAction objects
}
successThreshold = int
timeoutSeconds = int
}
readinessProbe = {
disableProbe = bool
failureThreshold = int
initialDelaySeconds = int
periodSeconds = int
probeAction = {
type = "string"
// For remaining properties, see ProbeAction objects
}
successThreshold = int
timeoutSeconds = int
}
resourceRequests = {
cpu = "string"
memory = "string"
}
scale = {
maxReplicas = int
minReplicas = int
rules = [
{
azureQueue = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
queueLength = int
queueName = "string"
}
custom = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
metadata = {
{customized property} = "string"
}
type = "string"
}
http = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
metadata = {
{customized property} = "string"
}
}
name = "string"
tcp = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
metadata = {
{customized property} = "string"
}
}
}
]
}
startupProbe = {
disableProbe = bool
failureThreshold = int
initialDelaySeconds = int
periodSeconds = int
probeAction = {
type = "string"
// For remaining properties, see ProbeAction objects
}
successThreshold = int
timeoutSeconds = int
}
terminationGracePeriodSeconds = int
}
source = {
version = "string"
type = "string"
// For remaining properties, see UserSourceInfo objects
}
}
sku = {
capacity = int
name = "string"
tier = "string"
}
}
}
Объекты UserSourceInfo
Задайте свойство типа , чтобы указать тип объекта.
Для BuildResultиспользуйте:
{
buildResultId = "string"
type = "BuildResult"
}
Для контейнераиспользуйте:
{
customContainer = {
args = [
"string"
]
command = [
"string"
]
containerImage = "string"
imageRegistryCredential = {
password = "string"
username = "string"
}
languageFramework = "string"
server = "string"
}
type = "Container"
}
Для Jarиспользуйте:
{
jvmOptions = "string"
relativePath = "string"
runtimeVersion = "string"
type = "Jar"
}
Для NetCoreZipиспользуйте:
{
netCoreMainEntryPath = "string"
relativePath = "string"
runtimeVersion = "string"
type = "NetCoreZip"
}
Для источникаиспользуйте:
{
artifactSelector = "string"
relativePath = "string"
runtimeVersion = "string"
type = "Source"
}
Для войныиспользуйте:
{
jvmOptions = "string"
relativePath = "string"
runtimeVersion = "string"
serverVersion = "string"
type = "War"
}
Объекты ProbeAction
Задайте свойство типа , чтобы указать тип объекта.
Для ExecActionиспользуйте:
{
command = [
"string"
]
type = "ExecAction"
}
Для HTTPGetActionиспользуйте:
{
path = "string"
scheme = "string"
type = "HTTPGetAction"
}
Для TCPSocketActionиспользуйте:
{
type = "TCPSocketAction"
}
Значения свойств
ApmСправка
Имя |
Описание |
Ценность |
идентификатор ресурса |
Идентификатор ресурса APM |
строка (обязательно) |
BuildResultUserSourceInfo
Имя |
Описание |
Ценность |
buildResultId |
Идентификатор ресурса существующей успешной сборки приводит к тому же экземпляру Spring. |
струна |
тип |
Тип отправленного источника |
BuildResult (обязательно) |
ContainerProbeSettings (ContainerProbeSettings)
Имя |
Описание |
Ценность |
disableProbe |
Указывает, отключает ли проба активности и готовности |
булевая переменная (bool) |
CustomContainer
Имя |
Описание |
Ценность |
Аргументы |
Аргументы в точку входа. CMD образа Docker используется, если это не указано. |
строка[] |
команда |
Массив точек входа. Не выполняется в оболочке. Запись образа Docker используется, если это не указано. |
строка[] |
Изображение контейнера |
Образ контейнера пользовательского контейнера. Это должно быть в виде <репозитория>:<тег> без имени сервера реестра |
струна |
Учетные данные imageRegistryCredential |
Учетные данные реестра образов |
Учетные данные ImageRegistryCredential |
languageFramework |
Языковая платформа отправленного образа контейнера. Поддерживаемые значения: Springboot, "", null. |
струна |
сервер |
Имя реестра, содержащего образ контейнера |
струна |
CustomContainerUserSourceInfo
Имя |
Описание |
Ценность |
customContainer |
Полезные данные пользовательского контейнера |
CustomContainer |
тип |
Тип отправленного источника |
Container (обязательный) |
Пользовательское правило масштабирования
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для настраиваемого правила масштабирования. |
ScaleRuleAuth[] |
метаданные |
Свойства метаданных для описания настраиваемого правила масштабирования. |
CustomScaleRuleMetadata |
тип |
Тип настраиваемого правила масштабирования например: azure-servicebus, redis и т. д. |
струна |
DeploymentResourceProperties (DeploymentResourceProperties)
DeploymentSettings (Настройки развертывания)
Имя |
Описание |
Ценность |
addonConfigs |
Коллекция надстроек |
DeploymentSettingsAddonConfigs |
АПМ |
Коллекция ApmReferences |
Справка об Apm[] |
containerProbeSettings |
Параметры проверки активности и готовности контейнера |
ContainerProbeSettings (ContainerProbeSettings) |
переменные окружения |
Коллекция переменных среды |
DeploymentSettingsEnvironmentVariables |
livenessProbe |
Периодический зонд активности экземпляра приложения. Экземпляр приложения будет перезапущен, если проба завершается ошибкой. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
пробы |
готовностьProbe |
Периодическое проверка готовности службы экземпляра приложений. Экземпляр приложения будет удален из конечных точек службы, если проба завершается ошибкой. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
пробы |
resourceRequests |
Запрошенное количество ресурсов для требуемого ЦП и памяти. Рекомендуется использовать это поле для представления требуемого ЦП и памяти, старое поле ЦП и памятьInGB будут устарели позже. |
Запросы на ресурсы |
шкала |
Масштабирование свойств для экземпляра приложения Azure Spring Apps. |
масштаб |
startupProbe |
StartupProbe указывает, что экземпляр приложения успешно инициализирован. Если задано, другие пробы не выполняются до тех пор, пока это не завершится успешно. Если эта проба завершается ошибкой, модуль Pod будет перезапущен так же, как если бы livenessProbe произошел сбой. Это можно использовать для предоставления различных параметров пробы в начале жизненного цикла экземпляра приложения, когда может потребоваться много времени для загрузки данных или теплого кэша, чем во время операции с устойчивым состоянием. Это невозможно обновить. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
пробы |
terminationGracePeriodSeconds |
Необязательный период в секундах экземпляр приложения должен завершиться корректно. Может быть уменьшено в запросе на удаление. Значение должно быть неотрицательно целым числом. Нулевое значение указывает, что немедленно останавливается через сигнал убийства (нет возможности завершить работу). Если это значение равно nil, вместо этого будет использоваться льготный период по умолчанию. Льготный период — это длительность в секундах после того, как процессы, выполняемые в экземпляре приложения, отправляются сигнал о завершении и время принудительного прекращения процессов с помощью сигнала об убийстве. Задайте это значение дольше ожидаемого времени очистки для процесса. Значение по умолчанию — 90 секунд. |
инт |
DeploymentSettingsAddonConfigs
DeploymentSettingsEnvironmentVariables
ExecAction
Имя |
Описание |
Ценность |
команда |
Команда — это командная строка, выполняемая внутри контейнера, рабочий каталог команды является корневым ('/) в файловой системе контейнера. Команда не выполняется внутри оболочки, поэтому традиционные инструкции оболочки ('|' и т. д.) не будут работать. Чтобы использовать оболочку, необходимо явно вызвать эту оболочку. Состояние выхода 0 рассматривается как живое или работоспособное и ненулевое является неработоспособным. |
строка[] |
тип |
Тип действия, выполняемого для проверки работоспособности. |
ExecAction (обязательно) |
HttpGetAction (HttpGetAction)
Имя |
Описание |
Ценность |
путь |
Путь к доступу на HTTP-сервере. |
струна |
схема |
Схема, используемая для подключения к узлу. По умолчанию используется протокол HTTP.
Возможные значения перечисления:
-
"HTTP" означает, что используемая схема будет http://
-
"HTTPS" означает, что используемая схема будет https:// |
"HTTP" "HTTPS" |
тип |
Тип действия, выполняемого для проверки работоспособности. |
HTTPGetAction (обязательно) |
Правило httpScaleRule (Правило HttpScale)
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для настраиваемого правила масштабирования. |
ScaleRuleAuth[] |
метаданные |
Свойства метаданных для описания правила масштабирования HTTP. |
Метаданные HttpScaleRule |
Учетные данные ImageRegistryCredential
Имя |
Описание |
Ценность |
пароль |
Пароль учетных данных реестра образов |
струна |
имя пользователя |
Имя пользователя учетных данных реестра образов |
струна |
JarUploadedUserSourceInfo
Имя |
Описание |
Ценность |
Опции jvmOptions |
Параметр JVM |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия jar-файла среды выполнения |
струна |
тип |
Тип отправленного источника |
Jar (обязательно) |
Имя |
Описание |
Ценность |
имя |
Имя ресурса |
строка (обязательно) |
идентификатор_родителя |
Идентификатор ресурса, который является родительским для этого ресурса. |
Идентификатор ресурса типа: Spring/apps |
свойства |
Свойства ресурса развертывания |
DeploymentResourceProperties (DeploymentResourceProperties) |
SKU |
Sku ресурса развертывания |
SKU |
тип |
Тип ресурса |
"Microsoft.AppPlatform/Spring/apps/deployments@2024-05-01-preview" |
NetCoreZipUploadedUserSourceInfo
Имя |
Описание |
Ценность |
netCoreMainEntryPath |
Путь к исполняемому файлу .NET относительно корневого zip-файла |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия среды выполнения файла .Net |
струна |
тип |
Тип отправленного источника |
NetCoreZip (обязательно) |
Зонд
Имя |
Описание |
Ценность |
disableProbe |
Укажите, отключена ли проба. |
bool (обязательно) |
Порог неудачи |
Минимальные последовательные сбои для проверки, которые будут считаться неудачными после успешного выполнения. Минимальное значение равно 1. |
инт |
initialDelaySeconds |
Количество секунд после запуска экземпляра приложения перед запуском проб. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
инт |
период в секундах |
Как часто (в секундах) выполнять пробу. Минимальное значение равно 1. |
инт |
probeAction |
Действие пробы. |
ProbeAction |
Порог успеха |
Минимальные последовательные успехи для пробы, которые будут считаться успешными после сбоя. Должно быть 1 для жизни и запуска. Минимальное значение равно 1. |
инт |
timeoutSeconds |
Количество секунд, после которого время ожидания пробы истекает. Минимальное значение равно 1. |
инт |
ProbeAction
Имя |
Описание |
Ценность |
тип |
Установите значение ExecAction для типа ExecAction. Установите значение HTTPGetAction для типа HttpGetAction. Установите значение "TCPSocketAction" для типа TCPSocketAction. |
«Исполнительное действие» "HTTPGetAction" TCPSocketAction (обязательный) |
Правило QueueScaleRule
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для правила масштабирования очереди. |
ScaleRuleAuth[] |
длина очереди |
Длина очереди. |
инт |
название очереди |
Имя очереди. |
струна |
Запросы на ресурсы
Имя |
Описание |
Ценность |
ЦПУ |
Обязательный ЦП. 1 ядро может быть представлено 1 или 1000 млн. Это должно быть 500 м или 1 для уровня "Базовый" и {500m, 1, 2, 3, 4} для уровня "Стандартный". |
струна |
память |
Требуемая память. 1 ГБ можно представить 1Gi или 1024Mi. Это должно быть {512Mi, 1Gi, 2Gi} для уровня "Базовый" и {512Mi, 1Gi, 2Gi, ..., 8Gi} для уровня "Стандартный". |
струна |
Шкала
Имя |
Описание |
Ценность |
maxReplicas |
Необязательный. Максимальное количество реплик контейнеров. Значение по умолчанию — 10, если не задано. |
инт |
minReplicas |
Необязательный. Минимальное количество реплик контейнеров. |
инт |
Правила |
Правила масштабирования. |
Правило масштабирования[] |
Правило масштабирования
ScaleRuleAuth (Масштабная аутентификация)
Имя |
Описание |
Ценность |
secretRef |
Имя секрета экземпляра приложения Azure Spring Apps, из которого необходимо извлечь парам проверки подлинности. |
струна |
triggerParameter |
Параметр триггера, использующий секрет |
струна |
Артикул
Имя |
Описание |
Ценность |
способность |
Текущая емкость целевого ресурса |
инт |
имя |
Имя SKU |
струна |
ярус |
Уровень SKU |
струна |
ИсточникЗагруженныйПользовательИсходная информация
Имя |
Описание |
Ценность |
артефактСелектор |
Селектор для артефакта, который будет использоваться для развертывания для проектов с несколькими модулями. Это должно быть относительный путь к целевому модулю или проекту. |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия исходного файла среды выполнения |
струна |
тип |
Тип отправленного источника |
Source (обязательный) |
Правило TcpScaleRule
Имя |
Описание |
Ценность |
авторизация |
Секреты проверки подлинности для правила масштабирования tcp. |
ScaleRuleAuth[] |
метаданные |
Свойства метаданных для описания правила масштабирования tcp. |
Метаданные TcpScaleRule |
TCPSocketAction
Имя |
Описание |
Ценность |
тип |
Тип действия, выполняемого для проверки работоспособности. |
TCPSocketAction (обязательный) |
Информация о пользователе
WarUploadedUserSourceInfo
Имя |
Описание |
Ценность |
Опции jvmOptions |
Параметр JVM |
струна |
relativePath |
Относительный путь к хранилищу, в котором хранится источник |
струна |
runtimeVersion |
Версия war file в среде выполнения |
струна |
версия сервера |
Версия сервера, в настоящее время поддерживается только Apache Tomcat |
струна |
тип |
Тип отправленного источника |
"Война" (обязательно) |