1. Packages
  2. Azure Native
  3. API Docs
  4. storage
  5. getFileShare
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.0 published on Monday, Jun 24, 2024 by Pulumi

azure-native.storage.getFileShare

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.0 published on Monday, Jun 24, 2024 by Pulumi

    Gets properties of a specified share. Azure REST API version: 2022-09-01.

    Other available API versions: 2023-01-01, 2023-04-01, 2023-05-01.

    Using getFileShare

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFileShare(args: GetFileShareArgs, opts?: InvokeOptions): Promise<GetFileShareResult>
    function getFileShareOutput(args: GetFileShareOutputArgs, opts?: InvokeOptions): Output<GetFileShareResult>
    def get_file_share(account_name: Optional[str] = None,
                       expand: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       share_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetFileShareResult
    def get_file_share_output(account_name: Optional[pulumi.Input[str]] = None,
                       expand: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       share_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetFileShareResult]
    func LookupFileShare(ctx *Context, args *LookupFileShareArgs, opts ...InvokeOption) (*LookupFileShareResult, error)
    func LookupFileShareOutput(ctx *Context, args *LookupFileShareOutputArgs, opts ...InvokeOption) LookupFileShareResultOutput

    > Note: This function is named LookupFileShare in the Go SDK.

    public static class GetFileShare 
    {
        public static Task<GetFileShareResult> InvokeAsync(GetFileShareArgs args, InvokeOptions? opts = null)
        public static Output<GetFileShareResult> Invoke(GetFileShareInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFileShareResult> getFileShare(GetFileShareArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:storage:getFileShare
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    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.
    ResourceGroupName string
    The name of the resource group within the user's subscription. The name is case insensitive.
    ShareName string
    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.
    Expand string
    Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.
    AccountName string
    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.
    ResourceGroupName string
    The name of the resource group within the user's subscription. The name is case insensitive.
    ShareName string
    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.
    Expand string
    Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.
    accountName String
    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.
    resourceGroupName String
    The name of the resource group within the user's subscription. The name is case insensitive.
    shareName String
    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.
    expand String
    Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.
    accountName string
    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.
    resourceGroupName string
    The name of the resource group within the user's subscription. The name is case insensitive.
    shareName string
    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.
    expand string
    Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.
    account_name 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.
    resource_group_name str
    The name of the resource group within the user's subscription. The name is case insensitive.
    share_name 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.
    expand str
    Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.
    accountName String
    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.
    resourceGroupName String
    The name of the resource group within the user's subscription. The name is case insensitive.
    shareName String
    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.
    expand String
    Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.

    getFileShare Result

    The following output properties are available:

    AccessTierChangeTime string
    Indicates the last modification time for share access tier.
    AccessTierStatus string
    Indicates if there is a pending transition for access tier.
    Deleted bool
    Indicates whether the share was deleted.
    DeletedTime string
    The deleted time if the share was deleted.
    Etag string
    Resource Etag.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    LastModifiedTime string
    Returns the date and time the share was last modified.
    LeaseDuration string
    Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
    LeaseState string
    Lease state of the share.
    LeaseStatus string
    The lease status of the share.
    Name string
    The name of the resource
    RemainingRetentionDays int
    Remaining retention days for share that was soft deleted.
    ShareUsageBytes double
    The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
    SnapshotTime string
    Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Version string
    The version of the share.
    AccessTier string
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
    EnabledProtocols string
    The authentication protocol that is used for the file share. Can only be specified when creating a share.
    Metadata Dictionary<string, string>
    A name-value pair to associate with the share as metadata.
    RootSquash string
    The property is for NFS share only. The default is NoRootSquash.
    ShareQuota 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.
    SignedIdentifiers List<Pulumi.AzureNative.Storage.Outputs.SignedIdentifierResponse>
    List of stored access policies specified on the share.
    AccessTierChangeTime string
    Indicates the last modification time for share access tier.
    AccessTierStatus string
    Indicates if there is a pending transition for access tier.
    Deleted bool
    Indicates whether the share was deleted.
    DeletedTime string
    The deleted time if the share was deleted.
    Etag string
    Resource Etag.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    LastModifiedTime string
    Returns the date and time the share was last modified.
    LeaseDuration string
    Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
    LeaseState string
    Lease state of the share.
    LeaseStatus string
    The lease status of the share.
    Name string
    The name of the resource
    RemainingRetentionDays int
    Remaining retention days for share that was soft deleted.
    ShareUsageBytes float64
    The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
    SnapshotTime string
    Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Version string
    The version of the share.
    AccessTier string
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
    EnabledProtocols string
    The authentication protocol that is used for the file share. Can only be specified when creating a share.
    Metadata map[string]string
    A name-value pair to associate with the share as metadata.
    RootSquash string
    The property is for NFS share only. The default is NoRootSquash.
    ShareQuota 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.
    SignedIdentifiers []SignedIdentifierResponse
    List of stored access policies specified on the share.
    accessTierChangeTime String
    Indicates the last modification time for share access tier.
    accessTierStatus String
    Indicates if there is a pending transition for access tier.
    deleted Boolean
    Indicates whether the share was deleted.
    deletedTime String
    The deleted time if the share was deleted.
    etag String
    Resource Etag.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastModifiedTime String
    Returns the date and time the share was last modified.
    leaseDuration String
    Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
    leaseState String
    Lease state of the share.
    leaseStatus String
    The lease status of the share.
    name String
    The name of the resource
    remainingRetentionDays Integer
    Remaining retention days for share that was soft deleted.
    shareUsageBytes Double
    The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
    snapshotTime String
    Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    version String
    The version of the share.
    accessTier String
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
    enabledProtocols String
    The authentication protocol that is used for the file share. Can only be specified when creating a share.
    metadata Map<String,String>
    A name-value pair to associate with the share as metadata.
    rootSquash String
    The property is for NFS share only. The default is NoRootSquash.
    shareQuota Integer
    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.
    signedIdentifiers List<SignedIdentifierResponse>
    List of stored access policies specified on the share.
    accessTierChangeTime string
    Indicates the last modification time for share access tier.
    accessTierStatus string
    Indicates if there is a pending transition for access tier.
    deleted boolean
    Indicates whether the share was deleted.
    deletedTime string
    The deleted time if the share was deleted.
    etag string
    Resource Etag.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastModifiedTime string
    Returns the date and time the share was last modified.
    leaseDuration string
    Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
    leaseState string
    Lease state of the share.
    leaseStatus string
    The lease status of the share.
    name string
    The name of the resource
    remainingRetentionDays number
    Remaining retention days for share that was soft deleted.
    shareUsageBytes number
    The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
    snapshotTime string
    Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    version string
    The version of the share.
    accessTier string
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
    enabledProtocols string
    The authentication protocol that is used for the file share. Can only be specified when creating a share.
    metadata {[key: string]: string}
    A name-value pair to associate with the share as metadata.
    rootSquash string
    The property is for NFS share only. The default is NoRootSquash.
    shareQuota number
    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.
    signedIdentifiers SignedIdentifierResponse[]
    List of stored access policies specified on the share.
    access_tier_change_time str
    Indicates the last modification time for share access tier.
    access_tier_status str
    Indicates if there is a pending transition for access tier.
    deleted bool
    Indicates whether the share was deleted.
    deleted_time str
    The deleted time if the share was deleted.
    etag str
    Resource Etag.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    last_modified_time str
    Returns the date and time the share was last modified.
    lease_duration str
    Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
    lease_state str
    Lease state of the share.
    lease_status str
    The lease status of the share.
    name str
    The name of the resource
    remaining_retention_days int
    Remaining retention days for share that was soft deleted.
    share_usage_bytes 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.
    snapshot_time str
    Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    version str
    The version of the share.
    access_tier str
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
    enabled_protocols str
    The authentication protocol that is used for the file share. Can only be specified when creating a share.
    metadata Mapping[str, str]
    A name-value pair to associate with the share as metadata.
    root_squash str
    The property is for NFS share only. The default is NoRootSquash.
    share_quota 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.
    signed_identifiers Sequence[SignedIdentifierResponse]
    List of stored access policies specified on the share.
    accessTierChangeTime String
    Indicates the last modification time for share access tier.
    accessTierStatus String
    Indicates if there is a pending transition for access tier.
    deleted Boolean
    Indicates whether the share was deleted.
    deletedTime String
    The deleted time if the share was deleted.
    etag String
    Resource Etag.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastModifiedTime String
    Returns the date and time the share was last modified.
    leaseDuration String
    Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
    leaseState String
    Lease state of the share.
    leaseStatus String
    The lease status of the share.
    name String
    The name of the resource
    remainingRetentionDays Number
    Remaining retention days for share that was soft deleted.
    shareUsageBytes Number
    The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
    snapshotTime String
    Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    version String
    The version of the share.
    accessTier String
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
    enabledProtocols String
    The authentication protocol that is used for the file share. Can only be specified when creating a share.
    metadata Map<String>
    A name-value pair to associate with the share as metadata.
    rootSquash String
    The property is for NFS share only. The default is NoRootSquash.
    shareQuota Number
    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.
    signedIdentifiers List<Property Map>
    List of stored access policies specified on the share.

    Supporting Types

    AccessPolicyResponse

    ExpiryTime string
    Expiry time of the access policy
    Permission string
    List of abbreviated permissions.
    StartTime string
    Start time of the access policy
    ExpiryTime string
    Expiry time of the access policy
    Permission string
    List of abbreviated permissions.
    StartTime string
    Start time of the access policy
    expiryTime String
    Expiry time of the access policy
    permission String
    List of abbreviated permissions.
    startTime String
    Start time of the access policy
    expiryTime string
    Expiry time of the access policy
    permission string
    List of abbreviated permissions.
    startTime string
    Start time of the access policy
    expiry_time str
    Expiry time of the access policy
    permission str
    List of abbreviated permissions.
    start_time str
    Start time of the access policy
    expiryTime String
    Expiry time of the access policy
    permission String
    List of abbreviated permissions.
    startTime String
    Start time of the access policy

    SignedIdentifierResponse

    AccessPolicy Pulumi.AzureNative.Storage.Inputs.AccessPolicyResponse
    Access policy
    Id string
    An unique identifier of the stored access policy.
    AccessPolicy AccessPolicyResponse
    Access policy
    Id string
    An unique identifier of the stored access policy.
    accessPolicy AccessPolicyResponse
    Access policy
    id String
    An unique identifier of the stored access policy.
    accessPolicy AccessPolicyResponse
    Access policy
    id string
    An unique identifier of the stored access policy.
    access_policy AccessPolicyResponse
    Access policy
    id str
    An unique identifier of the stored access policy.
    accessPolicy Property Map
    Access policy
    id String
    An unique identifier of the stored access policy.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.0 published on Monday, Jun 24, 2024 by Pulumi