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

Microsoft.AppPlatform Spring/apps/deployments 2023-11-01-preview

  • Статья

Определение ресурсов Bicep

Тип ресурса Spring/apps/deployments можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.AppPlatform/Spring/apps/deployments, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.AppPlatform/Spring/apps/deployments@2023-11-01-preview' = {
  name: 'string'
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  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
    }
  }
}

Объекты ProbeAction

Задайте свойство типа , чтобы указать тип объекта.

Для ExecActionиспользуйте:

  type: 'ExecAction'
  command: [
    'string'
  ]

Для HTTPGetActionиспользуйте:

  type: 'HTTPGetAction'
  path: 'string'
  scheme: 'string'

Для TCPSocketActionиспользуйте:

  type: 'TCPSocketAction'

Объекты UserSourceInfo

Задайте свойство типа , чтобы указать тип объекта.

Для 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'

Для войныиспользуйте:

  type: 'War'
  jvmOptions: 'string'
  relativePath: 'string'
  runtimeVersion: 'string'
  serverVersion: 'string'

Значения свойств

Spring/apps/deployments

Имя Описание Ценность
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в Bicep.		 строка (обязательно)
SKU Sku ресурса развертывания Sku
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: приложения
свойства Свойства ресурса развертывания DeploymentResourceProperties

DeploymentResourceProperties

Имя Описание Ценность
активный Указывает, активна ли развертывание bool
deploymentSettings Параметры развертывания развертывания DeploymentSettings
источник Отправлены исходные сведения о развертывании. UserSourceInfo

DeploymentSettings

Имя Описание Ценность
addonConfigs Коллекция надстроек DeploymentSettingsAddonConfigs
apms Коллекция ApmReferences ApmReference[]
containerProbeSettings Параметры проверки активности и готовности контейнера ContainerProbeSettings
environmentVariables Коллекция переменных среды 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 будут устарели позже. ResourceRequests
шкала Масштабирование свойств для экземпляра приложения Azure Spring Apps. масштабирование
startupProbe StartupProbe указывает, что экземпляр приложения успешно инициализирован. Если задано, другие пробы не выполняются до тех пор, пока это не завершится успешно. Если эта проба завершается ошибкой, модуль Pod будет перезапущен так же, как если бы livenessProbe произошел сбой. Это можно использовать для предоставления различных параметров пробы в начале жизненного цикла экземпляра приложения, когда может потребоваться много времени для загрузки данных или теплого кэша, чем во время операции с устойчивым состоянием. Это невозможно обновить. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes пробы
terminationGracePeriodSeconds Необязательный период в секундах экземпляр приложения должен завершиться корректно. Может быть уменьшено в запросе на удаление. Значение должно быть неотрицательно целым числом. Нулевое значение указывает, что немедленно останавливается через сигнал убийства (нет возможности завершить работу). Если это значение равно nil, вместо этого будет использоваться льготный период по умолчанию. Льготный период — это длительность в секундах после того, как процессы, выполняемые в экземпляре приложения, отправляются сигнал о завершении и время принудительного прекращения процессов с помощью сигнала об убийстве. Задайте это значение дольше ожидаемого времени очистки для процесса. Значение по умолчанию — 90 секунд. int

DeploymentSettingsAddonConfigs

Имя Описание Ценность
{настраиваемое свойство} Для Bicep можно использовать функцию any().

ApmReference

Имя Описание Ценность
resourceId Идентификатор ресурса APM строка (обязательно)

ContainerProbeSettings

Имя Описание Ценность
disableProbe Указывает, отключает ли проба активности и готовности bool

DeploymentSettingsEnvironmentVariables

Имя Описание Ценность
{настраиваемое свойство} струна

Зонд

Имя Описание Ценность
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 (обязательно)
путь Путь к доступу на HTTP-сервере. струна
схема Схема, используемая для подключения к узлу. По умолчанию используется протокол HTTP.

Возможные значения перечисления:
- "HTTP" означает, что используемая схема будет http://
- "HTTPS" означает, что используемая схема будет https://		 "HTTP"
"HTTPS"

TCPSocketAction

Имя Описание Ценность
тип Тип действия, выполняемого для проверки работоспособности. TCPSocketAction (обязательный)

ResourceRequests

Имя Описание Ценность
ЦПУ Обязательный ЦП. 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
обычай Пользовательское правило масштабирования. CustomScaleRule
http Масштабирование на основе HTTP-запросов. HttpScaleRule
имя Имя правила масштабирования струна
протокол tcp Масштабирование на основе tcp-запросов. TcpScaleRule

QueueScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для правила масштабирования очереди. ScaleRuleAuth[]
queueLength Длина очереди. int
queueName Имя очереди. струна

ScaleRuleAuth

Имя Описание Ценность
secretRef Имя секрета экземпляра приложения Azure Spring Apps, из которого необходимо извлечь парам проверки подлинности. струна
triggerParameter Параметр триггера, использующий секрет струна

CustomScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для настраиваемого правила масштабирования. ScaleRuleAuth[]
метаданные Свойства метаданных для описания настраиваемого правила масштабирования. CustomScaleRuleMetadata
тип Тип настраиваемого правила масштабирования
например: azure-servicebus, redis и т. д.
 струна

CustomScaleRuleMetadata

Имя Описание Ценность
{настраиваемое свойство} струна

HttpScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для настраиваемого правила масштабирования. ScaleRuleAuth[]
метаданные Свойства метаданных для описания правила масштабирования HTTP. HttpScaleRuleMetadata

HttpScaleRuleMetadata

Имя Описание Ценность
{настраиваемое свойство} струна

TcpScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для правила масштабирования tcp. ScaleRuleAuth[]
метаданные Свойства метаданных для описания правила масштабирования tcp. TcpScaleRuleMetadata

TcpScaleRuleMetadata

Имя Описание Ценность
{настраиваемое свойство} струна

UserSourceInfo

Имя Описание Ценность
Версия Версия источника струна
тип Установка типа объекта BuildResult
контейнер
Jar
NetCoreZip
источник
войны (обязательно)

BuildResultUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника BuildResult (обязательно)
buildResultId Идентификатор ресурса существующей успешной сборки приводит к тому же экземпляру Spring. струна

CustomContainerUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника Container (обязательный)
customContainer Полезные данные пользовательского контейнера CustomContainer

CustomContainer

Имя Описание Ценность
args Аргументы в точку входа. CMD образа Docker используется, если это не указано. string[]
команда Массив точек входа. Не выполняется в оболочке. Запись образа Docker используется, если это не указано. string[]
containerImage Образ контейнера пользовательского контейнера. Это должно быть в виде {репозитория}:{tag} без имени сервера реестра. струна
imageRegistryCredential Учетные данные реестра образов ImageRegistryCredential
languageFramework Языковая платформа отправленного образа контейнера. Поддерживаемые значения: Springboot, "", null. струна
сервер Имя реестра, содержащего образ контейнера струна

ImageRegistryCredential

Имя Описание Ценность
пароль Пароль учетных данных реестра образов струна
имя пользователя Имя пользователя учетных данных реестра образов струна

JarUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника Jar (обязательно)
jvmOptions Параметр JVM струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия jar-файла среды выполнения струна

NetCoreZipUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника NetCoreZip (обязательно)
netCoreMainEntryPath Путь к исполняемому файлу .NET относительно корневого zip-файла струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия среды выполнения файла .Net струна

SourceUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника Source (обязательный)
artifactSelector Селектор для артефакта, который будет использоваться для развертывания для проектов с несколькими модулями. Это должно быть
относительный путь к целевому модулю или проекту.		 струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия исходного файла среды выполнения струна

WarUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника "Война" (обязательно)
jvmOptions Параметр JVM струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия war file в среде выполнения струна
serverVersion Версия сервера, в настоящее время поддерживается только Apache Tomcat струна

Sku

Имя Описание Ценность
способность Текущая емкость целевого ресурса int
имя Имя SKU струна
ярус Уровень SKU струна

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Развертывание простого приложения микрослужбы Azure Spring Apps

развертывание в Azure		 Этот шаблон развертывает простое приложение микрослужбы Azure Spring Apps для запуска в Azure.

Определение ресурса шаблона ARM

Тип ресурса Spring/apps/deployments можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.AppPlatform/Spring/apps/deployments, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.AppPlatform/Spring/apps/deployments",
  "apiVersion": "2023-11-01-preview",
  "name": "string",
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "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
    }
  }
}

Объекты ProbeAction

Задайте свойство типа , чтобы указать тип объекта.

Для ExecActionиспользуйте:

  "type": "ExecAction",
  "command": [ "string" ]

Для HTTPGetActionиспользуйте:

  "type": "HTTPGetAction",
  "path": "string",
  "scheme": "string"

Для TCPSocketActionиспользуйте:

  "type": "TCPSocketAction"

Объекты UserSourceInfo

Задайте свойство типа , чтобы указать тип объекта.

Для 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"

Для войныиспользуйте:

  "type": "War",
  "jvmOptions": "string",
  "relativePath": "string",
  "runtimeVersion": "string",
  "serverVersion": "string"

Значения свойств

Spring/apps/deployments

Имя Описание Ценность
тип Тип ресурса "Microsoft.AppPlatform/Spring/apps/deployments"
apiVersion Версия API ресурсов '2023-11-01-preview'
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON.		 строка (обязательно)
SKU Sku ресурса развертывания Sku
свойства Свойства ресурса развертывания DeploymentResourceProperties

DeploymentResourceProperties

Имя Описание Ценность
активный Указывает, активна ли развертывание bool
deploymentSettings Параметры развертывания развертывания DeploymentSettings
источник Отправлены исходные сведения о развертывании. UserSourceInfo

DeploymentSettings

Имя Описание Ценность
addonConfigs Коллекция надстроек DeploymentSettingsAddonConfigs
apms Коллекция ApmReferences ApmReference[]
containerProbeSettings Параметры проверки активности и готовности контейнера ContainerProbeSettings
environmentVariables Коллекция переменных среды 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 будут устарели позже. ResourceRequests
шкала Масштабирование свойств для экземпляра приложения Azure Spring Apps. масштабирование
startupProbe StartupProbe указывает, что экземпляр приложения успешно инициализирован. Если задано, другие пробы не выполняются до тех пор, пока это не завершится успешно. Если эта проба завершается ошибкой, модуль Pod будет перезапущен так же, как если бы livenessProbe произошел сбой. Это можно использовать для предоставления различных параметров пробы в начале жизненного цикла экземпляра приложения, когда может потребоваться много времени для загрузки данных или теплого кэша, чем во время операции с устойчивым состоянием. Это невозможно обновить. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes пробы
terminationGracePeriodSeconds Необязательный период в секундах экземпляр приложения должен завершиться корректно. Может быть уменьшено в запросе на удаление. Значение должно быть неотрицательно целым числом. Нулевое значение указывает, что немедленно останавливается через сигнал убийства (нет возможности завершить работу). Если это значение равно nil, вместо этого будет использоваться льготный период по умолчанию. Льготный период — это длительность в секундах после того, как процессы, выполняемые в экземпляре приложения, отправляются сигнал о завершении и время принудительного прекращения процессов с помощью сигнала об убийстве. Задайте это значение дольше ожидаемого времени очистки для процесса. Значение по умолчанию — 90 секунд. int

DeploymentSettingsAddonConfigs

Имя Описание Ценность
{настраиваемое свойство}

ApmReference

Имя Описание Ценность
resourceId Идентификатор ресурса APM строка (обязательно)

ContainerProbeSettings

Имя Описание Ценность
disableProbe Указывает, отключает ли проба активности и готовности bool

DeploymentSettingsEnvironmentVariables

Имя Описание Ценность
{настраиваемое свойство} струна

Зонд

Имя Описание Ценность
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 (обязательно)
путь Путь к доступу на HTTP-сервере. струна
схема Схема, используемая для подключения к узлу. По умолчанию используется протокол HTTP.

Возможные значения перечисления:
- "HTTP" означает, что используемая схема будет http://
- "HTTPS" означает, что используемая схема будет https://		 "HTTP"
"HTTPS"

TCPSocketAction

Имя Описание Ценность
тип Тип действия, выполняемого для проверки работоспособности. TCPSocketAction (обязательный)

ResourceRequests

Имя Описание Ценность
ЦПУ Обязательный ЦП. 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
обычай Пользовательское правило масштабирования. CustomScaleRule
http Масштабирование на основе HTTP-запросов. HttpScaleRule
имя Имя правила масштабирования струна
протокол tcp Масштабирование на основе tcp-запросов. TcpScaleRule

QueueScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для правила масштабирования очереди. ScaleRuleAuth[]
queueLength Длина очереди. int
queueName Имя очереди. струна

ScaleRuleAuth

Имя Описание Ценность
secretRef Имя секрета экземпляра приложения Azure Spring Apps, из которого необходимо извлечь парам проверки подлинности. струна
triggerParameter Параметр триггера, использующий секрет струна

CustomScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для настраиваемого правила масштабирования. ScaleRuleAuth[]
метаданные Свойства метаданных для описания настраиваемого правила масштабирования. CustomScaleRuleMetadata
тип Тип настраиваемого правила масштабирования
например: azure-servicebus, redis и т. д.
 струна

CustomScaleRuleMetadata

Имя Описание Ценность
{настраиваемое свойство} струна

HttpScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для настраиваемого правила масштабирования. ScaleRuleAuth[]
метаданные Свойства метаданных для описания правила масштабирования HTTP. HttpScaleRuleMetadata

HttpScaleRuleMetadata

Имя Описание Ценность
{настраиваемое свойство} струна

TcpScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для правила масштабирования tcp. ScaleRuleAuth[]
метаданные Свойства метаданных для описания правила масштабирования tcp. TcpScaleRuleMetadata

TcpScaleRuleMetadata

Имя Описание Ценность
{настраиваемое свойство} струна

UserSourceInfo

Имя Описание Ценность
Версия Версия источника струна
тип Установка типа объекта BuildResult
контейнер
Jar
NetCoreZip
источник
войны (обязательно)

BuildResultUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника BuildResult (обязательно)
buildResultId Идентификатор ресурса существующей успешной сборки приводит к тому же экземпляру Spring. струна

CustomContainerUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника Container (обязательный)
customContainer Полезные данные пользовательского контейнера CustomContainer

CustomContainer

Имя Описание Ценность
args Аргументы в точку входа. CMD образа Docker используется, если это не указано. string[]
команда Массив точек входа. Не выполняется в оболочке. Запись образа Docker используется, если это не указано. string[]
containerImage Образ контейнера пользовательского контейнера. Это должно быть в виде {репозитория}:{tag} без имени сервера реестра. струна
imageRegistryCredential Учетные данные реестра образов ImageRegistryCredential
languageFramework Языковая платформа отправленного образа контейнера. Поддерживаемые значения: Springboot, "", null. струна
сервер Имя реестра, содержащего образ контейнера струна

ImageRegistryCredential

Имя Описание Ценность
пароль Пароль учетных данных реестра образов струна
имя пользователя Имя пользователя учетных данных реестра образов струна

JarUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника Jar (обязательно)
jvmOptions Параметр JVM струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия jar-файла среды выполнения струна

NetCoreZipUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника NetCoreZip (обязательно)
netCoreMainEntryPath Путь к исполняемому файлу .NET относительно корневого zip-файла струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия среды выполнения файла .Net струна

SourceUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника Source (обязательный)
artifactSelector Селектор для артефакта, который будет использоваться для развертывания для проектов с несколькими модулями. Это должно быть
относительный путь к целевому модулю или проекту.		 струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия исходного файла среды выполнения струна

WarUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника "Война" (обязательно)
jvmOptions Параметр JVM струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия war file в среде выполнения струна
serverVersion Версия сервера, в настоящее время поддерживается только Apache Tomcat струна

Sku

Имя Описание Ценность
способность Текущая емкость целевого ресурса int
имя Имя SKU струна
ярус Уровень SKU струна

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Развертывание простого приложения микрослужбы Azure Spring Apps

развертывание в Azure		 Этот шаблон развертывает простое приложение микрослужбы Azure Spring Apps для запуска в Azure.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса Spring/apps/deployments можно развернуть с помощью операций, предназначенных для следующих целей:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.AppPlatform/Spring/apps/deployments, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/apps/deployments@2023-11-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      active = bool
      deploymentSettings = {
        addonConfigs = {}
        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"
    }
  })
}

Объекты ProbeAction

Задайте свойство типа , чтобы указать тип объекта.

Для ExecActionиспользуйте:

  type = "ExecAction"
  command = [
    "string"
  ]

Для HTTPGetActionиспользуйте:

  type = "HTTPGetAction"
  path = "string"
  scheme = "string"

Для TCPSocketActionиспользуйте:

  type = "TCPSocketAction"

Объекты UserSourceInfo

Задайте свойство типа , чтобы указать тип объекта.

Для 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"

Для войныиспользуйте:

  type = "War"
  jvmOptions = "string"
  relativePath = "string"
  runtimeVersion = "string"
  serverVersion = "string"

Значения свойств

Spring/apps/deployments

Имя Описание Ценность
тип Тип ресурса "Microsoft.AppPlatform/Spring/apps/deployments@2023-11-01-preview"
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: приложения
SKU Sku ресурса развертывания Sku
свойства Свойства ресурса развертывания DeploymentResourceProperties

DeploymentResourceProperties

Имя Описание Ценность
активный Указывает, активна ли развертывание bool
deploymentSettings Параметры развертывания развертывания DeploymentSettings
источник Отправлены исходные сведения о развертывании. UserSourceInfo

DeploymentSettings

Имя Описание Ценность
addonConfigs Коллекция надстроек DeploymentSettingsAddonConfigs
apms Коллекция ApmReferences ApmReference[]
containerProbeSettings Параметры проверки активности и готовности контейнера ContainerProbeSettings
environmentVariables Коллекция переменных среды 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 будут устарели позже. ResourceRequests
шкала Масштабирование свойств для экземпляра приложения Azure Spring Apps. масштабирование
startupProbe StartupProbe указывает, что экземпляр приложения успешно инициализирован. Если задано, другие пробы не выполняются до тех пор, пока это не завершится успешно. Если эта проба завершается ошибкой, модуль Pod будет перезапущен так же, как если бы livenessProbe произошел сбой. Это можно использовать для предоставления различных параметров пробы в начале жизненного цикла экземпляра приложения, когда может потребоваться много времени для загрузки данных или теплого кэша, чем во время операции с устойчивым состоянием. Это невозможно обновить. Дополнительные сведения: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes пробы
terminationGracePeriodSeconds Необязательный период в секундах экземпляр приложения должен завершиться корректно. Может быть уменьшено в запросе на удаление. Значение должно быть неотрицательно целым числом. Нулевое значение указывает, что немедленно останавливается через сигнал убийства (нет возможности завершить работу). Если это значение равно nil, вместо этого будет использоваться льготный период по умолчанию. Льготный период — это длительность в секундах после того, как процессы, выполняемые в экземпляре приложения, отправляются сигнал о завершении и время принудительного прекращения процессов с помощью сигнала об убийстве. Задайте это значение дольше ожидаемого времени очистки для процесса. Значение по умолчанию — 90 секунд. int

DeploymentSettingsAddonConfigs

Имя Описание Ценность
{настраиваемое свойство}

ApmReference

Имя Описание Ценность
resourceId Идентификатор ресурса APM строка (обязательно)

ContainerProbeSettings

Имя Описание Ценность
disableProbe Указывает, отключает ли проба активности и готовности bool

DeploymentSettingsEnvironmentVariables

Имя Описание Ценность
{настраиваемое свойство} струна

Зонд

Имя Описание Ценность
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" (обязательно)
путь Путь к доступу на HTTP-сервере. струна
схема Схема, используемая для подключения к узлу. По умолчанию используется протокол HTTP.

Возможные значения перечисления:
- "HTTP" означает, что используемая схема будет http://
- "HTTPS" означает, что используемая схема будет https://		 "HTTP"
"HTTPS"

TCPSocketAction

Имя Описание Ценность
тип Тип действия, выполняемого для проверки работоспособности. "TCPSocketAction" (обязательно)

ResourceRequests

Имя Описание Ценность
ЦПУ Обязательный ЦП. 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
обычай Пользовательское правило масштабирования. CustomScaleRule
http Масштабирование на основе HTTP-запросов. HttpScaleRule
имя Имя правила масштабирования струна
протокол tcp Масштабирование на основе tcp-запросов. TcpScaleRule

QueueScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для правила масштабирования очереди. ScaleRuleAuth[]
queueLength Длина очереди. int
queueName Имя очереди. струна

ScaleRuleAuth

Имя Описание Ценность
secretRef Имя секрета экземпляра приложения Azure Spring Apps, из которого необходимо извлечь парам проверки подлинности. струна
triggerParameter Параметр триггера, использующий секрет струна

CustomScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для настраиваемого правила масштабирования. ScaleRuleAuth[]
метаданные Свойства метаданных для описания настраиваемого правила масштабирования. CustomScaleRuleMetadata
тип Тип настраиваемого правила масштабирования
например: azure-servicebus, redis и т. д.
 струна

CustomScaleRuleMetadata

Имя Описание Ценность
{настраиваемое свойство} струна

HttpScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для настраиваемого правила масштабирования. ScaleRuleAuth[]
метаданные Свойства метаданных для описания правила масштабирования HTTP. HttpScaleRuleMetadata

HttpScaleRuleMetadata

Имя Описание Ценность
{настраиваемое свойство} струна

TcpScaleRule

Имя Описание Ценность
auth Секреты проверки подлинности для правила масштабирования tcp. ScaleRuleAuth[]
метаданные Свойства метаданных для описания правила масштабирования tcp. TcpScaleRuleMetadata

TcpScaleRuleMetadata

Имя Описание Ценность
{настраиваемое свойство} струна

UserSourceInfo

Имя Описание Ценность
Версия Версия источника струна
тип Установка типа объекта BuildResult
контейнер
Jar
NetCoreZip
источник
войны (обязательно)

BuildResultUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника BuildResult (обязательно)
buildResultId Идентификатор ресурса существующей успешной сборки приводит к тому же экземпляру Spring. струна

CustomContainerUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника "Контейнер" (обязательно)
customContainer Полезные данные пользовательского контейнера CustomContainer

CustomContainer

Имя Описание Ценность
args Аргументы в точку входа. CMD образа Docker используется, если это не указано. string[]
команда Массив точек входа. Не выполняется в оболочке. Запись образа Docker используется, если это не указано. string[]
containerImage Образ контейнера пользовательского контейнера. Это должно быть в виде {репозитория}:{tag} без имени сервера реестра. струна
imageRegistryCredential Учетные данные реестра образов ImageRegistryCredential
languageFramework Языковая платформа отправленного образа контейнера. Поддерживаемые значения: Springboot, "", null. струна
сервер Имя реестра, содержащего образ контейнера струна

ImageRegistryCredential

Имя Описание Ценность
пароль Пароль учетных данных реестра образов струна
имя пользователя Имя пользователя учетных данных реестра образов струна

JarUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника Jar (обязательно)
jvmOptions Параметр JVM струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия jar-файла среды выполнения струна

NetCoreZipUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника NetCoreZip (обязательно)
netCoreMainEntryPath Путь к исполняемому файлу .NET относительно корневого zip-файла струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия среды выполнения файла .Net струна

SourceUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника Source (обязательно)
artifactSelector Селектор для артефакта, который будет использоваться для развертывания для проектов с несколькими модулями. Это должно быть
относительный путь к целевому модулю или проекту.		 струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия исходного файла среды выполнения струна

WarUploadedUserSourceInfo

Имя Описание Ценность
тип Тип отправленного источника "Война" (обязательно)
jvmOptions Параметр JVM струна
relativePath Относительный путь к хранилищу, в котором хранится источник струна
runtimeVersion Версия war file в среде выполнения струна
serverVersion Версия сервера, в настоящее время поддерживается только Apache Tomcat струна

Sku

Имя Описание Ценность
способность Текущая емкость целевого ресурса int
имя Имя SKU струна
ярус Уровень SKU струна