1. Packages
  2. Mso Provider
  3. API Docs
  4. getRest
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

mso.getRest

Explore with Pulumi AI

mso logo
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

    Data source for reading MSO objects via REST API.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as mso from "@pulumi/mso";
    
    const example = mso.getRest({
        path: "api/v1/platform/systemConfig",
    });
    
    import pulumi
    import pulumi_mso as mso
    
    example = mso.get_rest(path="api/v1/platform/systemConfig")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/mso/mso"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mso.LookupRest(ctx, &mso.LookupRestArgs{
    			Path: "api/v1/platform/systemConfig",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mso = Pulumi.Mso;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Mso.GetRest.Invoke(new()
        {
            Path = "api/v1/platform/systemConfig",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mso.MsoFunctions;
    import com.pulumi.mso.inputs.GetRestArgs;
    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 = MsoFunctions.getRest(GetRestArgs.builder()
                .path("api/v1/platform/systemConfig")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: mso:getRest
          arguments:
            path: api/v1/platform/systemConfig
    

    Argument Reference

    • path - (Required) The MSO REST endpoint, where the data is being read.

    Attribute Reference

    • content - (Read-Only) JSON response as a string.

    Using getRest

    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 getRest(args: GetRestArgs, opts?: InvokeOptions): Promise<GetRestResult>
    function getRestOutput(args: GetRestOutputArgs, opts?: InvokeOptions): Output<GetRestResult>
    def get_rest(id: Optional[str] = None,
                 path: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetRestResult
    def get_rest_output(id: Optional[pulumi.Input[str]] = None,
                 path: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetRestResult]
    func LookupRest(ctx *Context, args *LookupRestArgs, opts ...InvokeOption) (*LookupRestResult, error)
    func LookupRestOutput(ctx *Context, args *LookupRestOutputArgs, opts ...InvokeOption) LookupRestResultOutput

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

    public static class GetRest 
    {
        public static Task<GetRestResult> InvokeAsync(GetRestArgs args, InvokeOptions? opts = null)
        public static Output<GetRestResult> Invoke(GetRestInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRestResult> getRest(GetRestArgs args, InvokeOptions options)
    public static Output<GetRestResult> getRest(GetRestArgs args, InvokeOptions options)
    
    fn::invoke:
      function: mso:index/getRest:getRest
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Path string
    Id string
    Path string
    Id string
    path String
    id String
    path string
    id string
    path str
    id str
    path String
    id String

    getRest Result

    The following output properties are available:

    Content string
    Id string
    Path string
    Content string
    Id string
    Path string
    content String
    id String
    path String
    content string
    id string
    path string
    content str
    id str
    path str
    content String
    id String
    path String

    Package Details

    Repository
    mso ciscodevnet/terraform-provider-mso
    License
    Notes
    This Pulumi package is based on the mso Terraform Provider.
    mso logo
    mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet