PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}/?api-version=2023-09-01
The operation to create or update the extension.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
vmExtensionName |
String | Yes |
The name of the virtual machine extension. |
vmName |
String | Yes |
The name of the virtual machine where the extension should be created or updated. |
subscriptionId |
String | Yes |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
resourceGroupName |
String | Yes |
The name of the resource group. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id |
name |
String | No |
Resource name |
properties |
Object | No |
Describes the properties of a Virtual Machine Extension. |
properties.provisionAfterExtensions[] |
Array | No |
Collection of extension names after which this extension needs to be provisioned. |
properties.forceUpdateTag |
String | No |
How the extension handler should be forced to update even if the extension configuration has not changed. |
properties.protectedSettings |
Object | No |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
properties.instanceView |
Object | No |
The instance view of a virtual machine extension. |
properties.instanceView.name |
String | No |
The virtual machine extension name. |
properties.instanceView.type |
String | No |
Specifies the type of the extension; an example is "CustomScriptExtension". |
properties.instanceView.typeHandlerVersion |
String | No |
Specifies the version of the script handler. |
properties.instanceView.substatuses[] |
Array | No |
The resource status information. |
properties.instanceView.substatuses[].time |
String | No |
The time of the status. |
properties.instanceView.substatuses[].displayStatus |
String | No |
The short localizable label for the status. |
properties.instanceView.substatuses[].message |
String | No |
The detailed status message, including for alerts and error messages. |
properties.instanceView.substatuses[].level |
String | No |
The level code. Possible values:
|
properties.instanceView.substatuses[].code |
String | No |
The status code. |
properties.instanceView.statuses[] |
Array | No |
The resource status information. |
properties.instanceView.statuses[].time |
String | No |
The time of the status. |
properties.instanceView.statuses[].displayStatus |
String | No |
The short localizable label for the status. |
properties.instanceView.statuses[].message |
String | No |
The detailed status message, including for alerts and error messages. |
properties.instanceView.statuses[].level |
String | No |
The level code. Possible values:
|
properties.instanceView.statuses[].code |
String | No |
The status code. |
properties.enableAutomaticUpgrade |
Boolean | No |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. |
properties.suppressFailures |
Boolean | No |
Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. |
properties.publisher |
String | No |
The name of the extension handler publisher. |
properties.provisioningState |
String | No |
The provisioning state, which only appears in the response. |
properties.type |
String | No |
Specifies the type of the extension; an example is "CustomScriptExtension". |
properties.settings |
Object | No |
Json formatted public settings for the extension. |
properties.typeHandlerVersion |
String | No |
Specifies the version of the script handler. |
properties.autoUpgradeMinorVersion |
Boolean | No |
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.protectedSettingsFromKeyVault |
Object | No |
Describes a reference to Key Vault Secret |
properties.protectedSettingsFromKeyVault.sourceVault |
Object | Yes | |
properties.protectedSettingsFromKeyVault.sourceVault.id |
String | No |
Resource Id |
properties.protectedSettingsFromKeyVault.secretUrl |
String | Yes |
The URL referencing a secret in a Key Vault. |
location |
String | No |
Resource location |
tags |
Object | No |
Resource tags |
type |
String | No |
Resource type |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.