Virtual Machine Extensions - Create Or Update
Operación para crear o actualizar la extensión.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2024-07-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nombre del grupo de recursos. |
subscription
|
path | True |
string |
Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio. |
vm
|
path | True |
string |
Nombre de la extensión de máquina virtual. |
vm
|
path | True |
string |
Nombre de la máquina virtual donde se debe crear o actualizar la extensión. |
api-version
|
query | True |
string |
Versión de api de cliente. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
location |
string |
Ubicación del recurso |
properties.autoUpgradeMinorVersion |
boolean |
Indica si la extensión debe usar una versión secundaria más reciente si está disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true. |
properties.enableAutomaticUpgrade |
boolean |
Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible. |
properties.forceUpdateTag |
string |
Cómo se debe forzar el controlador de extensión para actualizar incluso si la configuración de la extensión no ha cambiado. |
properties.instanceView |
Vista de instancia de extensión de máquina virtual. |
|
properties.protectedSettings |
object |
La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida. |
properties.protectedSettingsFromKeyVault |
Configuración protegida de extensiones que se pasan por referencia y que se consumen desde el almacén de claves. |
|
properties.provisionAfterExtensions |
string[] |
Colección de nombres de extensión después de los cuales se debe aprovisionar esta extensión. |
properties.publisher |
string |
Nombre del publicador de controladores de extensión. |
properties.settings |
object |
Configuración pública con formato JSON para la extensión. |
properties.suppressFailures |
boolean |
Indica si los errores derivados de la extensión se suprimirán (los errores operativos, como no conectarse a la máquina virtual, no se suprimirán independientemente de este valor). El valor predeterminado es false. |
properties.type |
string |
Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension". |
properties.typeHandlerVersion |
string |
Especifica la versión del controlador de script. |
tags |
object |
Etiquetas de recursos |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
De acuerdo |
|
201 Created |
Creado |
|
Other Status Codes |
Respuesta de error que describe por qué se produjo un error en la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantar la cuenta de usuario |
Ejemplos
Virtual |
Virtual |
VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
Solicitud de ejemplo
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"
}
}
Respuesta de muestra
{
"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
Solicitud de ejemplo
Respuesta de muestra
{
"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"
}
Definiciones
Nombre | Description |
---|---|
Api |
Error de API. |
Api |
Base de errores de api. |
Cloud |
Respuesta de error del servicio Compute. |
Inner |
Detalles del error interno. |
Instance |
Estado de la vista de instancia. |
Key |
Describe una referencia al secreto de Key Vault. |
Status |
Código de nivel. |
Sub |
|
Virtual |
Describe una extensión de máquina virtual. |
Virtual |
Vista de instancia de una extensión de máquina virtual. |
ApiError
Error de API.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
details |
Detalles del error de api |
|
innererror |
Error interno de api |
|
message |
string |
Mensaje de error. |
target |
string |
Destino del error concreto. |
ApiErrorBase
Base de errores de api.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
message |
string |
Mensaje de error. |
target |
string |
Destino del error concreto. |
CloudError
Respuesta de error del servicio Compute.
Nombre | Tipo | Description |
---|---|---|
error |
Error de API. |
InnerError
Detalles del error interno.
Nombre | Tipo | Description |
---|---|---|
errordetail |
string |
Mensaje de error interno o volcado de memoria de excepciones. |
exceptiontype |
string |
Tipo de excepción. |
InstanceViewStatus
Estado de la vista de instancia.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de estado. |
displayStatus |
string |
Etiqueta localizable corta para el estado. |
level |
Código de nivel. |
|
message |
string |
Mensaje de estado detallado, incluido para alertas y mensajes de error. |
time |
string |
Hora del estado. |
KeyVaultSecretReference
Describe una referencia al secreto de Key Vault.
Nombre | Tipo | Description |
---|---|---|
secretUrl |
string |
Dirección URL que hace referencia a un secreto en un almacén de claves. |
sourceVault |
Dirección URL relativa del almacén de claves que contiene el secreto. |
StatusLevelTypes
Código de nivel.
Nombre | Tipo | Description |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
SubResource
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso |
VirtualMachineExtension
Describe una extensión de máquina virtual.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso |
location |
string |
Ubicación del recurso |
name |
string |
Nombre del recurso |
properties.autoUpgradeMinorVersion |
boolean |
Indica si la extensión debe usar una versión secundaria más reciente si está disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true. |
properties.enableAutomaticUpgrade |
boolean |
Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible. |
properties.forceUpdateTag |
string |
Cómo se debe forzar el controlador de extensión para actualizar incluso si la configuración de la extensión no ha cambiado. |
properties.instanceView |
Vista de instancia de extensión de máquina virtual. |
|
properties.protectedSettings |
object |
La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida. |
properties.protectedSettingsFromKeyVault |
Configuración protegida de extensiones que se pasan por referencia y que se consumen desde el almacén de claves. |
|
properties.provisionAfterExtensions |
string[] |
Colección de nombres de extensión después de los cuales se debe aprovisionar esta extensión. |
properties.provisioningState |
string |
Estado de aprovisionamiento, que solo aparece en la respuesta. |
properties.publisher |
string |
Nombre del publicador de controladores de extensión. |
properties.settings |
object |
Configuración pública con formato JSON para la extensión. |
properties.suppressFailures |
boolean |
Indica si los errores derivados de la extensión se suprimirán (los errores operativos, como no conectarse a la máquina virtual, no se suprimirán independientemente de este valor). El valor predeterminado es false. |
properties.type |
string |
Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension". |
properties.typeHandlerVersion |
string |
Especifica la versión del controlador de script. |
tags |
object |
Etiquetas de recursos |
type |
string |
Tipo de recurso |
VirtualMachineExtensionInstanceView
Vista de instancia de una extensión de máquina virtual.
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre de la extensión de máquina virtual. |
statuses |
Información de estado del recurso. |
|
substatuses |
Información de estado del recurso. |
|
type |
string |
Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension". |
typeHandlerVersion |
string |
Especifica la versión del controlador de script. |