Virtual Machine Scale Set Extensions - Update
The operation to update an extension.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}?api-version=2021-04-01
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
vm
|
path | True |
string |
The name of the VM scale set where the extension should be updated. |
vmss
|
path | True |
string |
The name of the VM scale set extension. |
api-version
|
query | True |
string |
Client Api Version. |
Name | Type | Description |
---|---|---|
properties.autoUpgradeMinorVersion |
boolean |
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
properties.enableAutomaticUpgrade |
boolean |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. |
properties.forceUpdateTag |
string |
If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. |
properties.protectedSettings |
object |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
properties.provisionAfterExtensions |
string[] |
Collection of extension names after which this extension needs to be provisioned. |
properties.publisher |
string |
The name of the extension handler publisher. |
properties.settings |
object |
Json formatted public settings for the extension. |
properties.type |
string |
Specifies the type of the extension; an example is "CustomScriptExtension". |
properties.typeHandlerVersion |
string |
Specifies the version of the script handler. |
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
201 Created |
Created |
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Name | Description |
---|---|
Virtual |
Describes a Virtual Machine Scale Set Extension. |
Virtual |
Describes a Virtual Machine Scale Set Extension. |
Describes a Virtual Machine Scale Set Extension.
Name | Type | Description |
---|---|---|
id |
string |
Resource Id |
name |
string |
The name of the extension. |
properties.autoUpgradeMinorVersion |
boolean |
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
properties.enableAutomaticUpgrade |
boolean |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. |
properties.forceUpdateTag |
string |
If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. |
properties.protectedSettings |
object |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
properties.provisionAfterExtensions |
string[] |
Collection of extension names after which this extension needs to be provisioned. |
properties.provisioningState |
string |
The provisioning state, which only appears in the response. |
properties.publisher |
string |
The name of the extension handler publisher. |
properties.settings |
object |
Json formatted public settings for the extension. |
properties.type |
string |
Specifies the type of the extension; an example is "CustomScriptExtension". |
properties.typeHandlerVersion |
string |
Specifies the version of the script handler. |
type |
string |
Resource type |
Describes a Virtual Machine Scale Set Extension.
Name | Type | Description |
---|---|---|
id |
string |
Resource Id |
name |
string |
The name of the extension. |
properties.autoUpgradeMinorVersion |
boolean |
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
properties.enableAutomaticUpgrade |
boolean |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. |
properties.forceUpdateTag |
string |
If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. |
properties.protectedSettings |
object |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
properties.provisionAfterExtensions |
string[] |
Collection of extension names after which this extension needs to be provisioned. |
properties.provisioningState |
string |
The provisioning state, which only appears in the response. |
properties.publisher |
string |
The name of the extension handler publisher. |
properties.settings |
object |
Json formatted public settings for the extension. |
properties.type |
string |
Specifies the type of the extension; an example is "CustomScriptExtension". |
properties.typeHandlerVersion |
string |
Specifies the version of the script handler. |
type |
string |
Resource type |