Compartir a través de


Gallery Script Versions - Update

Actualizar una galería Versión del guion.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
galleryName
path True

string

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

Nombre de Shared Image Gallery.

galleryScriptName
path True

string

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

El nombre de la galería Definición de guion será recuperado.

galleryScriptVersionName
path True

string

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

El nombre de la galería Script Version será recuperado.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

Identificador de la suscripción de destino.

api-version
query True

string

minLength: 1

Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
properties.publishingProfile True

GalleryScriptVersionPublishingProfile

Perfil de publicación de una versión de imagen de la galería.

properties.safetyProfile

GalleryScriptVersionSafetyProfile

El perfil de seguridad de la versión del guion de la galería.

tags

object

Etiquetas de recursos

Respuestas

Nombre Tipo Description
200 OK

GalleryScriptVersion

La operación de Azure se completó correctamente.

202 Accepted

Solicitud de actualización de recursos aceptada.

Encabezados

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

CloudError

Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
AdditionalReplicaSet

Describe la información adicional del conjunto de réplicas.

AggregatedReplicationState

Este es el estado de replicación agregado en función de todas las marcas de estado de replicación regional.

ApiError

Error de API.

ApiErrorBase

Base de errores de api.

CloudError

Respuesta de error del servicio Compute.

ConfidentialVMEncryptionType

tipos de cifrado de máquina virtual confidencial

createdByType

Tipo de identidad que creó el recurso.

DataDiskImageEncryption

Contiene la configuración de cifrado de una imagen de disco de datos.

EdgeZoneStorageAccountType

Especifica el tipo de cuenta de almacenamiento que se va a usar para almacenar la imagen. Esta propiedad no es actualizable.

EncryptionImages

Optional. Permite a los usuarios proporcionar claves administradas por el cliente para cifrar los discos de datos y del sistema operativo en el artefacto de la galería.

GalleryExtendedLocation

Nombre de la ubicación extendida.

GalleryExtendedLocationType

Es el tipo de la ubicación extendida.

GalleryProvisioningState

Estado de aprovisionamiento, que solo aparece en la respuesta.

GalleryScriptParameter

La definición de un parámetro que puede pasarse a un script de una versión de Gallery Script.

GalleryScriptParameterType

Especifica el tipo del parámetro Gallery Script. Los valores posibles son: String, Int, Double, Boolean, Enum

GalleryScriptVersion

Los tipos de recursos de seguimiento concreto se pueden crear mediante el alias de este tipo mediante un tipo de propiedad específico.

GalleryScriptVersionProperties

Describe las propiedades de una versión de guion de galería.

GalleryScriptVersionPublishingProfile

Perfil de publicación de una versión de imagen de la galería.

GalleryScriptVersionSafetyProfile

El perfil de seguridad de la versión del guion de la galería.

GalleryScriptVersionUpdate

Especifica la información sobre la versión del script de la galería que quieres actualizar.

GalleryTargetExtendedLocation
InnerError

Detalles del error interno.

OSDiskImageEncryption

Contiene la configuración de cifrado de una imagen de disco del sistema operativo.

OSDiskImageSecurityProfile

Contiene el perfil de seguridad de una imagen de disco del sistema operativo.

RegionalReplicationStatus

Este es el estado de replicación regional.

ReplicationMode

Parámetro opcional que especifica el modo que se va a usar para la replicación. Esta propiedad no es actualizable.

ReplicationState

Este es el estado de replicación regional.

ReplicationStatus

Este es el estado de replicación de la versión de la imagen de la galería.

ScriptSource

El script fuente del que se va a crear la versión del guion.

StorageAccountStrategy

Especifica la estrategia a utilizar al seleccionar el tipo de cuenta de almacenamiento. No se puede especificar junto con storageAccountType, pero puede ser anulado por región especificando targetRegions[].storageAccountType. Esta propiedad no es actualizable.

StorageAccountType

Especifica el tipo de cuenta de almacenamiento que se va a usar para almacenar la imagen. Esta propiedad no es actualizable.

systemData

Metadatos relativos a la creación y última modificación del recurso.

TargetRegion

Describe la información de la región de destino.

AdditionalReplicaSet

Describe la información adicional del conjunto de réplicas.

Nombre Tipo Description
regionalReplicaCount

integer (int32)

Número de réplicas de unidad directa de la versión de imagen que se va a crear. Esta propiedad es actualizable

storageAccountType

StorageAccountType

Especifica el tipo de cuenta de almacenamiento que se va a usar para crear las réplicas de unidad directa.

AggregatedReplicationState

Este es el estado de replicación agregado en función de todas las marcas de estado de replicación regional.

Valor Description
Unknown
InProgress
Completed
Failed

ApiError

Error de API.

Nombre Tipo Description
code

string

Código de error.

details

ApiErrorBase[]

Detalles del error de api

innererror

InnerError

Error interno de api

message

string

El mensaje de error.

target

string

Destino del error concreto.

ApiErrorBase

Base de errores de api.

Nombre Tipo Description
code

string

Código de error.

message

string

El mensaje de error.

target

string

Destino del error concreto.

CloudError

Respuesta de error del servicio Compute.

Nombre Tipo Description
error

ApiError

Error de API.

ConfidentialVMEncryptionType

tipos de cifrado de máquina virtual confidencial

Valor Description
EncryptedVMGuestStateOnlyWithPmk
EncryptedWithPmk
EncryptedWithCmk
NonPersistedTPM

createdByType

Tipo de identidad que creó el recurso.

Valor Description
User
Application
ManagedIdentity
Key

DataDiskImageEncryption

Contiene la configuración de cifrado de una imagen de disco de datos.

Nombre Tipo Description
diskEncryptionSetId

string

Un URI relativo que contiene el identificador de recurso del conjunto de cifrado de disco.

lun

integer (int32)

Esta propiedad especifica el número de unidad lógica del disco de datos. Este valor se usa para identificar discos de datos dentro de la máquina virtual y, por tanto, debe ser único para cada disco de datos conectado a la máquina virtual.

EdgeZoneStorageAccountType

Especifica el tipo de cuenta de almacenamiento que se va a usar para almacenar la imagen. Esta propiedad no es actualizable.

Valor Description
Standard_LRS
Standard_ZRS
StandardSSD_LRS
Premium_LRS

EncryptionImages

Optional. Permite a los usuarios proporcionar claves administradas por el cliente para cifrar los discos de datos y del sistema operativo en el artefacto de la galería.

Nombre Tipo Description
dataDiskImages

DataDiskImageEncryption[]

Lista de especificaciones de cifrado para imágenes de disco de datos.

osDiskImage

OSDiskImageEncryption

Contiene la configuración de cifrado de una imagen de disco del sistema operativo.

GalleryExtendedLocation

Nombre de la ubicación extendida.

Nombre Tipo Description
name

string

type

GalleryExtendedLocationType

Es el tipo de la ubicación extendida.

GalleryExtendedLocationType

Es el tipo de la ubicación extendida.

Valor Description
EdgeZone
Unknown

GalleryProvisioningState

Estado de aprovisionamiento, que solo aparece en la respuesta.

Valor Description
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GalleryScriptParameter

La definición de un parámetro que puede pasarse a un script de una versión de Gallery Script.

Nombre Tipo Description
defaultValue

string

El valor por defecto del parámetro solo se aplica a los tipos de cadena.

description

string

Descripción para ayudar a los usuarios a comprender lo que significa este parámetro

enumValues

string[]

Una lista de valores permitidos. Los únicos valores aplicables provienen de valores 'enum' definidos en 'GalleryScriptParameter'.

maxValue

string

El valor mínimo del parámetro.

minValue

string

El valor mínimo del parámetro.

name

string

Nombre del parámetro.

required

boolean

Indica si este parámetro debe ser superado.

type

GalleryScriptParameterType

Especifica el tipo del parámetro Gallery Script. Los valores posibles son: String, Int, Double, Boolean, Enum

GalleryScriptParameterType

Especifica el tipo del parámetro Gallery Script. Los valores posibles son: String, Int, Double, Boolean, Enum

Valor Description
String

Tipo de parámetro de script en la galería de cadenas

Int

Tipo de parámetro de script en galería int

Double

Tipo de parámetro de script de doble galería

Boolean

Tipo de parámetro de script de galería booleano

Enum

Tipo de parámetro de script de galería de enum

GalleryScriptVersion

Los tipos de recursos de seguimiento concreto se pueden crear mediante el alias de este tipo mediante un tipo de propiedad específico.

Nombre Tipo Description
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Ubicación geográfica donde reside el recurso

name

string

Nombre del recurso

properties

GalleryScriptVersionProperties

Describe las propiedades de una galería Versión de guion.

systemData

systemData

Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.

tags

object

Etiquetas de recursos.

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

GalleryScriptVersionProperties

Describe las propiedades de una versión de guion de galería.

Nombre Tipo Description
provisioningState

GalleryProvisioningState

Estado de aprovisionamiento, que solo aparece en la respuesta.

publishingProfile

GalleryScriptVersionPublishingProfile

Perfil de publicación de una versión de imagen de la galería.

replicationStatus

ReplicationStatus

Este es el estado de replicación de la versión de la imagen de la galería.

safetyProfile

GalleryScriptVersionSafetyProfile

El perfil de seguridad de la versión del guion de la galería.

GalleryScriptVersionPublishingProfile

Perfil de publicación de una versión de imagen de la galería.

Nombre Tipo Description
endOfLifeDate

string (date-time)

Fecha de finalización del ciclo de vida de la versión de la imagen de la galería. Esta propiedad se puede usar con fines de retirada. Esta propiedad es actualizable.

excludeFromLatest

boolean

Si se establece en true, las máquinas virtuales implementadas desde la versión más reciente de la definición de imagen no usarán esta versión de imagen.

publishedDate

string (date-time)

Marca de tiempo para cuando se publica la versión de la imagen de la galería.

replicaCount

integer (int32)

Número de réplicas de la versión de imagen que se va a crear por región. Esta propiedad surtiría efecto para una región cuando no se especifica regionalReplicaCount. Esta propiedad es actualizable.

replicationMode

ReplicationMode

Parámetro opcional que especifica el modo que se va a usar para la replicación. Esta propiedad no es actualizable.

source

ScriptSource

El script fuente del que se va a crear la versión del guion.

storageAccountStrategy

StorageAccountStrategy

Especifica la estrategia a utilizar al seleccionar el tipo de cuenta de almacenamiento. No se puede especificar junto con storageAccountType, pero puede ser anulado por región especificando targetRegions[].storageAccountType. Esta propiedad no es actualizable.

storageAccountType

StorageAccountType

Especifica el tipo de cuenta de almacenamiento que se va a usar para almacenar la imagen. No se puede especificar junto con storageAccountStrategy. Esta propiedad no es actualizable.

targetExtendedLocations

GalleryTargetExtendedLocation[]

Ubicaciones extendidas de destino en las que se va a replicar la versión de la imagen. Esta propiedad es actualizable.

targetRegions

TargetRegion[]

Las regiones de destino en las que se va a replicar la versión de la imagen. Esta propiedad es actualizable.

GalleryScriptVersionSafetyProfile

El perfil de seguridad de la versión del guion de la galería.

Nombre Tipo Description
allowDeletionOfReplicatedLocations

boolean

Indica si se permite quitar o no esta versión de imagen de la galería de regiones replicadas.

GalleryScriptVersionUpdate

Especifica la información sobre la versión del script de la galería que quieres actualizar.

Nombre Tipo Description
id

string

Identificador de recurso

name

string

Nombre del recurso

properties.provisioningState

GalleryProvisioningState

Estado de aprovisionamiento, que solo aparece en la respuesta.

properties.publishingProfile

GalleryScriptVersionPublishingProfile

Perfil de publicación de una versión de imagen de la galería.

properties.replicationStatus

ReplicationStatus

Este es el estado de replicación de la versión de la imagen de la galería.

properties.safetyProfile

GalleryScriptVersionSafetyProfile

El perfil de seguridad de la versión del guion de la galería.

tags

object

Etiquetas de recursos

type

string

Tipo de recurso

GalleryTargetExtendedLocation

Nombre Tipo Description
encryption

EncryptionImages

Optional. Permite a los usuarios proporcionar claves administradas por el cliente para cifrar los discos de datos y del sistema operativo en el artefacto de la galería.

extendedLocation

GalleryExtendedLocation

Nombre de la ubicación extendida.

extendedLocationReplicaCount

integer (int32)

Número de réplicas de la versión de imagen que se va a crear por ubicación extendida. Esta propiedad es actualizable.

name

string

Nombre de la región.

storageAccountType

EdgeZoneStorageAccountType

Especifica el tipo de cuenta de almacenamiento que se va a usar para almacenar la imagen. Esta propiedad no es actualizable.

InnerError

Detalles del error interno.

Nombre Tipo Description
errordetail

string

Mensaje de error interno o volcado de memoria de excepciones.

exceptiontype

string

Tipo de excepción.

OSDiskImageEncryption

Contiene la configuración de cifrado de una imagen de disco del sistema operativo.

Nombre Tipo Description
diskEncryptionSetId

string

Un URI relativo que contiene el identificador de recurso del conjunto de cifrado de disco.

securityProfile

OSDiskImageSecurityProfile

Esta propiedad especifica el perfil de seguridad de una imagen de disco del sistema operativo.

OSDiskImageSecurityProfile

Contiene el perfil de seguridad de una imagen de disco del sistema operativo.

Nombre Tipo Description
confidentialVMEncryptionType

ConfidentialVMEncryptionType

tipos de cifrado de máquina virtual confidencial

secureVMDiskEncryptionSetId

string

identificador del conjunto de cifrado de disco de máquina virtual segura

RegionalReplicationStatus

Este es el estado de replicación regional.

Nombre Tipo Description
details

string

Detalles del estado de replicación.

progress

integer (int32)

Indica el progreso del trabajo de replicación.

region

string

Región a la que se va a replicar la versión de la imagen de la galería.

state

ReplicationState

Este es el estado de replicación regional.

ReplicationMode

Parámetro opcional que especifica el modo que se va a usar para la replicación. Esta propiedad no es actualizable.

Valor Description
Full
Shallow

ReplicationState

Este es el estado de replicación regional.

Valor Description
Unknown
Replicating
Completed
Failed

ReplicationStatus

Este es el estado de replicación de la versión de la imagen de la galería.

Nombre Tipo Description
aggregatedState

AggregatedReplicationState

Este es el estado de replicación agregado en función de todas las marcas de estado de replicación regional.

summary

RegionalReplicationStatus[]

Este es un resumen del estado de replicación de cada región.

ScriptSource

El script fuente del que se va a crear la versión del guion.

Nombre Tipo Description
parameters

GalleryScriptParameter[]

Optional. Cualquier parámetro de entrada que necesite pasar al script y que se acceda dentro del script para su ejecución.

scriptLink

string

Obligatorio. El enlace del script de origen debe ser un blob de almacenamiento legible con URI SAS o URI de acceso público o identidad gestionada activada.

StorageAccountStrategy

Especifica la estrategia a utilizar al seleccionar el tipo de cuenta de almacenamiento. No se puede especificar junto con storageAccountType, pero puede ser anulado por región especificando targetRegions[].storageAccountType. Esta propiedad no es actualizable.

Valor Description
PreferStandard_ZRS

Elige Standard_ZRS almacenamiento si la región lo permite, de lo contrario elige Standard_LRS almacenamiento, salvo que se sobrescriba especificando el tipo de cuenta de almacenamiento regional. Si no se especifica storageAccountStrategy, esta es la estrategia predeterminada (desde la versión de la API 2025-03-03 en adelante).

DefaultStandard_LRS

Elige Standard_LRS almacenamiento a menos que se anule especificando el almacenamiento regionalTipo de Cuenta.

StorageAccountType

Especifica el tipo de cuenta de almacenamiento que se va a usar para almacenar la imagen. Esta propiedad no es actualizable.

Valor Description
Standard_LRS
Standard_ZRS
Premium_LRS
PremiumV2_LRS

systemData

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string (date-time)

Marca de tiempo de creación de recursos (UTC).

createdBy

string

Identidad que creó el recurso.

createdByType

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt

string (date-time)

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

Identidad que modificó por última vez el recurso.

lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

TargetRegion

Describe la información de la región de destino.

Nombre Tipo Description
additionalReplicaSets

AdditionalReplicaSet[]

Lista de SKU de almacenamiento con recuento de réplicas para crear réplicas de unidad directa.

encryption

EncryptionImages

Optional. Permite a los usuarios proporcionar claves administradas por el cliente para cifrar los discos de datos y del sistema operativo en el artefacto de la galería.

excludeFromLatest

boolean

Contiene la configuración de marca para ocultar una imagen cuando los usuarios especifican version='latest'

name

string

Nombre de la región.

regionalReplicaCount

integer (int32)

Número de réplicas de la versión de imagen que se va a crear por región. Esta propiedad es actualizable.

storageAccountType

StorageAccountType

Especifica el tipo de cuenta de almacenamiento que se va a usar para almacenar la imagen. Esta propiedad no es actualizable.