scm.getUrlCategoryList

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

//
// Data source to retrieve a list of URL Category objects.
//
// Example 1: Fetch a list of all URL Categories in the "Shared" folder.
const allShared = scm.getUrlCategoryList({
    folder: "All",
});
export const urlCategoriesListAllShared = allShared.then(allShared => allShared.datas);
// Example 2: Use pagination to get the first 5 URL Categories by name.
const paginated = scm.getUrlCategoryList({
    folder: "All",
    limit: 5,
    offset: 0,
});
export const urlCategoriesListPaginated = paginated.then(paginated => paginated.datas);

import pulumi
import pulumi_scm as scm

#
# Data source to retrieve a list of URL Category objects.
#
# Example 1: Fetch a list of all URL Categories in the "Shared" folder.
all_shared = scm.get_url_category_list(folder="All")
pulumi.export("urlCategoriesListAllShared", all_shared.datas)
# Example 2: Use pagination to get the first 5 URL Categories by name.
paginated = scm.get_url_category_list(folder="All",
    limit=5,
    offset=0)
pulumi.export("urlCategoriesListPaginated", paginated.datas)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Data source to retrieve a list of URL Category objects.
		//
		// Example 1: Fetch a list of all URL Categories in the "Shared" folder.
		allShared, err := scm.GetUrlCategoryList(ctx, &scm.GetUrlCategoryListArgs{
			Folder: pulumi.StringRef("All"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("urlCategoriesListAllShared", allShared.Datas)
		// Example 2: Use pagination to get the first 5 URL Categories by name.
		paginated, err := scm.GetUrlCategoryList(ctx, &scm.GetUrlCategoryListArgs{
			Folder: pulumi.StringRef("All"),
			Limit:  pulumi.IntRef(5),
			Offset: pulumi.IntRef(0),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("urlCategoriesListPaginated", paginated.Datas)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    //
    // Data source to retrieve a list of URL Category objects.
    //
    // Example 1: Fetch a list of all URL Categories in the "Shared" folder.
    var allShared = Scm.GetUrlCategoryList.Invoke(new()
    {
        Folder = "All",
    });

    // Example 2: Use pagination to get the first 5 URL Categories by name.
    var paginated = Scm.GetUrlCategoryList.Invoke(new()
    {
        Folder = "All",
        Limit = 5,
        Offset = 0,
    });

    return new Dictionary<string, object?>
    {
        ["urlCategoriesListAllShared"] = allShared.Apply(getUrlCategoryListResult => getUrlCategoryListResult.Datas),
        ["urlCategoriesListPaginated"] = paginated.Apply(getUrlCategoryListResult => getUrlCategoryListResult.Datas),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetUrlCategoryListArgs;
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) {
        //
        // Data source to retrieve a list of URL Category objects.
        //
        // Example 1: Fetch a list of all URL Categories in the "Shared" folder.
        final var allShared = ScmFunctions.getUrlCategoryList(GetUrlCategoryListArgs.builder()
            .folder("All")
            .build());

        ctx.export("urlCategoriesListAllShared", allShared.datas());
        // Example 2: Use pagination to get the first 5 URL Categories by name.
        final var paginated = ScmFunctions.getUrlCategoryList(GetUrlCategoryListArgs.builder()
            .folder("All")
            .limit(5)
            .offset(0)
            .build());

        ctx.export("urlCategoriesListPaginated", paginated.datas());
    }
}

variables:
  #
  # Data source to retrieve a list of URL Category objects.
  #

  # Example 1: Fetch a list of all URL Categories in the "Shared" folder.
  allShared:
    fn::invoke:
      function: scm:getUrlCategoryList
      arguments:
        folder: All
  # Example 2: Use pagination to get the first 5 URL Categories by name.
  paginated:
    fn::invoke:
      function: scm:getUrlCategoryList
      arguments:
        folder: All
        limit: 5
        offset: 0
outputs:
  # Output the list of all URL Category objects from the "Shared" folder.
  urlCategoriesListAllShared: ${allShared.datas}
  urlCategoriesListPaginated: ${paginated.datas}

function getUrlCategoryList(args: GetUrlCategoryListArgs, opts?: InvokeOptions): Promise<GetUrlCategoryListResult>
function getUrlCategoryListOutput(args: GetUrlCategoryListOutputArgs, opts?: InvokeOptions): Output<GetUrlCategoryListResult>

def get_url_category_list(device: Optional[str] = None,
                          folder: Optional[str] = None,
                          limit: Optional[int] = None,
                          name: Optional[str] = None,
                          offset: Optional[int] = None,
                          snippet: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetUrlCategoryListResult
def get_url_category_list_output(device: Optional[pulumi.Input[str]] = None,
                          folder: Optional[pulumi.Input[str]] = None,
                          limit: Optional[pulumi.Input[int]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          offset: Optional[pulumi.Input[int]] = None,
                          snippet: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetUrlCategoryListResult]

func GetUrlCategoryList(ctx *Context, args *GetUrlCategoryListArgs, opts ...InvokeOption) (*GetUrlCategoryListResult, error)
func GetUrlCategoryListOutput(ctx *Context, args *GetUrlCategoryListOutputArgs, opts ...InvokeOption) GetUrlCategoryListResultOutput

public static class GetUrlCategoryList 
{
    public static Task<GetUrlCategoryListResult> InvokeAsync(GetUrlCategoryListArgs args, InvokeOptions? opts = null)
    public static Output<GetUrlCategoryListResult> Invoke(GetUrlCategoryListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUrlCategoryListResult> getUrlCategoryList(GetUrlCategoryListArgs args, InvokeOptions options)
public static Output<GetUrlCategoryListResult> getUrlCategoryList(GetUrlCategoryListArgs args, InvokeOptions options)

fn::invoke:
  function: scm:index/getUrlCategoryList:getUrlCategoryList
  arguments:
    # arguments dictionary