共用方式為


Gallery Images - Create Or Update

建立或更新資源庫映像定義。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}?api-version=2024-03-03

URI 參數

名稱 位於 必要 類型 Description
galleryImageName
path True

string

要建立或更新的資源庫映像定義名稱。 允許的字元是字母和數位,其中包含中間允許的點、虛線和句點。 最大長度為80個字元。

galleryName
path True

string

要在其中建立映像定義的共用映像庫名稱。

resourceGroupName
path True

string

資源群組的名稱。

subscriptionId
path True

string

可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。

api-version
query True

string

用戶端 API 版本。

要求本文

名稱 必要 類型 Description
location True

string

資源位置

properties.identifier True

GalleryImageIdentifier

這是資源庫映像定義標識碼。

properties.osState True

OperatingSystemStateTypes

此屬性可讓使用者指定在此映射下建立的虛擬機是「一般化」或「特製化」。

properties.osType True

OperatingSystemTypes

這個屬性可讓您指定從受控映射建立 VM 時,磁碟中包含的 OS 類型。 可能的值為:Windows、Linux。

properties.allowUpdateImage

boolean

自選。 如果正在更新資源庫映像功能,則必須設定為 true。

properties.architecture

Architecture

映像的架構。 僅適用於OS磁碟。

properties.description

string

此資源庫映像定義資源的描述。 這個屬性是可更新的。

properties.disallowed

Disallowed

描述不允許的磁碟類型。

properties.endOfLifeDate

string

資源庫映像定義的生命週期結束日期。 這個屬性可用於解除委任用途。 這個屬性是可更新的。

properties.eula

string

資源庫映像定義的 Eula 合約。

properties.features

GalleryImageFeature[]

資源庫映像功能的清單。

properties.hyperVGeneration

HyperVGeneration

虛擬機的 Hypervisor 產生。 僅適用於OS磁碟。

properties.privacyStatementUri

string

隱私聲明 URI。

properties.purchasePlan

ImagePurchasePlan

描述資源庫映像定義購買方案。 Marketplace 映射會使用此映像。

properties.recommended

RecommendedMachineConfiguration

這些屬性描述此映像定義的建議機器組態。 這些屬性是可更新的。

properties.releaseNoteUri

string

版本附註 URI。

tags

object

資源標籤

回應

名稱 類型 Description
200 OK

GalleryImage

還行

201 Created

GalleryImage

創建

202 Accepted

GalleryImage

接受

Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

範例要求

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName?api-version=2024-03-03

{
  "location": "West US",
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    }
  }
}

範例回覆

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName",
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryImageName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName",
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "provisioningState": "Creating"
  },
  "location": "West US",
  "name": "myGalleryImageName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName",
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryImageName"
}

定義

名稱 Description
ApiError

Api 錯誤。

ApiErrorBase

API 錯誤基底。

Architecture

映像的架構。 僅適用於OS磁碟。

CloudError

來自計算服務的錯誤回應。

Disallowed

描述不允許的磁碟類型。

GalleryImage

指定您要建立或更新之資源庫映像定義的相關信息。

GalleryImageFeature

資源庫映像的功能。

GalleryImageIdentifier

這是資源庫映像定義標識碼。

GalleryProvisioningState

資源庫或資源庫成品的目前狀態。

HyperVGeneration

虛擬機的 Hypervisor 產生。 僅適用於OS磁碟。

ImagePurchasePlan

描述資源庫映像定義購買方案。 Marketplace 映射會使用此映像。

InnerError

內部錯誤詳細數據。

OperatingSystemStateTypes

此屬性可讓使用者指定在此映射下建立的虛擬機是「一般化」或「特製化」。

OperatingSystemTypes

這個屬性可讓您指定應用程式所建置之OS的支持類型。 可能的值為:Windows、Linux。

RecommendedMachineConfiguration

這些屬性描述此映像定義的建議機器組態。 這些屬性是可更新的。

ResourceRange

描述資源範圍。

ApiError

Api 錯誤。

名稱 類型 Description
code

string

錯誤碼。

details

ApiErrorBase[]

Api 錯誤詳細數據

innererror

InnerError

Api 內部錯誤

message

string

錯誤訊息。

target

string

特定錯誤的目標。

ApiErrorBase

API 錯誤基底。

名稱 類型 Description
code

string

錯誤碼。

message

string

錯誤訊息。

target

string

特定錯誤的目標。

Architecture

映像的架構。 僅適用於OS磁碟。

名稱 類型 Description
Arm64

string

x64

string

CloudError

來自計算服務的錯誤回應。

名稱 類型 Description
error

ApiError

Api 錯誤。

Disallowed

描述不允許的磁碟類型。

名稱 類型 Description
diskTypes

string[]

磁碟類型的清單。

GalleryImage

指定您要建立或更新之資源庫映像定義的相關信息。

名稱 類型 Description
id

string

資源標識碼

location

string

資源位置

name

string

資源名稱

properties.allowUpdateImage

boolean

自選。 如果正在更新資源庫映像功能,則必須設定為 true。

properties.architecture

Architecture

映像的架構。 僅適用於OS磁碟。

properties.description

string

此資源庫映像定義資源的描述。 這個屬性是可更新的。

properties.disallowed

Disallowed

描述不允許的磁碟類型。

properties.endOfLifeDate

string

資源庫映像定義的生命週期結束日期。 這個屬性可用於解除委任用途。 這個屬性是可更新的。

properties.eula

string

資源庫映像定義的 Eula 合約。

properties.features

GalleryImageFeature[]

資源庫映像功能的清單。

properties.hyperVGeneration

HyperVGeneration

虛擬機的 Hypervisor 產生。 僅適用於OS磁碟。

properties.identifier

GalleryImageIdentifier

這是資源庫映像定義標識碼。

properties.osState

OperatingSystemStateTypes

此屬性可讓使用者指定在此映射下建立的虛擬機是「一般化」或「特製化」。

properties.osType

OperatingSystemTypes

這個屬性可讓您指定從受控映射建立 VM 時,磁碟中包含的 OS 類型。 可能的值為:Windows、Linux。

properties.privacyStatementUri

string

隱私聲明 URI。

properties.provisioningState

GalleryProvisioningState

資源庫或資源庫成品的目前狀態。
只出現在回應中的布建狀態。

properties.purchasePlan

ImagePurchasePlan

描述資源庫映像定義購買方案。 Marketplace 映射會使用此映像。

properties.recommended

RecommendedMachineConfiguration

這些屬性描述此映像定義的建議機器組態。 這些屬性是可更新的。

properties.releaseNoteUri

string

版本附註 URI。

tags

object

資源標籤

type

string

資源類型

GalleryImageFeature

資源庫映像的功能。

名稱 類型 Description
name

string

資源庫映像功能的名稱。

startsAtVersion

string

支援這項功能的最低資源庫映像版本。

value

string

資源庫映像功能的值。

GalleryImageIdentifier

這是資源庫映像定義標識碼。

名稱 類型 Description
offer

string

資源庫映像定義供應項目的名稱。

publisher

string

資源庫映像定義發行者的名稱。

sku

string

資源庫映像定義 SKU 的名稱。

GalleryProvisioningState

資源庫或資源庫成品的目前狀態。

名稱 類型 Description
Creating

string

Deleting

string

Failed

string

Migrating

string

Succeeded

string

Updating

string

HyperVGeneration

虛擬機的 Hypervisor 產生。 僅適用於OS磁碟。

名稱 類型 Description
V1

string

V2

string

ImagePurchasePlan

描述資源庫映像定義購買方案。 Marketplace 映射會使用此映像。

名稱 類型 Description
name

string

方案標識碼。

product

string

產品標識碼。

publisher

string

發行者標識碼。

InnerError

內部錯誤詳細數據。

名稱 類型 Description
errordetail

string

內部錯誤訊息或例外狀況傾印。

exceptiontype

string

例外狀況類型。

OperatingSystemStateTypes

此屬性可讓使用者指定在此映射下建立的虛擬機是「一般化」或「特製化」。

名稱 類型 Description
Generalized

string

Specialized

string

OperatingSystemTypes

這個屬性可讓您指定應用程式所建置之OS的支持類型。 可能的值為:Windows、Linux。

名稱 類型 Description
Linux

string

Windows

string

RecommendedMachineConfiguration

這些屬性描述此映像定義的建議機器組態。 這些屬性是可更新的。

名稱 類型 Description
memory

ResourceRange

描述資源範圍。

vCPUs

ResourceRange

描述資源範圍。

ResourceRange

描述資源範圍。

名稱 類型 Description
max

integer

資源的最大數目。

min

integer

資源數目下限。