你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.AppPlatform Spring/apps 2023-11-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 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.AppPlatform/Spring/apps 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.AppPlatform/Spring/apps@2023-11-01-preview' = {
name: 'string'
location: 'string'
parent: resourceSymbolicName
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
addonConfigs: {
{customized property}: any()
}
customPersistentDisks: [
{
customPersistentDiskProperties: {
enableSubPath: bool
mountOptions: [
'string'
]
mountPath: 'string'
readOnly: bool
type: 'string'
// For remaining properties, see CustomPersistentDiskProperties objects
}
storageId: 'string'
}
]
enableEndToEndTLS: bool
httpsOnly: bool
ingressSettings: {
backendProtocol: 'string'
clientAuth: {
certificates: [
'string'
]
}
readTimeoutInSeconds: int
sendTimeoutInSeconds: int
sessionAffinity: 'string'
sessionCookieMaxAge: int
}
loadedCertificates: [
{
loadTrustStore: bool
resourceId: 'string'
}
]
persistentDisk: {
mountPath: 'string'
sizeInGB: int
}
public: bool
secrets: [
{
name: 'string'
value: 'string'
}
]
temporaryDisk: {
mountPath: 'string'
sizeInGB: int
}
vnetAddons: {
publicEndpoint: bool
}
workloadProfileName: 'string'
}
}
CustomPersistentDiskProperties 对象
设置 类型 属性以指定对象的类型。
对于 AzureFileVolume，请使用：
type: 'AzureFileVolume'
shareName: 'string'
属性值
Spring/apps
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 了解如何在 Bicep中设置子资源的名称和类型。 |
string （必需） |
| 位置 | 应用程序的 GEO 位置，与其父资源始终相同 | 字符串 |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：Spring |
| 身份 | 应用资源的托管标识类型 | ManagedIdentityProperties |
| 性能 | 应用资源的属性 | AppResourceProperties |
ManagedIdentityProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| principalId | 系统分配的托管标识的主体 ID。 | 字符串 |
| tenantId | 系统分配的托管标识的租户 ID。 | 字符串 |
| 类型 | 托管标识的类型 | “None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| userAssignedIdentities | 用户分配的托管标识的属性 | UserAssignedManagedIdentities |
UserAssignedManagedIdentities
| 名字 | 描述 | 价值 |
|---|---|---|
| {自定义属性} | UserAssignedManagedIdentity |
UserAssignedManagedIdentity
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
AppResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| addonConfigs | 加载项集合 | AppResourcePropertiesAddonConfigs |
| customPersistentDisks | 自定义永久性磁盘列表 | CustomPersistentDiskResource[] |
| enableEndToEndTLS | 指示是否启用了端到端 TLS。 | bool |
| httpsOnly | 指示是否只允许 https。 | bool |
| ingressSettings | 应用入口设置有效负载。 | IngressSettings |
| loadedCertificates | 已加载证书的集合 | LoadedCertificate[] |
| persistentDisk | 永久性磁盘设置 | PersistentDisk |
| 公共 | 指示应用是否公开公共终结点 | bool |
| 秘密 | 身份验证机密的集合 | 机密[] |
| temporaryDisk | 临时磁盘设置 | TemporaryDisk |
| vnetAddons | vnet 注入实例中的其他应用设置 | AppVNetAddons |
| workloadProfileName | 用于此应用的工作负荷配置文件。 支持消耗 + 专用计划。 | 字符串 |
AppResourcePropertiesAddonConfigs
| 名字 | 描述 | 价值 |
|---|---|---|
| {自定义属性} | 对于 Bicep，可以使用 any（） 函数。 |
CustomPersistentDiskResource
| 名字 | 描述 | 价值 |
|---|---|---|
| customPersistentDiskProperties | 自定义永久性磁盘资源有效负载的属性。 | CustomPersistentDiskProperties |
| storageId | Azure Spring Apps 存储资源的资源 ID。 | string （必需） |
CustomPersistentDiskProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| enableSubPath | 如果设置为 true，它将为每个单独的应用实例创建并装载专用目录。 | bool |
| mountOptions | 这些是永久性磁盘的装载选项。 | string[] |
| mountPath | 永久性磁盘的装载路径。 | string （必需） |
| readOnly | 指示永久性磁盘是否为 readOnly 磁盘。 | bool |
| 类型 | 设置对象类型 | AzureFileVolume （必需） |
AzureFileVolume
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 要作为永久性磁盘装载的基础资源的类型。 | “AzureFileVolume”（必需） |
| shareName | Azure 文件共享的共享名称。 | 字符串 |
IngressSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| backendProtocol | 入口应如何与此应用后端服务通信。 | “Default” “GRPC” |
| clientAuth | Client-Certification 身份验证。 | IngressSettingsClientAuth |
| readTimeoutInSeconds | 入口读取超时（以秒为单位）。 | int |
| sendTimeoutInSeconds | 入口发送超时（以秒为单位）。 | int |
| sessionAffinity | 相关性的类型，将此项设置为 Cookie 以启用会话相关性。 | “Cookie” “None” |
| sessionCookieMaxAge | Cookie 过期前的时间（以秒为单位）。 | int |
IngressSettingsClientAuth
| 名字 | 描述 | 价值 |
|---|---|---|
| 证书 | 证书资源 ID 的集合。 | string[] |
LoadedCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| loadTrustStore | 指示证书是否将加载到默认信任存储中，仅适用于 Java 运行时。 | bool |
| resourceId | 已加载证书的资源 ID | string （必需） |
PersistentDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| mountPath | 永久性磁盘的装载路径 | 字符串 |
| sizeInGB | 永久性磁盘的大小（以 GB 为单位） | int 约束： 最小值 = 0 最大值 = 50 |
秘密
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 机密名称。 | 字符串 |
| 价值 | 机密值。 | 字符串 约束： 敏感值。 以安全参数的形式传入。 |
TemporaryDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| mountPath | 临时磁盘的装载路径 | 字符串 |
| sizeInGB | 临时磁盘的大小（以 GB 为单位） | int 约束： 最小值 = 0 最大值 = 5 |
AppVNetAddons
| 名字 | 描述 | 价值 |
|---|---|---|
| publicEndpoint | 指示 vnet 注入实例中的应用是否公开可从 Internet 访问的终结点。 | bool |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
部署简单的 Azure Spring Apps 微服务应用程序
|
此模板部署一个简单的 Azure Spring Apps 微服务应用程序，以在 Azure 上运行。 |
ARM 模板资源定义
可以使用目标操作部署 Spring/apps 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.AppPlatform/Spring/apps 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.AppPlatform/Spring/apps",
"apiVersion": "2023-11-01-preview",
"name": "string",
"location": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"addonConfigs": {
"{customized property}": {}
},
"customPersistentDisks": [
{
"customPersistentDiskProperties": {
"enableSubPath": "bool",
"mountOptions": [ "string" ],
"mountPath": "string",
"readOnly": "bool",
"type": "string"
// For remaining properties, see CustomPersistentDiskProperties objects
},
"storageId": "string"
}
],
"enableEndToEndTLS": "bool",
"httpsOnly": "bool",
"ingressSettings": {
"backendProtocol": "string",
"clientAuth": {
"certificates": [ "string" ]
},
"readTimeoutInSeconds": "int",
"sendTimeoutInSeconds": "int",
"sessionAffinity": "string",
"sessionCookieMaxAge": "int"
},
"loadedCertificates": [
{
"loadTrustStore": "bool",
"resourceId": "string"
}
],
"persistentDisk": {
"mountPath": "string",
"sizeInGB": "int"
},
"public": "bool",
"secrets": [
{
"name": "string",
"value": "string"
}
],
"temporaryDisk": {
"mountPath": "string",
"sizeInGB": "int"
},
"vnetAddons": {
"publicEndpoint": "bool"
},
"workloadProfileName": "string"
}
}
CustomPersistentDiskProperties 对象
设置 类型 属性以指定对象的类型。
对于 AzureFileVolume，请使用：
"type": "AzureFileVolume",
"shareName": "string"
属性值
Spring/apps
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 资源类型 | “Microsoft.AppPlatform/Spring/apps” |
| apiVersion | 资源 API 版本 | '2023-11-01-preview' |
| 名字 | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
string （必需） |
| 位置 | 应用程序的 GEO 位置，与其父资源始终相同 | 字符串 |
| 身份 | 应用资源的托管标识类型 | ManagedIdentityProperties |
| 性能 | 应用资源的属性 | AppResourceProperties |
ManagedIdentityProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| principalId | 系统分配的托管标识的主体 ID。 | 字符串 |
| tenantId | 系统分配的托管标识的租户 ID。 | 字符串 |
| 类型 | 托管标识的类型 | “None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| userAssignedIdentities | 用户分配的托管标识的属性 | UserAssignedManagedIdentities |
UserAssignedManagedIdentities
| 名字 | 描述 | 价值 |
|---|---|---|
| {自定义属性} | UserAssignedManagedIdentity |
UserAssignedManagedIdentity
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
AppResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| addonConfigs | 加载项集合 | AppResourcePropertiesAddonConfigs |
| customPersistentDisks | 自定义永久性磁盘列表 | CustomPersistentDiskResource[] |
| enableEndToEndTLS | 指示是否启用了端到端 TLS。 | bool |
| httpsOnly | 指示是否只允许 https。 | bool |
| ingressSettings | 应用入口设置有效负载。 | IngressSettings |
| loadedCertificates | 已加载证书的集合 | LoadedCertificate[] |
| persistentDisk | 永久性磁盘设置 | PersistentDisk |
| 公共 | 指示应用是否公开公共终结点 | bool |
| 秘密 | 身份验证机密的集合 | 机密[] |
| temporaryDisk | 临时磁盘设置 | TemporaryDisk |
| vnetAddons | vnet 注入实例中的其他应用设置 | AppVNetAddons |
| workloadProfileName | 用于此应用的工作负荷配置文件。 支持消耗 + 专用计划。 | 字符串 |
AppResourcePropertiesAddonConfigs
| 名字 | 描述 | 价值 |
|---|---|---|
| {自定义属性} |
CustomPersistentDiskResource
| 名字 | 描述 | 价值 |
|---|---|---|
| customPersistentDiskProperties | 自定义永久性磁盘资源有效负载的属性。 | CustomPersistentDiskProperties |
| storageId | Azure Spring Apps 存储资源的资源 ID。 | string （必需） |
CustomPersistentDiskProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| enableSubPath | 如果设置为 true，它将为每个单独的应用实例创建并装载专用目录。 | bool |
| mountOptions | 这些是永久性磁盘的装载选项。 | string[] |
| mountPath | 永久性磁盘的装载路径。 | string （必需） |
| readOnly | 指示永久性磁盘是否为 readOnly 磁盘。 | bool |
| 类型 | 设置对象类型 | AzureFileVolume （必需） |
AzureFileVolume
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 要作为永久性磁盘装载的基础资源的类型。 | “AzureFileVolume”（必需） |
| shareName | Azure 文件共享的共享名称。 | 字符串 |
IngressSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| backendProtocol | 入口应如何与此应用后端服务通信。 | “Default” “GRPC” |
| clientAuth | Client-Certification 身份验证。 | IngressSettingsClientAuth |
| readTimeoutInSeconds | 入口读取超时（以秒为单位）。 | int |
| sendTimeoutInSeconds | 入口发送超时（以秒为单位）。 | int |
| sessionAffinity | 相关性的类型，将此项设置为 Cookie 以启用会话相关性。 | “Cookie” “None” |
| sessionCookieMaxAge | Cookie 过期前的时间（以秒为单位）。 | int |
IngressSettingsClientAuth
| 名字 | 描述 | 价值 |
|---|---|---|
| 证书 | 证书资源 ID 的集合。 | string[] |
LoadedCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| loadTrustStore | 指示证书是否将加载到默认信任存储中，仅适用于 Java 运行时。 | bool |
| resourceId | 已加载证书的资源 ID | string （必需） |
PersistentDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| mountPath | 永久性磁盘的装载路径 | 字符串 |
| sizeInGB | 永久性磁盘的大小（以 GB 为单位） | int 约束： 最小值 = 0 最大值 = 50 |
秘密
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 机密名称。 | 字符串 |
| 价值 | 机密值。 | 字符串 约束： 敏感值。 以安全参数的形式传入。 |
TemporaryDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| mountPath | 临时磁盘的装载路径 | 字符串 |
| sizeInGB | 临时磁盘的大小（以 GB 为单位） | int 约束： 最小值 = 0 最大值 = 5 |
AppVNetAddons
| 名字 | 描述 | 价值 |
|---|---|---|
| publicEndpoint | 指示 vnet 注入实例中的应用是否公开可从 Internet 访问的终结点。 | bool |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
|
部署简单的 Azure Spring Apps 微服务应用程序
|
此模板部署一个简单的 Azure Spring Apps 微服务应用程序，以在 Azure 上运行。 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 Spring/apps 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.AppPlatform/Spring/apps 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/apps@2023-11-01-preview"
name = "string"
location = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
addonConfigs = {}
customPersistentDisks = [
{
customPersistentDiskProperties = {
enableSubPath = bool
mountOptions = [
"string"
]
mountPath = "string"
readOnly = bool
type = "string"
// For remaining properties, see CustomPersistentDiskProperties objects
}
storageId = "string"
}
]
enableEndToEndTLS = bool
httpsOnly = bool
ingressSettings = {
backendProtocol = "string"
clientAuth = {
certificates = [
"string"
]
}
readTimeoutInSeconds = int
sendTimeoutInSeconds = int
sessionAffinity = "string"
sessionCookieMaxAge = int
}
loadedCertificates = [
{
loadTrustStore = bool
resourceId = "string"
}
]
persistentDisk = {
mountPath = "string"
sizeInGB = int
}
public = bool
secrets = [
{
name = "string"
value = "string"
}
]
temporaryDisk = {
mountPath = "string"
sizeInGB = int
}
vnetAddons = {
publicEndpoint = bool
}
workloadProfileName = "string"
}
})
}
CustomPersistentDiskProperties 对象
设置 类型 属性以指定对象的类型。
对于 AzureFileVolume，请使用：
type = "AzureFileVolume"
shareName = "string"
属性值
Spring/apps
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 资源类型 | “Microsoft.AppPlatform/Spring/apps@2023-11-01-preview” |
| 名字 | 资源名称 | string （必需） |
| 位置 | 应用程序的 GEO 位置，与其父资源始终相同 | 字符串 |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：Spring |
| 身份 | 应用资源的托管标识类型 | ManagedIdentityProperties |
| 性能 | 应用资源的属性 | AppResourceProperties |
ManagedIdentityProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 托管标识的类型 | “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| identity_ids | 用户分配的托管标识的属性 | 用户标识 ID 的数组。 |
UserAssignedManagedIdentities
| 名字 | 描述 | 价值 |
|---|---|---|
| {自定义属性} | UserAssignedManagedIdentity |
UserAssignedManagedIdentity
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
AppResourceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| addonConfigs | 加载项集合 | AppResourcePropertiesAddonConfigs |
| customPersistentDisks | 自定义永久性磁盘列表 | CustomPersistentDiskResource[] |
| enableEndToEndTLS | 指示是否启用了端到端 TLS。 | bool |
| httpsOnly | 指示是否只允许 https。 | bool |
| ingressSettings | 应用入口设置有效负载。 | IngressSettings |
| loadedCertificates | 已加载证书的集合 | LoadedCertificate[] |
| persistentDisk | 永久性磁盘设置 | PersistentDisk |
| 公共 | 指示应用是否公开公共终结点 | bool |
| 秘密 | 身份验证机密的集合 | 机密[] |
| temporaryDisk | 临时磁盘设置 | TemporaryDisk |
| vnetAddons | vnet 注入实例中的其他应用设置 | AppVNetAddons |
| workloadProfileName | 用于此应用的工作负荷配置文件。 支持消耗 + 专用计划。 | 字符串 |
AppResourcePropertiesAddonConfigs
| 名字 | 描述 | 价值 |
|---|---|---|
| {自定义属性} |
CustomPersistentDiskResource
| 名字 | 描述 | 价值 |
|---|---|---|
| customPersistentDiskProperties | 自定义永久性磁盘资源有效负载的属性。 | CustomPersistentDiskProperties |
| storageId | Azure Spring Apps 存储资源的资源 ID。 | string （必需） |
CustomPersistentDiskProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| enableSubPath | 如果设置为 true，它将为每个单独的应用实例创建并装载专用目录。 | bool |
| mountOptions | 这些是永久性磁盘的装载选项。 | string[] |
| mountPath | 永久性磁盘的装载路径。 | string （必需） |
| readOnly | 指示永久性磁盘是否为 readOnly 磁盘。 | bool |
| 类型 | 设置对象类型 | AzureFileVolume （必需） |
AzureFileVolume
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 要作为永久性磁盘装载的基础资源的类型。 | “AzureFileVolume”（必需） |
| shareName | Azure 文件共享的共享名称。 | 字符串 |
IngressSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| backendProtocol | 入口应如何与此应用后端服务通信。 | “Default” “GRPC” |
| clientAuth | Client-Certification 身份验证。 | IngressSettingsClientAuth |
| readTimeoutInSeconds | 入口读取超时（以秒为单位）。 | int |
| sendTimeoutInSeconds | 入口发送超时（以秒为单位）。 | int |
| sessionAffinity | 相关性的类型，将此项设置为 Cookie 以启用会话相关性。 | “Cookie” “None” |
| sessionCookieMaxAge | Cookie 过期前的时间（以秒为单位）。 | int |
IngressSettingsClientAuth
| 名字 | 描述 | 价值 |
|---|---|---|
| 证书 | 证书资源 ID 的集合。 | string[] |
LoadedCertificate
| 名字 | 描述 | 价值 |
|---|---|---|
| loadTrustStore | 指示证书是否将加载到默认信任存储中，仅适用于 Java 运行时。 | bool |
| resourceId | 已加载证书的资源 ID | string （必需） |
PersistentDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| mountPath | 永久性磁盘的装载路径 | 字符串 |
| sizeInGB | 永久性磁盘的大小（以 GB 为单位） | int 约束： 最小值 = 0 最大值 = 50 |
秘密
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 机密名称。 | 字符串 |
| 价值 | 机密值。 | 字符串 约束： 敏感值。 以安全参数的形式传入。 |
TemporaryDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| mountPath | 临时磁盘的装载路径 | 字符串 |
| sizeInGB | 临时磁盘的大小（以 GB 为单位） | int 约束： 最小值 = 0 最大值 = 5 |
AppVNetAddons
| 名字 | 描述 | 价值 |
|---|---|---|
| publicEndpoint | 指示 vnet 注入实例中的应用是否公开可从 Internet 访问的终结点。 | bool |