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 パラメーター

名前	/	必須	型	説明
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	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
properties.publishingProfile	True	GalleryScriptVersionPublishingProfile	ギャラリーイメージバージョンの発行プロファイル。
properties.safetyProfile		GalleryScriptVersionSafetyProfile	ギャラリースクリプト版の安全性プロファイル。
tags		object	リソースタグ

応答

名前	型	説明
200 OK	GalleryScriptVersion	Azure 操作は正常に完了しました。
202 Accepted		リソース更新要求は受け入れ済み。ヘッダー Azure-AsyncOperation: string Location: string Retry-After: integer
Other Status Codes	CloudError	予期しないエラー応答。

名前

型

説明

200 OK

GalleryScriptVersion

Azure 操作は正常に完了しました。

202 Accepted

リソース更新要求は受け入れ済み。

ヘッダー

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

Other Status Codes

CloudError

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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

定義

名前	説明
AdditionalReplicaSet	追加のレプリカセット情報について説明します。
AggregatedReplicationState	これは、すべてのリージョン・レプリケーション・ステータス・フラグに基づく集計されたレプリケーション・ステータスです。
ApiError	API エラー。
ApiErrorBase	API エラーベース。
CloudError	コンピュート・サービスからのエラー・レスポンス。
ConfidentialVMEncryptionType	機密性の高い VM 暗号化の種類
createdByType	リソースを作成した ID の種類。
DataDiskImageEncryption	データディスクイメージの暗号化設定が含まれます。
EdgeZoneStorageAccountType	イメージの格納に使用するストレージアカウントの種類を指定します。このプロパティは更新できません。
EncryptionImages	Optional. ユーザーは、ギャラリー成果物内の OS ディスクとデータディスクを暗号化するためのカスタマーマネージドキーを提供できます。
GalleryExtendedLocation	拡張された場所の名前。
GalleryExtendedLocationType	これは拡張された場所の型です。
GalleryProvisioningState	プロビジョニング状態。応答にのみ表示されます。
GalleryScriptParameter	ギャラリースクリプトバージョンのスクリプトに渡せるパラメータの定義。
GalleryScriptParameterType	ギャラリースクリプトパラメータの種類を指定します。可能な値は、文字列、直数、ダブル、ブール、エノムです
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

追加のレプリカセット情報について説明します。

名前	型	説明
regionalReplicaCount	integer (int32)	作成するイメージバージョンのダイレクトドライブレプリカの数。このプロパティは更新可能です
storageAccountType	StorageAccountType	ダイレクトドライブレプリカの作成に使用するストレージアカウントの種類を指定します

AggregatedReplicationState

列挙

これは、すべてのリージョン・レプリケーション・ステータス・フラグに基づく集計されたレプリケーション・ステータスです。

値	説明
Unknown
InProgress
Completed
Failed

ApiError

Object

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api 内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

Object

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

CloudError

Object

コンピュート・サービスからのエラー・レスポンス。

名前	型	説明
error	ApiError	API エラー。

ConfidentialVMEncryptionType

列挙

機密性の高い VM 暗号化の種類

値	説明
EncryptedVMGuestStateOnlyWithPmk
EncryptedWithPmk
EncryptedWithCmk
NonPersistedTPM

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DataDiskImageEncryption

Object

データディスクイメージの暗号化設定が含まれます。

名前	型	説明
diskEncryptionSetId	string	ディスク暗号化セットのリソース ID を含む相対 URI。
lun	integer (int32)	このプロパティは、データディスクの論理ユニット番号を指定します。この値は、仮想マシン内のデータディスクを識別するために使用されるため、仮想マシンに接続されているデータディスクごとに一意である必要があります。

EdgeZoneStorageAccountType

列挙

イメージの格納に使用するストレージアカウントの種類を指定します。このプロパティは更新できません。

値	説明
Standard_LRS
Standard_ZRS
StandardSSD_LRS
Premium_LRS

EncryptionImages

Object

Optional. ユーザーは、ギャラリー成果物内の OS ディスクとデータディスクを暗号化するためのカスタマーマネージドキーを提供できます。

名前	型	説明
dataDiskImages	DataDiskImageEncryption[]	データディスクイメージの暗号化仕様の一覧。
osDiskImage	OSDiskImageEncryption	OS ディスクイメージの暗号化設定が含まれています。

GalleryExtendedLocation

Object

拡張された場所の名前。

名前	型	説明
name	string
type	GalleryExtendedLocationType	これは拡張された場所の型です。

GalleryExtendedLocationType

列挙

これは拡張された場所の型です。

値	説明
EdgeZone
Unknown

GalleryProvisioningState

列挙

プロビジョニング状態。応答にのみ表示されます。

値	説明
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GalleryScriptParameter

Object

ギャラリースクリプトバージョンのスクリプトに渡せるパラメータの定義。

名前	型	説明
defaultValue	string	パラメータのデフォルト値は文字列型にのみ適用されます。
description	string	ユーザーがこのパラメーターの意味を理解するのに役立つ説明
enumValues	string[]	許容される価値のリスト。該当する値のみが「GalleryScriptParameter」で定義された「enum」の値から選ばれます。
maxValue	string	パラメータの最小値。
minValue	string	パラメータの最小値。
name	string	パラメーターの名前。
required	boolean	このパラメータをパスさせる必要があるかどうかを示します。
type	GalleryScriptParameterType	ギャラリースクリプトパラメータの種類を指定します。可能な値は、文字列、直数、ダブル、ブール、エノムです

GalleryScriptParameterType

列挙

ギャラリースクリプトパラメータの種類を指定します。可能な値は、文字列、直数、ダブル、ブール、エノムです

値	説明
String	文字列ギャラリースクリプトパラメータタイプ
Int	intギャラリースクリプトパラメータタイプ
Double	ダブルギャラリースクリプトパラメータタイプ
Boolean	ブールギャラリースクリプトパラメータタイプ
Enum	Enumギャラリースクリプトパラメータタイプ