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

oci.FileStorage.getFileSystemQuotaRule

Explore with Pulumi AI

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

    This data source provides details about a specific File System Quota Rule resource in Oracle Cloud Infrastructure File Storage service.

    Get an FS level, user or group quota rule given the fileSystemId and quotaRuleId parameters.

    Example Usage

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

const testFileSystemQuotaRule = oci.FileStorage.getFileSystemQuotaRule({
    fileSystemId: testFileSystem.id,
    quotaRuleId: testRule.id,
});

    import pulumi
import pulumi_oci as oci

test_file_system_quota_rule = oci.FileStorage.get_file_system_quota_rule(file_system_id=test_file_system["id"],
    quota_rule_id=test_rule["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.GetFileSystemQuotaRule(ctx, &filestorage.GetFileSystemQuotaRuleArgs{
			FileSystemId: testFileSystem.Id,
			QuotaRuleId:  pulumi.StringRef(testRule.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 testFileSystemQuotaRule = Oci.FileStorage.GetFileSystemQuotaRule.Invoke(new()
    {
        FileSystemId = testFileSystem.Id,
        QuotaRuleId = testRule.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.GetFileSystemQuotaRuleArgs;
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 testFileSystemQuotaRule = FileStorageFunctions.getFileSystemQuotaRule(GetFileSystemQuotaRuleArgs.builder()
            .fileSystemId(testFileSystem.id())
            .quotaRuleId(testRule.id())
            .build());

    }
}

    variables:
  testFileSystemQuotaRule:
    fn::invoke:
      function: oci:FileStorage:getFileSystemQuotaRule
      arguments:
        fileSystemId: ${testFileSystem.id}
        quotaRuleId: ${testRule.id}

    Using getFileSystemQuotaRule

    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 getFileSystemQuotaRule(args: GetFileSystemQuotaRuleArgs, opts?: InvokeOptions): Promise<GetFileSystemQuotaRuleResult>
function getFileSystemQuotaRuleOutput(args: GetFileSystemQuotaRuleOutputArgs, opts?: InvokeOptions): Output<GetFileSystemQuotaRuleResult>
    def get_file_system_quota_rule(are_violators_only: Optional[str] = None,
                               file_system_id: Optional[str] = None,
                               quota_rule_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetFileSystemQuotaRuleResult
def get_file_system_quota_rule_output(are_violators_only: Optional[pulumi.Input[str]] = None,
                               file_system_id: Optional[pulumi.Input[str]] = None,
                               quota_rule_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetFileSystemQuotaRuleResult]
    func GetFileSystemQuotaRule(ctx *Context, args *GetFileSystemQuotaRuleArgs, opts ...InvokeOption) (*GetFileSystemQuotaRuleResult, error)
func GetFileSystemQuotaRuleOutput(ctx *Context, args *GetFileSystemQuotaRuleOutputArgs, opts ...InvokeOption) GetFileSystemQuotaRuleResultOutput

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

    public static class GetFileSystemQuotaRule 
{
    public static Task<GetFileSystemQuotaRuleResult> InvokeAsync(GetFileSystemQuotaRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetFileSystemQuotaRuleResult> Invoke(GetFileSystemQuotaRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFileSystemQuotaRuleResult> getFileSystemQuotaRule(GetFileSystemQuotaRuleArgs args, InvokeOptions options)
public static Output<GetFileSystemQuotaRuleResult> getFileSystemQuotaRule(GetFileSystemQuotaRuleArgs args, InvokeOptions options)

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

    The following arguments are supported:

    FileSystemId string
    The OCID of the file system.
    AreViolatorsOnly string
    QuotaRuleId string
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    FileSystemId string
    The OCID of the file system.
    AreViolatorsOnly string
    QuotaRuleId string
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    fileSystemId String
    The OCID of the file system.
    areViolatorsOnly String
    quotaRuleId String
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    fileSystemId string
    The OCID of the file system.
    areViolatorsOnly string
    quotaRuleId string
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    file_system_id str
    The OCID of the file system.
    are_violators_only str
    quota_rule_id str
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
    fileSystemId String
    The OCID of the file system.
    areViolatorsOnly String
    quotaRuleId String
    The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.

    getFileSystemQuotaRule Result

    The following output properties are available:

    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.
    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 string
    QuotaRuleId string
    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.
    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 string
    QuotaRuleId string
    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.
    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 String
    quotaRuleId String
    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.
    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 string
    quotaRuleId string
    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.
    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
    are_violators_only str
    quota_rule_id str
    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.
    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 String
    quotaRuleId String

    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.28.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-oci