pulumi-azure-native 2.33.1a1711356993__py3-none-any.whl → 2.34.0__py3-none-any.whl

pulumi_azure_native/compute/v20240301/get_virtual_machine_scale_set_vm.py

@@ -0,0 +1,466 @@
+# 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__ = [
+    'GetVirtualMachineScaleSetVMResult',
+    'AwaitableGetVirtualMachineScaleSetVMResult',
+    'get_virtual_machine_scale_set_vm',
+    'get_virtual_machine_scale_set_vm_output',
+]
+
+@pulumi.output_type
+class GetVirtualMachineScaleSetVMResult:
+    """
+    Describes a virtual machine scale set virtual machine.
+    """
+    def __init__(__self__, additional_capabilities=None, availability_set=None, diagnostics_profile=None, etag=None, hardware_profile=None, id=None, identity=None, instance_id=None, instance_view=None, latest_model_applied=None, license_type=None, location=None, model_definition_applied=None, name=None, network_profile=None, network_profile_configuration=None, os_profile=None, plan=None, protection_policy=None, provisioning_state=None, resources=None, security_profile=None, sku=None, storage_profile=None, tags=None, time_created=None, type=None, user_data=None, vm_id=None, zones=None):
+        if additional_capabilities and not isinstance(additional_capabilities, dict):
+            raise TypeError("Expected argument 'additional_capabilities' to be a dict")
+        pulumi.set(__self__, "additional_capabilities", additional_capabilities)
+        if availability_set and not isinstance(availability_set, dict):
+            raise TypeError("Expected argument 'availability_set' to be a dict")
+        pulumi.set(__self__, "availability_set", availability_set)
+        if diagnostics_profile and not isinstance(diagnostics_profile, dict):
+            raise TypeError("Expected argument 'diagnostics_profile' to be a dict")
+        pulumi.set(__self__, "diagnostics_profile", diagnostics_profile)
+        if etag and not isinstance(etag, str):
+            raise TypeError("Expected argument 'etag' to be a str")
+        pulumi.set(__self__, "etag", etag)
+        if hardware_profile and not isinstance(hardware_profile, dict):
+            raise TypeError("Expected argument 'hardware_profile' to be a dict")
+        pulumi.set(__self__, "hardware_profile", hardware_profile)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if identity and not isinstance(identity, dict):
+            raise TypeError("Expected argument 'identity' to be a dict")
+        pulumi.set(__self__, "identity", identity)
+        if instance_id and not isinstance(instance_id, str):
+            raise TypeError("Expected argument 'instance_id' to be a str")
+        pulumi.set(__self__, "instance_id", instance_id)
+        if instance_view and not isinstance(instance_view, dict):
+            raise TypeError("Expected argument 'instance_view' to be a dict")
+        pulumi.set(__self__, "instance_view", instance_view)
+        if latest_model_applied and not isinstance(latest_model_applied, bool):
+            raise TypeError("Expected argument 'latest_model_applied' to be a bool")
+        pulumi.set(__self__, "latest_model_applied", latest_model_applied)
+        if license_type and not isinstance(license_type, str):
+            raise TypeError("Expected argument 'license_type' to be a str")
+        pulumi.set(__self__, "license_type", license_type)
+        if location and not isinstance(location, str):
+            raise TypeError("Expected argument 'location' to be a str")
+        pulumi.set(__self__, "location", location)
+        if model_definition_applied and not isinstance(model_definition_applied, str):
+            raise TypeError("Expected argument 'model_definition_applied' to be a str")
+        pulumi.set(__self__, "model_definition_applied", model_definition_applied)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if network_profile and not isinstance(network_profile, dict):
+            raise TypeError("Expected argument 'network_profile' to be a dict")
+        pulumi.set(__self__, "network_profile", network_profile)
+        if network_profile_configuration and not isinstance(network_profile_configuration, dict):
+            raise TypeError("Expected argument 'network_profile_configuration' to be a dict")
+        pulumi.set(__self__, "network_profile_configuration", network_profile_configuration)
+        if os_profile and not isinstance(os_profile, dict):
+            raise TypeError("Expected argument 'os_profile' to be a dict")
+        pulumi.set(__self__, "os_profile", os_profile)
+        if plan and not isinstance(plan, dict):
+            raise TypeError("Expected argument 'plan' to be a dict")
+        pulumi.set(__self__, "plan", plan)
+        if protection_policy and not isinstance(protection_policy, dict):
+            raise TypeError("Expected argument 'protection_policy' to be a dict")
+        pulumi.set(__self__, "protection_policy", protection_policy)
+        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 resources and not isinstance(resources, list):
+            raise TypeError("Expected argument 'resources' to be a list")
+        pulumi.set(__self__, "resources", resources)
+        if security_profile and not isinstance(security_profile, dict):
+            raise TypeError("Expected argument 'security_profile' to be a dict")
+        pulumi.set(__self__, "security_profile", security_profile)
+        if sku and not isinstance(sku, dict):
+            raise TypeError("Expected argument 'sku' to be a dict")
+        pulumi.set(__self__, "sku", sku)
+        if storage_profile and not isinstance(storage_profile, dict):
+            raise TypeError("Expected argument 'storage_profile' to be a dict")
+        pulumi.set(__self__, "storage_profile", storage_profile)
+        if tags and not isinstance(tags, dict):
+            raise TypeError("Expected argument 'tags' to be a dict")
+        pulumi.set(__self__, "tags", tags)
+        if time_created and not isinstance(time_created, str):
+            raise TypeError("Expected argument 'time_created' to be a str")
+        pulumi.set(__self__, "time_created", time_created)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+        if user_data and not isinstance(user_data, str):
+            raise TypeError("Expected argument 'user_data' to be a str")
+        pulumi.set(__self__, "user_data", user_data)
+        if vm_id and not isinstance(vm_id, str):
+            raise TypeError("Expected argument 'vm_id' to be a str")
+        pulumi.set(__self__, "vm_id", vm_id)
+        if zones and not isinstance(zones, list):
+            raise TypeError("Expected argument 'zones' to be a list")
+        pulumi.set(__self__, "zones", zones)
+
+    @property
+    @pulumi.getter(name="additionalCapabilities")
+    def additional_capabilities(self) -> Optional['outputs.AdditionalCapabilitiesResponse']:
+        """
+        Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
+        """
+        return pulumi.get(self, "additional_capabilities")
+
+    @property
+    @pulumi.getter(name="availabilitySet")
+    def availability_set(self) -> Optional['outputs.SubResourceResponse']:
+        """
+        Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.
+        """
+        return pulumi.get(self, "availability_set")
+
+    @property
+    @pulumi.getter(name="diagnosticsProfile")
+    def diagnostics_profile(self) -> Optional['outputs.DiagnosticsProfileResponse']:
+        """
+        Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
+        """
+        return pulumi.get(self, "diagnostics_profile")
+
+    @property
+    @pulumi.getter
+    def etag(self) -> str:
+        """
+        Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates.
+        """
+        return pulumi.get(self, "etag")
+
+    @property
+    @pulumi.getter(name="hardwareProfile")
+    def hardware_profile(self) -> Optional['outputs.HardwareProfileResponse']:
+        """
+        Specifies the hardware settings for the virtual machine.
+        """
+        return pulumi.get(self, "hardware_profile")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Resource Id
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def identity(self) -> Optional['outputs.VirtualMachineIdentityResponse']:
+        """
+        The identity of the virtual machine, if configured.
+        """
+        return pulumi.get(self, "identity")
+
+    @property
+    @pulumi.getter(name="instanceId")
+    def instance_id(self) -> str:
+        """
+        The virtual machine instance ID.
+        """
+        return pulumi.get(self, "instance_id")
+
+    @property
+    @pulumi.getter(name="instanceView")
+    def instance_view(self) -> 'outputs.VirtualMachineScaleSetVMInstanceViewResponse':
+        """
+        The virtual machine instance view.
+        """
+        return pulumi.get(self, "instance_view")
+
+    @property
+    @pulumi.getter(name="latestModelApplied")
+    def latest_model_applied(self) -> bool:
+        """
+        Specifies whether the latest model has been applied to the virtual machine.
+        """
+        return pulumi.get(self, "latest_model_applied")
+
+    @property
+    @pulumi.getter(name="licenseType")
+    def license_type(self) -> Optional[str]:
+        """
+        Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15
+        """
+        return pulumi.get(self, "license_type")
+
+    @property
+    @pulumi.getter
+    def location(self) -> str:
+        """
+        Resource location
+        """
+        return pulumi.get(self, "location")
+
+    @property
+    @pulumi.getter(name="modelDefinitionApplied")
+    def model_definition_applied(self) -> str:
+        """
+        Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.
+        """
+        return pulumi.get(self, "model_definition_applied")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        Resource name
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="networkProfile")
+    def network_profile(self) -> Optional['outputs.NetworkProfileResponse']:
+        """
+        Specifies the network interfaces of the virtual machine.
+        """
+        return pulumi.get(self, "network_profile")
+
+    @property
+    @pulumi.getter(name="networkProfileConfiguration")
+    def network_profile_configuration(self) -> Optional['outputs.VirtualMachineScaleSetVMNetworkProfileConfigurationResponse']:
+        """
+        Specifies the network profile configuration of the virtual machine.
+        """
+        return pulumi.get(self, "network_profile_configuration")
+
+    @property
+    @pulumi.getter(name="osProfile")
+    def os_profile(self) -> Optional['outputs.OSProfileResponse']:
+        """
+        Specifies the operating system settings for the virtual machine.
+        """
+        return pulumi.get(self, "os_profile")
+
+    @property
+    @pulumi.getter
+    def plan(self) -> Optional['outputs.PlanResponse']:
+        """
+        Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use.  In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.
+        """
+        return pulumi.get(self, "plan")
+
+    @property
+    @pulumi.getter(name="protectionPolicy")
+    def protection_policy(self) -> Optional['outputs.VirtualMachineScaleSetVMProtectionPolicyResponse']:
+        """
+        Specifies the protection policy of the virtual machine.
+        """
+        return pulumi.get(self, "protection_policy")
+
+    @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 resources(self) -> Sequence['outputs.VirtualMachineExtensionResponse']:
+        """
+        The virtual machine child extension resources.
+        """
+        return pulumi.get(self, "resources")
+
+    @property
+    @pulumi.getter(name="securityProfile")
+    def security_profile(self) -> Optional['outputs.SecurityProfileResponse']:
+        """
+        Specifies the Security related profile settings for the virtual machine.
+        """
+        return pulumi.get(self, "security_profile")
+
+    @property
+    @pulumi.getter
+    def sku(self) -> 'outputs.SkuResponse':
+        """
+        The virtual machine SKU.
+        """
+        return pulumi.get(self, "sku")
+
+    @property
+    @pulumi.getter(name="storageProfile")
+    def storage_profile(self) -> Optional['outputs.StorageProfileResponse']:
+        """
+        Specifies the storage settings for the virtual machine disks.
+        """
+        return pulumi.get(self, "storage_profile")
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Optional[Mapping[str, str]]:
+        """
+        Resource tags
+        """
+        return pulumi.get(self, "tags")
+
+    @property
+    @pulumi.getter(name="timeCreated")
+    def time_created(self) -> str:
+        """
+        Specifies the time at which the Virtual Machine resource was created.<br><br>Minimum api-version: 2021-11-01.
+        """
+        return pulumi.get(self, "time_created")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        Resource type
+        """
+        return pulumi.get(self, "type")
+
+    @property
+    @pulumi.getter(name="userData")
+    def user_data(self) -> Optional[str]:
+        """
+        UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01
+        """
+        return pulumi.get(self, "user_data")
+
+    @property
+    @pulumi.getter(name="vmId")
+    def vm_id(self) -> str:
+        """
+        Azure VM unique ID.
+        """
+        return pulumi.get(self, "vm_id")
+
+    @property
+    @pulumi.getter
+    def zones(self) -> Sequence[str]:
+        """
+        The virtual machine zones.
+        """
+        return pulumi.get(self, "zones")
+
+
+class AwaitableGetVirtualMachineScaleSetVMResult(GetVirtualMachineScaleSetVMResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetVirtualMachineScaleSetVMResult(
+            additional_capabilities=self.additional_capabilities,
+            availability_set=self.availability_set,
+            diagnostics_profile=self.diagnostics_profile,
+            etag=self.etag,
+            hardware_profile=self.hardware_profile,
+            id=self.id,
+            identity=self.identity,
+            instance_id=self.instance_id,
+            instance_view=self.instance_view,
+            latest_model_applied=self.latest_model_applied,
+            license_type=self.license_type,
+            location=self.location,
+            model_definition_applied=self.model_definition_applied,
+            name=self.name,
+            network_profile=self.network_profile,
+            network_profile_configuration=self.network_profile_configuration,
+            os_profile=self.os_profile,
+            plan=self.plan,
+            protection_policy=self.protection_policy,
+            provisioning_state=self.provisioning_state,
+            resources=self.resources,
+            security_profile=self.security_profile,
+            sku=self.sku,
+            storage_profile=self.storage_profile,
+            tags=self.tags,
+            time_created=self.time_created,
+            type=self.type,
+            user_data=self.user_data,
+            vm_id=self.vm_id,
+            zones=self.zones)
+
+
+def get_virtual_machine_scale_set_vm(expand: Optional[str] = None,
+                                     instance_id: Optional[str] = None,
+                                     resource_group_name: Optional[str] = None,
+                                     vm_scale_set_name: Optional[str] = None,
+                                     opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetVirtualMachineScaleSetVMResult:
+    """
+    Gets a virtual machine from a VM scale set.
+
+
+    :param str expand: The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.
+    :param str instance_id: The instance ID of the virtual machine.
+    :param str resource_group_name: The name of the resource group.
+    :param str vm_scale_set_name: The name of the VM scale set.
+    """
+    __args__ = dict()
+    __args__['expand'] = expand
+    __args__['instanceId'] = instance_id
+    __args__['resourceGroupName'] = resource_group_name
+    __args__['vmScaleSetName'] = vm_scale_set_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:compute/v20240301:getVirtualMachineScaleSetVM', __args__, opts=opts, typ=GetVirtualMachineScaleSetVMResult).value
+
+    return AwaitableGetVirtualMachineScaleSetVMResult(
+        additional_capabilities=pulumi.get(__ret__, 'additional_capabilities'),
+        availability_set=pulumi.get(__ret__, 'availability_set'),
+        diagnostics_profile=pulumi.get(__ret__, 'diagnostics_profile'),
+        etag=pulumi.get(__ret__, 'etag'),
+        hardware_profile=pulumi.get(__ret__, 'hardware_profile'),
+        id=pulumi.get(__ret__, 'id'),
+        identity=pulumi.get(__ret__, 'identity'),
+        instance_id=pulumi.get(__ret__, 'instance_id'),
+        instance_view=pulumi.get(__ret__, 'instance_view'),
+        latest_model_applied=pulumi.get(__ret__, 'latest_model_applied'),
+        license_type=pulumi.get(__ret__, 'license_type'),
+        location=pulumi.get(__ret__, 'location'),
+        model_definition_applied=pulumi.get(__ret__, 'model_definition_applied'),
+        name=pulumi.get(__ret__, 'name'),
+        network_profile=pulumi.get(__ret__, 'network_profile'),
+        network_profile_configuration=pulumi.get(__ret__, 'network_profile_configuration'),
+        os_profile=pulumi.get(__ret__, 'os_profile'),
+        plan=pulumi.get(__ret__, 'plan'),
+        protection_policy=pulumi.get(__ret__, 'protection_policy'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        resources=pulumi.get(__ret__, 'resources'),
+        security_profile=pulumi.get(__ret__, 'security_profile'),
+        sku=pulumi.get(__ret__, 'sku'),
+        storage_profile=pulumi.get(__ret__, 'storage_profile'),
+        tags=pulumi.get(__ret__, 'tags'),
+        time_created=pulumi.get(__ret__, 'time_created'),
+        type=pulumi.get(__ret__, 'type'),
+        user_data=pulumi.get(__ret__, 'user_data'),
+        vm_id=pulumi.get(__ret__, 'vm_id'),
+        zones=pulumi.get(__ret__, 'zones'))
+
+
+@_utilities.lift_output_func(get_virtual_machine_scale_set_vm)
+def get_virtual_machine_scale_set_vm_output(expand: Optional[pulumi.Input[Optional[str]]] = None,
+                                            instance_id: Optional[pulumi.Input[str]] = None,
+                                            resource_group_name: Optional[pulumi.Input[str]] = None,
+                                            vm_scale_set_name: Optional[pulumi.Input[str]] = None,
+                                            opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetVirtualMachineScaleSetVMResult]:
+    """
+    Gets a virtual machine from a VM scale set.
+
+
+    :param str expand: The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.
+    :param str instance_id: The instance ID of the virtual machine.
+    :param str resource_group_name: The name of the resource group.
+    :param str vm_scale_set_name: The name of the VM scale set.
+    """
+    ...