1. Packages
  2. Scm Provider
  3. API Docs
  4. getServiceList
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi

scm.getServiceList

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi

    Retrieves a listing of config items.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    const example = scm.getServiceList({
        folder: "Shared",
    });
    
    import pulumi
    import pulumi_scm as scm
    
    example = scm.get_service_list(folder="Shared")
    
    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 {
    		_, err := scm.GetServiceList(ctx, &scm.GetServiceListArgs{
    			Folder: pulumi.StringRef("Shared"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Scm.GetServiceList.Invoke(new()
        {
            Folder = "Shared",
        });
    
    });
    
    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.GetServiceListArgs;
    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 = ScmFunctions.getServiceList(GetServiceListArgs.builder()
                .folder("Shared")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: scm:getServiceList
          Arguments:
            folder: Shared
    

    Using getServiceList

    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 getServiceList(args: GetServiceListArgs, opts?: InvokeOptions): Promise<GetServiceListResult>
    function getServiceListOutput(args: GetServiceListOutputArgs, opts?: InvokeOptions): Output<GetServiceListResult>
    def get_service_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) -> GetServiceListResult
    def get_service_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[GetServiceListResult]
    func GetServiceList(ctx *Context, args *GetServiceListArgs, opts ...InvokeOption) (*GetServiceListResult, error)
    func GetServiceListOutput(ctx *Context, args *GetServiceListOutputArgs, opts ...InvokeOption) GetServiceListResultOutput

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

    public static class GetServiceList 
    {
        public static Task<GetServiceListResult> InvokeAsync(GetServiceListArgs args, InvokeOptions? opts = null)
        public static Output<GetServiceListResult> Invoke(GetServiceListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServiceListResult> getServiceList(GetServiceListArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scm:index/getServiceList:getServiceList
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Device string
    The Device param.
    Folder string
    The Folder param.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Name string
    The Name param.
    Offset int
    The Offset param. Default: 0.
    Snippet string
    The Snippet param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Name string
    The Name param.
    Offset int
    The Offset param. Default: 0.
    Snippet string
    The Snippet param.
    device String
    The Device param.
    folder String
    The Folder param.
    limit Integer
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name String
    The Name param.
    offset Integer
    The Offset param. Default: 0.
    snippet String
    The Snippet param.
    device string
    The Device param.
    folder string
    The Folder param.
    limit number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name string
    The Name param.
    offset number
    The Offset param. Default: 0.
    snippet string
    The Snippet param.
    device str
    The Device param.
    folder str
    The Folder param.
    limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name str
    The Name param.
    offset int
    The Offset param. Default: 0.
    snippet str
    The Snippet param.
    device String
    The Device param.
    folder String
    The Folder param.
    limit Number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name String
    The Name param.
    offset Number
    The Offset param. Default: 0.
    snippet String
    The Snippet param.

    getServiceList Result

    The following output properties are available:

    Datas List<GetServiceListData>
    The Data param.
    Id string
    The provider-assigned unique ID for this managed resource.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Offset int
    The Offset param. Default: 0.
    Tfid string
    Total int
    The Total param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    Datas []GetServiceListData
    The Data param.
    Id string
    The provider-assigned unique ID for this managed resource.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Offset int
    The Offset param. Default: 0.
    Tfid string
    Total int
    The Total param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    datas List<GetServiceListData>
    The Data param.
    id String
    The provider-assigned unique ID for this managed resource.
    limit Integer
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset Integer
    The Offset param. Default: 0.
    tfid String
    total Integer
    The Total param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param.
    snippet String
    The Snippet param.
    datas GetServiceListData[]
    The Data param.
    id string
    The provider-assigned unique ID for this managed resource.
    limit number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset number
    The Offset param. Default: 0.
    tfid string
    total number
    The Total param.
    device string
    The Device param.
    folder string
    The Folder param.
    name string
    The Name param.
    snippet string
    The Snippet param.
    datas Sequence[GetServiceListData]
    The Data param.
    id str
    The provider-assigned unique ID for this managed resource.
    limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset int
    The Offset param. Default: 0.
    tfid str
    total int
    The Total param.
    device str
    The Device param.
    folder str
    The Folder param.
    name str
    The Name param.
    snippet str
    The Snippet param.
    datas List<Property Map>
    The Data param.
    id String
    The provider-assigned unique ID for this managed resource.
    limit Number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset Number
    The Offset param. Default: 0.
    tfid String
    total Number
    The Total param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param.
    snippet String
    The Snippet param.

    Supporting Types

    GetServiceListData

    Description string
    The Description param. String length must not exceed 1023 characters.
    Id string
    UUID of the resource.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Protocol GetServiceListDataProtocol
    The Protocol param.
    Tags List<string>
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    Description string
    The Description param. String length must not exceed 1023 characters.
    Id string
    UUID of the resource.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Protocol GetServiceListDataProtocol
    The Protocol param.
    Tags []string
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    description String
    The Description param. String length must not exceed 1023 characters.
    id String
    UUID of the resource.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol GetServiceListDataProtocol
    The Protocol param.
    tags List<String>
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    description string
    The Description param. String length must not exceed 1023 characters.
    id string
    UUID of the resource.
    name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol GetServiceListDataProtocol
    The Protocol param.
    tags string[]
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    description str
    The Description param. String length must not exceed 1023 characters.
    id str
    UUID of the resource.
    name str
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol GetServiceListDataProtocol
    The Protocol param.
    tags Sequence[str]
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    description String
    The Description param. String length must not exceed 1023 characters.
    id String
    UUID of the resource.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    protocol Property Map
    The Protocol param.
    tags List<String>
    Tags for service object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.

    GetServiceListDataProtocol

    tcp Property Map
    The Tcp param.
    udp Property Map
    The Udp param.

    GetServiceListDataProtocolTcp

    Override GetServiceListDataProtocolTcpOverride
    The Override param.
    Port string
    The Port param. String length must be between 1 and 1023 characters.
    SourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    Override GetServiceListDataProtocolTcpOverride
    The Override param.
    Port string
    The Port param. String length must be between 1 and 1023 characters.
    SourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceListDataProtocolTcpOverride
    The Override param.
    port String
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort String
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceListDataProtocolTcpOverride
    The Override param.
    port string
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceListDataProtocolTcpOverride
    The Override param.
    port str
    The Port param. String length must be between 1 and 1023 characters.
    source_port str
    The SourcePort param. String length must be between 1 and 1023 characters.
    override Property Map
    The Override param.
    port String
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort String
    The SourcePort param. String length must be between 1 and 1023 characters.

    GetServiceListDataProtocolTcpOverride

    HalfcloseTimeout int
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    Timeout int
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    TimewaitTimeout int
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.
    HalfcloseTimeout int
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    Timeout int
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    TimewaitTimeout int
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.
    halfcloseTimeout Integer
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    timeout Integer
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    timewaitTimeout Integer
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.
    halfcloseTimeout number
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    timeout number
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    timewaitTimeout number
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.
    halfclose_timeout int
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    timeout int
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    timewait_timeout int
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.
    halfcloseTimeout Number
    tcp session half-close timeout value (in second). Value must be between 1 and 604800. Default: 120.
    timeout Number
    tcp session timeout value (in second). Value must be between 1 and 604800. Default: 3600.
    timewaitTimeout Number
    tcp session time-wait timeout value (in second). Value must be between 1 and 600. Default: 15.

    GetServiceListDataProtocolUdp

    Override GetServiceListDataProtocolUdpOverride
    The Override param.
    Port string
    The Port param. String length must be between 1 and 1023 characters.
    SourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    Override GetServiceListDataProtocolUdpOverride
    The Override param.
    Port string
    The Port param. String length must be between 1 and 1023 characters.
    SourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceListDataProtocolUdpOverride
    The Override param.
    port String
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort String
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceListDataProtocolUdpOverride
    The Override param.
    port string
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort string
    The SourcePort param. String length must be between 1 and 1023 characters.
    override GetServiceListDataProtocolUdpOverride
    The Override param.
    port str
    The Port param. String length must be between 1 and 1023 characters.
    source_port str
    The SourcePort param. String length must be between 1 and 1023 characters.
    override Property Map
    The Override param.
    port String
    The Port param. String length must be between 1 and 1023 characters.
    sourcePort String
    The SourcePort param. String length must be between 1 and 1023 characters.

    GetServiceListDataProtocolUdpOverride

    Timeout int
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.
    Timeout int
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.
    timeout Integer
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.
    timeout number
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.
    timeout int
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.
    timeout Number
    udp session timeout value (in second). Value must be between 1 and 604800. Default: 30.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi