Virtual Machine Scale Set Extensions - Create Or Update

Service:

Compute

API Version:

2017-12-01

The operation to create or update an extension.

HTTP

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}?api-version=2017-12-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vmScaleSetName	path	True	string	The name of the VM scale set where the extension should be create or updated.
vmssExtensionName	path	True	string	The name of the VM scale set extension.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
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.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.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.

Responses

Name	Type	Description
200 OK	VirtualMachineScaleSetExtension	OK
201 Created	VirtualMachineScaleSetExtension	Created

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Definitions

VirtualMachineScaleSetExtension

Object

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.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.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.