Condividi tramite


Gallery Script Versions - Update

Aggiorna una galleria Versione dello script.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
galleryName
path True

string

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

Il nome della galleria di immagini condivise.

galleryScriptName
path True

string

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

Il nome della galleria Definizione di Script sarà recuperato.

galleryScriptVersionName
path True

string

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

Il nome della galleria Script Version da recuperare.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

subscriptionId
path True

string

minLength: 1

ID della sottoscrizione di destinazione.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties.publishingProfile True

GalleryScriptVersionPublishingProfile

Profilo di pubblicazione di una versione dell'immagine della raccolta.

properties.safetyProfile

GalleryScriptVersionSafetyProfile

Il profilo di sicurezza della versione Gallery Script.

tags

object

Tag delle risorse

Risposte

Nome Tipo Descrizione
200 OK

GalleryScriptVersion

Operazione di Azure completata correttamente.

202 Accepted

Richiesta di aggiornamento delle risorse accettata.

Intestazioni

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

CloudError

Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
AdditionalReplicaSet

Vengono descritte le informazioni aggiuntive sul set di repliche.

AggregatedReplicationState

Questo è lo stato di replica aggregato in base a tutti i flag di stato della replica a livello di area.

ApiError

Errore API.

ApiErrorBase

Base di errore API.

CloudError

Risposta di errore dal servizio di calcolo.

ConfidentialVMEncryptionType

tipi di crittografia di macchine virtuali riservati

createdByType

Tipo di identità che ha creato la risorsa.

DataDiskImageEncryption

Contiene le impostazioni di crittografia per un'immagine del disco dati.

EdgeZoneStorageAccountType

Specifica il tipo di account di archiviazione da usare per archiviare l'immagine. Questa proprietà non è aggiornabile.

EncryptionImages

Optional. Consente agli utenti di fornire chiavi gestite dal cliente per crittografare il sistema operativo e i dischi dati nell'artefatto della raccolta.

GalleryExtendedLocation

Nome della posizione estesa.

GalleryExtendedLocationType

È il tipo della posizione estesa.

GalleryProvisioningState

Stato di provisioning, visualizzato solo nella risposta.

GalleryScriptParameter

La definizione di un parametro che può essere passato a uno script di una versione dello script della galleria.

GalleryScriptParameterType

Specifica il tipo del parametro Gallery Script. I valori possibili sono: String, Int, Double, Boolean, Enum

GalleryScriptVersion

I tipi di risorse rilevati concreti possono essere creati eseguendo l'aliasing di questo tipo usando un tipo di proprietà specifico.

GalleryScriptVersionProperties

Descrive le proprietà di una versione script in galleria.

GalleryScriptVersionPublishingProfile

Profilo di pubblicazione di una versione dell'immagine della raccolta.

GalleryScriptVersionSafetyProfile

Il profilo di sicurezza della versione Gallery Script.

GalleryScriptVersionUpdate

Specifica le informazioni sulla Versione dello Script della galleria che vuoi aggiornare.

GalleryTargetExtendedLocation
InnerError

Dettagli dell'errore interno.

OSDiskImageEncryption

Contiene le impostazioni di crittografia per un'immagine del disco del sistema operativo.

OSDiskImageSecurityProfile

Contiene il profilo di sicurezza per un'immagine disco del sistema operativo.

RegionalReplicationStatus

Questo è lo stato della replica a livello di area.

ReplicationMode

Parametro facoltativo che specifica la modalità da usare per la replica. Questa proprietà non è aggiornabile.

ReplicationState

Questo è lo stato di replica a livello di area.

ReplicationStatus

Questo è lo stato di replica della versione dell'immagine della raccolta.

ScriptSource

Lo script sorgente da cui verrà creata la Versione dello Script.

StorageAccountStrategy

Specifica la strategia da utilizzare nella selezione del tipo di conto di archiviazione. Non può essere specificato insieme a storageAccountType, ma può essere sovrascritto per regione specificando targetRegions[].storageAccountType. Questa proprietà non è aggiornabile.

StorageAccountType

Specifica il tipo di account di archiviazione da usare per archiviare l'immagine. Questa proprietà non è aggiornabile.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

TargetRegion

Vengono descritte le informazioni relative all'area di destinazione.

AdditionalReplicaSet

Vengono descritte le informazioni aggiuntive sul set di repliche.

Nome Tipo Descrizione
regionalReplicaCount

integer (int32)

Numero di repliche di unità dirette della versione dell'immagine da creare. Questa proprietà è aggiornabile

storageAccountType

StorageAccountType

Specifica il tipo di account di archiviazione da usare per creare le repliche di unità dirette

AggregatedReplicationState

Questo è lo stato di replica aggregato in base a tutti i flag di stato della replica a livello di area.

Valore Descrizione
Unknown
InProgress
Completed
Failed

ApiError

Errore API.

Nome Tipo Descrizione
code

string

Codice di errore.

details

ApiErrorBase[]

Dettagli dell'errore Api

innererror

InnerError

L'errore interno dell'API

message

string

Messaggio di errore.

target

string

Destinazione dell'errore specifico.

ApiErrorBase

Base di errore API.

Nome Tipo Descrizione
code

string

Codice di errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore specifico.

CloudError

Risposta di errore dal servizio di calcolo.

Nome Tipo Descrizione
error

ApiError

Errore API.

ConfidentialVMEncryptionType

tipi di crittografia di macchine virtuali riservati

Valore Descrizione
EncryptedVMGuestStateOnlyWithPmk
EncryptedWithPmk
EncryptedWithCmk
NonPersistedTPM

createdByType

Tipo di identità che ha creato la risorsa.

Valore Descrizione
User
Application
ManagedIdentity
Key

DataDiskImageEncryption

Contiene le impostazioni di crittografia per un'immagine del disco dati.

Nome Tipo Descrizione
diskEncryptionSetId

string

URI relativo contenente l'ID risorsa del set di crittografia del disco.

lun

integer (int32)

Questa proprietà specifica il numero di unità logica del disco dati. Questo valore viene usato per identificare i dischi dati all'interno della macchina virtuale e pertanto deve essere univoco per ogni disco dati collegato alla macchina virtuale.

EdgeZoneStorageAccountType

Specifica il tipo di account di archiviazione da usare per archiviare l'immagine. Questa proprietà non è aggiornabile.

Valore Descrizione
Standard_LRS
Standard_ZRS
StandardSSD_LRS
Premium_LRS

EncryptionImages

Optional. Consente agli utenti di fornire chiavi gestite dal cliente per crittografare il sistema operativo e i dischi dati nell'artefatto della raccolta.

Nome Tipo Descrizione
dataDiskImages

DataDiskImageEncryption[]

Elenco delle specifiche di crittografia per le immagini del disco dati.

osDiskImage

OSDiskImageEncryption

Contiene le impostazioni di crittografia per un'immagine del disco del sistema operativo.

GalleryExtendedLocation

Nome della posizione estesa.

Nome Tipo Descrizione
name

string

type

GalleryExtendedLocationType

È il tipo della posizione estesa.

GalleryExtendedLocationType

È il tipo della posizione estesa.

Valore Descrizione
EdgeZone
Unknown

GalleryProvisioningState

Stato di provisioning, visualizzato solo nella risposta.

Valore Descrizione
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GalleryScriptParameter

La definizione di un parametro che può essere passato a uno script di una versione dello script della galleria.

Nome Tipo Descrizione
defaultValue

string

Il valore predefinito del parametro si applica solo ai tipi di stringhe.

description

string

Descrizione che consente agli utenti di comprendere il significato di questo parametro

enumValues

string[]

Un elenco di valori ammissibili. Solo i valori applicabili provengono dai valori 'enum' definiti in 'GalleryScriptParameter'.

maxValue

string

Il valore minimo del parametro.

minValue

string

Il valore minimo del parametro.

name

string

Nome del parametro.

required

boolean

Indica se questo parametro deve essere superato.

type

GalleryScriptParameterType

Specifica il tipo del parametro Gallery Script. I valori possibili sono: String, Int, Double, Boolean, Enum

GalleryScriptParameterType

Specifica il tipo del parametro Gallery Script. I valori possibili sono: String, Int, Double, Boolean, Enum

Valore Descrizione
String

Tipo di parametro script per la galleria di stringhe

Int

Tipo di parametro dello script Int gallery

Double

Tipo di parametro di script a doppia galleria

Boolean

Tipo di parametro dello script della galleria booleana

Enum

Tipo di parametro script per galleria enum

GalleryScriptVersion

I tipi di risorse rilevati concreti possono essere creati eseguendo l'aliasing di questo tipo usando un tipo di proprietà specifico.

Nome Tipo Descrizione
id

string

ID risorsa completo per la risorsa. Ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Posizione geografica in cui risiede la risorsa

name

string

Nome della risorsa

properties

GalleryScriptVersionProperties

Descrive le proprietà di una galleria Script Version.

systemData

systemData

Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.

tags

object

Tag di risorsa.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

GalleryScriptVersionProperties

Descrive le proprietà di una versione script in galleria.

Nome Tipo Descrizione
provisioningState

GalleryProvisioningState

Stato di provisioning, visualizzato solo nella risposta.

publishingProfile

GalleryScriptVersionPublishingProfile

Profilo di pubblicazione di una versione dell'immagine della raccolta.

replicationStatus

ReplicationStatus

Questo è lo stato di replica della versione dell'immagine della raccolta.

safetyProfile

GalleryScriptVersionSafetyProfile

Il profilo di sicurezza della versione Gallery Script.

GalleryScriptVersionPublishingProfile

Profilo di pubblicazione di una versione dell'immagine della raccolta.

Nome Tipo Descrizione
endOfLifeDate

string (date-time)

Data di fine vita della versione dell'immagine della raccolta. Questa proprietà può essere utilizzata per scopi di rimozione delle autorizzazioni. Questa proprietà è aggiornabile.

excludeFromLatest

boolean

Se impostato su true, le macchine virtuali distribuite dalla versione più recente della definizione di immagine non useranno questa versione dell'immagine.

publishedDate

string (date-time)

Il timestamp per la pubblicazione della versione dell'immagine della galleria.

replicaCount

integer (int32)

Numero di repliche della versione dell'immagine da creare per area. Questa proprietà avrà effetto per un'area quando regionalReplicaCount non è specificato. Questa proprietà è aggiornabile.

replicationMode

ReplicationMode

Parametro facoltativo che specifica la modalità da usare per la replica. Questa proprietà non è aggiornabile.

source

ScriptSource

Lo script sorgente da cui verrà creata la Versione dello Script.

storageAccountStrategy

StorageAccountStrategy

Specifica la strategia da utilizzare nella selezione del tipo di conto di archiviazione. Non può essere specificato insieme a storageAccountType, ma può essere sovrascritto per regione specificando targetRegions[].storageAccountType. Questa proprietà non è aggiornabile.

storageAccountType

StorageAccountType

Specifica il tipo di account di archiviazione da usare per archiviare l'immagine. Non può essere specificato insieme a storageAccountStrategy. Questa proprietà non è aggiornabile.

targetExtendedLocations

GalleryTargetExtendedLocation[]

I percorsi estesi di destinazione in cui verrà replicata la versione dell'immagine. Questa proprietà è aggiornabile.

targetRegions

TargetRegion[]

Le aree di destinazione in cui verrà replicata la versione dell'immagine. Questa proprietà è aggiornabile.

GalleryScriptVersionSafetyProfile

Il profilo di sicurezza della versione Gallery Script.

Nome Tipo Descrizione
allowDeletionOfReplicatedLocations

boolean

Indica se è consentita o meno la rimozione della versione dell'immagine della raccolta dalle aree replicate.

GalleryScriptVersionUpdate

Specifica le informazioni sulla Versione dello Script della galleria che vuoi aggiornare.

Nome Tipo Descrizione
id

string

ID risorsa

name

string

Nome risorsa

properties.provisioningState

GalleryProvisioningState

Stato di provisioning, visualizzato solo nella risposta.

properties.publishingProfile

GalleryScriptVersionPublishingProfile

Profilo di pubblicazione di una versione dell'immagine della raccolta.

properties.replicationStatus

ReplicationStatus

Questo è lo stato di replica della versione dell'immagine della raccolta.

properties.safetyProfile

GalleryScriptVersionSafetyProfile

Il profilo di sicurezza della versione Gallery Script.

tags

object

Tag delle risorse

type

string

Tipo di risorsa

GalleryTargetExtendedLocation

Nome Tipo Descrizione
encryption

EncryptionImages

Optional. Consente agli utenti di fornire chiavi gestite dal cliente per crittografare il sistema operativo e i dischi dati nell'artefatto della raccolta.

extendedLocation

GalleryExtendedLocation

Nome della posizione estesa.

extendedLocationReplicaCount

integer (int32)

Numero di repliche della versione dell'immagine da creare per ogni posizione estesa. Questa proprietà è aggiornabile.

name

string

Nome dell'area.

storageAccountType

EdgeZoneStorageAccountType

Specifica il tipo di account di archiviazione da usare per archiviare l'immagine. Questa proprietà non è aggiornabile.

InnerError

Dettagli dell'errore interno.

Nome Tipo Descrizione
errordetail

string

Messaggio di errore interno o dump di eccezione.

exceptiontype

string

Tipo di eccezione.

OSDiskImageEncryption

Contiene le impostazioni di crittografia per un'immagine del disco del sistema operativo.

Nome Tipo Descrizione
diskEncryptionSetId

string

URI relativo contenente l'ID risorsa del set di crittografia del disco.

securityProfile

OSDiskImageSecurityProfile

Questa proprietà specifica il profilo di sicurezza di un'immagine del disco del sistema operativo.

OSDiskImageSecurityProfile

Contiene il profilo di sicurezza per un'immagine disco del sistema operativo.

Nome Tipo Descrizione
confidentialVMEncryptionType

ConfidentialVMEncryptionType

tipi di crittografia di macchine virtuali riservati

secureVMDiskEncryptionSetId

string

ID del set di crittografia del disco della macchina virtuale sicura

RegionalReplicationStatus

Questo è lo stato della replica a livello di area.

Nome Tipo Descrizione
details

string

Dettagli dello stato della replica.

progress

integer (int32)

Indica lo stato di avanzamento del processo di replica.

region

string

L'area in cui viene replicata la versione dell'immagine della raccolta.

state

ReplicationState

Questo è lo stato di replica a livello di area.

ReplicationMode

Parametro facoltativo che specifica la modalità da usare per la replica. Questa proprietà non è aggiornabile.

Valore Descrizione
Full
Shallow

ReplicationState

Questo è lo stato di replica a livello di area.

Valore Descrizione
Unknown
Replicating
Completed
Failed

ReplicationStatus

Questo è lo stato di replica della versione dell'immagine della raccolta.

Nome Tipo Descrizione
aggregatedState

AggregatedReplicationState

Questo è lo stato di replica aggregato in base a tutti i flag di stato della replica a livello di area.

summary

RegionalReplicationStatus[]

Questo è un riepilogo dello stato di replica per ogni area.

ScriptSource

Lo script sorgente da cui verrà creata la Versione dello Script.

Nome Tipo Descrizione
parameters

GalleryScriptParameter[]

Optional. Qualsiasi parametro di input che deve essere passato allo script e che viene accessibile all'interno dello script per la sua esecuzione.

scriptLink

string

Obbligatorio. Il link dello script sorgente deve essere un blob di memoria leggibile con URI SAS o URI pubblicamente accessibile o identità gestita abilitata.

StorageAccountStrategy

Specifica la strategia da utilizzare nella selezione del tipo di conto di archiviazione. Non può essere specificato insieme a storageAccountType, ma può essere sovrascritto per regione specificando targetRegions[].storageAccountType. Questa proprietà non è aggiornabile.

Valore Descrizione
PreferStandard_ZRS

Scegli Standard_ZRS storage se la regione lo supporta, altrimenti scegli Standard_LRS storage, a meno che non venga sovrascritto specificando regionale storageAccountType. Se non viene specificata alcuna storageAccountStrategy, questa è la strategia predefinita (dalla versione API 2025-03-03 in poi).

DefaultStandard_LRS

Scegli Standard_LRS storage a meno che non venga sovrascritto specificando storageAccountType regionale.

StorageAccountType

Specifica il tipo di account di archiviazione da usare per archiviare l'immagine. Questa proprietà non è aggiornabile.

Valore Descrizione
Standard_LRS
Standard_ZRS
Premium_LRS
PremiumV2_LRS

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string (date-time)

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

TargetRegion

Vengono descritte le informazioni relative all'area di destinazione.

Nome Tipo Descrizione
additionalReplicaSets

AdditionalReplicaSet[]

Elenco di SKU di archiviazione con numero di repliche per creare repliche di unità dirette.

encryption

EncryptionImages

Optional. Consente agli utenti di fornire chiavi gestite dal cliente per crittografare il sistema operativo e i dischi dati nell'artefatto della raccolta.

excludeFromLatest

boolean

Contiene l'impostazione del flag per nascondere un'immagine quando gli utenti specificano version='latest'

name

string

Nome dell'area.

regionalReplicaCount

integer (int32)

Numero di repliche della versione dell'immagine da creare per area. Questa proprietà è aggiornabile.

storageAccountType

StorageAccountType

Specifica il tipo di account di archiviazione da usare per archiviare l'immagine. Questa proprietà non è aggiornabile.