Gallery Script Versions - Update

服務:: Compute

API 版本:: 2025-03-03

更新畫廊腳本版本。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/scripts/{galleryScriptName}/versions/{galleryScriptVersionName}?api-version=2025-03-03

URI 參數

名稱	位於	必要	類型	Description
galleryName	path	True	string pattern: ^[^_\W][\w-._]{0,79}(?	共用映像庫的名稱。
galleryScriptName	path	True	string pattern: ^[a-zA-Z0-9]+([_]?[a-zA-Z0-9]+)*$	畫廊名稱腳本定義待檢索。
galleryScriptVersionName	path	True	string pattern: ^[0-9]+\.[0-9]+\.[0-9]+$	畫廊名稱劇本版本待檢索。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
properties.publishingProfile	True	GalleryScriptVersionPublishingProfile	資源庫映像版本的發行配置檔。
properties.safetyProfile		GalleryScriptVersionSafetyProfile	畫廊腳本版本的安全規格。
tags		object	資源標籤

回應

名稱	類型	Description
200 OK	GalleryScriptVersion	Azure 作業已順利完成。
202 Accepted		已接受資源更新要求。標題 Azure-AsyncOperation: string Location: string Retry-After: integer
Other Status Codes	CloudError	未預期的錯誤回應。

名稱

類型

Description

200 OK

GalleryScriptVersion

Azure 作業已順利完成。

202 Accepted

已接受資源更新要求。

標題

Azure-AsyncOperation: string
Location: string
Retry-After: integer

Other Status Codes

CloudError

未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Update a simple gallery Script Version.

範例要求

HTTP

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/galleries/myGalleryName/scripts/myGalleryScriptName/versions/1.0.0?api-version=2025-03-03

{
  "properties": {
    "publishingProfile": {
      "source": {
        "scriptLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/myScript.ps1?{sasKey}",
        "parameters": [
          {
            "name": "location",
            "required": true,
            "defaultValue": "westus",
            "type": "String"
          },
          {
            "name": "myGalleryScriptParameter1",
            "required": true,
            "type": "String",
            "defaultValue": "default value of parameter",
            "description": "description of the parameter"
          },
          {
            "name": "myGalleryScriptParameter2",
            "required": false,
            "type": "String",
            "defaultValue": "default value of parameter",
            "description": "description of the parameter"
          },
          {
            "name": "numberOfUnits",
            "required": true,
            "type": "Int",
            "defaultValue": "3",
            "description": "description of the parameter",
            "minValue": "1",
            "maxValue": "5"
          },
          {
            "name": "weightOfUnit",
            "required": true,
            "type": "Double",
            "defaultValue": "0.6",
            "description": "description of the parameter",
            "minValue": "0.1",
            "maxValue": "2"
          },
          {
            "name": "typeOfProduct",
            "required": false,
            "type": "Enum",
            "defaultValue": "Fruit",
            "description": "description of the parameter",
            "enumValues": [
              "Fruit",
              "Vegetable",
              "Greens",
              "Nuts"
            ]
          }
        ]
      },
      "targetRegions": [
        {
          "name": "West US",
          "regionalReplicaCount": 2,
          "storageAccountType": "Standard_LRS",
          "excludeFromLatest": false
        }
      ],
      "replicaCount": 2,
      "endOfLifeDate": "2027-07-01T07:00:00Z",
      "storageAccountType": "Standard_LRS"
    },
    "safetyProfile": {
      "allowDeletionOfReplicatedLocations": false
    }
  }
}

範例回覆

狀態碼:: 200

{
  "location": "West US",
  "name": "1.0.0",
  "type": "Microsoft.Compute/galleries/scripts/versions",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/galleries/myGalleryName/scripts/myGalleryScriptName/versions/1.0.0",
  "properties": {
    "publishingProfile": {
      "source": {
        "scriptLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/myScript.ps1",
        "parameters": [
          {
            "name": "location",
            "required": true,
            "defaultValue": "westus",
            "type": "String"
          },
          {
            "name": "myGalleryScriptParameter1",
            "required": true,
            "type": "String",
            "defaultValue": "default value of parameter",
            "description": "description of the parameter"
          },
          {
            "name": "myGalleryScriptParameter2",
            "required": false,
            "type": "String",
            "defaultValue": "default value of parameter",
            "description": "description of the parameter"
          },
          {
            "name": "numberOfUnits",
            "required": true,
            "type": "Int",
            "defaultValue": "3",
            "description": "description of the parameter",
            "minValue": "1",
            "maxValue": "5"
          },
          {
            "name": "weightOfUnit",
            "required": true,
            "type": "Double",
            "defaultValue": "0.6",
            "description": "description of the parameter",
            "minValue": "0.1",
            "maxValue": "2"
          },
          {
            "name": "typeOfProduct",
            "required": false,
            "type": "Enum",
            "defaultValue": "Fruit",
            "description": "description of the parameter",
            "enumValues": [
              "Fruit",
              "Vegetable",
              "Greens",
              "Nuts"
            ]
          }
        ]
      },
      "targetRegions": [
        {
          "name": "West US",
          "regionalReplicaCount": 2,
          "storageAccountType": "Standard_LRS",
          "excludeFromLatest": false
        }
      ],
      "replicaCount": 2,
      "excludeFromLatest": false,
      "publishedDate": "2025-06-21T17:13:57.5972568+00:00",
      "endOfLifeDate": "2027-07-01T07:00:00+00:00",
      "storageAccountType": "Standard_LRS"
    },
    "safetyProfile": {
      "allowDeletionOfReplicatedLocations": false
    },
    "provisioningState": "Updating"
  }
}

狀態碼:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2025-03-03
Location: https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2025-03-03

定義

名稱	Description
AdditionalReplicaSet	描述其他副本集資訊。
AggregatedReplicationState	這是根據所有區域復寫狀態旗標的匯總複寫狀態。
ApiError	Api 錯誤。
ApiErrorBase	API 錯誤基底。
CloudError	來自計算服務的錯誤回應。
ConfidentialVMEncryptionType	機密 VM 加密類型
createdByType	建立資源的身分識別類型。
DataDiskImageEncryption	包含數據磁碟映像的加密設定。
EdgeZoneStorageAccountType	指定要用來儲存映像的記憶體帳戶類型。這個屬性無法更新。
EncryptionImages	選擇性。允許使用者提供客戶管理的金鑰，以加密資源庫成品中的 OS 和數據磁碟。
GalleryExtendedLocation	擴充位置的名稱。
GalleryExtendedLocationType	它是擴充位置的類型。
GalleryProvisioningState	只出現在回應中的布建狀態。
GalleryScriptParameter	定義一個參數，可傳遞給畫廊腳本版本的腳本。
GalleryScriptParameterType	指定 Gallery Script 參數的類型。可能的值包括：字串、整數、雙重、布林值、枚舉
GalleryScriptVersion	您可以使用特定屬性類型來建立具象追蹤的資源類型。
GalleryScriptVersionProperties	描述畫廊劇本版本的特性。
GalleryScriptVersionPublishingProfile	資源庫映像版本的發行配置檔。
GalleryScriptVersionSafetyProfile	畫廊腳本版本的安全規格。
GalleryScriptVersionUpdate	指定你想更新的圖庫腳本版本資訊。
GalleryTargetExtendedLocation
InnerError	內部錯誤詳細數據。
OSDiskImageEncryption	包含 OS 磁碟映像的加密設定。
OSDiskImageSecurityProfile	包含 OS 磁碟映像的安全性設定檔。
RegionalReplicationStatus	這是區域復寫狀態。
ReplicationMode	選擇性參數，指定要用於複寫的模式。這個屬性無法更新。
ReplicationState	這是區域復寫狀態。
ReplicationStatus	這是資源庫映像版本的復寫狀態。
ScriptSource	就是用來建立腳本版本的原始腳本。
StorageAccountStrategy	指定選擇儲存帳戶類型時應採用的策略。無法與 storageAccountType 一起指定，但可依區域設定 targetRegions[].storageAccountType 來覆蓋。這個屬性無法更新。
StorageAccountType	指定要用來儲存映像的記憶體帳戶類型。這個屬性無法更新。
systemData	與建立和上次修改資源相關的元數據。
TargetRegion	描述目標區域資訊。

AdditionalReplicaSet

Object

描述其他副本集資訊。

名稱	類型	Description
regionalReplicaCount	integer (int32)	要建立之映像版本的直接磁碟驅動器複本數目。此屬性是可更新的
storageAccountType	StorageAccountType	指定要用來建立直接磁碟驅動器複本的記憶體帳戶類型

AggregatedReplicationState

列舉型別

這是根據所有區域復寫狀態旗標的匯總複寫狀態。

值	Description
Unknown
InProgress
Completed
Failed

ApiError

Object

Api 錯誤。

名稱	類型	Description
code	string	錯誤碼。
details	ApiErrorBase[]	Api 錯誤詳細數據
innererror	InnerError	Api 內部錯誤
message	string	錯誤訊息。
target	string	特定錯誤的目標。

ApiErrorBase

Object

API 錯誤基底。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息。
target	string	特定錯誤的目標。

CloudError

Object

來自計算服務的錯誤回應。

名稱	類型	Description
error	ApiError	Api 錯誤。

ConfidentialVMEncryptionType

列舉型別

機密 VM 加密類型

值	Description
EncryptedVMGuestStateOnlyWithPmk
EncryptedWithPmk
EncryptedWithCmk
NonPersistedTPM

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

DataDiskImageEncryption

Object

包含數據磁碟映像的加密設定。

名稱	類型	Description
diskEncryptionSetId	string	包含磁碟加密集資源標識碼的相對URI。
lun	integer (int32)	這個屬性會指定數據磁碟的邏輯單位編號。此值是用來識別虛擬機內的數據磁碟，因此對於連結至虛擬機的每個數據磁碟而言都必須是唯一的。

EdgeZoneStorageAccountType

列舉型別

指定要用來儲存映像的記憶體帳戶類型。這個屬性無法更新。

值	Description
Standard_LRS
Standard_ZRS
StandardSSD_LRS
Premium_LRS

EncryptionImages

Object

選擇性。允許使用者提供客戶管理的金鑰，以加密資源庫成品中的 OS 和數據磁碟。

名稱	類型	Description
dataDiskImages	DataDiskImageEncryption[]	數據磁碟映像的加密規格清單。
osDiskImage	OSDiskImageEncryption	包含 OS 磁碟映像的加密設定。

GalleryExtendedLocation

Object

擴充位置的名稱。

名稱	類型	Description
name	string
type	GalleryExtendedLocationType	它是擴充位置的類型。

GalleryExtendedLocationType

列舉型別

它是擴充位置的類型。

值	Description
EdgeZone
Unknown

GalleryProvisioningState

列舉型別

只出現在回應中的布建狀態。

值	Description
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GalleryScriptParameter

Object

定義一個參數，可傳遞給畫廊腳本版本的腳本。

名稱	類型	Description
defaultValue	string	參數的預設值只適用於字串類型。
description	string	說明，可協助使用者瞭解此參數的意義
enumValues	string[]	一份允許的數值清單。只有適用的值來自「GalleryScriptParameter」中定義的「enum」值。
maxValue	string	參數的最小值。
minValue	string	參數的最小值。
name	string	參數的名稱。
required	boolean	表示是否必須傳遞此參數。
type	GalleryScriptParameterType	指定 Gallery Script 參數的類型。可能的值包括：字串、整數、雙重、布林值、枚舉

GalleryScriptParameterType

列舉型別

指定 Gallery Script 參數的類型。可能的值包括：字串、整數、雙重、布林值、枚舉

值	Description
String	字串畫廊腳本參數類型
Int	整數畫廊腳本參數類型
Double	雙重畫廊腳本參數類型
Boolean	布林畫廊腳本參數類型
Enum	Enum gallery 腳本參數類型