你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Virtual Machine Extensions - Create Or Update
用于创建或更新扩展的操作。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2024-07-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源组的名称。 |
subscription
|
path | True |
string |
唯一标识 azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。 |
vm
|
path | True |
string |
虚拟机扩展的名称。 |
vm
|
path | True |
string |
应在其中创建或更新扩展的虚拟机的名称。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
location |
string |
资源位置 |
properties.autoUpgradeMinorVersion |
boolean |
指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 |
properties.enableAutomaticUpgrade |
boolean |
指示如果有较新版本的扩展可用,平台是否应自动升级扩展。 |
properties.forceUpdateTag |
string |
即使扩展配置未更改,扩展处理程序也应强制更新。 |
properties.instanceView |
虚拟机扩展实例视图。 |
|
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 |
指定脚本处理程序的版本。 |
tags |
object |
资源标记 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
还行 |
|
201 Created |
创建 |
|
Other Status Codes |
描述操作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Virtual |
Virtual |
VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
示例请求
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaaaaaaaaaaa?api-version=2024-07-01
{
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
示例响应
{
"name": "myVMExtension",
"type": "Microsoft.Compute/virtualMachines/extensions",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Creating",
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
location: https://foo.com/operationstatus
{
"name": "myVMExtension",
"type": "Microsoft.Compute/virtualMachines/extensions",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Creating",
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen
示例请求
示例响应
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
location: https://foo.com/operationstatus
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
定义
名称 | 说明 |
---|---|
Api |
Api 错误。 |
Api |
Api 错误基数。 |
Cloud |
来自计算服务的错误响应。 |
Inner |
内部错误详细信息。 |
Instance |
实例视图状态。 |
Key |
描述对 Key Vault 机密的引用 |
Status |
级别代码。 |
Sub |
|
Virtual |
描述虚拟机扩展。 |
Virtual |
虚拟机扩展的实例视图。 |
ApiError
Api 错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
details |
API 错误详细信息 |
|
innererror |
Api 内部错误 |
|
message |
string |
错误消息。 |
target |
string |
特定错误的目标。 |
ApiErrorBase
Api 错误基数。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
message |
string |
错误消息。 |
target |
string |
特定错误的目标。 |
CloudError
来自计算服务的错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
Api 错误。 |
InnerError
内部错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
errordetail |
string |
内部错误消息或异常转储。 |
exceptiontype |
string |
异常类型。 |
InstanceViewStatus
实例视图状态。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
状态代码。 |
displayStatus |
string |
状态的简短可本地化标签。 |
level |
级别代码。 |
|
message |
string |
详细状态消息,包括警报和错误消息。 |
time |
string |
状态的时间。 |
KeyVaultSecretReference
描述对 Key Vault 机密的引用
名称 | 类型 | 说明 |
---|---|---|
secretUrl |
string |
引用 Key Vault 中的机密的 URL。 |
sourceVault |
包含机密的 Key Vault 的相对 URL。 |
StatusLevelTypes
级别代码。
名称 | 类型 | 说明 |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
SubResource
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID |
VirtualMachineExtension
描述虚拟机扩展。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID |
location |
string |
资源位置 |
name |
string |
资源名称 |
properties.autoUpgradeMinorVersion |
boolean |
指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 |
properties.enableAutomaticUpgrade |
boolean |
指示如果有较新版本的扩展可用,平台是否应自动升级扩展。 |
properties.forceUpdateTag |
string |
即使扩展配置未更改,扩展处理程序也应强制更新。 |
properties.instanceView |
虚拟机扩展实例视图。 |
|
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 |
指定脚本处理程序的版本。 |
tags |
object |
资源标记 |
type |
string |
资源类型 |
VirtualMachineExtensionInstanceView
虚拟机扩展的实例视图。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
虚拟机扩展名称。 |
statuses |
资源状态信息。 |
|
substatuses |
资源状态信息。 |
|
type |
string |
指定扩展的类型;例如“CustomScriptExtension”。 |
typeHandlerVersion |
string |
指定脚本处理程序的版本。 |