pulumi-azure-native 2.21.2a1702068757__py3-none-any.whl → 2.21.3a1702685082__py3-none-any.whl

pulumi_azure_native/compute/v20230901/get_virtual_machine_scale_set_extension.py

@@ -0,0 +1,258 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetVirtualMachineScaleSetExtensionResult',
+    'AwaitableGetVirtualMachineScaleSetExtensionResult',
+    'get_virtual_machine_scale_set_extension',
+    'get_virtual_machine_scale_set_extension_output',
+]
+
+@pulumi.output_type
+class GetVirtualMachineScaleSetExtensionResult:
+    """
+    Describes a Virtual Machine Scale Set Extension.
+    """
+    def __init__(__self__, auto_upgrade_minor_version=None, enable_automatic_upgrade=None, force_update_tag=None, id=None, name=None, protected_settings=None, protected_settings_from_key_vault=None, provision_after_extensions=None, provisioning_state=None, publisher=None, settings=None, suppress_failures=None, type=None, type_handler_version=None):
+        if auto_upgrade_minor_version and not isinstance(auto_upgrade_minor_version, bool):
+            raise TypeError("Expected argument 'auto_upgrade_minor_version' to be a bool")
+        pulumi.set(__self__, "auto_upgrade_minor_version", auto_upgrade_minor_version)
+        if enable_automatic_upgrade and not isinstance(enable_automatic_upgrade, bool):
+            raise TypeError("Expected argument 'enable_automatic_upgrade' to be a bool")
+        pulumi.set(__self__, "enable_automatic_upgrade", enable_automatic_upgrade)
+        if force_update_tag and not isinstance(force_update_tag, str):
+            raise TypeError("Expected argument 'force_update_tag' to be a str")
+        pulumi.set(__self__, "force_update_tag", force_update_tag)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if protected_settings and not isinstance(protected_settings, dict):
+            raise TypeError("Expected argument 'protected_settings' to be a dict")
+        pulumi.set(__self__, "protected_settings", protected_settings)
+        if protected_settings_from_key_vault and not isinstance(protected_settings_from_key_vault, dict):
+            raise TypeError("Expected argument 'protected_settings_from_key_vault' to be a dict")
+        pulumi.set(__self__, "protected_settings_from_key_vault", protected_settings_from_key_vault)
+        if provision_after_extensions and not isinstance(provision_after_extensions, list):
+            raise TypeError("Expected argument 'provision_after_extensions' to be a list")
+        pulumi.set(__self__, "provision_after_extensions", provision_after_extensions)
+        if provisioning_state and not isinstance(provisioning_state, str):
+            raise TypeError("Expected argument 'provisioning_state' to be a str")
+        pulumi.set(__self__, "provisioning_state", provisioning_state)
+        if publisher and not isinstance(publisher, str):
+            raise TypeError("Expected argument 'publisher' to be a str")
+        pulumi.set(__self__, "publisher", publisher)
+        if settings and not isinstance(settings, dict):
+            raise TypeError("Expected argument 'settings' to be a dict")
+        pulumi.set(__self__, "settings", settings)
+        if suppress_failures and not isinstance(suppress_failures, bool):
+            raise TypeError("Expected argument 'suppress_failures' to be a bool")
+        pulumi.set(__self__, "suppress_failures", suppress_failures)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+        if type_handler_version and not isinstance(type_handler_version, str):
+            raise TypeError("Expected argument 'type_handler_version' to be a str")
+        pulumi.set(__self__, "type_handler_version", type_handler_version)
+
+    @property
+    @pulumi.getter(name="autoUpgradeMinorVersion")
+    def auto_upgrade_minor_version(self) -> Optional[bool]:
+        """
+        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.
+        """
+        return pulumi.get(self, "auto_upgrade_minor_version")
+
+    @property
+    @pulumi.getter(name="enableAutomaticUpgrade")
+    def enable_automatic_upgrade(self) -> Optional[bool]:
+        """
+        Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
+        """
+        return pulumi.get(self, "enable_automatic_upgrade")
+
+    @property
+    @pulumi.getter(name="forceUpdateTag")
+    def force_update_tag(self) -> Optional[str]:
+        """
+        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.
+        """
+        return pulumi.get(self, "force_update_tag")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Resource Id
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> Optional[str]:
+        """
+        The name of the extension.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="protectedSettings")
+    def protected_settings(self) -> Optional[Any]:
+        """
+        The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
+        """
+        return pulumi.get(self, "protected_settings")
+
+    @property
+    @pulumi.getter(name="protectedSettingsFromKeyVault")
+    def protected_settings_from_key_vault(self) -> Optional['outputs.KeyVaultSecretReferenceResponse']:
+        """
+        The extensions protected settings that are passed by reference, and consumed from key vault
+        """
+        return pulumi.get(self, "protected_settings_from_key_vault")
+
+    @property
+    @pulumi.getter(name="provisionAfterExtensions")
+    def provision_after_extensions(self) -> Optional[Sequence[str]]:
+        """
+        Collection of extension names after which this extension needs to be provisioned.
+        """
+        return pulumi.get(self, "provision_after_extensions")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> str:
+        """
+        The provisioning state, which only appears in the response.
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @property
+    @pulumi.getter
+    def publisher(self) -> Optional[str]:
+        """
+        The name of the extension handler publisher.
+        """
+        return pulumi.get(self, "publisher")
+
+    @property
+    @pulumi.getter
+    def settings(self) -> Optional[Any]:
+        """
+        Json formatted public settings for the extension.
+        """
+        return pulumi.get(self, "settings")
+
+    @property
+    @pulumi.getter(name="suppressFailures")
+    def suppress_failures(self) -> Optional[bool]:
+        """
+        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.
+        """
+        return pulumi.get(self, "suppress_failures")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        Resource type
+        """
+        return pulumi.get(self, "type")
+
+    @property
+    @pulumi.getter(name="typeHandlerVersion")
+    def type_handler_version(self) -> Optional[str]:
+        """
+        Specifies the version of the script handler.
+        """
+        return pulumi.get(self, "type_handler_version")
+
+
+class AwaitableGetVirtualMachineScaleSetExtensionResult(GetVirtualMachineScaleSetExtensionResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetVirtualMachineScaleSetExtensionResult(
+            auto_upgrade_minor_version=self.auto_upgrade_minor_version,
+            enable_automatic_upgrade=self.enable_automatic_upgrade,
+            force_update_tag=self.force_update_tag,
+            id=self.id,
+            name=self.name,
+            protected_settings=self.protected_settings,
+            protected_settings_from_key_vault=self.protected_settings_from_key_vault,
+            provision_after_extensions=self.provision_after_extensions,
+            provisioning_state=self.provisioning_state,
+            publisher=self.publisher,
+            settings=self.settings,
+            suppress_failures=self.suppress_failures,
+            type=self.type,
+            type_handler_version=self.type_handler_version)
+
+
+def get_virtual_machine_scale_set_extension(expand: Optional[str] = None,
+                                            resource_group_name: Optional[str] = None,
+                                            vm_scale_set_name: Optional[str] = None,
+                                            vmss_extension_name: Optional[str] = None,
+                                            opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetVirtualMachineScaleSetExtensionResult:
+    """
+    The operation to get the extension.
+
+
+    :param str expand: The expand expression to apply on the operation.
+    :param str resource_group_name: The name of the resource group.
+    :param str vm_scale_set_name: The name of the VM scale set containing the extension.
+    :param str vmss_extension_name: The name of the VM scale set extension.
+    """
+    __args__ = dict()
+    __args__['expand'] = expand
+    __args__['resourceGroupName'] = resource_group_name
+    __args__['vmScaleSetName'] = vm_scale_set_name
+    __args__['vmssExtensionName'] = vmss_extension_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:compute/v20230901:getVirtualMachineScaleSetExtension', __args__, opts=opts, typ=GetVirtualMachineScaleSetExtensionResult).value
+
+    return AwaitableGetVirtualMachineScaleSetExtensionResult(
+        auto_upgrade_minor_version=pulumi.get(__ret__, 'auto_upgrade_minor_version'),
+        enable_automatic_upgrade=pulumi.get(__ret__, 'enable_automatic_upgrade'),
+        force_update_tag=pulumi.get(__ret__, 'force_update_tag'),
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        protected_settings=pulumi.get(__ret__, 'protected_settings'),
+        protected_settings_from_key_vault=pulumi.get(__ret__, 'protected_settings_from_key_vault'),
+        provision_after_extensions=pulumi.get(__ret__, 'provision_after_extensions'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        publisher=pulumi.get(__ret__, 'publisher'),
+        settings=pulumi.get(__ret__, 'settings'),
+        suppress_failures=pulumi.get(__ret__, 'suppress_failures'),
+        type=pulumi.get(__ret__, 'type'),
+        type_handler_version=pulumi.get(__ret__, 'type_handler_version'))
+
+
+@_utilities.lift_output_func(get_virtual_machine_scale_set_extension)
+def get_virtual_machine_scale_set_extension_output(expand: Optional[pulumi.Input[Optional[str]]] = None,
+                                                   resource_group_name: Optional[pulumi.Input[str]] = None,
+                                                   vm_scale_set_name: Optional[pulumi.Input[str]] = None,
+                                                   vmss_extension_name: Optional[pulumi.Input[str]] = None,
+                                                   opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetVirtualMachineScaleSetExtensionResult]:
+    """
+    The operation to get the extension.
+
+
+    :param str expand: The expand expression to apply on the operation.
+    :param str resource_group_name: The name of the resource group.
+    :param str vm_scale_set_name: The name of the VM scale set containing the extension.
+    :param str vmss_extension_name: The name of the VM scale set extension.
+    """
+    ...