Microsoft.AppPlatform Spring/apps/deployments
Определение ресурса Bicep
Тип ресурса Spring/apps/deployments можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания групп ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.AppPlatform/Spring/apps/deployments, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.AppPlatform/Spring/apps/deployments@2023-03-01-preview' = {
name: 'string'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
parent: resourceSymbolicName
properties: {
active: bool
deploymentSettings: {
addonConfigs: {}
containerProbeSettings: {
disableProbe: bool
}
environmentVariables: {}
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: {}
type: 'string'
}
http: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
metadata: {}
}
name: 'string'
tcp: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
metadata: {}
}
}
]
}
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
}
}
}
Объекты ProbeAction
Задайте свойство type , чтобы указать тип объекта .
Для ExecAction используйте:
type: 'ExecAction'
command: [
'string'
]
Для HTTPGetAction используйте:
type: 'HTTPGetAction'
path: 'string'
scheme: 'string'
Для TCPSocketAction используйте:
type: 'TCPSocketAction'
Объекты UserSourceInfo
Задайте свойство type , чтобы указать тип объекта .
Для BuildResult используйте:
type: 'BuildResult'
buildResultId: 'string'
Для контейнера используйте:
type: 'Container'
customContainer: {
args: [
'string'
]
command: [
'string'
]
containerImage: 'string'
imageRegistryCredential: {
password: 'string'
username: 'string'
}
languageFramework: 'string'
server: 'string'
}
Для JAR-файла используйте:
type: 'Jar'
jvmOptions: 'string'
relativePath: 'string'
runtimeVersion: 'string'
Для NetCoreZip используйте:
type: 'NetCoreZip'
netCoreMainEntryPath: 'string'
relativePath: 'string'
runtimeVersion: 'string'
В качестве источника используйте:
type: 'Source'
artifactSelector: 'string'
relativePath: 'string'
runtimeVersion: 'string'
Значения свойств
Spring,apps/deployments
Имя | Описание | Значение |
---|---|---|
name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep. |
string (обязательно) |
sku | Номер SKU ресурса развертывания | SKU |
родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: apps |
properties | Свойства ресурса развертывания | DeploymentResourceProperties |
DeploymentResourceProperties
Имя | Описание | Значение |
---|---|---|
active | Указывает, активно ли развертывание. | bool |
deploymentSettings | Параметры развертывания развертывания | DeploymentSettings |
source | Отправлены исходные сведения о развертывании. | UserSourceInfo |
DeploymentSettings
Имя | Описание | Значение |
---|---|---|
addonConfigs | Коллекция надстроек | object |
containerProbeSettings | Параметры пробы активности и готовности контейнера | ContainerProbeSettings |
environmentVariables | Коллекция переменных среды | объект |
livenessProbe | Периодическая проверка активности экземпляра приложения. Экземпляр приложения будет перезапущен в случае сбоя пробы. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
Проба |
readinessProbe | Периодическая проверка готовности службы экземпляра приложения. Экземпляр приложения будет удален из конечных точек службы в случае сбоя пробы. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
Проба |
resourceRequests | Запрошенное количество ресурсов для требуемого ЦП и памяти. Рекомендуется использовать это поле для представления необходимых ЦП и памяти. Старое поле ЦП и памятьInGB будут устарели позже. | ResourceRequests |
scale | Свойства масштабирования для экземпляра приложения Azure Spring Apps. | Масштабирование |
startupProbe | StartupProbe указывает, что экземпляр приложения успешно инициализирован. Если этот параметр указан, другие пробы не выполняются до успешного завершения. Если эта проба завершается сбоем, pod будет перезапущен так же, как если бы livenessProbe завершился сбоем. Это можно использовать для предоставления различных параметров пробы в начале жизненного цикла экземпляра приложения, когда загрузка данных или разогрева кэша может занять много времени, чем во время операции с устойчивым состоянием. Обновление невозможно. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
Проба |
terminationGracePeriodSeconds | Необязательная длительность (в секундах) экземпляру приложения необходимо корректно завершить работу. Может быть уменьшено в запросе на удаление. Значение должно быть неотрицательно целым числом. Нулевое значение указывает на остановку немедленно через сигнал завершения (нет возможности завершить работу). Если это значение равно нулю, вместо него будет использоваться льготный период по умолчанию. Льготный период — это длительность в секундах после отправки сигнала о завершении процессов, запущенных в экземпляре приложения, и время принудительной остановки процессов с помощью сигнала завершения. Задайте это значение дольше, чем ожидаемое время очистки для процесса. Значение по умолчанию — 90 секунд. | INT |
ContainerProbeSettings
Имя | Описание | Значение |
---|---|---|
disableProbe | Указывает, отключается ли проба активности и готовности. | bool |
Проба
Имя | Описание | Значение |
---|---|---|
disableProbe | Укажите, отключена ли проба. | bool (обязательно) |
failureThreshold | Минимальное количество последовательных сбоев для проверки, которые будут считаться неудачными после успешного выполнения. Минимальное значение — 1. | INT |
initialDelaySeconds | Количество секунд после запуска экземпляра приложения до запуска проб. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
INT |
periodSeconds | Частота (в секундах) выполнения пробы. Минимальное значение — 1. | INT |
probeAction | Действие пробы. | ProbeAction |
successThreshold | Минимальный последовательный успех пробы, который будет считаться успешным после сбоя. Должно быть 1 для активности и запуска. Минимальное значение — 1. | INT |
timeoutSeconds | Количество секунд, по истечении которого время ожидания пробы истекает. Минимальное значение — 1. | INT |
ProbeAction
Имя | Описание | Значение |
---|---|---|
тип | Установка типа объекта | ExecAction HTTPGetAction TCPSocketAction (обязательно) |
ExecAction
Имя | Описание | Значение |
---|---|---|
тип | Тип действия, выполняемого для выполнения проверка работоспособности. | ExecAction (обязательно) |
. | Команда — это командная строка для выполнения в контейнере, а рабочий каталог для команды — корневой каталог ('/') в файловой системе контейнера. Команда не выполняется внутри оболочки, поэтому традиционные инструкции оболочки (',', и т. д.) не будут работать. Чтобы использовать оболочку, необходимо явно вызвать эту оболочку. Состояние выхода 0 считается активным или работоспособным, а ненулевое — неработоспособным. | string[] |
HttpGetAction
Имя | Описание | Значение |
---|---|---|
тип | Тип действия, выполняемого для выполнения проверка работоспособности. | HTTPGetAction (обязательно) |
path | Путь для доступа на HTTP-сервере. | строка |
схема | Схема, используемая для подключения к узлу. Значение по умолчанию — HTTP. Возможные значения перечисления: - "HTTP" означает, что используемая схема будет http:// - "HTTPS" означает, что используемая схема будет https:// |
"HTTP" "HTTPS" |
TCPSocketAction
Имя | Описание | Значение |
---|---|---|
тип | Тип действия, выполняемого для выполнения проверка работоспособности. | TCPSocketAction (обязательно) |
ResourceRequests
Имя | Описание | Значение |
---|---|---|
cpu | Требуемый ЦП. 1 ядро может быть представлено 1 или 1000 м. Значение должно быть 500 мин или 1 для уровня "Базовый" и {500m, 1, 2, 3, 4} для уровня "Стандартный". | строка |
Память | Требуемая память. 1 ГБ может быть представлен 1Gi или 1024Mi. Это должно быть {512Mi, 1Gi, 2Gi} для уровня "Базовый" и {512Mi, 1Gi, 2Gi, ..., 8Gi} для уровня "Стандартный". | строка |
Масштабирование
Имя | Описание | Значение |
---|---|---|
maxReplicas | Необязательный элемент. Максимальное число реплик контейнеров. Значение по умолчанию — 10, если не задано. | INT |
minReplicas | Необязательный элемент. Минимальное количество реплик контейнеров. | INT |
правила | Правила масштабирования. | ScaleRule[] |
ScaleRule
Имя | Описание | Значение |
---|---|---|
azureQueue | Масштабирование на основе очередей Azure. | QueueScaleRule |
custom | Настраиваемое правило масштабирования. | CustomScaleRule |
http | Масштабирование на основе HTTP-запросов. | HttpScaleRule |
name | Имя правила масштабирования | строка |
TCP | Масштабирование на основе TCP-запросов. | TcpScaleRule |
QueueScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для правила масштабирования очереди. | ScaleRuleAuth[] |
queueLength | Длина очереди. | INT |
queueName | Имя очереди. | строка |
ScaleRuleAuth
Имя | Описание | Значение |
---|---|---|
secretRef | Имя секрета экземпляра приложения Azure Spring Apps, из которого будут извлекаться параметры проверки подлинности. | строка |
triggerParameter | Параметр триггера, использующий секрет | строка |
CustomScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для настраиваемого правила масштабирования. | ScaleRuleAuth[] |
метаданные | Свойства метаданных для описания настраиваемого правила масштабирования. | object |
тип | Тип настраиваемого правила масштабирования Например: azure-servicebus, redis и т. д. |
строка |
HttpScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для настраиваемого правила масштабирования. | ScaleRuleAuth[] |
метаданные | Свойства метаданных для описания правила масштабирования HTTP. | object |
TcpScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для правила масштабирования TCP. | ScaleRuleAuth[] |
метаданные | Свойства метаданных для описания правила масштабирования TCP. | object |
UserSourceInfo
Имя | Описание | Значение |
---|---|---|
version | Версия источника | строка |
type | Установка типа объекта | BuildResult Контейнер Банку NetCoreZip Источник (обязательно) |
BuildResultUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | BuildResult (обязательно) |
buildResultId | Идентификатор ресурса существующего результата успешной сборки в том же экземпляре Spring. | строка |
CustomContainerUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | "Контейнер" (обязательно) |
customContainer | Полезные данные пользовательского контейнера | CustomContainer |
CustomContainer
Имя | Описание | Значение |
---|---|---|
args | Аргументы для точки входа. CmD образа Docker используется, если это не указано. | string[] |
. | Массив точек входа. Не выполняется в оболочке. Точка ВХОДА образа Docker используется, если она не указана. | string[] |
containerImage | Образ контейнера пользовательского контейнера. Оно должно быть в формате {repository}:{tag} без имени сервера реестра. | строка |
imageRegistryCredential | Учетные данные реестра образов | ImageRegistryCredential |
languageFramework | Языковая платформа отправленного образа контейнера | строка |
server | Имя реестра, содержащего образ контейнера. | строка |
ImageRegistryCredential
Имя | Описание | Значение |
---|---|---|
password | Пароль учетных данных реестра образов | строка |
username | Имя пользователя учетных данных реестра образов | строка |
JarUploadedUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | Jar (обязательный) |
jvmOptions | Параметр JVM | строка |
relativePath | Относительный путь к хранилищу, в котором хранится источник | строка |
runtimeVersion | Версия JAR-файла во время выполнения | строка |
NetCoreZipUploadedUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | NetCoreZip (обязательно) |
netCoreMainEntryPath | Путь к исполняемому файлу .NET относительно корня ZIP | строка |
relativePath | Относительный путь к хранилищу, в котором хранится источник | строка |
runtimeVersion | Версия среды выполнения файла .NET | строка |
SourceUploadedUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | "Источник" (обязательно) |
artifactSelector | Селектор артефакта, который будет использоваться для развертывания многомодульных проектов. Это должно быть относительный путь к целевому модулю или проекту. |
строка |
relativePath | Относительный путь к хранилищу, в котором хранится источник | строка |
runtimeVersion | Версия исходного файла среды выполнения | строка |
Sku
Имя | Описание | Значение |
---|---|---|
Емкость | Текущая емкость целевого ресурса | INT |
name | Имя SKU | строка |
Уровень | Уровень SKU | строка |
Определение ресурса шаблона ARM
Тип ресурса Spring/apps/deployments можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания групп ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.AppPlatform/Spring/apps/deployments, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.AppPlatform/Spring/apps/deployments",
"apiVersion": "2023-03-01-preview",
"name": "string",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"properties": {
"active": "bool",
"deploymentSettings": {
"addonConfigs": {},
"containerProbeSettings": {
"disableProbe": "bool"
},
"environmentVariables": {},
"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": {},
"type": "string"
},
"http": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"metadata": {}
},
"name": "string",
"tcp": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"metadata": {}
}
}
]
},
"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
}
}
}
Объекты ProbeAction
Задайте свойство type , чтобы указать тип объекта .
Для ExecAction используйте:
"type": "ExecAction",
"command": [ "string" ]
Для HTTPGetAction используйте:
"type": "HTTPGetAction",
"path": "string",
"scheme": "string"
Для TCPSocketAction используйте:
"type": "TCPSocketAction"
Объекты UserSourceInfo
Задайте свойство type , чтобы указать тип объекта .
Для BuildResult используйте:
"type": "BuildResult",
"buildResultId": "string"
Для контейнера используйте:
"type": "Container",
"customContainer": {
"args": [ "string" ],
"command": [ "string" ],
"containerImage": "string",
"imageRegistryCredential": {
"password": "string",
"username": "string"
},
"languageFramework": "string",
"server": "string"
}
Для JAR-файла используйте:
"type": "Jar",
"jvmOptions": "string",
"relativePath": "string",
"runtimeVersion": "string"
Для NetCoreZip используйте:
"type": "NetCoreZip",
"netCoreMainEntryPath": "string",
"relativePath": "string",
"runtimeVersion": "string"
В качестве источника используйте:
"type": "Source",
"artifactSelector": "string",
"relativePath": "string",
"runtimeVersion": "string"
Значения свойств
Spring,apps/deployments
Имя | Описание | Значение |
---|---|---|
тип | Тип ресурса | Microsoft.AppPlatform/Spring/apps/deployments |
версия_API | Версия API ресурсов | '2023-03-01-preview' |
name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM. |
string (обязательно) |
sku | Номер SKU ресурса развертывания | SKU |
properties | Свойства ресурса развертывания | DeploymentResourceProperties |
DeploymentResourceProperties
Имя | Описание | Значение |
---|---|---|
active | Указывает, активно ли развертывание. | bool |
deploymentSettings | Параметры развертывания развертывания | DeploymentSettings |
source | Отправлены исходные сведения о развертывании. | UserSourceInfo |
DeploymentSettings
Имя | Описание | Значение |
---|---|---|
addonConfigs | Коллекция надстроек | object |
containerProbeSettings | Параметры проб активности и готовности контейнера | ContainerProbeSettings |
environmentVariables | Коллекция переменных среды | объект |
livenessProbe | Периодическая проверка активности экземпляра приложения. Экземпляр приложения будет перезапущен в случае сбоя пробы. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
Проба |
readinessProbe | Периодическая проверка готовности службы экземпляра приложения. Экземпляр приложения будет удален из конечных точек службы в случае сбоя пробы. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
Проба |
resourceRequests | Запрошенное количество ресурсов для требуемого ЦП и памяти. Рекомендуется использовать это поле для представления необходимых ресурсов ЦП и памяти. Старое поле ЦП и memoryInGB будет считаться устаревшим позже. | ResourceRequests |
scale | Свойства масштабирования для экземпляра приложения Azure Spring Apps. | Масштабирование |
startupProbe | StartupProbe указывает, что экземпляр приложения успешно инициализирован. Если этот параметр указан, другие пробы не выполняются до успешного завершения. Если эта проба завершится сбоем, модуль Pod будет перезапущен так же, как и при сбое livenessProbe. Его можно использовать для предоставления различных параметров пробы в начале жизненного цикла экземпляра приложения, когда загрузка данных или разогрева кэша может занять много времени, чем во время работы с устойчивым состоянием. Обновление невозможно. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
Проба |
terminationGracePeriodSeconds | Необязательный период (в секундах), который экземпляр приложения должен завершиться корректно. Может быть уменьшено в запросе на удаление. Значение должно быть неотрицательно целым числом. Нулевое значение указывает, что остановка немедленно завершается с помощью сигнала завершения (нет возможности завершить работу). Если это значение равно nil, вместо него будет использоваться льготный период по умолчанию. Льготный период — это длительность в секундах после отправки сигнала о завершении процессов, выполняемых в экземпляре приложения, и время принудительной остановки процессов с сигналом завершения. Задайте это значение дольше ожидаемого времени очистки для процесса. Значение по умолчанию — 90 секунд. | INT |
ContainerProbeSettings
Имя | Описание | Значение |
---|---|---|
disableProbe | Указывает, отключается ли проба активности и готовности. | bool |
Проба
Имя | Описание | Значение |
---|---|---|
disableProbe | Укажите, отключена ли проба. | bool (обязательно) |
failureThreshold | Минимальные последовательные сбои пробы, которые будут считаться неудачными после успешного завершения. Минимальное значение — 1. | INT |
initialDelaySeconds | Количество секунд после запуска экземпляра приложения до запуска проб. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
INT |
periodSeconds | Частота (в секундах) выполнения пробы. Минимальное значение — 1. | INT |
probeAction | Действие пробы. | ProbeAction |
successThreshold | Минимальный последовательный успех пробы, который будет считаться успешным после сбоя. Значение должно быть 1 для активности и запуска. Минимальное значение — 1. | INT |
timeoutSeconds | Время ожидания пробы в секундах. Минимальное значение — 1. | INT |
ProbeAction
Имя | Описание | Значение |
---|---|---|
тип | Установка типа объекта | ExecAction HTTPGetAction TCPSocketAction (обязательно) |
ExecAction
Имя | Описание | Значение |
---|---|---|
тип | Тип действия, выполняемого для выполнения проверка работоспособности. | ExecAction (обязательный) |
. | Команда — это командная строка, выполняемая в контейнере. Рабочий каталог для команды является корневым ("/") в файловой системе контейнера. Команда не выполняется внутри оболочки, поэтому традиционные инструкции оболочки (',', и т. д.) не будут работать. Чтобы использовать оболочку, необходимо явно вызвать эту оболочку. Состояние выхода 0 считается работоспособным, а ненулевое — неработоспособным. | string[] |
HttpGetAction
Имя | Описание | Значение |
---|---|---|
тип | Тип действия, выполняемого для выполнения проверка работоспособности. | HTTPGetAction (обязательно) |
path | Путь для доступа на HTTP-сервере. | строка |
схема | Схема, используемая для подключения к узлу. Значение по умолчанию — HTTP. Возможные значения перечисления: - "HTTP" означает, что используемая схема будет иметь значение http:// - "HTTPS" означает, что используемая схема будет иметь значение https:// |
"HTTP" "HTTPS" |
TCPSocketAction
Имя | Описание | Значение |
---|---|---|
тип | Тип действия, выполняемого для выполнения проверка работоспособности. | TCPSocketAction (обязательно) |
ResourceRequests
Имя | Описание | Значение |
---|---|---|
cpu | Требуемый ЦП. 1 ядро может быть представлено 1 или 1000 м. Значение должно быть 500 мин или 1 для уровня "Базовый" и {500m, 1, 2, 3, 4} для уровня "Стандартный". | строка |
Память | Требуемая память. 1 ГБ может быть представлен 1Gi или 1024Mi. Это должно быть {512Mi, 1Gi, 2Gi} для уровня "Базовый" и {512Mi, 1Gi, 2Gi, ..., 8Gi} для уровня "Стандартный". | строка |
Масштабирование
Имя | Описание | Значение |
---|---|---|
maxReplicas | Необязательный элемент. Максимальное число реплик контейнеров. Значение по умолчанию — 10, если не задано. | INT |
minReplicas | Необязательный элемент. Минимальное количество реплик контейнеров. | INT |
правила | Правила масштабирования. | ScaleRule[] |
ScaleRule
Имя | Описание | Значение |
---|---|---|
azureQueue | Масштабирование на основе очередей Azure. | QueueScaleRule |
custom | Настраиваемое правило масштабирования. | CustomScaleRule |
http | Масштабирование на основе HTTP-запросов. | HttpScaleRule |
name | Имя правила масштабирования | строка |
TCP | Масштабирование на основе TCP-запросов. | TcpScaleRule |
QueueScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для правила масштабирования очереди. | ScaleRuleAuth[] |
queueLength | Длина очереди. | INT |
queueName | Имя очереди. | строка |
ScaleRuleAuth
Имя | Описание | Значение |
---|---|---|
secretRef | Имя секрета экземпляра приложения Azure Spring Apps, из которого будут извлекаться параметры проверки подлинности. | строка |
triggerParameter | Параметр триггера, использующий секрет | строка |
CustomScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для настраиваемого правила масштабирования. | ScaleRuleAuth[] |
метаданные | Свойства метаданных для описания настраиваемого правила масштабирования. | object |
тип | Тип настраиваемого правила масштабирования Например: azure-servicebus, redis и т. д. |
строка |
HttpScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для настраиваемого правила масштабирования. | ScaleRuleAuth[] |
метаданные | Свойства метаданных для описания правила масштабирования HTTP. | object |
TcpScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для правила масштабирования TCP. | ScaleRuleAuth[] |
метаданные | Свойства метаданных для описания правила масштабирования TCP. | object |
UserSourceInfo
Имя | Описание | Значение |
---|---|---|
version | Версия источника | строка |
type | Установка типа объекта | BuildResult Контейнер Банку NetCoreZip Источник (обязательно) |
BuildResultUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | BuildResult (обязательно) |
buildResultId | Идентификатор ресурса существующего результата успешной сборки в том же экземпляре Spring. | строка |
CustomContainerUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | Контейнер (обязательный) |
customContainer | Полезные данные пользовательского контейнера | CustomContainer |
CustomContainer
Имя | Описание | Значение |
---|---|---|
args | Аргументы для точки входа. CmD образа Docker используется, если он не указан. | string[] |
. | Массив точек входа. Не выполняется в оболочке. EntryPOINT образа Docker используется, если он не указан. | string[] |
containerImage | Образ контейнера пользовательского контейнера. Он должен быть в формате {repository}:{tag} без имени сервера реестра. | строка |
imageRegistryCredential | Учетные данные реестра образов | ImageRegistryCredential |
languageFramework | Языковая платформа отправленного образа контейнера | строка |
server | Имя реестра, содержащего образ контейнера. | строка |
ImageRegistryCredential
Имя | Описание | Значение |
---|---|---|
password | Пароль учетных данных реестра образов | строка |
username | Имя пользователя учетных данных реестра образов | строка |
JarUploadedUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | Jar (обязательно) |
jvmOptions | Параметр виртуальной машины Java | строка |
relativePath | Относительный путь к хранилищу, в котором хранится источник | строка |
runtimeVersion | Версия JAR-файла в среде выполнения | строка |
NetCoreZipUploadedUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | NetCoreZip (обязательно) |
netCoreMainEntryPath | Путь к исполняемому файлу .NET относительно корневого zip-файла | строка |
relativePath | Относительный путь к хранилищу, в котором хранится источник | строка |
runtimeVersion | Версия среды выполнения файла .NET | строка |
SourceUploadedUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | "Источник" (обязательно) |
artifactSelector | Селектор артефакта, который будет использоваться при развертывании для многомодульных проектов. Это должно быть относительный путь к целевому модулю или проекту. |
строка |
relativePath | Относительный путь к хранилищу, в котором хранится источник | строка |
runtimeVersion | Версия исходного файла в среде выполнения | строка |
Sku
Имя | Описание | Значение |
---|---|---|
Емкость | Текущая емкость целевого ресурса | INT |
name | Имя номера SKU | строка |
Уровень | Уровень номера SKU | строка |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса Spring/apps/deployments можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.AppPlatform/Spring/apps/deployments, добавьте в шаблон следующую версию Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/apps/deployments@2023-03-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
active = bool
deploymentSettings = {
addonConfigs = {}
containerProbeSettings = {
disableProbe = bool
}
environmentVariables = {}
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 = {}
type = "string"
}
http = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
metadata = {}
}
name = "string"
tcp = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
metadata = {}
}
}
]
}
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"
}
})
}
Объекты ProbeAction
Задайте свойство type , чтобы указать тип объекта .
Для ExecAction используйте:
type = "ExecAction"
command = [
"string"
]
Для HTTPGetAction используйте:
type = "HTTPGetAction"
path = "string"
scheme = "string"
Для TCPSocketAction используйте:
type = "TCPSocketAction"
Объекты UserSourceInfo
Задайте свойство type , чтобы указать тип объекта .
Для BuildResult используйте:
type = "BuildResult"
buildResultId = "string"
Для контейнера используйте:
type = "Container"
customContainer = {
args = [
"string"
]
command = [
"string"
]
containerImage = "string"
imageRegistryCredential = {
password = "string"
username = "string"
}
languageFramework = "string"
server = "string"
}
Для Jar используйте:
type = "Jar"
jvmOptions = "string"
relativePath = "string"
runtimeVersion = "string"
Для NetCoreZip используйте:
type = "NetCoreZip"
netCoreMainEntryPath = "string"
relativePath = "string"
runtimeVersion = "string"
В качестве источника используйте:
type = "Source"
artifactSelector = "string"
relativePath = "string"
runtimeVersion = "string"
Значения свойств
Spring,apps/deployments
Имя | Описание | Значение |
---|---|---|
тип | Тип ресурса | "Microsoft.AppPlatform/Spring/apps/deployments@2023-03-01-preview" |
name | имя ресурса. | строка (обязательно) |
parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа apps |
sku | Номер SKU ресурса развертывания | SKU |
properties | Свойства ресурса развертывания | DeploymentResourceProperties |
DeploymentResourceProperties
Имя | Описание | Значение |
---|---|---|
active | Указывает, активно ли развертывание. | bool |
deploymentSettings | Параметры развертывания развертывания | DeploymentSettings |
source | Отправлены исходные сведения о развертывании. | UserSourceInfo |
DeploymentSettings
Имя | Описание | Значение |
---|---|---|
addonConfigs | Коллекция надстроек | object |
containerProbeSettings | Параметры пробы активности и готовности контейнера | ContainerProbeSettings |
environmentVariables | Коллекция переменных среды | объект |
livenessProbe | Периодическая проверка активности экземпляра приложения. Экземпляр приложения будет перезапущен в случае сбоя пробы. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
Проба |
readinessProbe | Периодическая проверка готовности службы экземпляра приложения. Экземпляр приложения будет удален из конечных точек службы в случае сбоя пробы. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
Проба |
resourceRequests | Запрошенное количество ресурсов для требуемого ЦП и памяти. Рекомендуется использовать это поле для представления необходимых ЦП и памяти. Старое поле ЦП и памятьInGB будут устарели позже. | ResourceRequests |
scale | Свойства масштабирования для экземпляра приложения Azure Spring Apps. | Масштабирование |
startupProbe | StartupProbe указывает, что экземпляр приложения успешно инициализирован. Если этот параметр указан, другие пробы не выполняются до успешного завершения. Если эта проба завершается сбоем, pod будет перезапущен так же, как если бы livenessProbe завершился сбоем. Это можно использовать для предоставления различных параметров пробы в начале жизненного цикла экземпляра приложения, когда загрузка данных или разогрева кэша может занять много времени, чем во время операции с устойчивым состоянием. Обновление невозможно. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
Проба |
terminationGracePeriodSeconds | Необязательная длительность (в секундах) экземпляру приложения необходимо корректно завершить работу. Может быть уменьшено в запросе на удаление. Значение должно быть неотрицательно целым числом. Нулевое значение указывает на остановку немедленно через сигнал завершения (нет возможности завершить работу). Если это значение равно нулю, вместо него будет использоваться льготный период по умолчанию. Льготный период — это длительность в секундах после отправки сигнала о завершении процессов, запущенных в экземпляре приложения, и время принудительной остановки процессов с помощью сигнала завершения. Задайте это значение дольше, чем ожидаемое время очистки для процесса. Значение по умолчанию — 90 секунд. | INT |
ContainerProbeSettings
Имя | Описание | Значение |
---|---|---|
disableProbe | Указывает, отключается ли проба активности и готовности. | bool |
Проба
Имя | Описание | Значение |
---|---|---|
disableProbe | Укажите, отключена ли проба. | bool (обязательно) |
failureThreshold | Минимальное количество последовательных сбоев для проверки, которые будут считаться неудачными после успешного выполнения. Минимальное значение — 1. | INT |
initialDelaySeconds | Количество секунд после запуска экземпляра приложения до запуска проб. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
INT |
periodSeconds | Частота (в секундах) выполнения пробы. Минимальное значение — 1. | INT |
probeAction | Действие пробы. | ProbeAction |
successThreshold | Минимальный последовательный успех пробы, который будет считаться успешным после сбоя. Должно быть 1 для активности и запуска. Минимальное значение — 1. | INT |
timeoutSeconds | Количество секунд, по истечении которого время ожидания пробы истекает. Минимальное значение — 1. | INT |
ProbeAction
Имя | Описание | Значение |
---|---|---|
тип | Установка типа объекта | ExecAction HTTPGetAction TCPSocketAction (обязательно) |
ExecAction
Имя | Описание | Значение |
---|---|---|
тип | Тип действия, выполняемого для выполнения проверка работоспособности. | "ExecAction" (обязательно) |
. | Команда — это командная строка для выполнения в контейнере, а рабочий каталог для команды — корневой каталог ('/') в файловой системе контейнера. Команда не выполняется внутри оболочки, поэтому традиционные инструкции оболочки (',', и т. д.) не будут работать. Чтобы использовать оболочку, необходимо явно вызвать эту оболочку. Состояние выхода 0 считается активным или работоспособным, а ненулевое — неработоспособным. | string[] |
HttpGetAction
Имя | Описание | Значение |
---|---|---|
тип | Тип действия, выполняемого для выполнения проверка работоспособности. | "HTTPGetAction" (обязательно) |
path | Путь для доступа на HTTP-сервере. | строка |
схема | Схема, используемая для подключения к узлу. Значение по умолчанию — HTTP. Возможные значения перечисления: - "HTTP" означает, что используемая схема будет http:// - "HTTPS" означает, что используемая схема будет https:// |
HTTP "HTTPS" |
TCPSocketAction
Имя | Описание | Значение |
---|---|---|
тип | Тип действия, выполняемого для выполнения проверка работоспособности. | "TCPSocketAction" (обязательно) |
ResourceRequests
Имя | Описание | Значение |
---|---|---|
cpu | Необходимый ЦП. 1 ядро может быть представлено 1 или 1000 м. Значение должно быть 500 м или 1 для уровня "Базовый" и {500 м, 1, 2, 3, 4} для уровня "Стандартный". | строка |
Память | Необходимая память. 1 ГБ может быть представлен 1Gi или 1024Mi. Это должно быть {512Mi, 1Gi, 2Gi} для уровня "Базовый" и {512Mi, 1Gi, 2Gi, ..., 8Gi} для уровня "Стандартный". | строка |
Масштабирование
Имя | Описание | Значение |
---|---|---|
maxReplicas | Необязательный элемент. Максимальное число реплик контейнеров. Значение по умолчанию — 10, если не задано. | INT |
minReplicas | Необязательный элемент. Минимальное количество реплик контейнеров. | INT |
правила | Правила масштабирования. | ScaleRule[] |
ScaleRule
Имя | Описание | Значение |
---|---|---|
azureQueue | Масштабирование на основе очередей Azure. | QueueScaleRule |
custom | Настраиваемое правило масштабирования. | CustomScaleRule |
http | Масштабирование на основе HTTP-запросов. | HttpScaleRule |
name | Имя правила масштабирования | строка |
TCP | Масштабирование на основе TCP-запросов. | TcpScaleRule |
QueueScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для правила масштабирования очереди. | ScaleRuleAuth[] |
queueLength | Длина очереди. | INT |
queueName | Имя очереди. | строка |
ScaleRuleAuth
Имя | Описание | Значение |
---|---|---|
secretRef | Имя секрета экземпляра приложения Azure Spring Apps, из которого будут извлекаться параметры проверки подлинности. | строка |
triggerParameter | Параметр триггера, использующий секрет | строка |
CustomScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для настраиваемого правила масштабирования. | ScaleRuleAuth[] |
метаданные | Свойства метаданных для описания настраиваемого правила масштабирования. | object |
тип | Тип настраиваемого правила масштабирования Например: azure-servicebus, redis и т. д. |
строка |
HttpScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для настраиваемого правила масштабирования. | ScaleRuleAuth[] |
метаданные | Свойства метаданных для описания правила масштабирования HTTP. | object |
TcpScaleRule
Имя | Описание | Значение |
---|---|---|
auth | Секреты проверки подлинности для правила масштабирования TCP. | ScaleRuleAuth[] |
метаданные | Свойства метаданных для описания правила масштабирования TCP. | object |
UserSourceInfo
Имя | Описание | Значение |
---|---|---|
version | Версия источника | строка |
type | Установка типа объекта | BuildResult Контейнер Банку NetCoreZip Источник (обязательно) |
BuildResultUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | "BuildResult" (обязательно) |
buildResultId | Идентификатор ресурса существующего результата успешной сборки в том же экземпляре Spring. | строка |
CustomContainerUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | "Контейнер" (обязательно) |
customContainer | Полезные данные пользовательского контейнера | CustomContainer |
CustomContainer
Имя | Описание | Значение |
---|---|---|
args | Аргументы для точки входа. CmD образа Docker используется, если он не указан. | string[] |
. | Массив точек входа. Не выполняется в оболочке. EntryPOINT образа Docker используется, если он не указан. | string[] |
containerImage | Образ контейнера пользовательского контейнера. Он должен быть в формате {repository}:{tag} без имени сервера реестра. | строка |
imageRegistryCredential | Учетные данные реестра образов | ImageRegistryCredential |
languageFramework | Языковая платформа отправленного образа контейнера | строка |
server | Имя реестра, содержащего образ контейнера. | строка |
ImageRegistryCredential
Имя | Описание | Значение |
---|---|---|
password | Пароль учетных данных реестра образов | строка |
username | Имя пользователя учетных данных реестра образов | строка |
JarUploadedUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | Jar (обязательно) |
jvmOptions | Параметр виртуальной машины Java | строка |
relativePath | Относительный путь к хранилищу, в котором хранится источник | строка |
runtimeVersion | Версия JAR-файла в среде выполнения | строка |
NetCoreZipUploadedUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | "NetCoreZip" (обязательно) |
netCoreMainEntryPath | Путь к исполняемому файлу .NET относительно корневого zip-файла | строка |
relativePath | Относительный путь к хранилищу, в котором хранится источник | строка |
runtimeVersion | Версия среды выполнения файла .NET | строка |
SourceUploadedUserSourceInfo
Имя | Описание | Значение |
---|---|---|
тип | Тип отправленного источника | "Источник" (обязательно) |
artifactSelector | Селектор артефакта, который будет использоваться при развертывании для многомодульных проектов. Это должно быть относительный путь к целевому модулю или проекту. |
строка |
relativePath | Относительный путь к хранилищу, в котором хранится источник | строка |
runtimeVersion | Версия исходного файла в среде выполнения | строка |
Sku
Имя | Описание | Значение |
---|---|---|
Емкость | Текущая емкость целевого ресурса | INT |
name | Имя номера SKU | строка |
Уровень | Уровень номера SKU | строка |