Sdílet prostřednictvím


Gallery Script Versions - Update

Aktualizujte verzi skriptu galerie.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
galleryName
path True

string

pattern: ^[^_\W][\w-._]{0,79}(?

Název galerie sdílených imagí.

galleryScriptName
path True

string

pattern: ^[a-zA-Z0-9]+([_]?[a-zA-Z0-9]+)*$

Název galerie Definice scénáře bude získána.

galleryScriptVersionName
path True

string

pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Název galerie Script Version bude získán.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

subscriptionId
path True

string

minLength: 1

ID cílového předplatného.

api-version
query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Vyžadováno Typ Description
properties.publishingProfile True

GalleryScriptVersionPublishingProfile

Profil publikování verze image galerie.

properties.safetyProfile

GalleryScriptVersionSafetyProfile

Bezpečnostní profil verze Gallery Script.

tags

object

Štítky prostředků

Odpovědi

Name Typ Description
200 OK

GalleryScriptVersion

Operace Azure byla úspěšně dokončena.

202 Accepted

Žádost o aktualizaci prostředků byla přijata.

Hlavičky

  • Azure-AsyncOperation: string
  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Ukázkový požadavek

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
    }
  }
}

Ukázková odpověď

{
  "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"
  }
}
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

Definice

Name Description
AdditionalReplicaSet

Popisuje další informace o sadě replik.

AggregatedReplicationState

Toto je agregovaný stav replikace na základě všech příznaků stavu regionální replikace.

ApiError

Chyba rozhraní API

ApiErrorBase

Základ chyb rozhraní API.

CloudError

Odpověď na chybu z výpočetní služby

ConfidentialVMEncryptionType

důvěrné typy šifrování virtuálních počítačů

createdByType

Typ identity, která prostředek vytvořila.

DataDiskImageEncryption

Obsahuje nastavení šifrování pro bitovou kopii datového disku.

EdgeZoneStorageAccountType

Určuje typ účtu úložiště, který se má použít k uložení image. Tato vlastnost není aktualizovatelná.

EncryptionImages

Optional. Umožňuje uživatelům poskytnout klíče spravované zákazníkem pro šifrování disků s operačním systémem a datových disků v artefaktu galerie.

GalleryExtendedLocation

Název rozšířeného umístění.

GalleryExtendedLocationType

Jedná se o typ rozšířeného umístění.

GalleryProvisioningState

Stav zřizování, který se zobrazí pouze v odpovědi.

GalleryScriptParameter

Definice parametru, který lze předat skriptu verze Gallery Script.

GalleryScriptParameterType

Specifikuje typ parametru Gallery Script. Možné hodnoty jsou: String, Int, Double, Boolean, Enum

GalleryScriptVersion

Konkrétní sledované typy prostředků lze vytvořit aliasem tohoto typu pomocí konkrétního typu vlastnosti.

GalleryScriptVersionProperties

Popisuje vlastnosti verze galériového skriptu.

GalleryScriptVersionPublishingProfile

Profil publikování verze image galerie.

GalleryScriptVersionSafetyProfile

Bezpečnostní profil verze Gallery Script.

GalleryScriptVersionUpdate

Specifikuje informace o verzi skriptu galerie, kterou chcete aktualizovat.

GalleryTargetExtendedLocation
InnerError

Podrobnosti vnitřní chyby.

OSDiskImageEncryption

Obsahuje nastavení šifrování pro bitovou kopii disku s operačním systémem.

OSDiskImageSecurityProfile

Obsahuje profil zabezpečení pro image disku s operačním systémem.

RegionalReplicationStatus

Toto je stav regionální replikace.

ReplicationMode

Volitelný parametr, který určuje režim, který se má použít pro replikaci. Tato vlastnost není aktualizovatelná.

ReplicationState

Toto je stav regionální replikace.

ReplicationStatus

Toto je stav replikace verze image galerie.

ScriptSource

Zdrojový skript, ze kterého bude vytvořena verze skriptu.

StorageAccountStrategy

Specifikuje strategii, která má být použita při výběru typu úložného účtu. Nelze jej specifikovat spolu s storageAccountType, ale lze jej přepsat podle regionů zadáním targetRegions[].storageAccountType. Tato vlastnost není aktualizovatelná.

StorageAccountType

Určuje typ účtu úložiště, který se má použít k uložení image. Tato vlastnost není aktualizovatelná.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

TargetRegion

Popisuje informace o cílové oblasti.

AdditionalReplicaSet

Popisuje další informace o sadě replik.

Name Typ Description
regionalReplicaCount

integer (int32)

Počet replik přímých jednotek verze image, které se mají vytvořit. Tato vlastnost je aktualizovatelná.

storageAccountType

StorageAccountType

Určuje typ účtu úložiště, který se má použít k vytvoření replik přímých jednotek.

AggregatedReplicationState

Toto je agregovaný stav replikace na základě všech příznaků stavu regionální replikace.

Hodnota Description
Unknown
InProgress
Completed
Failed

ApiError

Chyba rozhraní API

Name Typ Description
code

string

Kód chyby.

details

ApiErrorBase[]

Podrobnosti o chybě rozhraní API

innererror

InnerError

Vnitřní chyba rozhraní API

message

string

Chybová zpráva.

target

string

Cíl konkrétní chyby.

ApiErrorBase

Základ chyb rozhraní API.

Name Typ Description
code

string

Kód chyby.

message

string

Chybová zpráva.

target

string

Cíl konkrétní chyby.

CloudError

Odpověď na chybu z výpočetní služby

Name Typ Description
error

ApiError

Chyba rozhraní API

ConfidentialVMEncryptionType

důvěrné typy šifrování virtuálních počítačů

Hodnota Description
EncryptedVMGuestStateOnlyWithPmk
EncryptedWithPmk
EncryptedWithCmk
NonPersistedTPM

createdByType

Typ identity, která prostředek vytvořila.

Hodnota Description
User
Application
ManagedIdentity
Key

DataDiskImageEncryption

Obsahuje nastavení šifrování pro bitovou kopii datového disku.

Name Typ Description
diskEncryptionSetId

string

Relativní identifikátor URI obsahující ID prostředku sady šifrování disku.

lun

integer (int32)

Tato vlastnost určuje číslo logické jednotky datového disku. Tato hodnota se používá k identifikaci datových disků v rámci virtuálního počítače, a proto musí být jedinečná pro každý datový disk připojený k virtuálnímu počítači.

EdgeZoneStorageAccountType

Určuje typ účtu úložiště, který se má použít k uložení image. Tato vlastnost není aktualizovatelná.

Hodnota Description
Standard_LRS
Standard_ZRS
StandardSSD_LRS
Premium_LRS

EncryptionImages

Optional. Umožňuje uživatelům poskytnout klíče spravované zákazníkem pro šifrování disků s operačním systémem a datových disků v artefaktu galerie.

Name Typ Description
dataDiskImages

DataDiskImageEncryption[]

Seznam specifikací šifrování pro bitové kopie datových disků

osDiskImage

OSDiskImageEncryption

Obsahuje nastavení šifrování pro bitovou kopii disku s operačním systémem.

GalleryExtendedLocation

Název rozšířeného umístění.

Name Typ Description
name

string

type

GalleryExtendedLocationType

Jedná se o typ rozšířeného umístění.

GalleryExtendedLocationType

Jedná se o typ rozšířeného umístění.

Hodnota Description
EdgeZone
Unknown

GalleryProvisioningState

Stav zřizování, který se zobrazí pouze v odpovědi.

Hodnota Description
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GalleryScriptParameter

Definice parametru, který lze předat skriptu verze Gallery Script.

Name Typ Description
defaultValue

string

Výchozí hodnota parametru se vztahuje pouze na typy řetězců.

description

string

Popis, který uživatelům pomůže pochopit, co tento parametr znamená

enumValues

string[]

Seznam přípustných hodnot. Použitelné hodnoty jsou pouze z hodnot 'enum' definovaných v 'GalleryScriptParameter'.

maxValue

string

Minimální hodnota parametru.

minValue

string

Minimální hodnota parametru.

name

string

Název parametru.

required

boolean

Označuje, zda je třeba tento parametr předat.

type

GalleryScriptParameterType

Specifikuje typ parametru Gallery Script. Možné hodnoty jsou: String, Int, Double, Boolean, Enum

GalleryScriptParameterType

Specifikuje typ parametru Gallery Script. Možné hodnoty jsou: String, Int, Double, Boolean, Enum

Hodnota Description
String

Typ parametru skriptu v galerii řetězců

Int

Typ parametru skriptu galerie Int

Double

Typ parametru skriptu s dvojitou galerií

Boolean

Typ parametru skriptu Booleovské galerie

Enum

Typ parametru skriptu enum gallery

GalleryScriptVersion

Konkrétní sledované typy prostředků lze vytvořit aliasem tohoto typu pomocí konkrétního typu vlastnosti.

Name Typ Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Geografické umístění, ve kterém se nachází zdroj

name

string

Název prostředku

properties

GalleryScriptVersionProperties

Popisuje vlastnosti galerie Script Version.

systemData

systemData

Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.

tags

object

Značky prostředků

type

string

Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

GalleryScriptVersionProperties

Popisuje vlastnosti verze galériového skriptu.

Name Typ Description
provisioningState

GalleryProvisioningState

Stav zřizování, který se zobrazí pouze v odpovědi.

publishingProfile

GalleryScriptVersionPublishingProfile

Profil publikování verze image galerie.

replicationStatus

ReplicationStatus

Toto je stav replikace verze image galerie.

safetyProfile

GalleryScriptVersionSafetyProfile

Bezpečnostní profil verze Gallery Script.

GalleryScriptVersionPublishingProfile

Profil publikování verze image galerie.

Name Typ Description
endOfLifeDate

string (date-time)

Datum konce životnosti verze image galerie. Tuto vlastnost lze použít pro účely vyřazení z provozu. Tato vlastnost je aktualizovatelná.

excludeFromLatest

boolean

Pokud je nastavená hodnota true, virtuální počítače nasazené z nejnovější verze definice image tuto verzi image nebudou používat.

publishedDate

string (date-time)

Časové razítko pro publikování verze image galerie.

replicaCount

integer (int32)

Počet replik verze image, které se mají vytvořit pro každou oblast. Tato vlastnost by se projevila pro oblast, pokud oblastReplicaCount není zadána. Tato vlastnost je aktualizovatelná.

replicationMode

ReplicationMode

Volitelný parametr, který určuje režim, který se má použít pro replikaci. Tato vlastnost není aktualizovatelná.

source

ScriptSource

Zdrojový skript, ze kterého bude vytvořena verze skriptu.

storageAccountStrategy

StorageAccountStrategy

Specifikuje strategii, která má být použita při výběru typu úložného účtu. Nelze jej specifikovat spolu s storageAccountType, ale lze jej přepsat podle regionů zadáním targetRegions[].storageAccountType. Tato vlastnost není aktualizovatelná.

storageAccountType

StorageAccountType

Určuje typ účtu úložiště, který se má použít k uložení image. Nelze to specifikovat spolu s storageAccountStrategy. Tato vlastnost není aktualizovatelná.

targetExtendedLocations

GalleryTargetExtendedLocation[]

Cílová rozšířená umístění, do kterých se bude verze image replikovat. Tato vlastnost je aktualizovatelná.

targetRegions

TargetRegion[]

Cílové oblasti, do kterých se bude verze image replikovat. Tato vlastnost je aktualizovatelná.

GalleryScriptVersionSafetyProfile

Bezpečnostní profil verze Gallery Script.

Name Typ Description
allowDeletionOfReplicatedLocations

boolean

Určuje, jestli je povolená nebo ne odebrání této verze image galerie z replikovaných oblastí.

GalleryScriptVersionUpdate

Specifikuje informace o verzi skriptu galerie, kterou chcete aktualizovat.

Name Typ Description
id

string

ID prostředku

name

string

Název prostředku

properties.provisioningState

GalleryProvisioningState

Stav zřizování, který se zobrazí pouze v odpovědi.

properties.publishingProfile

GalleryScriptVersionPublishingProfile

Profil publikování verze image galerie.

properties.replicationStatus

ReplicationStatus

Toto je stav replikace verze image galerie.

properties.safetyProfile

GalleryScriptVersionSafetyProfile

Bezpečnostní profil verze Gallery Script.

tags

object

Štítky prostředků

type

string

Typ zdroje

GalleryTargetExtendedLocation

Name Typ Description
encryption

EncryptionImages

Optional. Umožňuje uživatelům poskytnout klíče spravované zákazníkem pro šifrování disků s operačním systémem a datových disků v artefaktu galerie.

extendedLocation

GalleryExtendedLocation

Název rozšířeného umístění.

extendedLocationReplicaCount

integer (int32)

Počet replik verze image, které se mají vytvořit pro každé rozšířené umístění. Tato vlastnost je aktualizovatelná.

name

string

Název oblasti.

storageAccountType

EdgeZoneStorageAccountType

Určuje typ účtu úložiště, který se má použít k uložení image. Tato vlastnost není aktualizovatelná.

InnerError

Podrobnosti vnitřní chyby.

Name Typ Description
errordetail

string

Vnitřní chybová zpráva nebo výpis výjimky.

exceptiontype

string

Typ výjimky.

OSDiskImageEncryption

Obsahuje nastavení šifrování pro bitovou kopii disku s operačním systémem.

Name Typ Description
diskEncryptionSetId

string

Relativní identifikátor URI obsahující ID prostředku sady šifrování disku.

securityProfile

OSDiskImageSecurityProfile

Tato vlastnost určuje profil zabezpečení image disku s operačním systémem.

OSDiskImageSecurityProfile

Obsahuje profil zabezpečení pro image disku s operačním systémem.

Name Typ Description
confidentialVMEncryptionType

ConfidentialVMEncryptionType

důvěrné typy šifrování virtuálních počítačů

secureVMDiskEncryptionSetId

string

zabezpečené ID sady šifrování disků virtuálního počítače

RegionalReplicationStatus

Toto je stav regionální replikace.

Name Typ Description
details

string

Podrobnosti o stavu replikace

progress

integer (int32)

Označuje průběh úlohy replikace.

region

string

Oblast, do které se replikuje verze image galerie.

state

ReplicationState

Toto je stav regionální replikace.

ReplicationMode

Volitelný parametr, který určuje režim, který se má použít pro replikaci. Tato vlastnost není aktualizovatelná.

Hodnota Description
Full
Shallow

ReplicationState

Toto je stav regionální replikace.

Hodnota Description
Unknown
Replicating
Completed
Failed

ReplicationStatus

Toto je stav replikace verze image galerie.

Name Typ Description
aggregatedState

AggregatedReplicationState

Toto je agregovaný stav replikace na základě všech příznaků stavu regionální replikace.

summary

RegionalReplicationStatus[]

Toto je souhrn stavu replikace pro každou oblast.

ScriptSource

Zdrojový skript, ze kterého bude vytvořena verze skriptu.

Name Typ Description
parameters

GalleryScriptParameter[]

Optional. Vstupní parametry, které je třeba předat skriptu a které jsou přístupné uvnitř skriptu pro jeho vykonání.

scriptLink

string

Povinné. Spojení zdrojového skriptu musí být čitelný úložiště s povoleným SAS URI nebo veřejně přístupným URI či spravovanou identitou.

StorageAccountStrategy

Specifikuje strategii, která má být použita při výběru typu úložného účtu. Nelze jej specifikovat spolu s storageAccountType, ale lze jej přepsat podle regionů zadáním targetRegions[].storageAccountType. Tato vlastnost není aktualizovatelná.

Hodnota Description
PreferStandard_ZRS

Zvolte Standard_ZRS úložiště, pokud ho region podporuje, jinak zvolte Standard_LRS úložiště, pokud to není přepsáno zadáním regionálního úložištěAccountType. Pokud není uvedena storageAccountStrategy, jedná se o výchozí strategii (od verze API 2025-03-03).

DefaultStandard_LRS

Vyberte Standard_LRS úložiště, pokud není přepsáno zadáním regionálního úložištěAccountType.

StorageAccountType

Určuje typ účtu úložiště, který se má použít k uložení image. Tato vlastnost není aktualizovatelná.

Hodnota Description
Standard_LRS
Standard_ZRS
Premium_LRS
PremiumV2_LRS

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string (date-time)

Časové razítko vytvoření prostředku (UTC).

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt

string (date-time)

Časové razítko poslední změny zdroje (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

TargetRegion

Popisuje informace o cílové oblasti.

Name Typ Description
additionalReplicaSets

AdditionalReplicaSet[]

Seznam skladových položek úložiště s počtem replik pro vytvoření replik přímých jednotek

encryption

EncryptionImages

Optional. Umožňuje uživatelům poskytnout klíče spravované zákazníkem pro šifrování disků s operačním systémem a datových disků v artefaktu galerie.

excludeFromLatest

boolean

Obsahuje nastavení příznaku pro skrytí obrázku, když uživatelé zadají verzi ='latest'.

name

string

Název oblasti.

regionalReplicaCount

integer (int32)

Počet replik verze image, které se mají vytvořit pro každou oblast. Tato vlastnost je aktualizovatelná.

storageAccountType

StorageAccountType

Určuje typ účtu úložiště, který se má použít k uložení image. Tato vlastnost není aktualizovatelná.