Virtual Machine Extensions - Create Or Update
A operação para criar ou atualizar a extensão.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2025-04-01
Parâmetros URI
| Nome | Em | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
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. |
|
vm
|
path | True |
string |
O nome da extensão da máquina virtual. |
|
vm
|
path | True |
string |
O nome da máquina virtual. |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a utilizar para esta operação. |
Órgão do Pedido
| Nome | Necessário | Tipo | Descrição |
|---|---|---|---|
| location | True |
string |
A geolocalização onde o recurso vive |
| properties.autoUpgradeMinorVersion |
boolean |
Indica se a extensão deve usar uma versão secundária mais recente, se uma estiver disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true. |
|
| properties.enableAutomaticUpgrade |
boolean |
Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível. |
|
| properties.forceUpdateTag |
string |
Como o manipulador de extensão deve ser forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada. |
|
| properties.instanceView |
A exibição da instância de extensão de máquina virtual. |
||
| properties.protectedSettings |
A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida. |
||
| properties.protectedSettingsFromKeyVault |
As extensões protegem as configurações que são passadas por referência e consumidas do cofre de chaves |
||
| properties.provisionAfterExtensions |
string[] |
Coleção de nomes de extensão após a qual essa extensão precisa ser provisionada. |
|
| properties.publisher |
string |
O nome do editor do manipulador de extensão. |
|
| properties.settings |
Json formatou configurações públicas para a extensão. |
||
| properties.suppressFailures |
boolean |
Indica se as falhas decorrentes da extensão serão suprimidas (Falhas operacionais, como não se conectar à VM, não serão suprimidas, independentemente desse valor). O padrão é "false". |
|
| properties.type |
string |
Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". |
|
| properties.typeHandlerVersion |
string |
Especifica a versão do manipulador de script. |
|
| tags |
object |
Tags de recursos. |
Respostas
| Nome | Tipo | Descrição |
|---|---|---|
| 200 OK |
Operação de atualização do recurso 'VirtualMachineExtension' bem-sucedida |
|
| 201 Created |
Recurso 'VirtualMachineExtension' criar operação bem-sucedida Cabeçalhos
|
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Ative Directory.
Tipo:
oauth2
Flow:
implicit
URL de autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Alcances
| Nome | Descrição |
|---|---|
| user_impersonation | personificar a sua conta de utilizador |
Exemplos
|
Virtual |
|
Virtual |
VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
Pedido de exemplo
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaaaaaaaaaaa?api-version=2025-04-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"
}
}
Resposta de exemplo
{
"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
Pedido de exemplo
Resposta de exemplo
{
"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"
}
Definições
| Nome | Descrição |
|---|---|
|
Api |
Erro de api. |
|
Api |
Base de erro da api. |
|
Cloud |
Uma resposta de erro do serviço de computação. |
|
created |
O tipo de identidade que criou o recurso. |
|
Inner |
Detalhes do erro interno. |
|
Instance |
Status da exibição da instância. |
|
Key |
Descreve uma referência ao segredo do Key Vault |
|
Status |
O código de nível. |
|
Sub |
|
|
system |
Metadados referentes à criação e última modificação do recurso. |
|
Virtual |
Descreve uma extensão de máquina virtual. |
|
Virtual |
A exibição de instância de uma extensão de máquina virtual. |
ApiError
Erro de api.
| Nome | Tipo | Descrição |
|---|---|---|
| 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.
| Nome | Tipo | Descrição |
|---|---|---|
| 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.
| Nome | Tipo | Descrição |
|---|---|---|
| error |
Erro de api. |
createdByType
O tipo de identidade que criou o recurso.
| Valor | Descrição |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
InnerError
Detalhes do erro interno.
| Nome | Tipo | Descrição |
|---|---|---|
| errordetail |
string |
A mensagem de erro interna ou despejo de exceção. |
| exceptiontype |
string |
O tipo de exceção. |
InstanceViewStatus
Status da exibição da instância.
| Nome | Tipo | Descrição |
|---|---|---|
| code |
string |
O código de status. |
| displayStatus |
string |
O rótulo curto localizável para o status. |
| level |
O código de nível. |
|
| message |
string |
A mensagem de status detalhada, inclusive para alertas e mensagens de erro. |
| time |
string (date-time) |
A hora do status. |
KeyVaultSecretReference
Descreve uma referência ao segredo do Key Vault
| Nome | Tipo | Descrição |
|---|---|---|
| secretUrl |
string |
O URL que faz referência a um segredo em um Cofre de Chaves. |
| sourceVault |
O URL relativo do Cofre da Chave que contém o segredo. |
StatusLevelTypes
O código de nível.
| Valor | Descrição |
|---|---|
| Info | |
| Warning | |
| Error |
SubResource
| Nome | Tipo | Descrição |
|---|---|---|
| id |
string |
ID do recurso |
systemData
Metadados referentes à criação e última modificação do recurso.
| Nome | Tipo | Descrição |
|---|---|---|
| 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. |
VirtualMachineExtension
Descreve uma extensão de máquina virtual.
| Nome | Tipo | Descrição |
|---|---|---|
| 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.autoUpgradeMinorVersion |
boolean |
Indica se a extensão deve usar uma versão secundária mais recente, se uma estiver disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true. |
| properties.enableAutomaticUpgrade |
boolean |
Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível. |
| properties.forceUpdateTag |
string |
Como o manipulador de extensão deve ser forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada. |
| properties.instanceView |
A exibição da instância de extensão de máquina virtual. |
|
| properties.protectedSettings |
A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida. |
|
| properties.protectedSettingsFromKeyVault |
As extensões protegem as configurações que são passadas por referência e consumidas do cofre de chaves |
|
| properties.provisionAfterExtensions |
string[] |
Coleção de nomes de extensão após a qual essa extensão precisa ser provisionada. |
| properties.provisioningState |
string |
O estado de provisionamento, que só aparece na resposta. |
| properties.publisher |
string |
O nome do editor do manipulador de extensão. |
| properties.settings |
Json formatou configurações públicas para a extensão. |
|
| properties.suppressFailures |
boolean |
Indica se as falhas decorrentes da extensão serão suprimidas (Falhas operacionais, como não se conectar à VM, não serão suprimidas, independentemente desse valor). O padrão é "false". |
| properties.type |
string |
Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". |
| properties.typeHandlerVersion |
string |
Especifica a versão do manipulador de script. |
| 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" |
VirtualMachineExtensionInstanceView
A exibição de instância de uma extensão de máquina virtual.
| Nome | Tipo | Descrição |
|---|---|---|
| name |
string |
O nome da extensão da máquina virtual. |
| statuses |
As informações de status do recurso. |
|
| substatuses |
As informações de status do recurso. |
|
| type |
string |
Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". |
| typeHandlerVersion |
string |
Especifica a versão do manipulador de script. |