Dela via


Gallery Script Versions - Update

Uppdatera ett galleriskript version.

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

URI-parametrar

Name I Obligatorisk Typ Description
galleryName
path True

string

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

Namnet på det delade bildgalleriet.

galleryScriptName
path True

string

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

Namnet på galleriet Skriptdefinition som ska hämtas.

galleryScriptVersionName
path True

string

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

Namnet på galleriet Skriptversion som ska hämtas.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

minLength: 1

ID för målprenumerationen.

api-version
query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name Obligatorisk Typ Description
properties.publishingProfile True

GalleryScriptVersionPublishingProfile

Publiceringsprofilen för en galleribildversion.

properties.safetyProfile

GalleryScriptVersionSafetyProfile

Säkerhetsprofilen för galleriskriptversionen.

tags

object

Resursetiketter

Svar

Name Typ Description
200 OK

GalleryScriptVersion

Azure-åtgärden har slutförts.

202 Accepted

Begäran om resursuppdatering har godkänts.

Sidhuvuden

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

CloudError

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AdditionalReplicaSet

Beskriver ytterligare information om replikuppsättningen.

AggregatedReplicationState

Det här är den aggregerade replikeringsstatusen baserat på alla regionala replikeringsstatusflaggor.

ApiError

Api-fel.

ApiErrorBase

Api-felbas.

CloudError

Ett felsvar från Compute-tjänsten.

ConfidentialVMEncryptionType

krypteringstyper för konfidentiella virtuella datorer

createdByType

Den typ av identitet som skapade resursen.

DataDiskImageEncryption

Innehåller krypteringsinställningar för en datadiskbild.

EdgeZoneStorageAccountType

Anger vilken lagringskontotyp som ska användas för att lagra avbildningen. Den här egenskapen är inte uppdaterad.

EncryptionImages

Valfritt. Tillåter användare att tillhandahålla kundhanterade nycklar för kryptering av operativsystemet och datadiskarna i galleriartefakten.

GalleryExtendedLocation

Namnet på den utökade platsen.

GalleryExtendedLocationType

Det är typen av utökad plats.

GalleryProvisioningState

Etableringstillståndet, som bara visas i svaret.

GalleryScriptParameter

Definitionen av en parameter som kan skickas till ett skript i en Gallery Script Version.

GalleryScriptParameterType

Specificerar typen av parametern Gallery Script. Möjliga värden är: Sträng, Int, Dubbel, Boolesk, Enum

GalleryScriptVersion

Konkreta spårade resurstyper kan skapas genom att aliasisera den här typen med hjälp av en specifik egenskapstyp.

GalleryScriptVersionProperties

Beskriver egenskaperna hos en galleriskriptversion.

GalleryScriptVersionPublishingProfile

Publiceringsprofilen för en galleribildversion.

GalleryScriptVersionSafetyProfile

Säkerhetsprofilen för galleriskriptversionen.

GalleryScriptVersionUpdate

Specificerar information om den galleriskriptversion du vill uppdatera.

GalleryTargetExtendedLocation
InnerError

Inre felinformation.

OSDiskImageEncryption

Innehåller krypteringsinställningar för en OS-diskavbildning.

OSDiskImageSecurityProfile

Innehåller säkerhetsprofil för en OS-diskavbildning.

RegionalReplicationStatus

Det här är den regionala replikeringsstatusen.

ReplicationMode

Valfri parameter som anger det läge som ska användas för replikering. Den här egenskapen är inte uppdaterad.

ReplicationState

Det här är det regionala replikeringstillståndet.

ReplicationStatus

Det här är replikeringsstatusen för galleribildversionen.

ScriptSource

Källskriptet som Script Version ska skapas från.

StorageAccountStrategy

Specificerar strategin som ska användas vid val av lagringskontotyp. Kan inte specificeras tillsammans med storageAccountType, men kan åsidosättas per region genom att ange targetRegions[].storageAccountType. Den här egenskapen är inte uppdaterad.

StorageAccountType

Anger vilken lagringskontotyp som ska användas för att lagra avbildningen. Den här egenskapen är inte uppdaterad.

systemData

Metadata som rör skapande och senaste ändring av resursen.

TargetRegion

Beskriver information om målregionen.

AdditionalReplicaSet

Beskriver ytterligare information om replikuppsättningen.

Name Typ Description
regionalReplicaCount

integer (int32)

Antalet direktenhetsrepliker av avbildningsversionen som ska skapas. Den här egenskapen är uppdaterad

storageAccountType

StorageAccountType

Anger vilken lagringskontotyp som ska användas för att skapa direktenhetsrepliker

AggregatedReplicationState

Det här är den aggregerade replikeringsstatusen baserat på alla regionala replikeringsstatusflaggor.

Värde Description
Unknown
InProgress
Completed
Failed

ApiError

Api-fel.

Name Typ Description
code

string

Felkoden.

details

ApiErrorBase[]

Api-felinformationen

innererror

InnerError

Api:ets inre fel

message

string

Felmeddelandet.

target

string

Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name Typ Description
code

string

Felkoden.

message

string

Felmeddelandet.

target

string

Målet för det specifika felet.

CloudError

Ett felsvar från Compute-tjänsten.

Name Typ Description
error

ApiError

Api-fel.

ConfidentialVMEncryptionType

krypteringstyper för konfidentiella virtuella datorer

Värde Description
EncryptedVMGuestStateOnlyWithPmk
EncryptedWithPmk
EncryptedWithCmk
NonPersistedTPM

createdByType

Den typ av identitet som skapade resursen.

Värde Description
User
Application
ManagedIdentity
Key

DataDiskImageEncryption

Innehåller krypteringsinställningar för en datadiskbild.

Name Typ Description
diskEncryptionSetId

string

En relativ URI som innehåller resurs-ID för diskkrypteringsuppsättningen.

lun

integer (int32)

Den här egenskapen anger datadiskens logiska enhetsnummer. Det här värdet används för att identifiera datadiskar i den virtuella datorn och måste därför vara unikt för varje datadisk som är ansluten till den virtuella datorn.

EdgeZoneStorageAccountType

Anger vilken lagringskontotyp som ska användas för att lagra avbildningen. Den här egenskapen är inte uppdaterad.

Värde Description
Standard_LRS
Standard_ZRS
StandardSSD_LRS
Premium_LRS

EncryptionImages

Valfritt. Tillåter användare att tillhandahålla kundhanterade nycklar för kryptering av operativsystemet och datadiskarna i galleriartefakten.

Name Typ Description
dataDiskImages

DataDiskImageEncryption[]

En lista över krypteringsspecifikationer för datadiskbilder.

osDiskImage

OSDiskImageEncryption

Innehåller krypteringsinställningar för en OS-diskavbildning.

GalleryExtendedLocation

Namnet på den utökade platsen.

Name Typ Description
name

string

type

GalleryExtendedLocationType

Det är typen av utökad plats.

GalleryExtendedLocationType

Det är typen av utökad plats.

Värde Description
EdgeZone
Unknown

GalleryProvisioningState

Etableringstillståndet, som bara visas i svaret.

Värde Description
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GalleryScriptParameter

Definitionen av en parameter som kan skickas till ett skript i en Gallery Script Version.

Name Typ Description
defaultValue

string

Standardvärdet för parametern gäller endast för strängtyper.

description

string

En beskrivning som hjälper användarna att förstå vad den här parametern innebär

enumValues

string[]

En lista över tillåtna värden. Endast tillämpliga värden är från 'enum'-värden definierade i 'GalleryScriptParameter'.

maxValue

string

Minimivärdet av parametern.

minValue

string

Minimivärdet av parametern.

name

string

Namnet på parametern.

required

boolean

Anger om denna parameter måste passeras.

type

GalleryScriptParameterType

Specificerar typen av parametern Gallery Script. Möjliga värden är: Sträng, Int, Dubbel, Boolesk, Enum

GalleryScriptParameterType

Specificerar typen av parametern Gallery Script. Möjliga värden är: Sträng, Int, Dubbel, Boolesk, Enum

Värde Description
String

Parametertyp för stränggalleriskript

Int

Int gallery-skriptparametertyp

Double

Dubbelgalleriskriptparametertyp

Boolean

Boolesk galleriskriptparametertyp

Enum

Enum gallery skriptparametertyp

GalleryScriptVersion

Konkreta spårade resurstyper kan skapas genom att aliasisera den här typen med hjälp av en specifik egenskapstyp.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties

GalleryScriptVersionProperties

Beskriver egenskaperna hos en galleriskriptversion.

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

tags

object

Resursetiketter.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

GalleryScriptVersionProperties

Beskriver egenskaperna hos en galleriskriptversion.

Name Typ Description
provisioningState

GalleryProvisioningState

Etableringstillståndet, som bara visas i svaret.

publishingProfile

GalleryScriptVersionPublishingProfile

Publiceringsprofilen för en galleribildversion.

replicationStatus

ReplicationStatus

Det här är replikeringsstatusen för galleribildversionen.

safetyProfile

GalleryScriptVersionSafetyProfile

Säkerhetsprofilen för galleriskriptversionen.

GalleryScriptVersionPublishingProfile

Publiceringsprofilen för en galleribildversion.

Name Typ Description
endOfLifeDate

string (date-time)

Slutdatumet för galleribildversionen. Den här egenskapen kan användas för avaktivering. Den här egenskapen är uppdaterad.

excludeFromLatest

boolean

Om värdet är true använder virtuella datorer som distribuerats från den senaste versionen av avbildningsdefinitionen inte den här avbildningsversionen.

publishedDate

string (date-time)

Tidsstämpeln för när galleriavbildningsversionen publiceras.

replicaCount

integer (int32)

Antalet repliker av avbildningsversionen som ska skapas per region. Den här egenskapen träder i kraft för en region när regionalReplicaCount inte har angetts. Den här egenskapen är uppdaterad.

replicationMode

ReplicationMode

Valfri parameter som anger det läge som ska användas för replikering. Den här egenskapen är inte uppdaterad.

source

ScriptSource

Källskriptet som Script Version ska skapas från.

storageAccountStrategy

StorageAccountStrategy

Specificerar strategin som ska användas vid val av lagringskontotyp. Kan inte specificeras tillsammans med storageAccountType, men kan åsidosättas per region genom att ange targetRegions[].storageAccountType. Den här egenskapen är inte uppdaterad.

storageAccountType

StorageAccountType

Anger vilken lagringskontotyp som ska användas för att lagra avbildningen. Kan inte specificeras tillsammans med storageAccountStrategy. Den här egenskapen är inte uppdaterad.

targetExtendedLocations

GalleryTargetExtendedLocation[]

De utökade målplatserna där avbildningsversionen ska replikeras till. Den här egenskapen är uppdaterad.

targetRegions

TargetRegion[]

Målregionerna där avbildningsversionen ska replikeras till. Den här egenskapen är uppdaterad.

GalleryScriptVersionSafetyProfile

Säkerhetsprofilen för galleriskriptversionen.

Name Typ Description
allowDeletionOfReplicatedLocations

boolean

Anger om det är tillåtet att ta bort den här galleribildversionen från replikerade regioner.

GalleryScriptVersionUpdate

Specificerar information om den galleriskriptversion du vill uppdatera.

Name Typ Description
id

string

Resurs-ID

name

string

Resursnamn

properties.provisioningState

GalleryProvisioningState

Etableringstillståndet, som bara visas i svaret.

properties.publishingProfile

GalleryScriptVersionPublishingProfile

Publiceringsprofilen för en galleribildversion.

properties.replicationStatus

ReplicationStatus

Det här är replikeringsstatusen för galleribildversionen.

properties.safetyProfile

GalleryScriptVersionSafetyProfile

Säkerhetsprofilen för galleriskriptversionen.

tags

object

Resursetiketter

type

string

Resurstyp

GalleryTargetExtendedLocation

Name Typ Description
encryption

EncryptionImages

Valfritt. Tillåter användare att tillhandahålla kundhanterade nycklar för kryptering av operativsystemet och datadiskarna i galleriartefakten.

extendedLocation

GalleryExtendedLocation

Namnet på den utökade platsen.

extendedLocationReplicaCount

integer (int32)

Antalet repliker av avbildningsversionen som ska skapas per utökad plats. Den här egenskapen är uppdaterad.

name

string

Namnet på regionen.

storageAccountType

EdgeZoneStorageAccountType

Anger vilken lagringskontotyp som ska användas för att lagra avbildningen. Den här egenskapen är inte uppdaterad.

InnerError

Inre felinformation.

Name Typ Description
errordetail

string

Det interna felmeddelandet eller undantagsdumpen.

exceptiontype

string

Undantagstypen.

OSDiskImageEncryption

Innehåller krypteringsinställningar för en OS-diskavbildning.

Name Typ Description
diskEncryptionSetId

string

En relativ URI som innehåller resurs-ID för diskkrypteringsuppsättningen.

securityProfile

OSDiskImageSecurityProfile

Den här egenskapen anger säkerhetsprofilen för en OS-diskavbildning.

OSDiskImageSecurityProfile

Innehåller säkerhetsprofil för en OS-diskavbildning.

Name Typ Description
confidentialVMEncryptionType

ConfidentialVMEncryptionType

krypteringstyper för konfidentiella virtuella datorer

secureVMDiskEncryptionSetId

string

skydda ID för VM-diskkrypteringsuppsättning

RegionalReplicationStatus

Det här är den regionala replikeringsstatusen.

Name Typ Description
details

string

Information om replikeringsstatusen.

progress

integer (int32)

Det anger förloppet för replikeringsjobbet.

region

string

Den region som galleribildversionen replikeras till.

state

ReplicationState

Det här är det regionala replikeringstillståndet.

ReplicationMode

Valfri parameter som anger det läge som ska användas för replikering. Den här egenskapen är inte uppdaterad.

Värde Description
Full
Shallow

ReplicationState

Det här är det regionala replikeringstillståndet.

Värde Description
Unknown
Replicating
Completed
Failed

ReplicationStatus

Det här är replikeringsstatusen för galleribildversionen.

Name Typ Description
aggregatedState

AggregatedReplicationState

Det här är den aggregerade replikeringsstatusen baserat på alla regionala replikeringsstatusflaggor.

summary

RegionalReplicationStatus[]

Det här är en sammanfattning av replikeringsstatusen för varje region.

ScriptSource

Källskriptet som Script Version ska skapas från.

Name Typ Description
parameters

GalleryScriptParameter[]

Valfritt. Alla indataparametrar som behöver skickas till skriptet och nås inom skriptet för dess exekvering.

scriptLink

string

Obligatoriskt. Länken till källskriptet, det måste vara en läsbar lagringsblob med SAS URI eller offentligt tillgänglig URI eller hanterad identitet aktiverad.

StorageAccountStrategy

Specificerar strategin som ska användas vid val av lagringskontotyp. Kan inte specificeras tillsammans med storageAccountType, men kan åsidosättas per region genom att ange targetRegions[].storageAccountType. Den här egenskapen är inte uppdaterad.

Värde Description
PreferStandard_ZRS

Välj Standard_ZRS lagring om regionen stödjer det, annars välj Standard_LRS lagring, om det inte åsidosätts genom att ange regional storageAccountType. Om ingen storageAccountStrategy specificeras är detta standardstrategin (från API-version 2025-03-03 och framåt).

DefaultStandard_LRS

Välj Standard_LRS lagring om det inte åsidosätts genom att ange regional storageAccountType.

StorageAccountType

Anger vilken lagringskontotyp som ska användas för att lagra avbildningen. Den här egenskapen är inte uppdaterad.

Värde Description
Standard_LRS
Standard_ZRS
Premium_LRS
PremiumV2_LRS

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string (date-time)

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

TargetRegion

Beskriver information om målregionen.

Name Typ Description
additionalReplicaSets

AdditionalReplicaSet[]

Lista över lagrings-SKU med antal repliker för att skapa direktenhetsrepliker.

encryption

EncryptionImages

Valfritt. Tillåter användare att tillhandahålla kundhanterade nycklar för kryptering av operativsystemet och datadiskarna i galleriartefakten.

excludeFromLatest

boolean

Innehåller flagginställningen för att dölja en bild när användare anger version='senaste'

name

string

Namnet på regionen.

regionalReplicaCount

integer (int32)

Antalet repliker av avbildningsversionen som ska skapas per region. Den här egenskapen är uppdaterad.

storageAccountType

StorageAccountType

Anger vilken lagringskontotyp som ska användas för att lagra avbildningen. Den här egenskapen är inte uppdaterad.