Microsoft.Compute 資源庫/應用程式/2022-03-03 版
Bicep 資源定義
資源庫/應用程式/版本資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 Microsoft.Compute/galleries/applications/versions 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Compute/galleries/applications/versions@2022-03-03' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
publishingProfile: {
advancedSettings: {
{customized property}: 'string'
}
customActions: [
{
description: 'string'
name: 'string'
parameters: [
{
defaultValue: 'string'
description: 'string'
name: 'string'
required: bool
type: 'string'
}
]
script: 'string'
}
]
enableHealthCheck: bool
endOfLifeDate: 'string'
excludeFromLatest: bool
manageActions: {
install: 'string'
remove: 'string'
update: 'string'
}
replicaCount: int
replicationMode: 'string'
settings: {
configFileName: 'string'
packageFileName: 'string'
}
source: {
defaultConfigurationLink: 'string'
mediaLink: 'string'
}
storageAccountType: 'string'
targetExtendedLocations: [
{
encryption: {
dataDiskImages: [
{
diskEncryptionSetId: 'string'
lun: int
}
]
osDiskImage: {
diskEncryptionSetId: 'string'
securityProfile: {
confidentialVMEncryptionType: 'string'
secureVMDiskEncryptionSetId: 'string'
}
}
}
extendedLocation: {
name: 'string'
type: 'string'
}
extendedLocationReplicaCount: int
name: 'string'
storageAccountType: 'string'
}
]
targetRegions: [
{
encryption: {
dataDiskImages: [
{
diskEncryptionSetId: 'string'
lun: int
}
]
osDiskImage: {
diskEncryptionSetId: 'string'
securityProfile: {
confidentialVMEncryptionType: 'string'
secureVMDiskEncryptionSetId: 'string'
}
}
}
excludeFromLatest: bool
name: 'string'
regionalReplicaCount: int
storageAccountType: 'string'
}
]
}
safetyProfile: {
allowDeletionOfReplicatedLocations: bool
}
}
tags: {
{customized property}: 'string'
}
}
屬性值
DataDiskImageEncryption
名字 |
描述 |
價值 |
diskEncryptionSetId |
包含磁碟加密集資源標識碼的相對URI。 |
字串 |
倫 |
這個屬性會指定數據磁碟的邏輯單位編號。 此值是用來識別虛擬機內的數據磁碟,因此對於連結至虛擬機的每個數據磁碟而言都必須是唯一的。 |
int (必要) |
EncryptionImages
GalleryApplicationCustomAction
GalleryApplicationCustomActionParameter
名字 |
描述 |
價值 |
defaultValue |
參數的預設值。 僅適用於字串類型 |
字串 |
描述 |
說明,可協助使用者瞭解此參數的意義 |
字串 |
名字 |
自定義動作的名稱。 資源庫應用程式版本內必須是唯一的。 |
字串 (必要) |
必填 |
指出在執行自定義動作時,是否必須傳遞此參數。 |
bool |
類型 |
指定自訂動作參數的類型。 可能的值為:String、ConfigurationDataBlob 或 LogOutputBlob |
'ConfigurationDataBlob' 'LogOutputBlob' 'String' |
GalleryApplicationVersionProperties
GalleryApplicationVersionPublishingProfile
GalleryApplicationVersionPublishingProfileAdvancedSettings
GalleryApplicationVersionSafetyProfile
名字 |
描述 |
價值 |
allowDeletionOfReplicatedLocations |
指出是否允許從復寫區域移除此資源庫映像版本。 |
bool |
GalleryExtendedLocation
名字 |
描述 |
價值 |
名字 |
|
字串 |
類型 |
它是擴充位置的類型。 |
'EdgeZone' 'Unknown' |
GalleryTargetExtendedLocation
名字 |
描述 |
價值 |
加密 |
自選。 允許使用者提供客戶管理的金鑰,以加密資源庫成品中的 OS 和數據磁碟。 |
EncryptionImages |
extendedLocation |
擴充位置的名稱。 |
GalleryExtendedLocation |
extendedLocationReplicaCount |
每個擴充位置要建立之映像版本的複本數目。 這個屬性是可更新的。 |
int |
名字 |
區域的名稱。 |
字串 |
storageAccountType |
指定要用來儲存映像的記憶體帳戶類型。 這個屬性無法更新。 |
'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'Standard_ZRS' |
Microsoft.Compute/galleries/applications/versions
OSDiskImageEncryption
OSDiskImageSecurityProfile
名字 |
描述 |
價值 |
confidentialVMEncryptionType |
機密 VM 加密類型 |
'EncryptedVMGuestStateOnlyWithPmk' 'EncryptedWithCmk' 'EncryptedWithPmk' |
secureVMDiskEncryptionSetId |
安全的 VM 磁碟加密集標識符 |
字串 |
TargetRegion
名字 |
描述 |
價值 |
加密 |
自選。 允許使用者提供客戶管理的金鑰,以加密資源庫成品中的 OS 和數據磁碟。 |
EncryptionImages |
excludeFromLatest |
包含當使用者指定 version='latest' 時隱藏映射的旗標設定 |
bool |
名字 |
區域的名稱。 |
字串 (必要) |
regionalReplicaCount |
要為每個區域建立之映像版本的複本數目。 這個屬性是可更新的。 |
int |
storageAccountType |
指定要用來儲存映像的記憶體帳戶類型。 這個屬性無法更新。 |
'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
UserArtifactManage
名字 |
描述 |
價值 |
安裝 |
必填。 安裝資源庫應用程式的路徑和自變數。 這限制為 4096 個字元。 |
字串 (必要) |
刪除 |
必填。 要移除資源庫應用程式的路徑和自變數。 這限制為 4096 個字元。 |
字串 (必要) |
更新 |
自選。 更新資源庫應用程式的路徑和自變數。 如果沒有,則更新作業將會在舊版上叫用 remove 命令,並在資源庫應用程式的目前版本上安裝命令。 這限制為 4096 個字元。 |
字串 |
UserArtifactSettings
名字 |
描述 |
價值 |
configFileName |
自選。 要指派 VM 上下載組態檔的名稱。 這限制為 4096 個字元。 如果未指定,組態檔將會命名為附加 「_config」 的資源庫應用程式名稱。 |
字串 |
packageFileName |
自選。 要指派 VM 上下載套件檔案的名稱。 這限制為 4096 個字元。 如果未指定,封裝檔案的名稱會與資源庫應用程式名稱相同。 |
字串 |
UserArtifactSource
名字 |
描述 |
價值 |
defaultConfigurationLink |
自選。 成品的 defaultConfigurationLink 必須是可讀取的記憶體分頁 Blob。 |
字串 |
mediaLink |
必填。 成品的 mediaLink 必須是可讀取的記憶體分頁 Blob。 |
字串 (必要) |
ARM 樣本資源定義
資源庫/應用程式/版本資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 Microsoft.Compute/galleries/applications/versions 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.Compute/galleries/applications/versions",
"apiVersion": "2022-03-03",
"name": "string",
"location": "string",
"properties": {
"publishingProfile": {
"advancedSettings": {
"{customized property}": "string"
},
"customActions": [
{
"description": "string",
"name": "string",
"parameters": [
{
"defaultValue": "string",
"description": "string",
"name": "string",
"required": "bool",
"type": "string"
}
],
"script": "string"
}
],
"enableHealthCheck": "bool",
"endOfLifeDate": "string",
"excludeFromLatest": "bool",
"manageActions": {
"install": "string",
"remove": "string",
"update": "string"
},
"replicaCount": "int",
"replicationMode": "string",
"settings": {
"configFileName": "string",
"packageFileName": "string"
},
"source": {
"defaultConfigurationLink": "string",
"mediaLink": "string"
},
"storageAccountType": "string",
"targetExtendedLocations": [
{
"encryption": {
"dataDiskImages": [
{
"diskEncryptionSetId": "string",
"lun": "int"
}
],
"osDiskImage": {
"diskEncryptionSetId": "string",
"securityProfile": {
"confidentialVMEncryptionType": "string",
"secureVMDiskEncryptionSetId": "string"
}
}
},
"extendedLocation": {
"name": "string",
"type": "string"
},
"extendedLocationReplicaCount": "int",
"name": "string",
"storageAccountType": "string"
}
],
"targetRegions": [
{
"encryption": {
"dataDiskImages": [
{
"diskEncryptionSetId": "string",
"lun": "int"
}
],
"osDiskImage": {
"diskEncryptionSetId": "string",
"securityProfile": {
"confidentialVMEncryptionType": "string",
"secureVMDiskEncryptionSetId": "string"
}
}
},
"excludeFromLatest": "bool",
"name": "string",
"regionalReplicaCount": "int",
"storageAccountType": "string"
}
]
},
"safetyProfile": {
"allowDeletionOfReplicatedLocations": "bool"
}
},
"tags": {
"{customized property}": "string"
}
}
屬性值
DataDiskImageEncryption
名字 |
描述 |
價值 |
diskEncryptionSetId |
包含磁碟加密集資源標識碼的相對URI。 |
字串 |
倫 |
這個屬性會指定數據磁碟的邏輯單位編號。 此值是用來識別虛擬機內的數據磁碟,因此對於連結至虛擬機的每個數據磁碟而言都必須是唯一的。 |
int (必要) |
EncryptionImages
GalleryApplicationCustomAction
GalleryApplicationCustomActionParameter
名字 |
描述 |
價值 |
defaultValue |
參數的預設值。 僅適用於字串類型 |
字串 |
描述 |
說明,可協助使用者瞭解此參數的意義 |
字串 |
名字 |
自定義動作的名稱。 資源庫應用程式版本內必須是唯一的。 |
字串 (必要) |
必填 |
指出在執行自定義動作時,是否必須傳遞此參數。 |
bool |
類型 |
指定自訂動作參數的類型。 可能的值為:String、ConfigurationDataBlob 或 LogOutputBlob |
'ConfigurationDataBlob' 'LogOutputBlob' 'String' |
GalleryApplicationVersionProperties
GalleryApplicationVersionPublishingProfile
GalleryApplicationVersionPublishingProfileAdvancedSettings
GalleryApplicationVersionSafetyProfile
名字 |
描述 |
價值 |
allowDeletionOfReplicatedLocations |
指出是否允許從復寫區域移除此資源庫映像版本。 |
bool |
GalleryExtendedLocation
名字 |
描述 |
價值 |
名字 |
|
字串 |
類型 |
它是擴充位置的類型。 |
'EdgeZone' 'Unknown' |
GalleryTargetExtendedLocation
名字 |
描述 |
價值 |
加密 |
自選。 允許使用者提供客戶管理的金鑰,以加密資源庫成品中的 OS 和數據磁碟。 |
EncryptionImages |
extendedLocation |
擴充位置的名稱。 |
GalleryExtendedLocation |
extendedLocationReplicaCount |
每個擴充位置要建立之映像版本的複本數目。 這個屬性是可更新的。 |
int |
名字 |
區域的名稱。 |
字串 |
storageAccountType |
指定要用來儲存映像的記憶體帳戶類型。 這個屬性無法更新。 |
'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'Standard_ZRS' |
Microsoft.Compute/galleries/applications/versions
名字 |
描述 |
價值 |
apiVersion |
API 版本 |
'2022-03-03' |
位置 |
資源位置 |
字串 (必要) |
名字 |
資源名稱 |
字串 (必要) |
性能 |
描述資源庫映像版本的屬性。 |
GalleryApplicationVersionProperties |
標籤 |
資源標籤 |
標記名稱和值的字典。 請參閱範本中的 標籤 |
類型 |
資源類型 |
'Microsoft.Compute/galleries/applications/versions' |
OSDiskImageEncryption
OSDiskImageSecurityProfile
名字 |
描述 |
價值 |
confidentialVMEncryptionType |
機密 VM 加密類型 |
'EncryptedVMGuestStateOnlyWithPmk' 'EncryptedWithCmk' 'EncryptedWithPmk' |
secureVMDiskEncryptionSetId |
安全的 VM 磁碟加密集標識符 |
字串 |
TargetRegion
名字 |
描述 |
價值 |
加密 |
自選。 允許使用者提供客戶管理的金鑰,以加密資源庫成品中的 OS 和數據磁碟。 |
EncryptionImages |
excludeFromLatest |
包含當使用者指定 version='latest' 時隱藏映射的旗標設定 |
bool |
名字 |
區域的名稱。 |
字串 (必要) |
regionalReplicaCount |
要為每個區域建立之映像版本的複本數目。 這個屬性是可更新的。 |
int |
storageAccountType |
指定要用來儲存映像的記憶體帳戶類型。 這個屬性無法更新。 |
'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
UserArtifactManage
名字 |
描述 |
價值 |
安裝 |
必填。 安裝資源庫應用程式的路徑和自變數。 這限制為 4096 個字元。 |
字串 (必要) |
刪除 |
必填。 要移除資源庫應用程式的路徑和自變數。 這限制為 4096 個字元。 |
字串 (必要) |
更新 |
自選。 更新資源庫應用程式的路徑和自變數。 如果沒有,則更新作業將會在舊版上叫用 remove 命令,並在資源庫應用程式的目前版本上安裝命令。 這限制為 4096 個字元。 |
字串 |
UserArtifactSettings
名字 |
描述 |
價值 |
configFileName |
自選。 要指派 VM 上下載組態檔的名稱。 這限制為 4096 個字元。 如果未指定,組態檔將會命名為附加 「_config」 的資源庫應用程式名稱。 |
字串 |
packageFileName |
自選。 要指派 VM 上下載套件檔案的名稱。 這限制為 4096 個字元。 如果未指定,封裝檔案的名稱會與資源庫應用程式名稱相同。 |
字串 |
UserArtifactSource
名字 |
描述 |
價值 |
defaultConfigurationLink |
自選。 成品的 defaultConfigurationLink 必須是可讀取的記憶體分頁 Blob。 |
字串 |
mediaLink |
必填。 成品的 mediaLink 必須是可讀取的記憶體分頁 Blob。 |
字串 (必要) |
資源庫/應用程式/版本資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 Microsoft.Compute/galleries/applications/versions 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/galleries/applications/versions@2022-03-03"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
publishingProfile = {
advancedSettings = {
{customized property} = "string"
}
customActions = [
{
description = "string"
name = "string"
parameters = [
{
defaultValue = "string"
description = "string"
name = "string"
required = bool
type = "string"
}
]
script = "string"
}
]
enableHealthCheck = bool
endOfLifeDate = "string"
excludeFromLatest = bool
manageActions = {
install = "string"
remove = "string"
update = "string"
}
replicaCount = int
replicationMode = "string"
settings = {
configFileName = "string"
packageFileName = "string"
}
source = {
defaultConfigurationLink = "string"
mediaLink = "string"
}
storageAccountType = "string"
targetExtendedLocations = [
{
encryption = {
dataDiskImages = [
{
diskEncryptionSetId = "string"
lun = int
}
]
osDiskImage = {
diskEncryptionSetId = "string"
securityProfile = {
confidentialVMEncryptionType = "string"
secureVMDiskEncryptionSetId = "string"
}
}
}
extendedLocation = {
name = "string"
type = "string"
}
extendedLocationReplicaCount = int
name = "string"
storageAccountType = "string"
}
]
targetRegions = [
{
encryption = {
dataDiskImages = [
{
diskEncryptionSetId = "string"
lun = int
}
]
osDiskImage = {
diskEncryptionSetId = "string"
securityProfile = {
confidentialVMEncryptionType = "string"
secureVMDiskEncryptionSetId = "string"
}
}
}
excludeFromLatest = bool
name = "string"
regionalReplicaCount = int
storageAccountType = "string"
}
]
}
safetyProfile = {
allowDeletionOfReplicatedLocations = bool
}
}
})
}
屬性值
DataDiskImageEncryption
名字 |
描述 |
價值 |
diskEncryptionSetId |
包含磁碟加密集資源標識碼的相對URI。 |
字串 |
倫 |
這個屬性會指定數據磁碟的邏輯單位編號。 此值是用來識別虛擬機內的數據磁碟,因此對於連結至虛擬機的每個數據磁碟而言都必須是唯一的。 |
int (必要) |
EncryptionImages
GalleryApplicationCustomAction
GalleryApplicationCustomActionParameter
名字 |
描述 |
價值 |
defaultValue |
參數的預設值。 僅適用於字串類型 |
字串 |
描述 |
說明,可協助使用者瞭解此參數的意義 |
字串 |
名字 |
自定義動作的名稱。 資源庫應用程式版本內必須是唯一的。 |
字串 (必要) |
必填 |
指出在執行自定義動作時,是否必須傳遞此參數。 |
bool |
類型 |
指定自訂動作參數的類型。 可能的值為:String、ConfigurationDataBlob 或 LogOutputBlob |
'ConfigurationDataBlob' 'LogOutputBlob' 'String' |
GalleryApplicationVersionProperties
GalleryApplicationVersionPublishingProfile
GalleryApplicationVersionPublishingProfileAdvancedSettings
GalleryApplicationVersionSafetyProfile
名字 |
描述 |
價值 |
allowDeletionOfReplicatedLocations |
指出是否允許從復寫區域移除此資源庫映像版本。 |
bool |
GalleryExtendedLocation
名字 |
描述 |
價值 |
名字 |
|
字串 |
類型 |
它是擴充位置的類型。 |
'EdgeZone' 'Unknown' |
GalleryTargetExtendedLocation
名字 |
描述 |
價值 |
加密 |
自選。 允許使用者提供客戶管理的金鑰,以加密資源庫成品中的 OS 和數據磁碟。 |
EncryptionImages |
extendedLocation |
擴充位置的名稱。 |
GalleryExtendedLocation |
extendedLocationReplicaCount |
每個擴充位置要建立之映像版本的複本數目。 這個屬性是可更新的。 |
int |
名字 |
區域的名稱。 |
字串 |
storageAccountType |
指定要用來儲存映像的記憶體帳戶類型。 這個屬性無法更新。 |
'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'Standard_ZRS' |
Microsoft.Compute/galleries/applications/versions
名字 |
描述 |
價值 |
位置 |
資源位置 |
字串 (必要) |
名字 |
資源名稱 |
字串 (必要) |
parent_id |
此資源為父系之資源的標識碼。 |
類型資源的標識碼:資源庫/應用程式 |
性能 |
描述資源庫映像版本的屬性。 |
GalleryApplicationVersionProperties |
標籤 |
資源標籤 |
標記名稱和值的字典。 |
類型 |
資源類型 |
“Microsoft.Compute/galleries/applications/versions@2022-03-03” |
OSDiskImageEncryption
OSDiskImageSecurityProfile
名字 |
描述 |
價值 |
confidentialVMEncryptionType |
機密 VM 加密類型 |
'EncryptedVMGuestStateOnlyWithPmk' 'EncryptedWithCmk' 'EncryptedWithPmk' |
secureVMDiskEncryptionSetId |
安全的 VM 磁碟加密集標識符 |
字串 |
TargetRegion
名字 |
描述 |
價值 |
加密 |
自選。 允許使用者提供客戶管理的金鑰,以加密資源庫成品中的 OS 和數據磁碟。 |
EncryptionImages |
excludeFromLatest |
包含當使用者指定 version='latest' 時隱藏映射的旗標設定 |
bool |
名字 |
區域的名稱。 |
字串 (必要) |
regionalReplicaCount |
要為每個區域建立之映像版本的複本數目。 這個屬性是可更新的。 |
int |
storageAccountType |
指定要用來儲存映像的記憶體帳戶類型。 這個屬性無法更新。 |
'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
UserArtifactManage
名字 |
描述 |
價值 |
安裝 |
必填。 安裝資源庫應用程式的路徑和自變數。 這限制為 4096 個字元。 |
字串 (必要) |
刪除 |
必填。 要移除資源庫應用程式的路徑和自變數。 這限制為 4096 個字元。 |
字串 (必要) |
更新 |
自選。 更新資源庫應用程式的路徑和自變數。 如果沒有,則更新作業將會在舊版上叫用 remove 命令,並在資源庫應用程式的目前版本上安裝命令。 這限制為 4096 個字元。 |
字串 |
UserArtifactSettings
名字 |
描述 |
價值 |
configFileName |
自選。 要指派 VM 上下載組態檔的名稱。 這限制為 4096 個字元。 如果未指定,組態檔將會命名為附加 「_config」 的資源庫應用程式名稱。 |
字串 |
packageFileName |
自選。 要指派 VM 上下載套件檔案的名稱。 這限制為 4096 個字元。 如果未指定,封裝檔案的名稱會與資源庫應用程式名稱相同。 |
字串 |
UserArtifactSource
名字 |
描述 |
價值 |
defaultConfigurationLink |
自選。 成品的 defaultConfigurationLink 必須是可讀取的記憶體分頁 Blob。 |
字串 |
mediaLink |
必填。 成品的 mediaLink 必須是可讀取的記憶體分頁 Blob。 |
字串 (必要) |