Virtual Machine Scale Set Extensions - Update
更新延伸模組的作業。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}?api-version=2024-07-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
資源群組的名稱。 |
subscription
|
path | True |
string |
可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。 |
vm
|
path | True |
string |
應更新擴充功能的 VM 擴展集名稱。 |
vmss
|
path | True |
string |
VM 擴展集擴充功能的名稱。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
properties.autoUpgradeMinorVersion |
boolean |
指出如果部署期間有新的次要版本,擴充功能是否應該使用較新的次要版本。 不過,部署之後,除非重新部署,否則擴充功能不會升級次要版本,即使此屬性設定為 true 也一定會升級。 |
properties.enableAutomaticUpgrade |
boolean |
指出如果有較新版本的延伸模組可用,平臺是否應該自動升級延伸模組。 |
properties.forceUpdateTag |
string |
如果提供值,且與先前的值不同,即使延伸模組組態尚未變更,擴充處理程式仍會強制更新。 |
properties.protectedSettings |
object |
延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 |
properties.protectedSettingsFromKeyVault |
以傳址方式傳遞的延伸模組受保護設定,並從金鑰保存庫取用 |
|
properties.provisionAfterExtensions |
string[] |
必須布建此延伸模組之後的延伸模組名稱集合。 |
properties.publisher |
string |
擴充處理程序發行者的名稱。 |
properties.settings |
object |
擴充功能的 Json 格式化公用設定。 |
properties.suppressFailures |
boolean |
指出延伸模組產生的失敗是否會隱藏(不論此值為何,無法連線到 VM 等作業失敗)。 默認值為 false。 |
properties.type |
string |
指定延伸模組的類型;例如“CustomScriptExtension”。 |
properties.typeHandlerVersion |
string |
指定文稿處理程式的版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
還行 |
|
201 Created |
創建 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Virtual |
Virtual |
VirtualMachineScaleSetExtension_Update_MaximumSet_Gen
範例要求
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaa?api-version=2024-07-01
{
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
}
}
範例回覆
{
"name": "{extension-name}",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisioningState": "aaa",
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
},
"type": "aaaaaaaaaaaaaaaaaaaaaaaa",
"id": "aaaaaaaa"
}
location: https://foo.com/operationstatus
{
"name": "{extension-name}",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisioningState": "aaa",
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
},
"type": "aaaaaaaaaaaaaaaaaaaaaaaa",
"id": "aaaaaaaa"
}
VirtualMachineScaleSetExtension_Update_MinimumSet_Gen
範例要求
範例回覆
{}
location: https://foo.com/operationstatus
{}
定義
名稱 | Description |
---|---|
Api |
Api 錯誤。 |
Api |
API 錯誤基底。 |
Cloud |
來自計算服務的錯誤回應。 |
Inner |
內部錯誤詳細數據。 |
Key |
描述 Key Vault 秘密的參考 |
Sub |
|
Virtual |
描述虛擬機擴展集擴充功能。 |
Virtual |
描述虛擬機擴展集擴充功能。 |
ApiError
Api 錯誤。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
details |
Api 錯誤詳細數據 |
|
innererror |
Api 內部錯誤 |
|
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
ApiErrorBase
API 錯誤基底。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
CloudError
來自計算服務的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error |
Api 錯誤。 |
InnerError
內部錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
errordetail |
string |
內部錯誤訊息或例外狀況傾印。 |
exceptiontype |
string |
例外狀況類型。 |
KeyVaultSecretReference
描述 Key Vault 秘密的參考
名稱 | 類型 | Description |
---|---|---|
secretUrl |
string |
參考 Key Vault 中秘密的 URL。 |
sourceVault |
包含秘密之 Key Vault 的相對 URL。 |
SubResource
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
VirtualMachineScaleSetExtension
描述虛擬機擴展集擴充功能。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
name |
string |
延伸模組的名稱。 |
properties.autoUpgradeMinorVersion |
boolean |
指出如果部署期間有新的次要版本,擴充功能是否應該使用較新的次要版本。 不過,部署之後,除非重新部署,否則擴充功能不會升級次要版本,即使此屬性設定為 true 也一定會升級。 |
properties.enableAutomaticUpgrade |
boolean |
指出如果有較新版本的延伸模組可用,平臺是否應該自動升級延伸模組。 |
properties.forceUpdateTag |
string |
如果提供值,且與先前的值不同,即使延伸模組組態尚未變更,擴充處理程式仍會強制更新。 |
properties.protectedSettings |
object |
延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 |
properties.protectedSettingsFromKeyVault |
以傳址方式傳遞的延伸模組受保護設定,並從金鑰保存庫取用 |
|
properties.provisionAfterExtensions |
string[] |
必須布建此延伸模組之後的延伸模組名稱集合。 |
properties.provisioningState |
string |
只出現在回應中的布建狀態。 |
properties.publisher |
string |
擴充處理程序發行者的名稱。 |
properties.settings |
object |
擴充功能的 Json 格式化公用設定。 |
properties.suppressFailures |
boolean |
指出延伸模組產生的失敗是否會隱藏(不論此值為何,無法連線到 VM 等作業失敗)。 默認值為 false。 |
properties.type |
string |
指定延伸模組的類型;例如“CustomScriptExtension”。 |
properties.typeHandlerVersion |
string |
指定文稿處理程式的版本。 |
type |
string |
資源類型 |
VirtualMachineScaleSetExtensionUpdate
描述虛擬機擴展集擴充功能。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
name |
string |
延伸模組的名稱。 |
properties.autoUpgradeMinorVersion |
boolean |
指出如果部署期間有新的次要版本,擴充功能是否應該使用較新的次要版本。 不過,部署之後,除非重新部署,否則擴充功能不會升級次要版本,即使此屬性設定為 true 也一定會升級。 |
properties.enableAutomaticUpgrade |
boolean |
指出如果有較新版本的延伸模組可用,平臺是否應該自動升級延伸模組。 |
properties.forceUpdateTag |
string |
如果提供值,且與先前的值不同,即使延伸模組組態尚未變更,擴充處理程式仍會強制更新。 |
properties.protectedSettings |
object |
延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 |
properties.protectedSettingsFromKeyVault |
以傳址方式傳遞的延伸模組受保護設定,並從金鑰保存庫取用 |
|
properties.provisionAfterExtensions |
string[] |
必須布建此延伸模組之後的延伸模組名稱集合。 |
properties.provisioningState |
string |
只出現在回應中的布建狀態。 |
properties.publisher |
string |
擴充處理程序發行者的名稱。 |
properties.settings |
object |
擴充功能的 Json 格式化公用設定。 |
properties.suppressFailures |
boolean |
指出延伸模組產生的失敗是否會隱藏(不論此值為何,無法連線到 VM 等作業失敗)。 默認值為 false。 |
properties.type |
string |
指定延伸模組的類型;例如“CustomScriptExtension”。 |
properties.typeHandlerVersion |
string |
指定文稿處理程式的版本。 |
type |
string |
資源類型 |