azure-native.scvmm.MachineExtension
Explore with Pulumi AI
Describes a Machine Extension. Azure REST API version: 2022-05-21-preview.
Other available API versions: 2023-04-01-preview.
Example Usage
Create or Update a Machine Extension (PUT)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var machineExtension = new AzureNative.ScVmm.MachineExtension("machineExtension", new()
{
ExtensionName = "CustomScriptExtension",
Location = "eastus2euap",
Publisher = "Microsoft.Compute",
ResourceGroupName = "myResourceGroup",
Settings = new Dictionary<string, object?>
{
["commandToExecute"] = "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"",
},
Type = "CustomScriptExtension",
TypeHandlerVersion = "1.10",
VirtualMachineName = "myMachine",
});
});
package main
import (
scvmm "github.com/pulumi/pulumi-azure-native-sdk/scvmm/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := scvmm.NewMachineExtension(ctx, "machineExtension", &scvmm.MachineExtensionArgs{
ExtensionName: pulumi.String("CustomScriptExtension"),
Location: pulumi.String("eastus2euap"),
Publisher: pulumi.String("Microsoft.Compute"),
ResourceGroupName: pulumi.String("myResourceGroup"),
Settings: pulumi.Any(map[string]interface{}{
"commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"",
}),
Type: pulumi.String("CustomScriptExtension"),
TypeHandlerVersion: pulumi.String("1.10"),
VirtualMachineName: pulumi.String("myMachine"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.scvmm.MachineExtension;
import com.pulumi.azurenative.scvmm.MachineExtensionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var machineExtension = new MachineExtension("machineExtension", MachineExtensionArgs.builder()
.extensionName("CustomScriptExtension")
.location("eastus2euap")
.publisher("Microsoft.Compute")
.resourceGroupName("myResourceGroup")
.settings(Map.of("commandToExecute", "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\""))
.type("CustomScriptExtension")
.typeHandlerVersion("1.10")
.virtualMachineName("myMachine")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
machine_extension = azure_native.scvmm.MachineExtension("machineExtension",
extension_name="CustomScriptExtension",
location="eastus2euap",
publisher="Microsoft.Compute",
resource_group_name="myResourceGroup",
settings={
"commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"",
},
type="CustomScriptExtension",
type_handler_version="1.10",
virtual_machine_name="myMachine")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const machineExtension = new azure_native.scvmm.MachineExtension("machineExtension", {
extensionName: "CustomScriptExtension",
location: "eastus2euap",
publisher: "Microsoft.Compute",
resourceGroupName: "myResourceGroup",
settings: {
commandToExecute: "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"",
},
type: "CustomScriptExtension",
typeHandlerVersion: "1.10",
virtualMachineName: "myMachine",
});
resources:
machineExtension:
type: azure-native:scvmm:MachineExtension
properties:
extensionName: CustomScriptExtension
location: eastus2euap
publisher: Microsoft.Compute
resourceGroupName: myResourceGroup
settings:
commandToExecute: powershell.exe -c "Get-Process | Where-Object { $_.CPU -gt 10000 }"
type: CustomScriptExtension
typeHandlerVersion: '1.10'
virtualMachineName: myMachine
Create MachineExtension Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MachineExtension(name: string, args: MachineExtensionArgs, opts?: CustomResourceOptions);
@overload
def MachineExtension(resource_name: str,
args: MachineExtensionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MachineExtension(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
virtual_machine_name: Optional[str] = None,
publisher: Optional[str] = None,
force_update_tag: Optional[str] = None,
location: Optional[str] = None,
protected_settings: Optional[Any] = None,
auto_upgrade_minor_version: Optional[bool] = None,
extension_name: Optional[str] = None,
settings: Optional[Any] = None,
tags: Optional[Mapping[str, str]] = None,
type: Optional[str] = None,
type_handler_version: Optional[str] = None,
enable_automatic_upgrade: Optional[bool] = None)
func NewMachineExtension(ctx *Context, name string, args MachineExtensionArgs, opts ...ResourceOption) (*MachineExtension, error)
public MachineExtension(string name, MachineExtensionArgs args, CustomResourceOptions? opts = null)
public MachineExtension(String name, MachineExtensionArgs args)
public MachineExtension(String name, MachineExtensionArgs args, CustomResourceOptions options)
type: azure-native:scvmm:MachineExtension
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args MachineExtensionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args MachineExtensionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args MachineExtensionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MachineExtensionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MachineExtensionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var examplemachineExtensionResourceResourceFromScvmm = new AzureNative.ScVmm.MachineExtension("examplemachineExtensionResourceResourceFromScvmm", new()
{
ResourceGroupName = "string",
VirtualMachineName = "string",
Publisher = "string",
ForceUpdateTag = "string",
Location = "string",
ProtectedSettings = "any",
AutoUpgradeMinorVersion = false,
ExtensionName = "string",
Settings = "any",
Tags =
{
{ "string", "string" },
},
Type = "string",
TypeHandlerVersion = "string",
EnableAutomaticUpgrade = false,
});
example, err := scvmm.NewMachineExtension(ctx, "examplemachineExtensionResourceResourceFromScvmm", &scvmm.MachineExtensionArgs{
ResourceGroupName: pulumi.String("string"),
VirtualMachineName: pulumi.String("string"),
Publisher: pulumi.String("string"),
ForceUpdateTag: pulumi.String("string"),
Location: pulumi.String("string"),
ProtectedSettings: pulumi.Any("any"),
AutoUpgradeMinorVersion: pulumi.Bool(false),
ExtensionName: pulumi.String("string"),
Settings: pulumi.Any("any"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Type: pulumi.String("string"),
TypeHandlerVersion: pulumi.String("string"),
EnableAutomaticUpgrade: pulumi.Bool(false),
})
var examplemachineExtensionResourceResourceFromScvmm = new MachineExtension("examplemachineExtensionResourceResourceFromScvmm", MachineExtensionArgs.builder()
.resourceGroupName("string")
.virtualMachineName("string")
.publisher("string")
.forceUpdateTag("string")
.location("string")
.protectedSettings("any")
.autoUpgradeMinorVersion(false)
.extensionName("string")
.settings("any")
.tags(Map.of("string", "string"))
.type("string")
.typeHandlerVersion("string")
.enableAutomaticUpgrade(false)
.build());
examplemachine_extension_resource_resource_from_scvmm = azure_native.scvmm.MachineExtension("examplemachineExtensionResourceResourceFromScvmm",
resource_group_name="string",
virtual_machine_name="string",
publisher="string",
force_update_tag="string",
location="string",
protected_settings="any",
auto_upgrade_minor_version=False,
extension_name="string",
settings="any",
tags={
"string": "string",
},
type="string",
type_handler_version="string",
enable_automatic_upgrade=False)
const examplemachineExtensionResourceResourceFromScvmm = new azure_native.scvmm.MachineExtension("examplemachineExtensionResourceResourceFromScvmm", {
resourceGroupName: "string",
virtualMachineName: "string",
publisher: "string",
forceUpdateTag: "string",
location: "string",
protectedSettings: "any",
autoUpgradeMinorVersion: false,
extensionName: "string",
settings: "any",
tags: {
string: "string",
},
type: "string",
typeHandlerVersion: "string",
enableAutomaticUpgrade: false,
});
type: azure-native:scvmm:MachineExtension
properties:
autoUpgradeMinorVersion: false
enableAutomaticUpgrade: false
extensionName: string
forceUpdateTag: string
location: string
protectedSettings: any
publisher: string
resourceGroupName: string
settings: any
tags:
string: string
type: string
typeHandlerVersion: string
virtualMachineName: string
MachineExtension Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The MachineExtension resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group.
- Virtual
Machine stringName - The name of the machine where the extension should be created or updated.
- Auto
Upgrade boolMinor Version - 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.
- Enable
Automatic boolUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- Extension
Name string - The name of the machine extension.
- Force
Update stringTag - How the extension handler should be forced to update even if the extension configuration has not changed.
- Location string
- The geo-location where the resource lives
- Protected
Settings object - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- Publisher string
- The name of the extension handler publisher.
- Settings object
- Json formatted public settings for the extension.
- Dictionary<string, string>
- Resource tags.
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion - Specifies the version of the script handler.
- Resource
Group stringName - The name of the resource group.
- Virtual
Machine stringName - The name of the machine where the extension should be created or updated.
- Auto
Upgrade boolMinor Version - 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.
- Enable
Automatic boolUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- Extension
Name string - The name of the machine extension.
- Force
Update stringTag - How the extension handler should be forced to update even if the extension configuration has not changed.
- Location string
- The geo-location where the resource lives
- Protected
Settings interface{} - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- Publisher string
- The name of the extension handler publisher.
- Settings interface{}
- Json formatted public settings for the extension.
- map[string]string
- Resource tags.
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion - Specifies the version of the script handler.
- resource
Group StringName - The name of the resource group.
- virtual
Machine StringName - The name of the machine where the extension should be created or updated.
- auto
Upgrade BooleanMinor Version - 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.
- enable
Automatic BooleanUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- extension
Name String - The name of the machine extension.
- force
Update StringTag - How the extension handler should be forced to update even if the extension configuration has not changed.
- location String
- The geo-location where the resource lives
- protected
Settings Object - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- publisher String
- The name of the extension handler publisher.
- settings Object
- Json formatted public settings for the extension.
- Map<String,String>
- Resource tags.
- type String
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler StringVersion - Specifies the version of the script handler.
- resource
Group stringName - The name of the resource group.
- virtual
Machine stringName - The name of the machine where the extension should be created or updated.
- auto
Upgrade booleanMinor Version - 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.
- enable
Automatic booleanUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- extension
Name string - The name of the machine extension.
- force
Update stringTag - How the extension handler should be forced to update even if the extension configuration has not changed.
- location string
- The geo-location where the resource lives
- protected
Settings any - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- publisher string
- The name of the extension handler publisher.
- settings any
- Json formatted public settings for the extension.
- {[key: string]: string}
- Resource tags.
- type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler stringVersion - Specifies the version of the script handler.
- resource_
group_ strname - The name of the resource group.
- virtual_
machine_ strname - The name of the machine where the extension should be created or updated.
- auto_
upgrade_ boolminor_ version - 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.
- enable_
automatic_ boolupgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- extension_
name str - The name of the machine extension.
- force_
update_ strtag - How the extension handler should be forced to update even if the extension configuration has not changed.
- location str
- The geo-location where the resource lives
- protected_
settings Any - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- publisher str
- The name of the extension handler publisher.
- settings Any
- Json formatted public settings for the extension.
- Mapping[str, str]
- Resource tags.
- type str
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type_
handler_ strversion - Specifies the version of the script handler.
- resource
Group StringName - The name of the resource group.
- virtual
Machine StringName - The name of the machine where the extension should be created or updated.
- auto
Upgrade BooleanMinor Version - 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.
- enable
Automatic BooleanUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
- extension
Name String - The name of the machine extension.
- force
Update StringTag - How the extension handler should be forced to update even if the extension configuration has not changed.
- location String
- The geo-location where the resource lives
- protected
Settings Any - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- publisher String
- The name of the extension handler publisher.
- settings Any
- Json formatted public settings for the extension.
- Map<String>
- Resource tags.
- type String
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler StringVersion - Specifies the version of the script handler.
Outputs
All input properties are implicitly available as output properties. Additionally, the MachineExtension resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - The provisioning state, which only appears in the response.
- System
Data Pulumi.Azure Native. Sc Vmm. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Instance
View Pulumi.Azure Native. Sc Vmm. Outputs. Machine Extension Properties Response Instance View - The machine extension instance view.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - The provisioning state, which only appears in the response.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Instance
View MachineExtension Properties Response Instance View - The machine extension instance view.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - The provisioning state, which only appears in the response.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- instance
View MachineExtension Properties Response Instance View - The machine extension instance view.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- provisioning
State string - The provisioning state, which only appears in the response.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- instance
View MachineExtension Properties Response Instance View - The machine extension instance view.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- provisioning_
state str - The provisioning state, which only appears in the response.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- instance_
view MachineExtension Properties Response Instance View - The machine extension instance view.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - The provisioning state, which only appears in the response.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- instance
View Property Map - The machine extension instance view.
Supporting Types
MachineExtensionInstanceViewResponseStatus, MachineExtensionInstanceViewResponseStatusArgs
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level string
- The level code.
- Message string
- The detailed status message, including for alerts and error messages.
- Time string
- The time of the status.
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level string
- The level code.
- Message string
- The detailed status message, including for alerts and error messages.
- Time string
- The time of the status.
- code String
- The status code.
- display
Status String - The short localizable label for the status.
- level String
- The level code.
- message String
- The detailed status message, including for alerts and error messages.
- time String
- The time of the status.
- code string
- The status code.
- display
Status string - The short localizable label for the status.
- level string
- The level code.
- message string
- The detailed status message, including for alerts and error messages.
- time string
- The time of the status.
- code str
- The status code.
- display_
status str - The short localizable label for the status.
- level str
- The level code.
- message str
- The detailed status message, including for alerts and error messages.
- time str
- The time of the status.
- code String
- The status code.
- display
Status String - The short localizable label for the status.
- level String
- The level code.
- message String
- The detailed status message, including for alerts and error messages.
- time String
- The time of the status.
MachineExtensionPropertiesResponseInstanceView, MachineExtensionPropertiesResponseInstanceViewArgs
- Name string
- The machine extension name.
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion - Specifies the version of the script handler.
- Status
Pulumi.
Azure Native. Sc Vmm. Inputs. Machine Extension Instance View Response Status - Instance view status.
- Name string
- The machine extension name.
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion - Specifies the version of the script handler.
- Status
Machine
Extension Instance View Response Status - Instance view status.
- name String
- The machine extension name.
- type String
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler StringVersion - Specifies the version of the script handler.
- status
Machine
Extension Instance View Response Status - Instance view status.
- name string
- The machine extension name.
- type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler stringVersion - Specifies the version of the script handler.
- status
Machine
Extension Instance View Response Status - Instance view status.
- name str
- The machine extension name.
- type str
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type_
handler_ strversion - Specifies the version of the script handler.
- status
Machine
Extension Instance View Response Status - Instance view status.
- name String
- The machine extension name.
- type String
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler StringVersion - Specifies the version of the script handler.
- status Property Map
- Instance view status.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:scvmm:MachineExtension CustomScriptExtension /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/extensions/{extensionName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0