@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Describes a VMSS VM Extension.
*
* Uses Azure REST API version 2024-11-01. In version 2.x of the Azure Native provider, it used API version 2023-03-01.
*
* Other available API versions: 2022-08-01, 2022-11-01, 2023-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native compute [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class VirtualMachineScaleSetVMExtension extends pulumi.CustomResource {
/**
* Get an existing VirtualMachineScaleSetVMExtension resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): VirtualMachineScaleSetVMExtension;
/**
* Returns true if the given object is an instance of VirtualMachineScaleSetVMExtension. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VirtualMachineScaleSetVMExtension;
/**
* 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.
*/
readonly autoUpgradeMinorVersion: pulumi.Output<boolean | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
*/
readonly enableAutomaticUpgrade: pulumi.Output<boolean | undefined>;
/**
* How the extension handler should be forced to update even if the extension configuration has not changed.
*/
readonly forceUpdateTag: pulumi.Output<string | undefined>;
/**
* The virtual machine extension instance view.
*/
readonly instanceView: pulumi.Output<outputs.compute.VirtualMachineExtensionInstanceViewResponse | undefined>;
/**
* The location of the extension.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Resource name
*/
readonly name: pulumi.Output<string>;
/**
* The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
*/
readonly protectedSettings: pulumi.Output<any | undefined>;
/**
* The extensions protected settings that are passed by reference, and consumed from key vault
*/
readonly protectedSettingsFromKeyVault: pulumi.Output<outputs.compute.KeyVaultSecretReferenceResponse | undefined>;
/**
* Collection of extension names after which this extension needs to be provisioned.
*/
readonly provisionAfterExtensions: pulumi.Output<string[] | undefined>;
/**
* The provisioning state, which only appears in the response.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The name of the extension handler publisher.
*/
readonly publisher: pulumi.Output<string | undefined>;
/**
* Json formatted public settings for the extension.
*/
readonly settings: pulumi.Output<any | undefined>;
/**
* 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.
*/
readonly suppressFailures: pulumi.Output<boolean | undefined>;
/**
* Resource type
*/
readonly type: pulumi.Output<string>;
/**
* Specifies the version of the script handler.
*/
readonly typeHandlerVersion: pulumi.Output<string | undefined>;
/**
* Create a VirtualMachineScaleSetVMExtension resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: VirtualMachineScaleSetVMExtensionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a VirtualMachineScaleSetVMExtension resource.
*/
export interface VirtualMachineScaleSetVMExtensionArgs {
/**
* 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.
*/
autoUpgradeMinorVersion?: pulumi.Input<boolean>;
/**
* Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
*/
enableAutomaticUpgrade?: pulumi.Input<boolean>;
/**
* How the extension handler should be forced to update even if the extension configuration has not changed.
*/
forceUpdateTag?: pulumi.Input<string>;
/**
* The instance ID of the virtual machine.
*/
instanceId: pulumi.Input<string>;
/**
* The virtual machine extension instance view.
*/
instanceView?: pulumi.Input<inputs.compute.VirtualMachineExtensionInstanceViewArgs>;
/**
* The location of the extension.
*/
location?: pulumi.Input<string>;
/**
* The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
*/
protectedSettings?: any;
/**
* The extensions protected settings that are passed by reference, and consumed from key vault
*/
protectedSettingsFromKeyVault?: pulumi.Input<inputs.compute.KeyVaultSecretReferenceArgs>;
/**
* Collection of extension names after which this extension needs to be provisioned.
*/
provisionAfterExtensions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the extension handler publisher.
*/
publisher?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Json formatted public settings for the extension.
*/
settings?: any;
/**
* 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.
*/
suppressFailures?: pulumi.Input<boolean>;
/**
* Specifies the type of the extension; an example is "CustomScriptExtension".
*/
type?: pulumi.Input<string>;
/**
* Specifies the version of the script handler.
*/
typeHandlerVersion?: pulumi.Input<string>;
/**
* The name of the virtual machine extension.
*/
vmExtensionName?: pulumi.Input<string>;
/**
* The name of the VM scale set.
*/
vmScaleSetName: pulumi.Input<string>;
}