Gallery Script Versions - Update
Mettre à jour une version du script de la galerie.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/scripts/{galleryScriptName}/versions/{galleryScriptVersionName}?api-version=2025-03-03
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
gallery
|
path | True |
string pattern: ^[^_\W][\w-._]{0,79}(? |
Nom de la galerie d’images partagées. |
|
gallery
|
path | True |
string pattern: ^[a-zA-Z0-9]+([_]?[a-zA-Z0-9]+)*$ |
Le nom de la galerie Définition du script à récupérer. |
|
gallery
|
path | True |
string pattern: ^[0-9]+\.[0-9]+\.[0-9]+$ |
Le nom de la galerie : Script Version à récupérer. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
|
subscription
|
path | True |
string minLength: 1 |
ID de l’abonnement cible. |
|
api-version
|
query | True |
string minLength: 1 |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| properties.publishingProfile | True |
Profil de publication d’une version d’image de galerie. |
|
| properties.safetyProfile |
Le profil de sécurité de la version Gallery Script. |
||
| tags |
object |
Balises de ressources |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
L’opération Azure s’est terminée avec succès. |
|
| 202 Accepted |
Demande de mise à jour de ressource acceptée. En-têtes
|
|
| Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
| Nom | Description |
|---|---|
| user_impersonation | emprunter l’identité de votre compte d’utilisateur |
Exemples
Update a simple gallery Script Version.
Exemple de requête
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
}
}
}
Exemple de réponse
{
"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
Définitions
| Nom | Description |
|---|---|
|
Additional |
Décrit les informations supplémentaires sur le jeu de réplicas. |
|
Aggregated |
Il s’agit de l’état de réplication agrégé basé sur tous les indicateurs d’état de réplication régionaux. |
|
Api |
Erreur d’API. |
|
Api |
Base d’erreur de l’API. |
|
Cloud |
Réponse d’erreur du service de calcul. |
|
Confidential |
types de chiffrement de machine virtuelle confidentielle |
|
created |
Type d’identité qui a créé la ressource. |
|
Data |
Contient les paramètres de chiffrement d’une image disque de données. |
|
Edge |
Spécifie le type de compte de stockage à utiliser pour stocker l’image. Cette propriété n’est pas modifiable. |
|
Encryption |
Optional. Permet aux utilisateurs de fournir des clés gérées par le client pour chiffrer le système d’exploitation et les disques de données dans l’artefact de la galerie. |
|
Gallery |
Nom de l’emplacement étendu. |
|
Gallery |
Il s’agit du type de l’emplacement étendu. |
|
Gallery |
État d’approvisionnement, qui apparaît uniquement dans la réponse. |
|
Gallery |
La définition d’un paramètre pouvant être transmis à un script d’une version de script de galerie. |
|
Gallery |
Spécifie le type du paramètre Gallery Script. Les valeurs possibles sont : String, Int, Double, Boolean, Enum |
|
Gallery |
Les types de ressources suivis concrets peuvent être créés en alias ce type à l’aide d’un type de propriété spécifique. |
|
Gallery |
Décrit les propriétés d’une version de script de galerie. |
|
Gallery |
Profil de publication d’une version d’image de galerie. |
|
Gallery |
Le profil de sécurité de la version Gallery Script. |
|
Gallery |
Précise les informations sur la version du script de la galerie que vous souhaitez mettre à jour. |
|
Gallery |
|
|
Inner |
Détails de l’erreur interne. |
|
OSDisk |
Contient les paramètres de chiffrement d’une image de disque de système d’exploitation. |
|
OSDisk |
Contient le profil de sécurité d’une image disque du système d’exploitation. |
|
Regional |
Il s’agit de l’état de la réplication régionale. |
|
Replication |
Paramètre facultatif qui spécifie le mode à utiliser pour la réplication. Cette propriété n’est pas modifiable. |
|
Replication |
Il s’agit de l’état de réplication régionale. |
|
Replication |
Il s’agit de l’état de réplication de la version de l’image de la galerie. |
|
Script |
Le script source à partir duquel la version du script va être créée. |
|
Storage |
Spécifie la stratégie à utiliser lors du choix du type de compte de stockage. Ne peut pas être spécifié avec storageAccountType, mais peut être remplacé par région en spécifiant targetRegions[].storageAccountType. Cette propriété n’est pas modifiable. |
|
Storage |
Spécifie le type de compte de stockage à utiliser pour stocker l’image. Cette propriété n’est pas modifiable. |
|
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
|
Target |
Décrit les informations relatives à la région cible. |
AdditionalReplicaSet
Décrit les informations supplémentaires sur le jeu de réplicas.
| Nom | Type | Description |
|---|---|---|
| regionalReplicaCount |
integer (int32) |
Nombre de réplicas de lecteur direct de la version d’image à créer. Cette propriété est pouvant être mise à jour |
| storageAccountType |
Spécifie le type de compte de stockage à utiliser pour créer les réplicas de lecteur direct |
AggregatedReplicationState
Il s’agit de l’état de réplication agrégé basé sur tous les indicateurs d’état de réplication régionaux.
| Valeur | Description |
|---|---|
| Unknown | |
| InProgress | |
| Completed | |
| Failed |
ApiError
Erreur d’API.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Code d'erreur. |
| details |
Les détails de l’erreur Api |
|
| innererror |
L’erreur interne de l’API |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible de l’erreur particulière. |
ApiErrorBase
Base d’erreur de l’API.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Code d'erreur. |
| message |
string |
Message d’erreur. |
| target |
string |
Cible de l’erreur particulière. |
CloudError
Réponse d’erreur du service de calcul.
| Nom | Type | Description |
|---|---|---|
| error |
Erreur d’API. |
ConfidentialVMEncryptionType
types de chiffrement de machine virtuelle confidentielle
| Valeur | Description |
|---|---|
| EncryptedVMGuestStateOnlyWithPmk | |
| EncryptedWithPmk | |
| EncryptedWithCmk | |
| NonPersistedTPM |
createdByType
Type d’identité qui a créé la ressource.
| Valeur | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DataDiskImageEncryption
Contient les paramètres de chiffrement d’une image disque de données.
| Nom | Type | Description |
|---|---|---|
| diskEncryptionSetId |
string |
URI relatif contenant l’ID de ressource du jeu de chiffrement de disque. |
| lun |
integer (int32) |
Cette propriété spécifie le numéro d’unité logique du disque de données. Cette valeur est utilisée pour identifier les disques de données au sein de la machine virtuelle et doit donc être unique pour chaque disque de données attaché à la machine virtuelle. |
EdgeZoneStorageAccountType
Spécifie le type de compte de stockage à utiliser pour stocker l’image. Cette propriété n’est pas modifiable.
| Valeur | Description |
|---|---|
| Standard_LRS | |
| Standard_ZRS | |
| StandardSSD_LRS | |
| Premium_LRS |
EncryptionImages
Optional. Permet aux utilisateurs de fournir des clés gérées par le client pour chiffrer le système d’exploitation et les disques de données dans l’artefact de la galerie.
| Nom | Type | Description |
|---|---|---|
| dataDiskImages |
Liste des spécifications de chiffrement pour les images de disque de données. |
|
| osDiskImage |
Contient les paramètres de chiffrement d’une image de disque de système d’exploitation. |
GalleryExtendedLocation
Nom de l’emplacement étendu.
| Nom | Type | Description |
|---|---|---|
| name |
string |
|
| type |
Il s’agit du type de l’emplacement étendu. |
GalleryExtendedLocationType
Il s’agit du type de l’emplacement étendu.
| Valeur | Description |
|---|---|
| EdgeZone | |
| Unknown |
GalleryProvisioningState
État d’approvisionnement, qui apparaît uniquement dans la réponse.
| Valeur | Description |
|---|---|
| Creating | |
| Updating | |
| Failed | |
| Succeeded | |
| Deleting | |
| Migrating |
GalleryScriptParameter
La définition d’un paramètre pouvant être transmis à un script d’une version de script de galerie.
| Nom | Type | Description |
|---|---|---|
| defaultValue |
string |
La valeur par défaut du paramètre ne s’applique qu’aux types de chaînes. |
| description |
string |
Description permettant aux utilisateurs de comprendre ce que signifie ce paramètre |
| enumValues |
string[] |
Une liste de valeurs permises. Les seules valeurs applicables proviennent des valeurs « enum » définies dans « GalleryScriptParameter ». |
| maxValue |
string |
La valeur minimale d’un paramètre. |
| minValue |
string |
La valeur minimale d’un paramètre. |
| name |
string |
Nom du paramètre. |
| required |
boolean |
Indique si ce paramètre doit être dépassé. |
| type |
Spécifie le type du paramètre Gallery Script. Les valeurs possibles sont : String, Int, Double, Boolean, Enum |
GalleryScriptParameterType
Spécifie le type du paramètre Gallery Script. Les valeurs possibles sont : String, Int, Double, Boolean, Enum
| Valeur | Description |
|---|---|
| String |
Type de paramètre de script de galerie de chaînes |
| Int |
Type de paramètre de script de galerie int |
| Double |
Type de paramètre de script double galerie |
| Boolean |
Type de paramètre de script de galerie booléen |
| Enum |
Type de paramètre de script de galerie d’enum |
GalleryScriptVersion
Les types de ressources suivis concrets peuvent être créés en alias ce type à l’aide d’un type de propriété spécifique.
| Nom | Type | Description |
|---|---|---|
| id |
string |
ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
Emplacement géographique où réside la ressource |
| name |
string |
Nom de la ressource |
| properties |
Décrit les propriétés d’une galerie Version script. |
|
| systemData |
Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. |
|
| tags |
object |
Balises de ressource. |
| type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
GalleryScriptVersionProperties
Décrit les propriétés d’une version de script de galerie.
| Nom | Type | Description |
|---|---|---|
| provisioningState |
État d’approvisionnement, qui apparaît uniquement dans la réponse. |
|
| publishingProfile |
Profil de publication d’une version d’image de galerie. |
|
| replicationStatus |
Il s’agit de l’état de réplication de la version de l’image de la galerie. |
|
| safetyProfile |
Le profil de sécurité de la version Gallery Script. |
GalleryScriptVersionPublishingProfile
Profil de publication d’une version d’image de galerie.
| Nom | Type | Description |
|---|---|---|
| endOfLifeDate |
string (date-time) |
Date de fin de vie de la version de l’image de la galerie. Cette propriété peut être utilisée à des fins de désaffectation. Cette propriété est pouvant être mise à jour. |
| excludeFromLatest |
boolean |
Si la valeur est true, les machines virtuelles déployées à partir de la dernière version de la définition d’image n’utilisent pas cette version d’image. |
| publishedDate |
string (date-time) |
Horodatage de la publication de la version de l’image de la galerie. |
| replicaCount |
integer (int32) |
Nombre de réplicas de la version d’image à créer par région. Cette propriété prend effet pour une région lorsque regionalReplicaCount n’est pas spécifié. Cette propriété est pouvant être mise à jour. |
| replicationMode |
Paramètre facultatif qui spécifie le mode à utiliser pour la réplication. Cette propriété n’est pas modifiable. |
|
| source |
Le script source à partir duquel la version du script va être créée. |
|
| storageAccountStrategy |
Spécifie la stratégie à utiliser lors du choix du type de compte de stockage. Ne peut pas être spécifié avec storageAccountType, mais peut être remplacé par région en spécifiant targetRegions[].storageAccountType. Cette propriété n’est pas modifiable. |
|
| storageAccountType |
Spécifie le type de compte de stockage à utiliser pour stocker l’image. Ne peut pas être spécifié avec storageAccountStrategy. Cette propriété n’est pas modifiable. |
|
| targetExtendedLocations |
Emplacements étendus cibles vers lesquels la version de l’image doit être répliquée. Cette propriété est pouvant être mise à jour. |
|
| targetRegions |
Régions cibles vers lesquelles la version de l’image sera répliquée. Cette propriété est pouvant être mise à jour. |
GalleryScriptVersionSafetyProfile
Le profil de sécurité de la version Gallery Script.
| Nom | Type | Description |
|---|---|---|
| allowDeletionOfReplicatedLocations |
boolean |
Indique si la suppression ou non de cette version d’image de galerie des régions répliquées est autorisée. |
GalleryScriptVersionUpdate
Précise les informations sur la version du script de la galerie que vous souhaitez mettre à jour.
| Nom | Type | Description |
|---|---|---|
| id |
string |
ID de ressource |
| name |
string |
Nom de la ressource |
| properties.provisioningState |
État d’approvisionnement, qui apparaît uniquement dans la réponse. |
|
| properties.publishingProfile |
Profil de publication d’une version d’image de galerie. |
|
| properties.replicationStatus |
Il s’agit de l’état de réplication de la version de l’image de la galerie. |
|
| properties.safetyProfile |
Le profil de sécurité de la version Gallery Script. |
|
| tags |
object |
Balises de ressources |
| type |
string |
Type de ressource |
GalleryTargetExtendedLocation
| Nom | Type | Description |
|---|---|---|
| encryption |
Optional. Permet aux utilisateurs de fournir des clés gérées par le client pour chiffrer le système d’exploitation et les disques de données dans l’artefact de la galerie. |
|
| extendedLocation |
Nom de l’emplacement étendu. |
|
| extendedLocationReplicaCount |
integer (int32) |
Nombre de réplicas de la version d’image à créer par emplacement étendu. Cette propriété est pouvant être mise à jour. |
| name |
string |
Nom de la région. |
| storageAccountType |
Spécifie le type de compte de stockage à utiliser pour stocker l’image. Cette propriété n’est pas modifiable. |
InnerError
Détails de l’erreur interne.
| Nom | Type | Description |
|---|---|---|
| errordetail |
string |
Message d’erreur interne ou vidage d’exception. |
| exceptiontype |
string |
Type d’exception. |
OSDiskImageEncryption
Contient les paramètres de chiffrement d’une image de disque de système d’exploitation.
| Nom | Type | Description |
|---|---|---|
| diskEncryptionSetId |
string |
URI relatif contenant l’ID de ressource du jeu de chiffrement de disque. |
| securityProfile |
Cette propriété spécifie le profil de sécurité d’une image de disque de système d’exploitation. |
OSDiskImageSecurityProfile
Contient le profil de sécurité d’une image disque du système d’exploitation.
| Nom | Type | Description |
|---|---|---|
| confidentialVMEncryptionType |
types de chiffrement de machine virtuelle confidentielle |
|
| secureVMDiskEncryptionSetId |
string |
ID de jeu de chiffrement de disque de machine virtuelle sécurisé |
RegionalReplicationStatus
Il s’agit de l’état de la réplication régionale.
| Nom | Type | Description |
|---|---|---|
| details |
string |
Détails de l’état de la réplication. |
| progress |
integer (int32) |
Il indique la progression de la tâche de réplication. |
| region |
string |
Région dans laquelle la version de l’image de la galerie est répliquée. |
| state |
Il s’agit de l’état de réplication régionale. |
ReplicationMode
Paramètre facultatif qui spécifie le mode à utiliser pour la réplication. Cette propriété n’est pas modifiable.
| Valeur | Description |
|---|---|
| Full | |
| Shallow |
ReplicationState
Il s’agit de l’état de réplication régionale.
| Valeur | Description |
|---|---|
| Unknown | |
| Replicating | |
| Completed | |
| Failed |
ReplicationStatus
Il s’agit de l’état de réplication de la version de l’image de la galerie.
| Nom | Type | Description |
|---|---|---|
| aggregatedState |
Il s’agit de l’état de réplication agrégé basé sur tous les indicateurs d’état de réplication régionaux. |
|
| summary |
Il s’agit d’un résumé de l’état de la réplication pour chaque région. |
ScriptSource
Le script source à partir duquel la version du script va être créée.
| Nom | Type | Description |
|---|---|---|
| parameters |
Optional. Tous les paramètres d’entrée qui doivent être transmis au script et qui sont consultés dans le script pour son exécution. |
|
| scriptLink |
string |
Obligatoire. Le lien du script source doit être un blob de stockage lisible avec une URI SAS ou une URI accessible publiquement ou une identité gérée activée. |
StorageAccountStrategy
Spécifie la stratégie à utiliser lors du choix du type de compte de stockage. Ne peut pas être spécifié avec storageAccountType, mais peut être remplacé par région en spécifiant targetRegions[].storageAccountType. Cette propriété n’est pas modifiable.
| Valeur | Description |
|---|---|
| PreferStandard_ZRS |
Choisissez Standard_ZRS stockage si la région le supporte, sinon choisissez Standard_LRS stockage, sauf si cela est remplacé en spécifiant un type de compte de stockage régional. Si aucune storageAccountStrategy n’est spécifiée, c’est la stratégie par défaut (à partir de la version API 2025-03-03). |
| DefaultStandard_LRS |
Choisissez Standard_LRS stockage sauf si cela est remplacé en spécifiant le stockage régionalTypeCompte. |
StorageAccountType
Spécifie le type de compte de stockage à utiliser pour stocker l’image. Cette propriété n’est pas modifiable.
| Valeur | Description |
|---|---|
| Standard_LRS | |
| Standard_ZRS | |
| Premium_LRS | |
| PremiumV2_LRS |
systemData
Métadonnées relatives à la création et à la dernière modification de la ressource.
| Nom | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
Horodatage de la création de ressources (UTC). |
| createdBy |
string |
Identité qui a créé la ressource. |
| createdByType |
Type d’identité qui a créé la ressource. |
|
| lastModifiedAt |
string (date-time) |
Horodatage de la dernière modification de ressource (UTC) |
| lastModifiedBy |
string |
Identité qui a modifié la ressource pour la dernière fois. |
| lastModifiedByType |
Type d’identité qui a modifié la ressource pour la dernière fois. |
TargetRegion
Décrit les informations relatives à la région cible.
| Nom | Type | Description |
|---|---|---|
| additionalReplicaSets |
Liste des références SKU de stockage avec nombre de réplicas pour créer des réplicas de lecteur direct. |
|
| encryption |
Optional. Permet aux utilisateurs de fournir des clés gérées par le client pour chiffrer le système d’exploitation et les disques de données dans l’artefact de la galerie. |
|
| excludeFromLatest |
boolean |
Contient le paramètre d’indicateur pour masquer une image lorsque les utilisateurs spécifient version='latest' |
| name |
string |
Nom de la région. |
| regionalReplicaCount |
integer (int32) |
Nombre de réplicas de la version d’image à créer par région. Cette propriété est pouvant être mise à jour. |
| storageAccountType |
Spécifie le type de compte de stockage à utiliser pour stocker l’image. Cette propriété n’est pas modifiable. |