getRules

Volcengine v0.0.38, Oct 31 25

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Example Usage

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

const default = volcengine.vmp.getRules({
    kind: "Recording",
    workspaceId: "baa02ffb-6f22-43c4-841b-ecf90ded****",
});

import pulumi
import pulumi_volcengine as volcengine

default = volcengine.vmp.get_rules(kind="Recording",
    workspace_id="baa02ffb-6f22-43c4-841b-ecf90ded****")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vmp"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vmp.GetRules(ctx, &vmp.GetRulesArgs{
			Kind:        "Recording",
			WorkspaceId: "baa02ffb-6f22-43c4-841b-ecf90ded****",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Vmp.GetRules.Invoke(new()
    {
        Kind = "Recording",
        WorkspaceId = "baa02ffb-6f22-43c4-841b-ecf90ded****",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vmp.VmpFunctions;
import com.pulumi.volcengine.vmp.inputs.GetRulesArgs;
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 default = VmpFunctions.getRules(GetRulesArgs.builder()
            .kind("Recording")
            .workspaceId("baa02ffb-6f22-43c4-841b-ecf90ded****")
            .build());

    }
}

variables:
  default:
    fn::invoke:
      Function: volcengine:vmp:getRules
      Arguments:
        kind: Recording
        workspaceId: baa02ffb-6f22-43c4-841b-ecf90ded****

Using getRules

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 getRules(args: GetRulesArgs, opts?: InvokeOptions): Promise<GetRulesResult>
function getRulesOutput(args: GetRulesOutputArgs, opts?: InvokeOptions): Output<GetRulesResult>

def get_rules(kind: Optional[str] = None,
              name: Optional[str] = None,
              output_file: Optional[str] = None,
              rule_file_names: Optional[Sequence[str]] = None,
              rule_group_names: Optional[Sequence[str]] = None,
              status: Optional[str] = None,
              workspace_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetRulesResult
def get_rules_output(kind: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              rule_file_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              rule_group_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              status: Optional[pulumi.Input[str]] = None,
              workspace_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRulesResult]

func GetRules(ctx *Context, args *GetRulesArgs, opts ...InvokeOption) (*GetRulesResult, error)
func GetRulesOutput(ctx *Context, args *GetRulesOutputArgs, opts ...InvokeOption) GetRulesResultOutput

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

public static class GetRules 
{
    public static Task<GetRulesResult> InvokeAsync(GetRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetRulesResult> Invoke(GetRulesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRulesResult> getRules(GetRulesArgs args, InvokeOptions options)
public static Output<GetRulesResult> getRules(GetRulesArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:vmp/getRules:getRules
  arguments:
    # arguments dictionary

The following arguments are supported:

Kind string: The kind of rule.
WorkspaceId string: The id of workspace.
Name string: The name of rule.
OutputFile string: File name where to save data source results.
RuleFileNames List<string>: The name of rule file.
RuleGroupNames List<string>: The name of rule group.
Status string: The status of rule.

Kind string: The kind of rule.
WorkspaceId string: The id of workspace.
Name string: The name of rule.
OutputFile string: File name where to save data source results.
RuleFileNames []string: The name of rule file.
RuleGroupNames []string: The name of rule group.
Status string: The status of rule.

kind String: The kind of rule.
workspaceId String: The id of workspace.
name String: The name of rule.
outputFile String: File name where to save data source results.
ruleFileNames List<String>: The name of rule file.
ruleGroupNames List<String>: The name of rule group.
status String: The status of rule.

kind string: The kind of rule.
workspaceId string: The id of workspace.
name string: The name of rule.
outputFile string: File name where to save data source results.
ruleFileNames string[]: The name of rule file.
ruleGroupNames string[]: The name of rule group.
status string: The status of rule.

kind str: The kind of rule.
workspace_id str: The id of workspace.
name str: The name of rule.
output_file str: File name where to save data source results.
rule_file_names Sequence[str]: The name of rule file.
rule_group_names Sequence[str]: The name of rule group.
status str: The status of rule.

kind String: The kind of rule.
workspaceId String: The id of workspace.
name String: The name of rule.
outputFile String: File name where to save data source results.
ruleFileNames List<String>: The name of rule file.
ruleGroupNames List<String>: The name of rule group.
status String: The status of rule.

getRules Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Kind string: The kind of rule.
Rules List<GetRulesRule>: The collection of query.
TotalCount int: The total count of query.
WorkspaceId string
Name string: The name of rule.
OutputFile string
RuleFileNames List<string>
RuleGroupNames List<string>
Status string: The status of rule.

Id string: The provider-assigned unique ID for this managed resource.
Kind string: The kind of rule.
Rules []GetRulesRule: The collection of query.
TotalCount int: The total count of query.
WorkspaceId string
Name string: The name of rule.
OutputFile string
RuleFileNames []string
RuleGroupNames []string
Status string: The status of rule.

id String: The provider-assigned unique ID for this managed resource.
kind String: The kind of rule.
rules List<GetRulesRule>: The collection of query.
totalCount Integer: The total count of query.
workspaceId String
name String: The name of rule.
outputFile String
ruleFileNames List<String>
ruleGroupNames List<String>
status String: The status of rule.

id string: The provider-assigned unique ID for this managed resource.
kind string: The kind of rule.
rules GetRulesRule[]: The collection of query.
totalCount number: The total count of query.
workspaceId string
name string: The name of rule.
outputFile string
ruleFileNames string[]
ruleGroupNames string[]
status string: The status of rule.

id str: The provider-assigned unique ID for this managed resource.
kind str: The kind of rule.
rules Sequence[GetRulesRule]: The collection of query.
total_count int: The total count of query.
workspace_id str
name str: The name of rule.
output_file str
rule_file_names Sequence[str]
rule_group_names Sequence[str]
status str: The status of rule.

id String: The provider-assigned unique ID for this managed resource.
kind String: The kind of rule.
rules List<Property Map>: The collection of query.
totalCount Number: The total count of query.
workspaceId String
name String: The name of rule.
outputFile String
ruleFileNames List<String>
ruleGroupNames List<String>
status String: The status of rule.

Supporting Types

GetRulesRule

Expr string: The expr of rule.
Kind string: The kind of rule.
Labels List<GetRulesRuleLabel>: The labels of rule.
LastEvaluation string: The last evaluation of rule.
Name string: The name of rule.
Reason string: The reason of rule.
RuleFileName string: The name of rule file.
RuleGroupName string: The name of rule group.
Status string: The status of rule.

Expr string: The expr of rule.
Kind string: The kind of rule.
Labels []GetRulesRuleLabel: The labels of rule.
LastEvaluation string: The last evaluation of rule.
Name string: The name of rule.
Reason string: The reason of rule.
RuleFileName string: The name of rule file.
RuleGroupName string: The name of rule group.
Status string: The status of rule.

expr String: The expr of rule.
kind String: The kind of rule.
labels List<GetRulesRuleLabel>: The labels of rule.
lastEvaluation String: The last evaluation of rule.
name String: The name of rule.
reason String: The reason of rule.
ruleFileName String: The name of rule file.
ruleGroupName String: The name of rule group.
status String: The status of rule.

expr string: The expr of rule.
kind string: The kind of rule.
labels GetRulesRuleLabel[]: The labels of rule.
lastEvaluation string: The last evaluation of rule.
name string: The name of rule.
reason string: The reason of rule.
ruleFileName string: The name of rule file.
ruleGroupName string: The name of rule group.
status string: The status of rule.

expr str: The expr of rule.
kind str: The kind of rule.
labels Sequence[GetRulesRuleLabel]: The labels of rule.
last_evaluation str: The last evaluation of rule.
name str: The name of rule.
reason str: The reason of rule.
rule_file_name str: The name of rule file.
rule_group_name str: The name of rule group.
status str: The status of rule.

expr String: The expr of rule.
kind String: The kind of rule.
labels List<Property Map>: The labels of rule.
lastEvaluation String: The last evaluation of rule.
name String: The name of rule.
reason String: The reason of rule.
ruleFileName String: The name of rule file.
ruleGroupName String: The name of rule group.
status String: The status of rule.

GetRulesRuleLabel

Key string: The key of label.
Value string: The value of label.

Key string: The key of label.
Value string: The value of label.

key String: The key of label.
value String: The value of label.

key string: The key of label.
value string: The value of label.

key str: The key of label.
value str: The value of label.

key String: The key of label.
value String: The value of label.

Package Details

Repository: volcengine volcengine/pulumi-volcengine
License: Apache-2.0
Notes: This Pulumi package is based on the volcengine Terraform Provider.

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

volcengine.vmp.getRules

On this page

On this page

Example Usage

Using getRules

getRules Result

Supporting Types

GetRulesRule

GetRulesRuleLabel

Package Details

On this page

On this page