1. Packages
  2. Azure Native
  3. API Docs
  4. fileshares
  5. getFileShareLimits
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.7.1 published on Wednesday, Aug 13, 2025 by Pulumi

azure-native.fileshares.getFileShareLimits

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.7.1 published on Wednesday, Aug 13, 2025 by Pulumi

    Get file shares limits.

    Uses Azure REST API version 2025-06-01-preview.

    Using getFileShareLimits

    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 getFileShareLimits(args: GetFileShareLimitsArgs, opts?: InvokeOptions): Promise<GetFileShareLimitsResult>
    function getFileShareLimitsOutput(args: GetFileShareLimitsOutputArgs, opts?: InvokeOptions): Output<GetFileShareLimitsResult>
    def get_file_share_limits(location: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetFileShareLimitsResult
    def get_file_share_limits_output(location: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetFileShareLimitsResult]
    func GetFileShareLimits(ctx *Context, args *GetFileShareLimitsArgs, opts ...InvokeOption) (*GetFileShareLimitsResult, error)
    func GetFileShareLimitsOutput(ctx *Context, args *GetFileShareLimitsOutputArgs, opts ...InvokeOption) GetFileShareLimitsResultOutput

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

    public static class GetFileShareLimits 
    {
        public static Task<GetFileShareLimitsResult> InvokeAsync(GetFileShareLimitsArgs args, InvokeOptions? opts = null)
        public static Output<GetFileShareLimitsResult> Invoke(GetFileShareLimitsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFileShareLimitsResult> getFileShareLimits(GetFileShareLimitsArgs args, InvokeOptions options)
    public static Output<GetFileShareLimitsResult> getFileShareLimits(GetFileShareLimitsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:fileshares:getFileShareLimits
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Location string
    The name of the Azure region.
    Location string
    The name of the Azure region.
    location String
    The name of the Azure region.
    location string
    The name of the Azure region.
    location str
    The name of the Azure region.
    location String
    The name of the Azure region.

    getFileShareLimits Result

    The following output properties are available:

    Properties FileShareLimitsOutputResponse
    The properties of the file share limits.
    properties FileShareLimitsOutputResponse
    The properties of the file share limits.
    properties FileShareLimitsOutputResponse
    The properties of the file share limits.
    properties FileShareLimitsOutputResponse
    The properties of the file share limits.
    properties Property Map
    The properties of the file share limits.

    Supporting Types

    FileShareLimitsOutputResponse

    Limits FileShareLimitsResponse
    The limits for the file share.
    ProvisioningConstants FileShareProvisioningConstantsResponse
    The provisioning constants for the file share.
    limits FileShareLimitsResponse
    The limits for the file share.
    provisioningConstants FileShareProvisioningConstantsResponse
    The provisioning constants for the file share.
    limits FileShareLimitsResponse
    The limits for the file share.
    provisioningConstants FileShareProvisioningConstantsResponse
    The provisioning constants for the file share.
    limits FileShareLimitsResponse
    The limits for the file share.
    provisioning_constants FileShareProvisioningConstantsResponse
    The provisioning constants for the file share.
    limits Property Map
    The limits for the file share.
    provisioningConstants Property Map
    The provisioning constants for the file share.

    FileShareLimitsResponse

    MaxFileSharePrivateEndpointConnections int
    The maximum number of private endpoint connections allowed for a file share.
    MaxFileShareSnapshots int
    The maximum number of snapshots allowed per file share.
    MaxFileShareSubnets int
    The maximum number of subnets that can be associated with a file share.
    MaxFileShares int
    The maximum number of file shares that can be created.
    MaxProvisionedIOPerSec int
    The maximum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    MaxProvisionedStorageGiB int
    The maximum provisioned storage in GiB for a file share.
    MaxProvisionedThroughputMiBPerSec int
    The maximum provisioned throughput in MiB/s for a file share.
    MinProvisionedIOPerSec int
    The minimum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    MinProvisionedStorageGiB int
    The minimum provisioned storage in GiB for a file share.
    MinProvisionedThroughputMiBPerSec int
    The minimum provisioned throughput in MiB/s for a file share.
    MaxFileSharePrivateEndpointConnections int
    The maximum number of private endpoint connections allowed for a file share.
    MaxFileShareSnapshots int
    The maximum number of snapshots allowed per file share.
    MaxFileShareSubnets int
    The maximum number of subnets that can be associated with a file share.
    MaxFileShares int
    The maximum number of file shares that can be created.
    MaxProvisionedIOPerSec int
    The maximum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    MaxProvisionedStorageGiB int
    The maximum provisioned storage in GiB for a file share.
    MaxProvisionedThroughputMiBPerSec int
    The maximum provisioned throughput in MiB/s for a file share.
    MinProvisionedIOPerSec int
    The minimum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    MinProvisionedStorageGiB int
    The minimum provisioned storage in GiB for a file share.
    MinProvisionedThroughputMiBPerSec int
    The minimum provisioned throughput in MiB/s for a file share.
    maxFileSharePrivateEndpointConnections Integer
    The maximum number of private endpoint connections allowed for a file share.
    maxFileShareSnapshots Integer
    The maximum number of snapshots allowed per file share.
    maxFileShareSubnets Integer
    The maximum number of subnets that can be associated with a file share.
    maxFileShares Integer
    The maximum number of file shares that can be created.
    maxProvisionedIOPerSec Integer
    The maximum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    maxProvisionedStorageGiB Integer
    The maximum provisioned storage in GiB for a file share.
    maxProvisionedThroughputMiBPerSec Integer
    The maximum provisioned throughput in MiB/s for a file share.
    minProvisionedIOPerSec Integer
    The minimum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    minProvisionedStorageGiB Integer
    The minimum provisioned storage in GiB for a file share.
    minProvisionedThroughputMiBPerSec Integer
    The minimum provisioned throughput in MiB/s for a file share.
    maxFileSharePrivateEndpointConnections number
    The maximum number of private endpoint connections allowed for a file share.
    maxFileShareSnapshots number
    The maximum number of snapshots allowed per file share.
    maxFileShareSubnets number
    The maximum number of subnets that can be associated with a file share.
    maxFileShares number
    The maximum number of file shares that can be created.
    maxProvisionedIOPerSec number
    The maximum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    maxProvisionedStorageGiB number
    The maximum provisioned storage in GiB for a file share.
    maxProvisionedThroughputMiBPerSec number
    The maximum provisioned throughput in MiB/s for a file share.
    minProvisionedIOPerSec number
    The minimum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    minProvisionedStorageGiB number
    The minimum provisioned storage in GiB for a file share.
    minProvisionedThroughputMiBPerSec number
    The minimum provisioned throughput in MiB/s for a file share.
    max_file_share_private_endpoint_connections int
    The maximum number of private endpoint connections allowed for a file share.
    max_file_share_snapshots int
    The maximum number of snapshots allowed per file share.
    max_file_share_subnets int
    The maximum number of subnets that can be associated with a file share.
    max_file_shares int
    The maximum number of file shares that can be created.
    max_provisioned_io_per_sec int
    The maximum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    max_provisioned_storage_gi_b int
    The maximum provisioned storage in GiB for a file share.
    max_provisioned_throughput_mi_b_per_sec int
    The maximum provisioned throughput in MiB/s for a file share.
    min_provisioned_io_per_sec int
    The minimum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    min_provisioned_storage_gi_b int
    The minimum provisioned storage in GiB for a file share.
    min_provisioned_throughput_mi_b_per_sec int
    The minimum provisioned throughput in MiB/s for a file share.
    maxFileSharePrivateEndpointConnections Number
    The maximum number of private endpoint connections allowed for a file share.
    maxFileShareSnapshots Number
    The maximum number of snapshots allowed per file share.
    maxFileShareSubnets Number
    The maximum number of subnets that can be associated with a file share.
    maxFileShares Number
    The maximum number of file shares that can be created.
    maxProvisionedIOPerSec Number
    The maximum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    maxProvisionedStorageGiB Number
    The maximum provisioned storage in GiB for a file share.
    maxProvisionedThroughputMiBPerSec Number
    The maximum provisioned throughput in MiB/s for a file share.
    minProvisionedIOPerSec Number
    The minimum provisioned IOPS (Input/Output Operations Per Second) for a file share.
    minProvisionedStorageGiB Number
    The minimum provisioned storage in GiB for a file share.
    minProvisionedThroughputMiBPerSec Number
    The minimum provisioned throughput in MiB/s for a file share.

    FileShareProvisioningConstantsResponse

    BaseIOPerSec int
    Base IO per second.
    BaseThroughputMiBPerSec int
    Base throughput in MiB per second.
    ScalarIOPerSec double
    Scalar IO per second.
    ScalarThroughputMiBPerSec double
    Scalar throughput in MiB per second.
    BaseIOPerSec int
    Base IO per second.
    BaseThroughputMiBPerSec int
    Base throughput in MiB per second.
    ScalarIOPerSec float64
    Scalar IO per second.
    ScalarThroughputMiBPerSec float64
    Scalar throughput in MiB per second.
    baseIOPerSec Integer
    Base IO per second.
    baseThroughputMiBPerSec Integer
    Base throughput in MiB per second.
    scalarIOPerSec Double
    Scalar IO per second.
    scalarThroughputMiBPerSec Double
    Scalar throughput in MiB per second.
    baseIOPerSec number
    Base IO per second.
    baseThroughputMiBPerSec number
    Base throughput in MiB per second.
    scalarIOPerSec number
    Scalar IO per second.
    scalarThroughputMiBPerSec number
    Scalar throughput in MiB per second.
    base_io_per_sec int
    Base IO per second.
    base_throughput_mi_b_per_sec int
    Base throughput in MiB per second.
    scalar_io_per_sec float
    Scalar IO per second.
    scalar_throughput_mi_b_per_sec float
    Scalar throughput in MiB per second.
    baseIOPerSec Number
    Base IO per second.
    baseThroughputMiBPerSec Number
    Base throughput in MiB per second.
    scalarIOPerSec Number
    Scalar IO per second.
    scalarThroughputMiBPerSec Number
    Scalar throughput in MiB per second.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.7.1 published on Wednesday, Aug 13, 2025 by Pulumi