你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.AppPlatform Spring/apps/deployments 2022-01-01-preview

• 最新
• 2024-05-01-preview
• 2024-01-01-preview
• 2023-12-01
• 2023-11-01-preview
• 2023-09-01-preview
• 2023-07-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2023-01-01-preview
• 2022-12-01
• 2022-11-01-preview
• 2022-09-01-preview
• 2022-05-01-preview
• 2022-04-01
• 2022-03-01-preview
• 2022-01-01-preview
• 2021-09-01-preview
• 2021-06-01-preview
• 2020-11-01-preview
• 2020-07-01

Bicep 资源定义

可以使用目标操作部署 Spring/apps/deployments 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.AppPlatform/Spring/apps/deployments 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.AppPlatform/Spring/apps/deployments@2022-01-01-preview' = {
  name: 'string'
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    active: bool
    deploymentSettings: {
      addonConfigs: {
        {customized property}: {
          {customized property}: any()
        }
      }
      containerProbeSettings: {
        disableProbe: bool
      }
      environmentVariables: {
        {customized property}: 'string'
      }
      resourceRequests: {
        cpu: 'string'
        memory: 'string'
      }
    }
    source: {
      version: 'string'
      type: 'string'
      // For remaining properties, see UserSourceInfo objects
    }
  }
}

UserSourceInfo 对象

设置 类型 属性以指定对象的类型。

对于 BuildResult，请使用：

  type: 'BuildResult'
  buildResultId: 'string'

对于 容器，请使用：

  type: 'Container'
  customContainer: {
    args: [
      'string'
    ]
    command: [
      'string'
    ]
    containerImage: 'string'
    imageRegistryCredential: {
      password: 'string'
      username: '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

名字	描述	价值
名字	资源名称 了解如何在 Bicep中设置子资源的名称和类型。	string （必需）
sku	部署资源的 SKU	Sku
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：应用
性能	部署资源的属性	DeploymentResourceProperties

DeploymentResourceProperties

名字	描述	价值
积极	指示部署是否处于活动状态	bool
deploymentSettings	部署的部署设置	DeploymentSettings
源	已上传部署的源信息。	UserSourceInfo

DeploymentSettings

名字	描述	价值
addonConfigs	加载项集合	DeploymentSettingsAddonConfigs
containerProbeSettings	容器生存度和就绪情况探测设置	ContainerProbeSettings
environmentVariables	环境变量集合	DeploymentSettingsEnvironmentVariables
resourceRequests	所需的 CPU 和内存的请求资源数量。 建议使用此字段来表示所需的 CPU 和内存，稍后将弃用旧字段 CPU 和 memoryInGB。	ResourceRequests

DeploymentSettingsAddonConfigs

名字	描述	价值
{自定义属性}		AddonProfile

AddonProfile

名字	描述	价值
{自定义属性}		对于 Bicep，可以使用 any（） 函数。

ContainerProbeSettings

名字	描述	价值
disableProbe	指示是否禁用实时性和就绪情况探测	bool

DeploymentSettingsEnvironmentVariables

名字	描述	价值
{自定义属性}		字符串

ResourceRequests

名字	描述	价值
中央处理器	所需的 CPU。 1 核可以表示 1 或 1000 米。 对于基本层，这应为 500 米或 1，标准层应为 {500m、1、2、3、 4} 。	字符串
记忆	所需的内存。 1 GB 可以由 1Gi 或 1024Mi 表示。 对于基本层，这应该是 {512Mi、1Gi、2Gi} 和标准层的 {512Mi、1Gi、2Gi、...、8Gi}。	字符串

UserSourceInfo

名字	描述	价值
版本	源的版本	字符串
类型	设置对象类型	BuildResult 容器 Jar NetCoreZip 源（必需）

BuildResultUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“BuildResult”（必需）
buildResultId	同一 Spring 实例下现有成功生成结果的资源 ID。	字符串

CustomContainerUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“Container”（必需）
customContainer	自定义容器有效负载	CustomContainer

CustomContainer

名字	描述	价值
args	入口点的参数。 如果未提供 docker 映像的 CMD，则使用此 CMD。	string[]
命令	入口点数组。 未在 shell 中执行。 如果未提供 Docker 映像的 ENTRYPOINT，则使用此条目。	string[]
containerImage	自定义容器的容器映像。 这应采用 {repository}：{tag} 的形式，没有注册表的服务器名称	字符串
imageRegistryCredential	映像注册表的凭据	ImageRegistryCredential
服务器	包含容器映像的注册表的名称	字符串

ImageRegistryCredential

名字	描述	价值
密码	映像注册表凭据的密码	字符串
username	映像注册表凭据的用户名	字符串

JarUploadedUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“Jar”（必需）
jvmOptions	JVM 参数	字符串
relativePath	存储源的存储的相对路径	字符串
runtimeVersion	Jar 文件的运行时版本	字符串

NetCoreZipUploadedUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“NetCoreZip”（必需）
netCoreMainEntryPath	相对于 zip 根目录的 .NET 可执行文件的路径	字符串
relativePath	存储源的存储的相对路径	字符串
runtimeVersion	.Net 文件的运行时版本	字符串

SourceUploadedUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“Source”（必需）
artifactSelector	要用于多模块项目的部署的项目的选择器。 这应该是 目标模块/项目的相对路径。	字符串
relativePath	存储源的存储的相对路径	字符串
runtimeVersion	源文件的运行时版本	字符串

Sku

名字	描述	价值
能力	目标资源的当前容量	int
名字	Sku 的名称	字符串
层	Sku 的层	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
部署简单的 Azure Spring Apps 微服务应用程序	此模板部署一个简单的 Azure Spring Apps 微服务应用程序，以在 Azure 上运行。

ARM 模板资源定义

可以使用目标操作部署 Spring/apps/deployments 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.AppPlatform/Spring/apps/deployments 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.AppPlatform/Spring/apps/deployments",
  "apiVersion": "2022-01-01-preview",
  "name": "string",
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "active": "bool",
    "deploymentSettings": {
      "addonConfigs": {
        "{customized property}": {
          "{customized property}": {}
        }
      },
      "containerProbeSettings": {
        "disableProbe": "bool"
      },
      "environmentVariables": {
        "{customized property}": "string"
      },
      "resourceRequests": {
        "cpu": "string",
        "memory": "string"
      }
    },
    "source": {
      "version": "string",
      "type": "string"
      // For remaining properties, see UserSourceInfo objects
    }
  }
}

UserSourceInfo 对象

设置 类型 属性以指定对象的类型。

对于 BuildResult，请使用：

  "type": "BuildResult",
  "buildResultId": "string"

对于 容器，请使用：

  "type": "Container",
  "customContainer": {
    "args": [ "string" ],
    "command": [ "string" ],
    "containerImage": "string",
    "imageRegistryCredential": {
      "password": "string",
      "username": "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”
apiVersion	资源 API 版本	'2022-01-01-preview'
名字	资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。	string （必需）
sku	部署资源的 SKU	Sku
性能	部署资源的属性	DeploymentResourceProperties

DeploymentResourceProperties

名字	描述	价值
积极	指示部署是否处于活动状态	bool
deploymentSettings	部署的部署设置	DeploymentSettings
源	已上传部署的源信息。	UserSourceInfo

DeploymentSettings

名字	描述	价值
addonConfigs	加载项集合	DeploymentSettingsAddonConfigs
containerProbeSettings	容器生存度和就绪情况探测设置	ContainerProbeSettings
environmentVariables	环境变量集合	DeploymentSettingsEnvironmentVariables
resourceRequests	所需的 CPU 和内存的请求资源数量。 建议使用此字段来表示所需的 CPU 和内存，稍后将弃用旧字段 CPU 和 memoryInGB。	ResourceRequests

DeploymentSettingsAddonConfigs

名字	描述	价值
{自定义属性}		AddonProfile

AddonProfile

名字	描述	价值
{自定义属性}

ContainerProbeSettings

名字	描述	价值
disableProbe	指示是否禁用实时性和就绪情况探测	bool

DeploymentSettingsEnvironmentVariables

名字	描述	价值
{自定义属性}		字符串

ResourceRequests

名字	描述	价值
中央处理器	所需的 CPU。 1 核可以表示 1 或 1000 米。 对于基本层，这应为 500 米或 1，标准层应为 {500m、1、2、3、 4} 。	字符串
记忆	所需的内存。 1 GB 可以由 1Gi 或 1024Mi 表示。 对于基本层，这应该是 {512Mi、1Gi、2Gi} 和标准层的 {512Mi、1Gi、2Gi、...、8Gi}。	字符串

UserSourceInfo

名字	描述	价值
版本	源的版本	字符串
类型	设置对象类型	BuildResult 容器 Jar NetCoreZip 源（必需）

BuildResultUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“BuildResult”（必需）
buildResultId	同一 Spring 实例下现有成功生成结果的资源 ID。	字符串

CustomContainerUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“Container”（必需）
customContainer	自定义容器有效负载	CustomContainer

CustomContainer

名字	描述	价值
args	入口点的参数。 如果未提供 docker 映像的 CMD，则使用此 CMD。	string[]
命令	入口点数组。 未在 shell 中执行。 如果未提供 Docker 映像的 ENTRYPOINT，则使用此条目。	string[]
containerImage	自定义容器的容器映像。 这应采用 {repository}：{tag} 的形式，没有注册表的服务器名称	字符串
imageRegistryCredential	映像注册表的凭据	ImageRegistryCredential
服务器	包含容器映像的注册表的名称	字符串

ImageRegistryCredential

名字	描述	价值
密码	映像注册表凭据的密码	字符串
username	映像注册表凭据的用户名	字符串

JarUploadedUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“Jar”（必需）
jvmOptions	JVM 参数	字符串
relativePath	存储源的存储的相对路径	字符串
runtimeVersion	Jar 文件的运行时版本	字符串

NetCoreZipUploadedUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“NetCoreZip”（必需）
netCoreMainEntryPath	相对于 zip 根目录的 .NET 可执行文件的路径	字符串
relativePath	存储源的存储的相对路径	字符串
runtimeVersion	.Net 文件的运行时版本	字符串

SourceUploadedUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“Source”（必需）
artifactSelector	要用于多模块项目的部署的项目的选择器。 这应该是 目标模块/项目的相对路径。	字符串
relativePath	存储源的存储的相对路径	字符串
runtimeVersion	源文件的运行时版本	字符串

Sku

名字	描述	价值
能力	目标资源的当前容量	int
名字	Sku 的名称	字符串
层	Sku 的层	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
部署简单的 Azure Spring Apps 微服务应用程序	此模板部署一个简单的 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@2022-01-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      active = bool
      deploymentSettings = {
        addonConfigs = {
          {customized property} = {}
        }
        containerProbeSettings = {
          disableProbe = bool
        }
        environmentVariables = {
          {customized property} = "string"
        }
        resourceRequests = {
          cpu = "string"
          memory = "string"
        }
      }
      source = {
        version = "string"
        type = "string"
        // For remaining properties, see UserSourceInfo objects
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

UserSourceInfo 对象

设置 类型 属性以指定对象的类型。

对于 BuildResult，请使用：

  type = "BuildResult"
  buildResultId = "string"

对于 容器，请使用：

  type = "Container"
  customContainer = {
    args = [
      "string"
    ]
    command = [
      "string"
    ]
    containerImage = "string"
    imageRegistryCredential = {
      password = "string"
      username = "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@2022-01-01-preview”
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：应用
sku	部署资源的 SKU	Sku
性能	部署资源的属性	DeploymentResourceProperties

DeploymentResourceProperties

名字	描述	价值
积极	指示部署是否处于活动状态	bool
deploymentSettings	部署的部署设置	DeploymentSettings
源	已上传部署的源信息。	UserSourceInfo

DeploymentSettings

名字	描述	价值
addonConfigs	加载项集合	DeploymentSettingsAddonConfigs
containerProbeSettings	容器生存度和就绪情况探测设置	ContainerProbeSettings
environmentVariables	环境变量集合	DeploymentSettingsEnvironmentVariables
resourceRequests	所需的 CPU 和内存的请求资源数量。 建议使用此字段来表示所需的 CPU 和内存，稍后将弃用旧字段 CPU 和 memoryInGB。	ResourceRequests

DeploymentSettingsAddonConfigs

名字	描述	价值
{自定义属性}		AddonProfile

AddonProfile

名字	描述	价值
{自定义属性}

ContainerProbeSettings

名字	描述	价值
disableProbe	指示是否禁用实时性和就绪情况探测	bool

DeploymentSettingsEnvironmentVariables

名字	描述	价值
{自定义属性}		字符串

ResourceRequests

名字	描述	价值
中央处理器	所需的 CPU。 1 核可以表示 1 或 1000 米。 对于基本层，这应为 500 米或 1，标准层应为 {500m、1、2、3、 4} 。	字符串
记忆	所需的内存。 1 GB 可以由 1Gi 或 1024Mi 表示。 对于基本层，这应该是 {512Mi、1Gi、2Gi} 和标准层的 {512Mi、1Gi、2Gi、...、8Gi}。	字符串

UserSourceInfo

名字	描述	价值
版本	源的版本	字符串
类型	设置对象类型	BuildResult 容器 Jar NetCoreZip 源（必需）

BuildResultUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“BuildResult”（必需）
buildResultId	同一 Spring 实例下现有成功生成结果的资源 ID。	字符串

CustomContainerUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“容器”（必需）
customContainer	自定义容器有效负载	CustomContainer

CustomContainer

名字	描述	价值
args	入口点的参数。 如果未提供 docker 映像的 CMD，则使用此 CMD。	string[]
命令	入口点数组。 未在 shell 中执行。 如果未提供 Docker 映像的 ENTRYPOINT，则使用此条目。	string[]
containerImage	自定义容器的容器映像。 这应采用 {repository}：{tag} 的形式，没有注册表的服务器名称	字符串
imageRegistryCredential	映像注册表的凭据	ImageRegistryCredential
服务器	包含容器映像的注册表的名称	字符串

ImageRegistryCredential

名字	描述	价值
密码	映像注册表凭据的密码	字符串
username	映像注册表凭据的用户名	字符串

JarUploadedUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“Jar”（必需）
jvmOptions	JVM 参数	字符串
relativePath	存储源的存储的相对路径	字符串
runtimeVersion	Jar 文件的运行时版本	字符串

NetCoreZipUploadedUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“NetCoreZip”（必需）
netCoreMainEntryPath	相对于 zip 根目录的 .NET 可执行文件的路径	字符串
relativePath	存储源的存储的相对路径	字符串
runtimeVersion	.Net 文件的运行时版本	字符串

SourceUploadedUserSourceInfo

名字	描述	价值
类型	上传的源的类型	“源”（必需）
artifactSelector	要用于多模块项目的部署的项目的选择器。 这应该是 目标模块/项目的相对路径。	字符串
relativePath	存储源的存储的相对路径	字符串
runtimeVersion	源文件的运行时版本	字符串

Sku

名字	描述	价值
能力	目标资源的当前容量	int
名字	Sku 的名称	字符串
层	Sku 的层	字符串