Gallery Script Versions - Update
Atualize uma galeria Versão do Script.
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 do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
gallery
|
path | True |
string pattern: ^[^_\W][\w-._]{0,79}(? |
O nome da Galeria de Imagens Compartilhadas. |
|
gallery
|
path | True |
string pattern: ^[a-zA-Z0-9]+([_]?[a-zA-Z0-9]+)*$ |
O nome da galeria Definição de Guião a ser recuperado. |
|
gallery
|
path | True |
string pattern: ^[0-9]+\.[0-9]+\.[0-9]+$ |
O nome da galeria Script Version a ser recuperado. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas. |
|
subscription
|
path | True |
string minLength: 1 |
A ID da assinatura de destino. |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| properties.publishingProfile | True |
O perfil de publicação de uma versão de imagem de galeria. |
|
| properties.safetyProfile |
O perfil de segurança da Versão do Script da Galeria. |
||
| tags |
object |
Etiquetas de recursos |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
Operação do Azure concluída com êxito. |
|
| 202 Accepted |
Pedido de atualização de recursos aceito. Cabeçalhos
|
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
| Name | Description |
|---|---|
| user_impersonation | personificar a sua conta de utilizador |
Exemplos
Update a simple gallery Script Version.
Pedido de amostra
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
}
}
}
Resposta da amostra
{
"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
Definições
| Name | Description |
|---|---|
|
Additional |
Descreve as informações adicionais do conjunto de réplicas. |
|
Aggregated |
Este é o status de replicação agregado com base em todos os sinalizadores de status de replicação regional. |
|
Api |
Erro de api. |
|
Api |
Base de erro da api. |
|
Cloud |
Uma resposta de erro do serviço de computação. |
|
Confidential |
tipos de criptografia de VM confidenciais |
|
created |
O tipo de identidade que criou o recurso. |
|
Data |
Contém configurações de criptografia para uma imagem de disco de dados. |
|
Edge |
Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem. Esta propriedade não é atualizável. |
|
Encryption |
Opcional. Permite que os usuários forneçam chaves gerenciadas pelo cliente para criptografar o sistema operacional e os discos de dados no artefato da galeria. |
|
Gallery |
O nome do local estendido. |
|
Gallery |
É o tipo de local estendido. |
|
Gallery |
O estado de provisionamento, que só aparece na resposta. |
|
Gallery |
A definição de um parâmetro que pode ser passado para um script de uma Versão do Script da Galeria. |
|
Gallery |
Especifica o tipo do parâmetro Gallery Script. Os valores possíveis são: String, Int, Double, Boolean, Enum |
|
Gallery |
Tipos de recursos controlados concretos podem ser criados aliasing esse tipo usando um tipo de propriedade específico. |
|
Gallery |
Descreve as propriedades de uma versão de script de galeria. |
|
Gallery |
O perfil de publicação de uma versão de imagem de galeria. |
|
Gallery |
O perfil de segurança da Versão do Script da Galeria. |
|
Gallery |
Especifica informações sobre a Versão do Script da galeria que pretende atualizar. |
|
Gallery |
|
|
Inner |
Detalhes do erro interno. |
|
OSDisk |
Contém configurações de criptografia para uma imagem de disco do sistema operacional. |
|
OSDisk |
Contém perfil de segurança para uma imagem de disco do SO. |
|
Regional |
Este é o status de replicação regional. |
|
Replication |
Parâmetro opcional que especifica o modo a ser usado para replicação. Esta propriedade não é atualizável. |
|
Replication |
Este é o estado de replicação regional. |
|
Replication |
Este é o status de replicação da versão da imagem da galeria. |
|
Script |
O script de origem a partir do qual a Versão do Script vai ser criada. |
|
Storage |
Especifica a estratégia a usar ao selecionar o tipo de conta de armazenamento. Não pode ser especificado juntamente com storageAccountType, mas pode ser sobreposto por região especificando targetRegions[].storageAccountType. Esta propriedade não é atualizável. |
|
Storage |
Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem. Esta propriedade não é atualizável. |
|
system |
Metadados referentes à criação e última modificação do recurso. |
|
Target |
Descreve as informações da região de destino. |
AdditionalReplicaSet
Descreve as informações adicionais do conjunto de réplicas.
| Name | Tipo | Description |
|---|---|---|
| regionalReplicaCount |
integer (int32) |
O número de réplicas de unidade direta da Versão da Imagem a ser criada. Esta propriedade é atualizável |
| storageAccountType |
Especifica o tipo de conta de armazenamento a ser usado para criar as réplicas de unidade direta |
AggregatedReplicationState
Este é o status de replicação agregado com base em todos os sinalizadores de status de replicação regional.
| Valor | Description |
|---|---|
| Unknown | |
| InProgress | |
| Completed | |
| Failed |
ApiError
Erro de api.
| Name | Tipo | Description |
|---|---|---|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro Api |
|
| innererror |
O erro interno da Api |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O alvo do erro específico. |
ApiErrorBase
Base de erro da api.
| Name | Tipo | Description |
|---|---|---|
| code |
string |
O código de erro. |
| message |
string |
A mensagem de erro. |
| target |
string |
O alvo do erro específico. |
CloudError
Uma resposta de erro do serviço de computação.
| Name | Tipo | Description |
|---|---|---|
| error |
Erro de api. |
ConfidentialVMEncryptionType
tipos de criptografia de VM confidenciais
| Valor | Description |
|---|---|
| EncryptedVMGuestStateOnlyWithPmk | |
| EncryptedWithPmk | |
| EncryptedWithCmk | |
| NonPersistedTPM |
createdByType
O tipo de identidade que criou o recurso.
| Valor | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DataDiskImageEncryption
Contém configurações de criptografia para uma imagem de disco de dados.
| Name | Tipo | Description |
|---|---|---|
| diskEncryptionSetId |
string |
Um URI relativo que contém a ID do recurso do conjunto de criptografia de disco. |
| lun |
integer (int32) |
Esta propriedade especifica o número da unidade lógica do disco de dados. Esse valor é usado para identificar discos de dados dentro da Máquina Virtual e, portanto, deve ser exclusivo para cada disco de dados conectado à Máquina Virtual. |
EdgeZoneStorageAccountType
Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem. Esta propriedade não é atualizável.
| Valor | Description |
|---|---|
| Standard_LRS | |
| Standard_ZRS | |
| StandardSSD_LRS | |
| Premium_LRS |
EncryptionImages
Opcional. Permite que os usuários forneçam chaves gerenciadas pelo cliente para criptografar o sistema operacional e os discos de dados no artefato da galeria.
| Name | Tipo | Description |
|---|---|---|
| dataDiskImages |
Uma lista de especificações de criptografia para imagens de disco de dados. |
|
| osDiskImage |
Contém configurações de criptografia para uma imagem de disco do sistema operacional. |
GalleryExtendedLocation
O nome do local estendido.
| Name | Tipo | Description |
|---|---|---|
| name |
string |
|
| type |
É o tipo de local estendido. |
GalleryExtendedLocationType
É o tipo de local estendido.
| Valor | Description |
|---|---|
| EdgeZone | |
| Unknown |
GalleryProvisioningState
O estado de provisionamento, que só aparece na resposta.
| Valor | Description |
|---|---|
| Creating | |
| Updating | |
| Failed | |
| Succeeded | |
| Deleting | |
| Migrating |
GalleryScriptParameter
A definição de um parâmetro que pode ser passado para um script de uma Versão do Script da Galeria.
| Name | Tipo | Description |
|---|---|---|
| defaultValue |
string |
O valor padrão do parâmetro aplica-se apenas aos tipos de cadeia. |
| description |
string |
Uma descrição para ajudar os usuários a entender o que esse parâmetro significa |
| enumValues |
string[] |
Uma lista de valores permitidos. Os únicos valores aplicáveis provêm dos valores 'enum' definidos em 'GalleryScriptParameter'. |
| maxValue |
string |
O valor mínimo do parâmetro. |
| minValue |
string |
O valor mínimo do parâmetro. |
| name |
string |
O nome do parâmetro. |
| required |
boolean |
Indica se este parâmetro deve ser ultrapassado. |
| type |
Especifica o tipo do parâmetro Gallery Script. Os valores possíveis são: String, Int, Double, Boolean, Enum |
GalleryScriptParameterType
Especifica o tipo do parâmetro Gallery Script. Os valores possíveis são: String, Int, Double, Boolean, Enum
| Valor | Description |
|---|---|
| String |
Tipo de parâmetro de script da galeria de strings |
| Int |
Tipo de parâmetro de script de galeria int |
| Double |
Tipo de parâmetro de script de dupla galeria |
| Boolean |
Tipo de parâmetro de script de galeria booleano |
| Enum |
Tipo de parâmetro de script de galeria de enum |
GalleryScriptVersion
Tipos de recursos controlados concretos podem ser criados aliasing esse tipo usando um tipo de propriedade específico.
| Name | Tipo | Description |
|---|---|---|
| id |
string |
ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
A geolocalização onde o recurso vive |
| name |
string |
O nome do recurso |
| properties |
Descreve as propriedades de uma Versão de Script de galeria. |
|
| systemData |
Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy. |
|
| tags |
object |
Tags de recursos. |
| type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
GalleryScriptVersionProperties
Descreve as propriedades de uma versão de script de galeria.
| Name | Tipo | Description |
|---|---|---|
| provisioningState |
O estado de provisionamento, que só aparece na resposta. |
|
| publishingProfile |
O perfil de publicação de uma versão de imagem de galeria. |
|
| replicationStatus |
Este é o status de replicação da versão da imagem da galeria. |
|
| safetyProfile |
O perfil de segurança da Versão do Script da Galeria. |
GalleryScriptVersionPublishingProfile
O perfil de publicação de uma versão de imagem de galeria.
| Name | Tipo | Description |
|---|---|---|
| endOfLifeDate |
string (date-time) |
A data de fim da vida útil da versão da imagem da galeria. Esta propriedade pode ser usada para fins de descomissionamento. Esta propriedade é atualizável. |
| excludeFromLatest |
boolean |
Se definido como true, as Máquinas Virtuais implantadas a partir da versão mais recente da Definição de Imagem não usarão essa Versão de Imagem. |
| publishedDate |
string (date-time) |
O carimbo de data/hora para quando a versão da imagem da galeria é publicada. |
| replicaCount |
integer (int32) |
O número de réplicas da Versão da Imagem a ser criada por região. Essa propriedade teria efeito para uma região quando regionalReplicaCount não é especificado. Esta propriedade é atualizável. |
| replicationMode |
Parâmetro opcional que especifica o modo a ser usado para replicação. Esta propriedade não é atualizável. |
|
| source |
O script de origem a partir do qual a Versão do Script vai ser criada. |
|
| storageAccountStrategy |
Especifica a estratégia a usar ao selecionar o tipo de conta de armazenamento. Não pode ser especificado juntamente com storageAccountType, mas pode ser sobreposto por região especificando targetRegions[].storageAccountType. Esta propriedade não é atualizável. |
|
| storageAccountType |
Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem. Não pode ser especificado juntamente com storageAccountStrategy. Esta propriedade não é atualizável. |
|
| targetExtendedLocations |
Os locais estendidos de destino para onde a Versão da Imagem será replicada. Esta propriedade é atualizável. |
|
| targetRegions |
As regiões de destino para as quais a Versão da Imagem será replicada. Esta propriedade é atualizável. |
GalleryScriptVersionSafetyProfile
O perfil de segurança da Versão do Script da Galeria.
| Name | Tipo | Description |
|---|---|---|
| allowDeletionOfReplicatedLocations |
boolean |
Indica se a remoção desta Versão da Imagem da Galeria das regiões replicadas é permitida ou não. |
GalleryScriptVersionUpdate
Especifica informações sobre a Versão do Script da galeria que pretende atualizar.
| Name | Tipo | Description |
|---|---|---|
| id |
string |
ID do recurso |
| name |
string |
Nome do recurso |
| properties.provisioningState |
O estado de provisionamento, que só aparece na resposta. |
|
| properties.publishingProfile |
O perfil de publicação de uma versão de imagem de galeria. |
|
| properties.replicationStatus |
Este é o status de replicação da versão da imagem da galeria. |
|
| properties.safetyProfile |
O perfil de segurança da Versão do Script da Galeria. |
|
| tags |
object |
Etiquetas de recursos |
| type |
string |
Tipo de recurso |
GalleryTargetExtendedLocation
| Name | Tipo | Description |
|---|---|---|
| encryption |
Opcional. Permite que os usuários forneçam chaves gerenciadas pelo cliente para criptografar o sistema operacional e os discos de dados no artefato da galeria. |
|
| extendedLocation |
O nome do local estendido. |
|
| extendedLocationReplicaCount |
integer (int32) |
O número de réplicas da Versão da Imagem a ser criada por local estendido. Esta propriedade é atualizável. |
| name |
string |
O nome da região. |
| storageAccountType |
Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem. Esta propriedade não é atualizável. |
InnerError
Detalhes do erro interno.
| Name | Tipo | Description |
|---|---|---|
| errordetail |
string |
A mensagem de erro interna ou despejo de exceção. |
| exceptiontype |
string |
O tipo de exceção. |
OSDiskImageEncryption
Contém configurações de criptografia para uma imagem de disco do sistema operacional.
| Name | Tipo | Description |
|---|---|---|
| diskEncryptionSetId |
string |
Um URI relativo que contém a ID do recurso do conjunto de criptografia de disco. |
| securityProfile |
Esta propriedade especifica o perfil de segurança de uma imagem de disco do sistema operacional. |
OSDiskImageSecurityProfile
Contém perfil de segurança para uma imagem de disco do SO.
| Name | Tipo | Description |
|---|---|---|
| confidentialVMEncryptionType |
tipos de criptografia de VM confidenciais |
|
| secureVMDiskEncryptionSetId |
string |
ID do conjunto de criptografia de disco de VM seguro |
RegionalReplicationStatus
Este é o status de replicação regional.
| Name | Tipo | Description |
|---|---|---|
| details |
string |
Os detalhes do status da replicação. |
| progress |
integer (int32) |
Ele indica o progresso do trabalho de replicação. |
| region |
string |
A região para a qual a versão da imagem da galeria está sendo replicada. |
| state |
Este é o estado de replicação regional. |
ReplicationMode
Parâmetro opcional que especifica o modo a ser usado para replicação. Esta propriedade não é atualizável.
| Valor | Description |
|---|---|
| Full | |
| Shallow |
ReplicationState
Este é o estado de replicação regional.
| Valor | Description |
|---|---|
| Unknown | |
| Replicating | |
| Completed | |
| Failed |
ReplicationStatus
Este é o status de replicação da versão da imagem da galeria.
| Name | Tipo | Description |
|---|---|---|
| aggregatedState |
Este é o status de replicação agregado com base em todos os sinalizadores de status de replicação regional. |
|
| summary |
Este é um resumo do status de replicação para cada região. |
ScriptSource
O script de origem a partir do qual a Versão do Script vai ser criada.
| Name | Tipo | Description |
|---|---|---|
| parameters |
Opcional. Quaisquer parâmetros de entrada que precisem de passar para o script e que sejam acedidos dentro do script para a sua execução. |
|
| scriptLink |
string |
Required. O link do script de origem deve ser um blob de armazenamento legível com URI SAS ou URI acessível publicamente ou identidade gerida ativada. |
StorageAccountStrategy
Especifica a estratégia a usar ao selecionar o tipo de conta de armazenamento. Não pode ser especificado juntamente com storageAccountType, mas pode ser sobreposto por região especificando targetRegions[].storageAccountType. Esta propriedade não é atualizável.
| Valor | Description |
|---|---|
| PreferStandard_ZRS |
Escolha Standard_ZRS armazenamento se a região o suportar, caso contrário escolha Standard_LRS armazenamento, a menos que seja sobreposto especificando o regionalTypeAccountType. Se não for especificado storageAccountStrategy, esta é a estratégia padrão (a partir da versão da API 2025-03-03). |
| DefaultStandard_LRS |
Escolha Standard_LRS armazenamento, a menos que seja sobreposto especificando o storageTypeAccountType regional. |
StorageAccountType
Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem. Esta propriedade não é atualizável.
| Valor | Description |
|---|---|
| Standard_LRS | |
| Standard_ZRS | |
| Premium_LRS | |
| PremiumV2_LRS |
systemData
Metadados referentes à criação e última modificação do recurso.
| Name | Tipo | Description |
|---|---|---|
| createdAt |
string (date-time) |
O carimbo de data/hora da criação de recursos (UTC). |
| createdBy |
string |
A identidade que criou o recurso. |
| createdByType |
O tipo de identidade que criou o recurso. |
|
| lastModifiedAt |
string (date-time) |
O carimbo de data/hora da última modificação do recurso (UTC) |
| lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
| lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |
TargetRegion
Descreve as informações da região de destino.
| Name | Tipo | Description |
|---|---|---|
| additionalReplicaSets |
Lista de sku de armazenamento com contagem de réplicas para criar réplicas diretas de drive. |
|
| encryption |
Opcional. Permite que os usuários forneçam chaves gerenciadas pelo cliente para criptografar o sistema operacional e os discos de dados no artefato da galeria. |
|
| excludeFromLatest |
boolean |
Contém a configuração de sinalizador para ocultar uma imagem quando os usuários especificam version='latest' |
| name |
string |
O nome da região. |
| regionalReplicaCount |
integer (int32) |
O número de réplicas da Versão da Imagem a ser criada por região. Esta propriedade é atualizável. |
| storageAccountType |
Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem. Esta propriedade não é atualizável. |