pulumi-azure-native 2.80.0a1735629569__py3-none-any.whl → 2.81.0__py3-none-any.whl

pulumi_azure_native/networkcloud/v20241001preview/get_volume.py

@@ -0,0 +1,252 @@
+# 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 sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetVolumeResult',
+    'AwaitableGetVolumeResult',
+    'get_volume',
+    'get_volume_output',
+]
+
+@pulumi.output_type
+class GetVolumeResult:
+    def __init__(__self__, attached_to=None, detailed_status=None, detailed_status_message=None, extended_location=None, id=None, location=None, name=None, provisioning_state=None, serial_number=None, size_mi_b=None, system_data=None, tags=None, type=None):
+        if attached_to and not isinstance(attached_to, list):
+            raise TypeError("Expected argument 'attached_to' to be a list")
+        pulumi.set(__self__, "attached_to", attached_to)
+        if detailed_status and not isinstance(detailed_status, str):
+            raise TypeError("Expected argument 'detailed_status' to be a str")
+        pulumi.set(__self__, "detailed_status", detailed_status)
+        if detailed_status_message and not isinstance(detailed_status_message, str):
+            raise TypeError("Expected argument 'detailed_status_message' to be a str")
+        pulumi.set(__self__, "detailed_status_message", detailed_status_message)
+        if extended_location and not isinstance(extended_location, dict):
+            raise TypeError("Expected argument 'extended_location' to be a dict")
+        pulumi.set(__self__, "extended_location", extended_location)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if location and not isinstance(location, str):
+            raise TypeError("Expected argument 'location' to be a str")
+        pulumi.set(__self__, "location", location)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        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 serial_number and not isinstance(serial_number, str):
+            raise TypeError("Expected argument 'serial_number' to be a str")
+        pulumi.set(__self__, "serial_number", serial_number)
+        if size_mi_b and not isinstance(size_mi_b, float):
+            raise TypeError("Expected argument 'size_mi_b' to be a float")
+        pulumi.set(__self__, "size_mi_b", size_mi_b)
+        if system_data and not isinstance(system_data, dict):
+            raise TypeError("Expected argument 'system_data' to be a dict")
+        pulumi.set(__self__, "system_data", system_data)
+        if tags and not isinstance(tags, dict):
+            raise TypeError("Expected argument 'tags' to be a dict")
+        pulumi.set(__self__, "tags", tags)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @property
+    @pulumi.getter(name="attachedTo")
+    def attached_to(self) -> Sequence[str]:
+        """
+        The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
+        """
+        return pulumi.get(self, "attached_to")
+
+    @property
+    @pulumi.getter(name="detailedStatus")
+    def detailed_status(self) -> str:
+        """
+        The more detailed status of the volume.
+        """
+        return pulumi.get(self, "detailed_status")
+
+    @property
+    @pulumi.getter(name="detailedStatusMessage")
+    def detailed_status_message(self) -> str:
+        """
+        The descriptive message about the current detailed status.
+        """
+        return pulumi.get(self, "detailed_status_message")
+
+    @property
+    @pulumi.getter(name="extendedLocation")
+    def extended_location(self) -> 'outputs.ExtendedLocationResponse':
+        """
+        The extended location of the cluster associated with the resource.
+        """
+        return pulumi.get(self, "extended_location")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def location(self) -> str:
+        """
+        The geo-location where the resource lives
+        """
+        return pulumi.get(self, "location")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> str:
+        """
+        The provisioning state of the volume.
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @property
+    @pulumi.getter(name="serialNumber")
+    def serial_number(self) -> str:
+        """
+        The unique identifier of the volume.
+        """
+        return pulumi.get(self, "serial_number")
+
+    @property
+    @pulumi.getter(name="sizeMiB")
+    def size_mi_b(self) -> float:
+        """
+        The size of the allocation for this volume in Mebibytes.
+        """
+        return pulumi.get(self, "size_mi_b")
+
+    @property
+    @pulumi.getter(name="systemData")
+    def system_data(self) -> 'outputs.SystemDataResponse':
+        """
+        Azure Resource Manager metadata containing createdBy and modifiedBy information.
+        """
+        return pulumi.get(self, "system_data")
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Optional[Mapping[str, str]]:
+        """
+        Resource tags.
+        """
+        return pulumi.get(self, "tags")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetVolumeResult(GetVolumeResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetVolumeResult(
+            attached_to=self.attached_to,
+            detailed_status=self.detailed_status,
+            detailed_status_message=self.detailed_status_message,
+            extended_location=self.extended_location,
+            id=self.id,
+            location=self.location,
+            name=self.name,
+            provisioning_state=self.provisioning_state,
+            serial_number=self.serial_number,
+            size_mi_b=self.size_mi_b,
+            system_data=self.system_data,
+            tags=self.tags,
+            type=self.type)
+
+
+def get_volume(resource_group_name: Optional[str] = None,
+               volume_name: Optional[str] = None,
+               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetVolumeResult:
+    """
+    Get properties of the provided volume.
+
+
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str volume_name: The name of the volume.
+    """
+    __args__ = dict()
+    __args__['resourceGroupName'] = resource_group_name
+    __args__['volumeName'] = volume_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:networkcloud/v20241001preview:getVolume', __args__, opts=opts, typ=GetVolumeResult).value
+
+    return AwaitableGetVolumeResult(
+        attached_to=pulumi.get(__ret__, 'attached_to'),
+        detailed_status=pulumi.get(__ret__, 'detailed_status'),
+        detailed_status_message=pulumi.get(__ret__, 'detailed_status_message'),
+        extended_location=pulumi.get(__ret__, 'extended_location'),
+        id=pulumi.get(__ret__, 'id'),
+        location=pulumi.get(__ret__, 'location'),
+        name=pulumi.get(__ret__, 'name'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        serial_number=pulumi.get(__ret__, 'serial_number'),
+        size_mi_b=pulumi.get(__ret__, 'size_mi_b'),
+        system_data=pulumi.get(__ret__, 'system_data'),
+        tags=pulumi.get(__ret__, 'tags'),
+        type=pulumi.get(__ret__, 'type'))
+def get_volume_output(resource_group_name: Optional[pulumi.Input[str]] = None,
+                      volume_name: Optional[pulumi.Input[str]] = None,
+                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetVolumeResult]:
+    """
+    Get properties of the provided volume.
+
+
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str volume_name: The name of the volume.
+    """
+    __args__ = dict()
+    __args__['resourceGroupName'] = resource_group_name
+    __args__['volumeName'] = volume_name
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('azure-native:networkcloud/v20241001preview:getVolume', __args__, opts=opts, typ=GetVolumeResult)
+    return __ret__.apply(lambda __response__: GetVolumeResult(
+        attached_to=pulumi.get(__response__, 'attached_to'),
+        detailed_status=pulumi.get(__response__, 'detailed_status'),
+        detailed_status_message=pulumi.get(__response__, 'detailed_status_message'),
+        extended_location=pulumi.get(__response__, 'extended_location'),
+        id=pulumi.get(__response__, 'id'),
+        location=pulumi.get(__response__, 'location'),
+        name=pulumi.get(__response__, 'name'),
+        provisioning_state=pulumi.get(__response__, 'provisioning_state'),
+        serial_number=pulumi.get(__response__, 'serial_number'),
+        size_mi_b=pulumi.get(__response__, 'size_mi_b'),
+        system_data=pulumi.get(__response__, 'system_data'),
+        tags=pulumi.get(__response__, 'tags'),
+        type=pulumi.get(__response__, 'type')))