pulumi-azure-native 2.40.0a1714997514__py3-none-any.whl → 2.41.0__py3-none-any.whl

pulumi_azure_native/storage/v20230501/file_share.py

@@ -0,0 +1,501 @@
+# 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
+from ._enums import *
+from ._inputs import *
+
+__all__ = ['FileShareArgs', 'FileShare']
+
+@pulumi.input_type
+class FileShareArgs:
+    def __init__(__self__, *,
+                 account_name: pulumi.Input[str],
+                 resource_group_name: pulumi.Input[str],
+                 access_tier: Optional[pulumi.Input[Union[str, 'ShareAccessTier']]] = None,
+                 enabled_protocols: Optional[pulumi.Input[Union[str, 'EnabledProtocols']]] = None,
+                 expand: Optional[pulumi.Input[str]] = None,
+                 metadata: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 root_squash: Optional[pulumi.Input[Union[str, 'RootSquashType']]] = None,
+                 share_name: Optional[pulumi.Input[str]] = None,
+                 share_quota: Optional[pulumi.Input[int]] = None,
+                 signed_identifiers: Optional[pulumi.Input[Sequence[pulumi.Input['SignedIdentifierArgs']]]] = None):
+        """
+        The set of arguments for constructing a FileShare resource.
+        :param pulumi.Input[str] account_name: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
+        :param pulumi.Input[str] resource_group_name: The name of the resource group within the user's subscription. The name is case insensitive.
+        :param pulumi.Input[Union[str, 'ShareAccessTier']] access_tier: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
+        :param pulumi.Input[Union[str, 'EnabledProtocols']] enabled_protocols: The authentication protocol that is used for the file share. Can only be specified when creating a share.
+        :param pulumi.Input[str] expand: Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] metadata: A name-value pair to associate with the share as metadata.
+        :param pulumi.Input[Union[str, 'RootSquashType']] root_squash: The property is for NFS share only. The default is NoRootSquash.
+        :param pulumi.Input[str] share_name: The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
+        :param pulumi.Input[int] share_quota: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.
+        :param pulumi.Input[Sequence[pulumi.Input['SignedIdentifierArgs']]] signed_identifiers: List of stored access policies specified on the share.
+        """
+        pulumi.set(__self__, "account_name", account_name)
+        pulumi.set(__self__, "resource_group_name", resource_group_name)
+        if access_tier is not None:
+            pulumi.set(__self__, "access_tier", access_tier)
+        if enabled_protocols is not None:
+            pulumi.set(__self__, "enabled_protocols", enabled_protocols)
+        if expand is not None:
+            pulumi.set(__self__, "expand", expand)
+        if metadata is not None:
+            pulumi.set(__self__, "metadata", metadata)
+        if root_squash is not None:
+            pulumi.set(__self__, "root_squash", root_squash)
+        if share_name is not None:
+            pulumi.set(__self__, "share_name", share_name)
+        if share_quota is not None:
+            pulumi.set(__self__, "share_quota", share_quota)
+        if signed_identifiers is not None:
+            pulumi.set(__self__, "signed_identifiers", signed_identifiers)
+
+    @property
+    @pulumi.getter(name="accountName")
+    def account_name(self) -> pulumi.Input[str]:
+        """
+        The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
+        """
+        return pulumi.get(self, "account_name")
+
+    @account_name.setter
+    def account_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "account_name", value)
+
+    @property
+    @pulumi.getter(name="resourceGroupName")
+    def resource_group_name(self) -> pulumi.Input[str]:
+        """
+        The name of the resource group within the user's subscription. The name is case insensitive.
+        """
+        return pulumi.get(self, "resource_group_name")
+
+    @resource_group_name.setter
+    def resource_group_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "resource_group_name", value)
+
+    @property
+    @pulumi.getter(name="accessTier")
+    def access_tier(self) -> Optional[pulumi.Input[Union[str, 'ShareAccessTier']]]:
+        """
+        Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
+        """
+        return pulumi.get(self, "access_tier")
+
+    @access_tier.setter
+    def access_tier(self, value: Optional[pulumi.Input[Union[str, 'ShareAccessTier']]]):
+        pulumi.set(self, "access_tier", value)
+
+    @property
+    @pulumi.getter(name="enabledProtocols")
+    def enabled_protocols(self) -> Optional[pulumi.Input[Union[str, 'EnabledProtocols']]]:
+        """
+        The authentication protocol that is used for the file share. Can only be specified when creating a share.
+        """
+        return pulumi.get(self, "enabled_protocols")
+
+    @enabled_protocols.setter
+    def enabled_protocols(self, value: Optional[pulumi.Input[Union[str, 'EnabledProtocols']]]):
+        pulumi.set(self, "enabled_protocols", value)
+
+    @property
+    @pulumi.getter
+    def expand(self) -> Optional[pulumi.Input[str]]:
+        """
+        Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
+        """
+        return pulumi.get(self, "expand")
+
+    @expand.setter
+    def expand(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "expand", value)
+
+    @property
+    @pulumi.getter
+    def metadata(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
+        """
+        A name-value pair to associate with the share as metadata.
+        """
+        return pulumi.get(self, "metadata")
+
+    @metadata.setter
+    def metadata(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
+        pulumi.set(self, "metadata", value)
+
+    @property
+    @pulumi.getter(name="rootSquash")
+    def root_squash(self) -> Optional[pulumi.Input[Union[str, 'RootSquashType']]]:
+        """
+        The property is for NFS share only. The default is NoRootSquash.
+        """
+        return pulumi.get(self, "root_squash")
+
+    @root_squash.setter
+    def root_squash(self, value: Optional[pulumi.Input[Union[str, 'RootSquashType']]]):
+        pulumi.set(self, "root_squash", value)
+
+    @property
+    @pulumi.getter(name="shareName")
+    def share_name(self) -> Optional[pulumi.Input[str]]:
+        """
+        The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
+        """
+        return pulumi.get(self, "share_name")
+
+    @share_name.setter
+    def share_name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "share_name", value)
+
+    @property
+    @pulumi.getter(name="shareQuota")
+    def share_quota(self) -> Optional[pulumi.Input[int]]:
+        """
+        The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.
+        """
+        return pulumi.get(self, "share_quota")
+
+    @share_quota.setter
+    def share_quota(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "share_quota", value)
+
+    @property
+    @pulumi.getter(name="signedIdentifiers")
+    def signed_identifiers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SignedIdentifierArgs']]]]:
+        """
+        List of stored access policies specified on the share.
+        """
+        return pulumi.get(self, "signed_identifiers")
+
+    @signed_identifiers.setter
+    def signed_identifiers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SignedIdentifierArgs']]]]):
+        pulumi.set(self, "signed_identifiers", value)
+
+
+class FileShare(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 access_tier: Optional[pulumi.Input[Union[str, 'ShareAccessTier']]] = None,
+                 account_name: Optional[pulumi.Input[str]] = None,
+                 enabled_protocols: Optional[pulumi.Input[Union[str, 'EnabledProtocols']]] = None,
+                 expand: Optional[pulumi.Input[str]] = None,
+                 metadata: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 resource_group_name: Optional[pulumi.Input[str]] = None,
+                 root_squash: Optional[pulumi.Input[Union[str, 'RootSquashType']]] = None,
+                 share_name: Optional[pulumi.Input[str]] = None,
+                 share_quota: Optional[pulumi.Input[int]] = None,
+                 signed_identifiers: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['SignedIdentifierArgs']]]]] = None,
+                 __props__=None):
+        """
+        Properties of the file share, including Id, resource name, resource type, Etag.
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[Union[str, 'ShareAccessTier']] access_tier: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
+        :param pulumi.Input[str] account_name: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
+        :param pulumi.Input[Union[str, 'EnabledProtocols']] enabled_protocols: The authentication protocol that is used for the file share. Can only be specified when creating a share.
+        :param pulumi.Input[str] expand: Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] metadata: A name-value pair to associate with the share as metadata.
+        :param pulumi.Input[str] resource_group_name: The name of the resource group within the user's subscription. The name is case insensitive.
+        :param pulumi.Input[Union[str, 'RootSquashType']] root_squash: The property is for NFS share only. The default is NoRootSquash.
+        :param pulumi.Input[str] share_name: The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
+        :param pulumi.Input[int] share_quota: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.
+        :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['SignedIdentifierArgs']]]] signed_identifiers: List of stored access policies specified on the share.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: FileShareArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Properties of the file share, including Id, resource name, resource type, Etag.
+
+        :param str resource_name: The name of the resource.
+        :param FileShareArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(FileShareArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 access_tier: Optional[pulumi.Input[Union[str, 'ShareAccessTier']]] = None,
+                 account_name: Optional[pulumi.Input[str]] = None,
+                 enabled_protocols: Optional[pulumi.Input[Union[str, 'EnabledProtocols']]] = None,
+                 expand: Optional[pulumi.Input[str]] = None,
+                 metadata: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 resource_group_name: Optional[pulumi.Input[str]] = None,
+                 root_squash: Optional[pulumi.Input[Union[str, 'RootSquashType']]] = None,
+                 share_name: Optional[pulumi.Input[str]] = None,
+                 share_quota: Optional[pulumi.Input[int]] = None,
+                 signed_identifiers: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['SignedIdentifierArgs']]]]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = FileShareArgs.__new__(FileShareArgs)
+
+            __props__.__dict__["access_tier"] = access_tier
+            if account_name is None and not opts.urn:
+                raise TypeError("Missing required property 'account_name'")
+            __props__.__dict__["account_name"] = account_name
+            __props__.__dict__["enabled_protocols"] = enabled_protocols
+            __props__.__dict__["expand"] = expand
+            __props__.__dict__["metadata"] = metadata
+            if resource_group_name is None and not opts.urn:
+                raise TypeError("Missing required property 'resource_group_name'")
+            __props__.__dict__["resource_group_name"] = resource_group_name
+            __props__.__dict__["root_squash"] = root_squash
+            __props__.__dict__["share_name"] = share_name
+            __props__.__dict__["share_quota"] = share_quota
+            __props__.__dict__["signed_identifiers"] = signed_identifiers
+            __props__.__dict__["access_tier_change_time"] = None
+            __props__.__dict__["access_tier_status"] = None
+            __props__.__dict__["deleted"] = None
+            __props__.__dict__["deleted_time"] = None
+            __props__.__dict__["etag"] = None
+            __props__.__dict__["last_modified_time"] = None
+            __props__.__dict__["lease_duration"] = None
+            __props__.__dict__["lease_state"] = None
+            __props__.__dict__["lease_status"] = None
+            __props__.__dict__["name"] = None
+            __props__.__dict__["remaining_retention_days"] = None
+            __props__.__dict__["share_usage_bytes"] = None
+            __props__.__dict__["snapshot_time"] = None
+            __props__.__dict__["type"] = None
+            __props__.__dict__["version"] = None
+        alias_opts = pulumi.ResourceOptions(aliases=[pulumi.Alias(type_="azure-native:storage:FileShare"), pulumi.Alias(type_="azure-native:storage/v20190401:FileShare"), pulumi.Alias(type_="azure-native:storage/v20190601:FileShare"), pulumi.Alias(type_="azure-native:storage/v20200801preview:FileShare"), pulumi.Alias(type_="azure-native:storage/v20210101:FileShare"), pulumi.Alias(type_="azure-native:storage/v20210201:FileShare"), pulumi.Alias(type_="azure-native:storage/v20210401:FileShare"), pulumi.Alias(type_="azure-native:storage/v20210601:FileShare"), pulumi.Alias(type_="azure-native:storage/v20210801:FileShare"), pulumi.Alias(type_="azure-native:storage/v20210901:FileShare"), pulumi.Alias(type_="azure-native:storage/v20220501:FileShare"), pulumi.Alias(type_="azure-native:storage/v20220901:FileShare"), pulumi.Alias(type_="azure-native:storage/v20230101:FileShare"), pulumi.Alias(type_="azure-native:storage/v20230401:FileShare")])
+        opts = pulumi.ResourceOptions.merge(opts, alias_opts)
+        super(FileShare, __self__).__init__(
+            'azure-native:storage/v20230501:FileShare',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None) -> 'FileShare':
+        """
+        Get an existing FileShare resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = FileShareArgs.__new__(FileShareArgs)
+
+        __props__.__dict__["access_tier"] = None
+        __props__.__dict__["access_tier_change_time"] = None
+        __props__.__dict__["access_tier_status"] = None
+        __props__.__dict__["deleted"] = None
+        __props__.__dict__["deleted_time"] = None
+        __props__.__dict__["enabled_protocols"] = None
+        __props__.__dict__["etag"] = None
+        __props__.__dict__["last_modified_time"] = None
+        __props__.__dict__["lease_duration"] = None
+        __props__.__dict__["lease_state"] = None
+        __props__.__dict__["lease_status"] = None
+        __props__.__dict__["metadata"] = None
+        __props__.__dict__["name"] = None
+        __props__.__dict__["remaining_retention_days"] = None
+        __props__.__dict__["root_squash"] = None
+        __props__.__dict__["share_quota"] = None
+        __props__.__dict__["share_usage_bytes"] = None
+        __props__.__dict__["signed_identifiers"] = None
+        __props__.__dict__["snapshot_time"] = None
+        __props__.__dict__["type"] = None
+        __props__.__dict__["version"] = None
+        return FileShare(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="accessTier")
+    def access_tier(self) -> pulumi.Output[Optional[str]]:
+        """
+        Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
+        """
+        return pulumi.get(self, "access_tier")
+
+    @property
+    @pulumi.getter(name="accessTierChangeTime")
+    def access_tier_change_time(self) -> pulumi.Output[str]:
+        """
+        Indicates the last modification time for share access tier.
+        """
+        return pulumi.get(self, "access_tier_change_time")
+
+    @property
+    @pulumi.getter(name="accessTierStatus")
+    def access_tier_status(self) -> pulumi.Output[str]:
+        """
+        Indicates if there is a pending transition for access tier.
+        """
+        return pulumi.get(self, "access_tier_status")
+
+    @property
+    @pulumi.getter
+    def deleted(self) -> pulumi.Output[bool]:
+        """
+        Indicates whether the share was deleted.
+        """
+        return pulumi.get(self, "deleted")
+
+    @property
+    @pulumi.getter(name="deletedTime")
+    def deleted_time(self) -> pulumi.Output[str]:
+        """
+        The deleted time if the share was deleted.
+        """
+        return pulumi.get(self, "deleted_time")
+
+    @property
+    @pulumi.getter(name="enabledProtocols")
+    def enabled_protocols(self) -> pulumi.Output[Optional[str]]:
+        """
+        The authentication protocol that is used for the file share. Can only be specified when creating a share.
+        """
+        return pulumi.get(self, "enabled_protocols")
+
+    @property
+    @pulumi.getter
+    def etag(self) -> pulumi.Output[str]:
+        """
+        Resource Etag.
+        """
+        return pulumi.get(self, "etag")
+
+    @property
+    @pulumi.getter(name="lastModifiedTime")
+    def last_modified_time(self) -> pulumi.Output[str]:
+        """
+        Returns the date and time the share was last modified.
+        """
+        return pulumi.get(self, "last_modified_time")
+
+    @property
+    @pulumi.getter(name="leaseDuration")
+    def lease_duration(self) -> pulumi.Output[str]:
+        """
+        Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
+        """
+        return pulumi.get(self, "lease_duration")
+
+    @property
+    @pulumi.getter(name="leaseState")
+    def lease_state(self) -> pulumi.Output[str]:
+        """
+        Lease state of the share.
+        """
+        return pulumi.get(self, "lease_state")
+
+    @property
+    @pulumi.getter(name="leaseStatus")
+    def lease_status(self) -> pulumi.Output[str]:
+        """
+        The lease status of the share.
+        """
+        return pulumi.get(self, "lease_status")
+
+    @property
+    @pulumi.getter
+    def metadata(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
+        """
+        A name-value pair to associate with the share as metadata.
+        """
+        return pulumi.get(self, "metadata")
+
+    @property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[str]:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="remainingRetentionDays")
+    def remaining_retention_days(self) -> pulumi.Output[int]:
+        """
+        Remaining retention days for share that was soft deleted.
+        """
+        return pulumi.get(self, "remaining_retention_days")
+
+    @property
+    @pulumi.getter(name="rootSquash")
+    def root_squash(self) -> pulumi.Output[Optional[str]]:
+        """
+        The property is for NFS share only. The default is NoRootSquash.
+        """
+        return pulumi.get(self, "root_squash")
+
+    @property
+    @pulumi.getter(name="shareQuota")
+    def share_quota(self) -> pulumi.Output[Optional[int]]:
+        """
+        The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.
+        """
+        return pulumi.get(self, "share_quota")
+
+    @property
+    @pulumi.getter(name="shareUsageBytes")
+    def share_usage_bytes(self) -> pulumi.Output[float]:
+        """
+        The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
+        """
+        return pulumi.get(self, "share_usage_bytes")
+
+    @property
+    @pulumi.getter(name="signedIdentifiers")
+    def signed_identifiers(self) -> pulumi.Output[Optional[Sequence['outputs.SignedIdentifierResponse']]]:
+        """
+        List of stored access policies specified on the share.
+        """
+        return pulumi.get(self, "signed_identifiers")
+
+    @property
+    @pulumi.getter(name="snapshotTime")
+    def snapshot_time(self) -> pulumi.Output[str]:
+        """
+        Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
+        """
+        return pulumi.get(self, "snapshot_time")
+
+    @property
+    @pulumi.getter
+    def type(self) -> pulumi.Output[str]:
+        """
+        The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+        """
+        return pulumi.get(self, "type")
+
+    @property
+    @pulumi.getter
+    def version(self) -> pulumi.Output[str]:
+        """
+        The version of the share.
+        """
+        return pulumi.get(self, "version")
+