Gallery Script Versions - Update
Обновите версию сценария галереи.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/scripts/{galleryScriptName}/versions/{galleryScriptVersionName}?api-version=2025-03-03
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
gallery
|
path | True |
string pattern: ^[^_\W][\w-._]{0,79}(? |
Имя Общей галереи изображений. |
|
gallery
|
path | True |
string pattern: ^[a-zA-Z0-9]+([_]?[a-zA-Z0-9]+)*$ |
Название галереи Script Definition будет извлечено. |
|
gallery
|
path | True |
string pattern: ^[0-9]+\.[0-9]+\.[0-9]+$ |
Название галереи — версия сценария, которую нужно получить. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Имя группы ресурсов. Имя не зависит от регистра. |
|
subscription
|
path | True |
string minLength: 1 |
Идентификатор целевой подписки. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Текст запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| properties.publishingProfile | True |
Профиль публикации версии образа коллекции. |
|
| properties.safetyProfile |
Профиль безопасности версии Gallery Script. |
||
| tags |
object |
Теги ресурсов |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Операция Azure успешно завершена. |
|
| 202 Accepted |
Принятый запрос на обновление ресурсов. Заголовки
|
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
Update a simple gallery Script Version.
Образец запроса
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
}
}
}
Пример ответа
{
"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
Определения
| Имя | Описание |
|---|---|
|
Additional |
Описывает дополнительные сведения о наборе реплик. |
|
Aggregated |
Это агрегированное состояние репликации, основанное на всех флагах состояния региональной репликации. |
|
Api |
Ошибка API. |
|
Api |
База ошибок API. |
|
Cloud |
Ответ об ошибке от службы вычислений. |
|
Confidential |
Типы шифрования конфиденциальных виртуальных машин |
|
created |
Тип удостоверения, создавшего ресурс. |
|
Data |
Содержит параметры шифрования для образа диска данных. |
|
Edge |
Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. |
|
Encryption |
Необязательно. Позволяет пользователям предоставлять управляемые клиентом ключи для шифрования дисков ОС и данных в артефакте коллекции. |
|
Gallery |
Имя расширенного расположения. |
|
Gallery |
Тип расширенного расположения. |
|
Gallery |
Состояние подготовки, которое отображается только в ответе. |
|
Gallery |
Определение параметра, который можно передать скрипту Gallery Script Version. |
|
Gallery |
Задаёт тип параметра Gallery Script. Возможные значения: String, Int, Double, Boolean, Enum |
|
Gallery |
Конкретные отслеживаемые типы ресурсов можно создать путем псевдонима этого типа с помощью определенного типа свойства. |
|
Gallery |
Описывает свойства версии галерейного сценария. |
|
Gallery |
Профиль публикации версии образа коллекции. |
|
Gallery |
Профиль безопасности версии Gallery Script. |
|
Gallery |
Указывает информацию о версии скрипта галереи, которую вы хотите обновить. |
|
Gallery |
|
|
Inner |
Сведения о внутренней ошибке. |
|
OSDisk |
Содержит параметры шифрования для образа диска ОС. |
|
OSDisk |
Содержит профиль безопасности для образа диска ОС. |
|
Regional |
Это состояние региональной репликации. |
|
Replication |
Необязательный параметр, указывающий режим, используемый для репликации. Это свойство не является обновляемым. |
|
Replication |
Это региональное состояние репликации. |
|
Replication |
Это состояние репликации версии образа галереи. |
|
Script |
Исходный скрипт, из которого будет создана версия сценария. |
|
Storage |
Указывает стратегию, которую следует использовать при выборе типа аккаунта хранения. Нельзя указывать вместе с storageAccountType, но может быть переопределен по регионам, указав targetRegions[].storageAccountType. Это свойство не является обновляемым. |
|
Storage |
Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. |
|
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
|
Target |
Описывает сведения о целевом регионе. |
AdditionalReplicaSet
Описывает дополнительные сведения о наборе реплик.
| Имя | Тип | Описание |
|---|---|---|
| regionalReplicaCount |
integer (int32) |
Количество реплик прямого диска создаваемой версии образа. Это свойство является обновляемым |
| storageAccountType |
Указывает тип учетной записи хранения, используемый для создания реплик прямого диска |
AggregatedReplicationState
Это агрегированное состояние репликации, основанное на всех флагах состояния региональной репликации.
| Значение | Описание |
|---|---|
| Unknown | |
| InProgress | |
| Completed | |
| Failed |
ApiError
Ошибка API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке Api |
|
| innererror |
Внутренняя ошибка Api |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект конкретной ошибки. |
ApiErrorBase
База ошибок API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект конкретной ошибки. |
CloudError
Ответ об ошибке от службы вычислений.
| Имя | Тип | Описание |
|---|---|---|
| error |
Ошибка API. |
ConfidentialVMEncryptionType
Типы шифрования конфиденциальных виртуальных машин
| Значение | Описание |
|---|---|
| EncryptedVMGuestStateOnlyWithPmk | |
| EncryptedWithPmk | |
| EncryptedWithCmk | |
| NonPersistedTPM |
createdByType
Тип удостоверения, создавшего ресурс.
| Значение | Описание |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DataDiskImageEncryption
Содержит параметры шифрования для образа диска данных.
| Имя | Тип | Описание |
|---|---|---|
| diskEncryptionSetId |
string |
Относительный URI, содержащий идентификатор ресурса набора шифрования дисков. |
| lun |
integer (int32) |
Это свойство указывает логическую единицу диска данных. Это значение используется для идентификации дисков данных в виртуальной машине и поэтому должно быть уникальным для каждого диска данных, подключенного к виртуальной машине. |
EdgeZoneStorageAccountType
Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым.
| Значение | Описание |
|---|---|
| Standard_LRS | |
| Standard_ZRS | |
| StandardSSD_LRS | |
| Premium_LRS |
EncryptionImages
Необязательно. Позволяет пользователям предоставлять управляемые клиентом ключи для шифрования дисков ОС и данных в артефакте коллекции.
| Имя | Тип | Описание |
|---|---|---|
| dataDiskImages |
Список спецификаций шифрования для образов дисков данных. |
|
| osDiskImage |
Содержит параметры шифрования для образа диска ОС. |
GalleryExtendedLocation
Имя расширенного расположения.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
|
| type |
Тип расширенного расположения. |
GalleryExtendedLocationType
Тип расширенного расположения.
| Значение | Описание |
|---|---|
| EdgeZone | |
| Unknown |
GalleryProvisioningState
Состояние подготовки, которое отображается только в ответе.
| Значение | Описание |
|---|---|
| Creating | |
| Updating | |
| Failed | |
| Succeeded | |
| Deleting | |
| Migrating |
GalleryScriptParameter
Определение параметра, который можно передать скрипту Gallery Script Version.
| Имя | Тип | Описание |
|---|---|---|
| defaultValue |
string |
Значение параметра по умолчанию применяется только к типам строк. |
| description |
string |
Описание, помогающий пользователям понять, что это означает этот параметр. |
| enumValues |
string[] |
Список допустимых ценностей. Единственные применимые значения взяты из 'enum', определённых в 'GalleryScriptParameter'. |
| maxValue |
string |
Минимальное значение параметра. |
| minValue |
string |
Минимальное значение параметра. |
| name |
string |
Имя параметра. |
| required |
boolean |
Указывает, нужно ли передавать этот параметр. |
| type |
Задаёт тип параметра Gallery Script. Возможные значения: String, Int, Double, Boolean, Enum |
GalleryScriptParameterType
Задаёт тип параметра Gallery Script. Возможные значения: String, Int, Double, Boolean, Enum
| Значение | Описание |
|---|---|
| String |
Тип параметра скрипта галереи строк |
| Int |
Тип параметра скрипта галереи Int |
| Double |
Тип параметра двойного галерейного скрипта |
| Boolean |
Тип параметра скрипта булевой галереи |
| Enum |
Тип параметра скрипта галереи Enum |
GalleryScriptVersion
Конкретные отслеживаемые типы ресурсов можно создать путем псевдонима этого типа с помощью определенного типа свойства.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
Географическое расположение, в котором находится ресурс |
| name |
string |
Имя ресурса |
| properties |
Описывает свойства галерейной версии сценария. |
|
| systemData |
Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy. |
|
| tags |
object |
Теги ресурсов. |
| type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
GalleryScriptVersionProperties
Описывает свойства версии галерейного сценария.
| Имя | Тип | Описание |
|---|---|---|
| provisioningState |
Состояние подготовки, которое отображается только в ответе. |
|
| publishingProfile |
Профиль публикации версии образа коллекции. |
|
| replicationStatus |
Это состояние репликации версии образа галереи. |
|
| safetyProfile |
Профиль безопасности версии Gallery Script. |
GalleryScriptVersionPublishingProfile
Профиль публикации версии образа коллекции.
| Имя | Тип | Описание |
|---|---|---|
| endOfLifeDate |
string (date-time) |
Дата окончания срока действия версии образа коллекции. Это свойство можно использовать для вывода из эксплуатации. Это свойство является обновляемым. |
| excludeFromLatest |
boolean |
Если задано значение true, виртуальные машины, развернутые из последней версии определения образа, не будут использовать эту версию образа. |
| publishedDate |
string (date-time) |
Метка времени публикации версии изображения галереи. |
| replicaCount |
integer (int32) |
Количество реплик версии образа для каждого региона. Это свойство вступит в силу для региона, если регионReplicaCount не указан. Это свойство является обновляемым. |
| replicationMode |
Необязательный параметр, указывающий режим, используемый для репликации. Это свойство не является обновляемым. |
|
| source |
Исходный скрипт, из которого будет создана версия сценария. |
|
| storageAccountStrategy |
Указывает стратегию, которую следует использовать при выборе типа аккаунта хранения. Нельзя указывать вместе с storageAccountType, но может быть переопределен по регионам, указав targetRegions[].storageAccountType. Это свойство не является обновляемым. |
|
| storageAccountType |
Указывает тип учетной записи хранения, используемый для хранения образа. Не может быть указано вместе с storageAccountStrategy. Это свойство не является обновляемым. |
|
| targetExtendedLocations |
Целевые расширенные расположения, в которых будет реплицироваться версия образа. Это свойство является обновляемым. |
|
| targetRegions |
Целевые регионы, в которых будет реплицироваться версия образа. Это свойство является обновляемым. |
GalleryScriptVersionSafetyProfile
Профиль безопасности версии Gallery Script.
| Имя | Тип | Описание |
|---|---|---|
| allowDeletionOfReplicatedLocations |
boolean |
Указывает, разрешено ли удаление этой версии образа коллекции из реплицированных регионов. |
GalleryScriptVersionUpdate
Указывает информацию о версии скрипта галереи, которую вы хотите обновить.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса |
| name |
string |
Имя ресурса |
| properties.provisioningState |
Состояние подготовки, которое отображается только в ответе. |
|
| properties.publishingProfile |
Профиль публикации версии образа коллекции. |
|
| properties.replicationStatus |
Это состояние репликации версии образа галереи. |
|
| properties.safetyProfile |
Профиль безопасности версии Gallery Script. |
|
| tags |
object |
Теги ресурсов |
| type |
string |
Тип ресурса |
GalleryTargetExtendedLocation
| Имя | Тип | Описание |
|---|---|---|
| encryption |
Необязательно. Позволяет пользователям предоставлять управляемые клиентом ключи для шифрования дисков ОС и данных в артефакте коллекции. |
|
| extendedLocation |
Имя расширенного расположения. |
|
| extendedLocationReplicaCount |
integer (int32) |
Количество реплик версии образа для каждого расширенного расположения. Это свойство является обновляемым. |
| name |
string |
Имя региона. |
| storageAccountType |
Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. |
InnerError
Сведения о внутренней ошибке.
| Имя | Тип | Описание |
|---|---|---|
| errordetail |
string |
Внутреннее сообщение об ошибке или дамп исключений. |
| exceptiontype |
string |
Тип исключения. |
OSDiskImageEncryption
Содержит параметры шифрования для образа диска ОС.
| Имя | Тип | Описание |
|---|---|---|
| diskEncryptionSetId |
string |
Относительный URI, содержащий идентификатор ресурса набора шифрования дисков. |
| securityProfile |
Это свойство указывает профиль безопасности образа диска ОС. |
OSDiskImageSecurityProfile
Содержит профиль безопасности для образа диска ОС.
| Имя | Тип | Описание |
|---|---|---|
| confidentialVMEncryptionType |
Типы шифрования конфиденциальных виртуальных машин |
|
| secureVMDiskEncryptionSetId |
string |
Идентификатор набора шифрования дисков защищенной виртуальной машины |
RegionalReplicationStatus
Это состояние региональной репликации.
| Имя | Тип | Описание |
|---|---|---|
| details |
string |
Сведения о состоянии репликации. |
| progress |
integer (int32) |
Он указывает на ход выполнения задания репликации. |
| region |
string |
Область, в которую реплицируется версия образа галереи. |
| state |
Это региональное состояние репликации. |
ReplicationMode
Необязательный параметр, указывающий режим, используемый для репликации. Это свойство не является обновляемым.
| Значение | Описание |
|---|---|
| Full | |
| Shallow |
ReplicationState
Это региональное состояние репликации.
| Значение | Описание |
|---|---|
| Unknown | |
| Replicating | |
| Completed | |
| Failed |
ReplicationStatus
Это состояние репликации версии образа галереи.
| Имя | Тип | Описание |
|---|---|---|
| aggregatedState |
Это агрегированное состояние репликации, основанное на всех флагах состояния региональной репликации. |
|
| summary |
Это сводка состояния репликации для каждого региона. |
ScriptSource
Исходный скрипт, из которого будет создана версия сценария.
| Имя | Тип | Описание |
|---|---|---|
| parameters |
Необязательно. Любые входные параметры, которые нужно передать скрипту и которые доступны внутри скрипта для его выполнения. |
|
| scriptLink |
string |
Обязательное. Ссылка исходного скрипта должна быть читаемым блоком хранения с включённым SAS URI или публично доступным URI или управляемой идентичностью. |
StorageAccountStrategy
Указывает стратегию, которую следует использовать при выборе типа аккаунта хранения. Нельзя указывать вместе с storageAccountType, но может быть переопределен по регионам, указав targetRegions[].storageAccountType. Это свойство не является обновляемым.
| Значение | Описание |
|---|---|
| PreferStandard_ZRS |
Выберите Standard_ZRS хранилище, если регион это поддерживает, иначе выберите Standard_LRS хранилище, если только это не будет переопределено с указанием регионального хранилищаAccountType. Если storageAccountStrategy не указана, это стандартная стратегия (начиная с версии API 2025-03-03). |
| DefaultStandard_LRS |
Выберите Standard_LRS хранилище, если оно не переопределено, указав региональное хранилищеAccountType. |
StorageAccountType
Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым.
| Значение | Описание |
|---|---|
| Standard_LRS | |
| Standard_ZRS | |
| Premium_LRS | |
| PremiumV2_LRS |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
| Имя | Тип | Описание |
|---|---|---|
| createdAt |
string (date-time) |
Метка времени создания ресурса (UTC). |
| createdBy |
string |
Удостоверение, создающее ресурс. |
| createdByType |
Тип удостоверения, создавшего ресурс. |
|
| lastModifiedAt |
string (date-time) |
Метка времени последнего изменения ресурса (UTC) |
| lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
| lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |
TargetRegion
Описывает сведения о целевом регионе.
| Имя | Тип | Описание |
|---|---|---|
| additionalReplicaSets |
Список SKU хранилища с числом реплик для создания реплик прямого диска. |
|
| encryption |
Необязательно. Позволяет пользователям предоставлять управляемые клиентом ключи для шифрования дисков ОС и данных в артефакте коллекции. |
|
| excludeFromLatest |
boolean |
Содержит параметр флага, чтобы скрыть изображение, когда пользователи указывают version='latest' |
| name |
string |
Имя региона. |
| regionalReplicaCount |
integer (int32) |
Количество реплик версии образа для каждого региона. Это свойство является обновляемым. |
| storageAccountType |
Указывает тип учетной записи хранения, используемый для хранения образа. Это свойство не является обновляемым. |