Docs Packages
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getRuleLabels
Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler
zscaler/pulumi-zia

zia.getRuleLabels

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler
zscaler/pulumi-zia

    Use the zia_rule_labels data source to get information about a rule label resource in the Zscaler Internet Access cloud or via the API. This data source can then be associated with resources such as: Firewall Rules and URL filtering rules

    Example Usage

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

const example = zia.getRuleLabels({
    name: "Example",
});

    import pulumi
import pulumi_zia as zia

example = zia.get_rule_labels(name="Example")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zia/sdk/go/zia"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zia.LookupRuleLabels(ctx, &zia.LookupRuleLabelsArgs{
			Name: pulumi.StringRef("Example"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Zia.GetRuleLabels.Invoke(new()
    {
        Name = "Example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.ZiaFunctions;
import com.pulumi.zia.inputs.GetRuleLabelsArgs;
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 example = ZiaFunctions.getRuleLabels(GetRuleLabelsArgs.builder()
            .name("Example")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: zia:getRuleLabels
      Arguments:
        name: Example

    Using getRuleLabels

    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 getRuleLabels(args: GetRuleLabelsArgs, opts?: InvokeOptions): Promise<GetRuleLabelsResult>
function getRuleLabelsOutput(args: GetRuleLabelsOutputArgs, opts?: InvokeOptions): Output<GetRuleLabelsResult>
    def get_rule_labels(id: Optional[int] = None,
                    name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetRuleLabelsResult
def get_rule_labels_output(id: Optional[pulumi.Input[int]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetRuleLabelsResult]
    func LookupRuleLabels(ctx *Context, args *LookupRuleLabelsArgs, opts ...InvokeOption) (*LookupRuleLabelsResult, error)
func LookupRuleLabelsOutput(ctx *Context, args *LookupRuleLabelsOutputArgs, opts ...InvokeOption) LookupRuleLabelsResultOutput

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

    public static class GetRuleLabels 
{
    public static Task<GetRuleLabelsResult> InvokeAsync(GetRuleLabelsArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleLabelsResult> Invoke(GetRuleLabelsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRuleLabelsResult> getRuleLabels(GetRuleLabelsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: zia:index/getRuleLabels:getRuleLabels
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id int
    The unique identifer for the device group.
    Name string
    The name of the rule label to be exported.
    Id int
    The unique identifer for the device group.
    Name string
    The name of the rule label to be exported.
    id Integer
    The unique identifer for the device group.
    name String
    The name of the rule label to be exported.
    id number
    The unique identifer for the device group.
    name string
    The name of the rule label to be exported.
    id int
    The unique identifer for the device group.
    name str
    The name of the rule label to be exported.
    id Number
    The unique identifer for the device group.
    name String
    The name of the rule label to be exported.

    getRuleLabels Result

    The following output properties are available:

    CreatedBies List<zscaler.PulumiPackage.Zia.Outputs.GetRuleLabelsCreatedBy>
    (String) The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
    Description string
    (String) The rule label description.
    Id int
    LastModifiedBies List<zscaler.PulumiPackage.Zia.Outputs.GetRuleLabelsLastModifiedBy>
    (String) The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
    LastModifiedTime int
    (String) Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
    Name string
    ReferencedRuleCount int
    (int) The number of rules that reference the label.
    CreatedBies []GetRuleLabelsCreatedBy
    (String) The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
    Description string
    (String) The rule label description.
    Id int
    LastModifiedBies []GetRuleLabelsLastModifiedBy
    (String) The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
    LastModifiedTime int
    (String) Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
    Name string
    ReferencedRuleCount int
    (int) The number of rules that reference the label.
    createdBies List<GetRuleLabelsCreatedBy>
    (String) The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
    description String
    (String) The rule label description.
    id Integer
    lastModifiedBies List<GetRuleLabelsLastModifiedBy>
    (String) The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
    lastModifiedTime Integer
    (String) Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
    name String
    referencedRuleCount Integer
    (int) The number of rules that reference the label.
    createdBies GetRuleLabelsCreatedBy[]
    (String) The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
    description string
    (String) The rule label description.
    id number
    lastModifiedBies GetRuleLabelsLastModifiedBy[]
    (String) The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
    lastModifiedTime number
    (String) Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
    name string
    referencedRuleCount number
    (int) The number of rules that reference the label.
    created_bies Sequence[GetRuleLabelsCreatedBy]
    (String) The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
    description str
    (String) The rule label description.
    id int
    last_modified_bies Sequence[GetRuleLabelsLastModifiedBy]
    (String) The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
    last_modified_time int
    (String) Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
    name str
    referenced_rule_count int
    (int) The number of rules that reference the label.
    createdBies List<Property Map>
    (String) The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
    description String
    (String) The rule label description.
    id Number
    lastModifiedBies List<Property Map>
    (String) The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
    lastModifiedTime Number
    (String) Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
    name String
    referencedRuleCount Number
    (int) The number of rules that reference the label.

    Supporting Types

    GetRuleLabelsCreatedBy

    Extensions Dictionary<string, string>
    Id int
    The unique identifer for the device group.
    Name string
    The name of the rule label to be exported.
    Extensions map[string]string
    Id int
    The unique identifer for the device group.
    Name string
    The name of the rule label to be exported.
    extensions Map<String,String>
    id Integer
    The unique identifer for the device group.
    name String
    The name of the rule label to be exported.
    extensions {[key: string]: string}
    id number
    The unique identifer for the device group.
    name string
    The name of the rule label to be exported.
    extensions Mapping[str, str]
    id int
    The unique identifer for the device group.
    name str
    The name of the rule label to be exported.
    extensions Map<String>
    id Number
    The unique identifer for the device group.
    name String
    The name of the rule label to be exported.

    GetRuleLabelsLastModifiedBy

    Extensions Dictionary<string, string>
    Id int
    The unique identifer for the device group.
    Name string
    The name of the rule label to be exported.
    Extensions map[string]string
    Id int
    The unique identifer for the device group.
    Name string
    The name of the rule label to be exported.
    extensions Map<String,String>
    id Integer
    The unique identifer for the device group.
    name String
    The name of the rule label to be exported.
    extensions {[key: string]: string}
    id number
    The unique identifer for the device group.
    name string
    The name of the rule label to be exported.
    extensions Mapping[str, str]
    id int
    The unique identifer for the device group.
    name str
    The name of the rule label to be exported.
    extensions Map<String>
    id Number
    The unique identifer for the device group.
    name String
    The name of the rule label to be exported.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler
    zscaler/pulumi-zia