Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FileStorage
  5. getFileSystemQuotaRules
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

oci.FileStorage.getFileSystemQuotaRules

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of File System Quota Rules in Oracle Cloud Infrastructure File Storage service.

    List user or group usages and their quota rules by certain principal type.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testFileSystemQuotaRules = oci.FileStorage.getFileSystemQuotaRules({
    fileSystemId: testFileSystem.id,
    principalType: fileSystemQuotaRulePrincipalType,
    areViolatorsOnly: fileSystemQuotaRuleAreViolatorsOnly,
    principalId: testPrincipal.id,
});

    import pulumi
import pulumi_oci as oci

test_file_system_quota_rules = oci.FileStorage.get_file_system_quota_rules(file_system_id=test_file_system["id"],
    principal_type=file_system_quota_rule_principal_type,
    are_violators_only=file_system_quota_rule_are_violators_only,
    principal_id=test_principal["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/filestorage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filestorage.GetFileSystemQuotaRules(ctx, &filestorage.GetFileSystemQuotaRulesArgs{
			FileSystemId:     testFileSystem.Id,
			PrincipalType:    fileSystemQuotaRulePrincipalType,
			AreViolatorsOnly: pulumi.BoolRef(fileSystemQuotaRuleAreViolatorsOnly),
			PrincipalId:      pulumi.IntRef(testPrincipal.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testFileSystemQuotaRules = Oci.FileStorage.GetFileSystemQuotaRules.Invoke(new()
    {
        FileSystemId = testFileSystem.Id,
        PrincipalType = fileSystemQuotaRulePrincipalType,
        AreViolatorsOnly = fileSystemQuotaRuleAreViolatorsOnly,
        PrincipalId = testPrincipal.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.FileStorageFunctions;
import com.pulumi.oci.FileStorage.inputs.GetFileSystemQuotaRulesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testFileSystemQuotaRules = FileStorageFunctions.getFileSystemQuotaRules(GetFileSystemQuotaRulesArgs.builder()
            .fileSystemId(testFileSystem.id())
            .principalType(fileSystemQuotaRulePrincipalType)
            .areViolatorsOnly(fileSystemQuotaRuleAreViolatorsOnly)
            .principalId(testPrincipal.id())
            .build());

    }
}

    variables:
  testFileSystemQuotaRules:
    fn::invoke:
      function: oci:FileStorage:getFileSystemQuotaRules
      arguments:
        fileSystemId: ${testFileSystem.id}
        principalType: ${fileSystemQuotaRulePrincipalType}
        areViolatorsOnly: ${fileSystemQuotaRuleAreViolatorsOnly}
        principalId: ${testPrincipal.id}

    Using getFileSystemQuotaRules

    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 getFileSystemQuotaRules(args: GetFileSystemQuotaRulesArgs, opts?: InvokeOptions): Promise<GetFileSystemQuotaRulesResult>
function getFileSystemQuotaRulesOutput(args: GetFileSystemQuotaRulesOutputArgs, opts?: InvokeOptions): Output<GetFileSystemQuotaRulesResult>
    def get_file_system_quota_rules(are_violators_only: Optional[bool] = None,
                                file_system_id: Optional[str] = None,
                                filters: Optional[Sequence[_filestorage.GetFileSystemQuotaRulesFilter]] = None,
                                principal_id: Optional[int] = None,
                                principal_type: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetFileSystemQuotaRulesResult
def get_file_system_quota_rules_output(are_violators_only: Optional[pulumi.Input[bool]] = None,
                                file_system_id: Optional[pulumi.Input[str]] = None,
                                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_filestorage.GetFileSystemQuotaRulesFilterArgs]]]] = None,
                                principal_id: Optional[pulumi.Input[int]] = None,
                                principal_type: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetFileSystemQuotaRulesResult]
    func GetFileSystemQuotaRules(ctx *Context, args *GetFileSystemQuotaRulesArgs, opts ...InvokeOption) (*GetFileSystemQuotaRulesResult, error)
func GetFileSystemQuotaRulesOutput(ctx *Context, args *GetFileSystemQuotaRulesOutputArgs, opts ...InvokeOption) GetFileSystemQuotaRulesResultOutput

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

    public static class GetFileSystemQuotaRules 
{
    public static Task<GetFileSystemQuotaRulesResult> InvokeAsync(GetFileSystemQuotaRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetFileSystemQuotaRulesResult> Invoke(GetFileSystemQuotaRulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFileSystemQuotaRulesResult> getFileSystemQuotaRules(GetFileSystemQuotaRulesArgs args, InvokeOptions options)
public static Output<GetFileSystemQuotaRulesResult> getFileSystemQuotaRules(GetFileSystemQuotaRulesArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:FileStorage/getFileSystemQuotaRules:getFileSystemQuotaRules
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FileSystemId string
    The OCID of the file system.
    PrincipalType string
    The type of the owner of this quota rule and usage.
    AreViolatorsOnly bool
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    Filters List<GetFileSystemQuotaRulesFilter>
    PrincipalId int
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    FileSystemId string
    The OCID of the file system.
    PrincipalType string
    The type of the owner of this quota rule and usage.
    AreViolatorsOnly bool
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    Filters []GetFileSystemQuotaRulesFilter
    PrincipalId int
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    fileSystemId String
    The OCID of the file system.
    principalType String
    The type of the owner of this quota rule and usage.
    areViolatorsOnly Boolean
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    filters List<GetFileSystemQuotaRulesFilter>
    principalId Integer
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    fileSystemId string
    The OCID of the file system.
    principalType string
    The type of the owner of this quota rule and usage.
    areViolatorsOnly boolean
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    filters GetFileSystemQuotaRulesFilter[]
    principalId number
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    file_system_id str
    The OCID of the file system.
    principal_type str
    The type of the owner of this quota rule and usage.
    are_violators_only bool
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    filters Sequence[filestorage.GetFileSystemQuotaRulesFilter]
    principal_id int
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    fileSystemId String
    The OCID of the file system.
    principalType String
    The type of the owner of this quota rule and usage.
    areViolatorsOnly Boolean
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    filters List<Property Map>
    principalId Number
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.

    getFileSystemQuotaRules Result

    The following output properties are available:

    FileSystemId string
    The OCID of the file System.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalType string
    The type of the owner of this quota rule and usage.
    QuotaRules List<GetFileSystemQuotaRulesQuotaRule>
    The list of quota_rules.
    AreViolatorsOnly bool
    Filters List<GetFileSystemQuotaRulesFilter>
    PrincipalId int
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    FileSystemId string
    The OCID of the file System.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalType string
    The type of the owner of this quota rule and usage.
    QuotaRules []GetFileSystemQuotaRulesQuotaRule
    The list of quota_rules.
    AreViolatorsOnly bool
    Filters []GetFileSystemQuotaRulesFilter
    PrincipalId int
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    fileSystemId String
    The OCID of the file System.
    id String
    The provider-assigned unique ID for this managed resource.
    principalType String
    The type of the owner of this quota rule and usage.
    quotaRules List<GetFileSystemQuotaRulesQuotaRule>
    The list of quota_rules.
    areViolatorsOnly Boolean
    filters List<GetFileSystemQuotaRulesFilter>
    principalId Integer
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    fileSystemId string
    The OCID of the file System.
    id string
    The provider-assigned unique ID for this managed resource.
    principalType string
    The type of the owner of this quota rule and usage.
    quotaRules GetFileSystemQuotaRulesQuotaRule[]
    The list of quota_rules.
    areViolatorsOnly boolean
    filters GetFileSystemQuotaRulesFilter[]
    principalId number
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    file_system_id str
    The OCID of the file System.
    id str
    The provider-assigned unique ID for this managed resource.
    principal_type str
    The type of the owner of this quota rule and usage.
    quota_rules Sequence[filestorage.GetFileSystemQuotaRulesQuotaRule]
    The list of quota_rules.
    are_violators_only bool
    filters Sequence[filestorage.GetFileSystemQuotaRulesFilter]
    principal_id int
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    fileSystemId String
    The OCID of the file System.
    id String
    The provider-assigned unique ID for this managed resource.
    principalType String
    The type of the owner of this quota rule and usage.
    quotaRules List<Property Map>
    The list of quota_rules.
    areViolatorsOnly Boolean
    filters List<Property Map>
    principalId Number
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.

    Supporting Types

    GetFileSystemQuotaRulesFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetFileSystemQuotaRulesQuotaRule

    AreViolatorsOnly bool
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    DisplayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: UserXYZ's quota
    FileSystemId string
    The OCID of the file system.
    Id string
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    IsHardQuota bool
    The flag is an identifier to tell whether the quota rule will be enforced. If isHardQuota is false, the quota rule will be enforced so the usage cannot exceed the hard quota limit. If isHardQuota is true, usage can exceed the soft quota limit. An alarm or notification will be sent to the customer, if the specific usage exceeds.
    PrincipalId int
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    PrincipalType string
    The type of the owner of this quota rule and usage.
    QuotaLimitInGigabytes int
    The value of the quota rule. The unit is Gigabyte.
    QuotaRuleId string
    TimeCreated string
    The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the quota rule was last updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    AreViolatorsOnly bool
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    DisplayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: UserXYZ's quota
    FileSystemId string
    The OCID of the file system.
    Id string
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    IsHardQuota bool
    The flag is an identifier to tell whether the quota rule will be enforced. If isHardQuota is false, the quota rule will be enforced so the usage cannot exceed the hard quota limit. If isHardQuota is true, usage can exceed the soft quota limit. An alarm or notification will be sent to the customer, if the specific usage exceeds.
    PrincipalId int
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    PrincipalType string
    The type of the owner of this quota rule and usage.
    QuotaLimitInGigabytes int
    The value of the quota rule. The unit is Gigabyte.
    QuotaRuleId string
    TimeCreated string
    The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the quota rule was last updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    areViolatorsOnly Boolean
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    displayName String
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: UserXYZ's quota
    fileSystemId String
    The OCID of the file system.
    id String
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    isHardQuota Boolean
    The flag is an identifier to tell whether the quota rule will be enforced. If isHardQuota is false, the quota rule will be enforced so the usage cannot exceed the hard quota limit. If isHardQuota is true, usage can exceed the soft quota limit. An alarm or notification will be sent to the customer, if the specific usage exceeds.
    principalId Integer
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    principalType String
    The type of the owner of this quota rule and usage.
    quotaLimitInGigabytes Integer
    The value of the quota rule. The unit is Gigabyte.
    quotaRuleId String
    timeCreated String
    The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the quota rule was last updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    areViolatorsOnly boolean
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    displayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: UserXYZ's quota
    fileSystemId string
    The OCID of the file system.
    id string
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    isHardQuota boolean
    The flag is an identifier to tell whether the quota rule will be enforced. If isHardQuota is false, the quota rule will be enforced so the usage cannot exceed the hard quota limit. If isHardQuota is true, usage can exceed the soft quota limit. An alarm or notification will be sent to the customer, if the specific usage exceeds.
    principalId number
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    principalType string
    The type of the owner of this quota rule and usage.
    quotaLimitInGigabytes number
    The value of the quota rule. The unit is Gigabyte.
    quotaRuleId string
    timeCreated string
    The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the quota rule was last updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    are_violators_only bool
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    display_name str
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: UserXYZ's quota
    file_system_id str
    The OCID of the file system.
    id str
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    is_hard_quota bool
    The flag is an identifier to tell whether the quota rule will be enforced. If isHardQuota is false, the quota rule will be enforced so the usage cannot exceed the hard quota limit. If isHardQuota is true, usage can exceed the soft quota limit. An alarm or notification will be sent to the customer, if the specific usage exceeds.
    principal_id int
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    principal_type str
    The type of the owner of this quota rule and usage.
    quota_limit_in_gigabytes int
    The value of the quota rule. The unit is Gigabyte.
    quota_rule_id str
    time_created str
    The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the quota rule was last updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    areViolatorsOnly Boolean
    An option to only display the users or groups that violate their quota rules. If areViolatorsOnly is false, the list result will display all the quota and usage report. If areViolatorsOnly is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules.
    displayName String
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: UserXYZ's quota
    fileSystemId String
    The OCID of the file system.
    id String
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    isHardQuota Boolean
    The flag is an identifier to tell whether the quota rule will be enforced. If isHardQuota is false, the quota rule will be enforced so the usage cannot exceed the hard quota limit. If isHardQuota is true, usage can exceed the soft quota limit. An alarm or notification will be sent to the customer, if the specific usage exceeds.
    principalId Number
    An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control.
    principalType String
    The type of the owner of this quota rule and usage.
    quotaLimitInGigabytes Number
    The value of the quota rule. The unit is Gigabyte.
    quotaRuleId String
    timeCreated String
    The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the quota rule was last updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-oci