1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FileStorage
  5. getFileSystemQuotaRules
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

oci.FileStorage.getFileSystemQuotaRules

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

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,
});
Copy
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"])
Copy
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
	})
}
Copy
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,
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func GetFileSystemQuotaRules(ctx *Context, args *GetFileSystemQuotaRulesArgs, opts ...InvokeOption) (*GetFileSystemQuotaRulesResult, error)
func GetFileSystemQuotaRulesOutput(ctx *Context, args *GetFileSystemQuotaRulesOutputArgs, opts ...InvokeOption) GetFileSystemQuotaRulesResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetFileSystemQuotaRulesResult> getFileSystemQuotaRules(GetFileSystemQuotaRulesArgs args, InvokeOptions options)
public static Output<GetFileSystemQuotaRulesResult> getFileSystemQuotaRules(GetFileSystemQuotaRulesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:FileStorage/getFileSystemQuotaRules:getFileSystemQuotaRules
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FileSystemId This property is required. string
The OCID of the file system.
PrincipalType This property is required. 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 Changes to this property will trigger replacement. 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 This property is required. string
The OCID of the file system.
PrincipalType This property is required. 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 Changes to this property will trigger replacement. []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 This property is required. String
The OCID of the file system.
principalType This property is required. 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 Changes to this property will trigger replacement. 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 This property is required. string
The OCID of the file system.
principalType This property is required. 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 Changes to this property will trigger replacement. 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 This property is required. str
The OCID of the file system.
principal_type This property is required. 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 Changes to this property will trigger replacement. 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 This property is required. String
The OCID of the file system.
principalType This property is required. 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 Changes to this property will trigger replacement. 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 This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

GetFileSystemQuotaRulesQuotaRule

AreViolatorsOnly This property is required. 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 This property is required. 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 This property is required. string
The OCID of the file system.
Id This property is required. string
The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
IsHardQuota This property is required. 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 This property is required. 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 This property is required. string
The type of the owner of this quota rule and usage.
QuotaLimitInGigabytes This property is required. int
The value of the quota rule. The unit is Gigabyte.
QuotaRuleId This property is required. string
TimeCreated This property is required. string
The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
TimeUpdated This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
The OCID of the file system.
Id This property is required. string
The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
IsHardQuota This property is required. 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 This property is required. 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 This property is required. string
The type of the owner of this quota rule and usage.
QuotaLimitInGigabytes This property is required. int
The value of the quota rule. The unit is Gigabyte.
QuotaRuleId This property is required. string
TimeCreated This property is required. string
The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
TimeUpdated This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The OCID of the file system.
id This property is required. String
The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
isHardQuota This property is required. 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 This property is required. 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 This property is required. String
The type of the owner of this quota rule and usage.
quotaLimitInGigabytes This property is required. Integer
The value of the quota rule. The unit is Gigabyte.
quotaRuleId This property is required. String
timeCreated This property is required. String
The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
timeUpdated This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
The OCID of the file system.
id This property is required. string
The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
isHardQuota This property is required. 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 This property is required. 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 This property is required. string
The type of the owner of this quota rule and usage.
quotaLimitInGigabytes This property is required. number
The value of the quota rule. The unit is Gigabyte.
quotaRuleId This property is required. string
timeCreated This property is required. string
The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
timeUpdated This property is required. 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 This property is required. 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 This property is required. 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 This property is required. str
The OCID of the file system.
id This property is required. str
The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
is_hard_quota This property is required. 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 This property is required. 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 This property is required. str
The type of the owner of this quota rule and usage.
quota_limit_in_gigabytes This property is required. int
The value of the quota rule. The unit is Gigabyte.
quota_rule_id This property is required. str
time_created This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The OCID of the file system.
id This property is required. String
The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
isHardQuota This property is required. 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 This property is required. 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 This property is required. String
The type of the owner of this quota rule and usage.
quotaLimitInGigabytes This property is required. Number
The value of the quota rule. The unit is Gigabyte.
quotaRuleId This property is required. String
timeCreated This property is required. String
The date and time the quota rule was started, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
timeUpdated This property is required. 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.
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi