Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getServiceConnection
Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-scm

scm.getServiceConnection

Explore with Pulumi AI

Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-scm

Retrieves a config item.

Example Usage

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

const example = scm.getServiceConnection({
    id: "1234-56-789",
    folder: "Service Connections",
});
Copy
import pulumi
import pulumi_scm as scm

example = scm.get_service_connection(id="1234-56-789",
    folder="Service Connections")
Copy
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.LookupServiceConnection(ctx, &scm.LookupServiceConnectionArgs{
			Id:     "1234-56-789",
			Folder: pulumi.StringRef("Service Connections"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    var example = Scm.GetServiceConnection.Invoke(new()
    {
        Id = "1234-56-789",
        Folder = "Service Connections",
    });

});
Copy
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.GetServiceConnectionArgs;
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.getServiceConnection(GetServiceConnectionArgs.builder()
            .id("1234-56-789")
            .folder("Service Connections")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: scm:getServiceConnection
      arguments:
        id: 1234-56-789
        folder: Service Connections
Copy

Using getServiceConnection

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 getServiceConnection(args: GetServiceConnectionArgs, opts?: InvokeOptions): Promise<GetServiceConnectionResult>
function getServiceConnectionOutput(args: GetServiceConnectionOutputArgs, opts?: InvokeOptions): Output<GetServiceConnectionResult>
Copy
def get_service_connection(folder: Optional[str] = None,
                           id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetServiceConnectionResult
def get_service_connection_output(folder: Optional[pulumi.Input[str]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetServiceConnectionResult]
Copy
func LookupServiceConnection(ctx *Context, args *LookupServiceConnectionArgs, opts ...InvokeOption) (*LookupServiceConnectionResult, error)
func LookupServiceConnectionOutput(ctx *Context, args *LookupServiceConnectionOutputArgs, opts ...InvokeOption) LookupServiceConnectionResultOutput
Copy

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

public static class GetServiceConnection 
{
    public static Task<GetServiceConnectionResult> InvokeAsync(GetServiceConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceConnectionResult> Invoke(GetServiceConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServiceConnectionResult> getServiceConnection(GetServiceConnectionArgs args, InvokeOptions options)
public static Output<GetServiceConnectionResult> getServiceConnection(GetServiceConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: scm:index/getServiceConnection:getServiceConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The Id param.
Folder string
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
Id This property is required. string
The Id param.
Folder string
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
id This property is required. String
The Id param.
folder String
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
id This property is required. string
The Id param.
folder string
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
id This property is required. str
The Id param.
folder str
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
id This property is required. String
The Id param.
folder String
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".

getServiceConnection Result

The following output properties are available:

BackupSC string
The BackupSC param.
BgpPeer GetServiceConnectionBgpPeer
The BgpPeer param.
Folder string
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
Id string
The Id param.
IpsecTunnel string
The IpsecTunnel param.
Name string
The Name param.
NatPool string
The NatPool param.
NoExportCommunity string
The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
OnboardingType string
The OnboardingType param. String must be one of these: "classic". Default: "classic".
Protocol GetServiceConnectionProtocol
The Protocol param.
Qos GetServiceConnectionQos
The Qos param.
Region string
The Region param.
SecondaryIpsecTunnel string
The SecondaryIpsecTunnel param.
SourceNat bool
The SourceNat param.
Subnets List<string>
The Subnets param.
Tfid string
BackupSC string
The BackupSC param.
BgpPeer GetServiceConnectionBgpPeer
The BgpPeer param.
Folder string
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
Id string
The Id param.
IpsecTunnel string
The IpsecTunnel param.
Name string
The Name param.
NatPool string
The NatPool param.
NoExportCommunity string
The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
OnboardingType string
The OnboardingType param. String must be one of these: "classic". Default: "classic".
Protocol GetServiceConnectionProtocol
The Protocol param.
Qos GetServiceConnectionQos
The Qos param.
Region string
The Region param.
SecondaryIpsecTunnel string
The SecondaryIpsecTunnel param.
SourceNat bool
The SourceNat param.
Subnets []string
The Subnets param.
Tfid string
backupSC String
The BackupSC param.
bgpPeer GetServiceConnectionBgpPeer
The BgpPeer param.
folder String
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
id String
The Id param.
ipsecTunnel String
The IpsecTunnel param.
name String
The Name param.
natPool String
The NatPool param.
noExportCommunity String
The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
onboardingType String
The OnboardingType param. String must be one of these: "classic". Default: "classic".
protocol GetServiceConnectionProtocol
The Protocol param.
qos GetServiceConnectionQos
The Qos param.
region String
The Region param.
secondaryIpsecTunnel String
The SecondaryIpsecTunnel param.
sourceNat Boolean
The SourceNat param.
subnets List<String>
The Subnets param.
tfid String
backupSC string
The BackupSC param.
bgpPeer GetServiceConnectionBgpPeer
The BgpPeer param.
folder string
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
id string
The Id param.
ipsecTunnel string
The IpsecTunnel param.
name string
The Name param.
natPool string
The NatPool param.
noExportCommunity string
The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
onboardingType string
The OnboardingType param. String must be one of these: "classic". Default: "classic".
protocol GetServiceConnectionProtocol
The Protocol param.
qos GetServiceConnectionQos
The Qos param.
region string
The Region param.
secondaryIpsecTunnel string
The SecondaryIpsecTunnel param.
sourceNat boolean
The SourceNat param.
subnets string[]
The Subnets param.
tfid string
backup_sc str
The BackupSC param.
bgp_peer GetServiceConnectionBgpPeer
The BgpPeer param.
folder str
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
id str
The Id param.
ipsec_tunnel str
The IpsecTunnel param.
name str
The Name param.
nat_pool str
The NatPool param.
no_export_community str
The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
onboarding_type str
The OnboardingType param. String must be one of these: "classic". Default: "classic".
protocol GetServiceConnectionProtocol
The Protocol param.
qos GetServiceConnectionQos
The Qos param.
region str
The Region param.
secondary_ipsec_tunnel str
The SecondaryIpsecTunnel param.
source_nat bool
The SourceNat param.
subnets Sequence[str]
The Subnets param.
tfid str
backupSC String
The BackupSC param.
bgpPeer Property Map
The BgpPeer param.
folder String
The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
id String
The Id param.
ipsecTunnel String
The IpsecTunnel param.
name String
The Name param.
natPool String
The NatPool param.
noExportCommunity String
The NoExportCommunity param. String must be one of these: "Disabled", "Enabled-In", "Enabled-Out", "Enabled-Both".
onboardingType String
The OnboardingType param. String must be one of these: "classic". Default: "classic".
protocol Property Map
The Protocol param.
qos Property Map
The Qos param.
region String
The Region param.
secondaryIpsecTunnel String
The SecondaryIpsecTunnel param.
sourceNat Boolean
The SourceNat param.
subnets List<String>
The Subnets param.
tfid String

Supporting Types

GetServiceConnectionBgpPeer

LocalIpAddress This property is required. string
The LocalIpAddress param.
LocalIpv6Address This property is required. string
The LocalIpv6Address param.
PeerIpAddress This property is required. string
The PeerIpAddress param.
PeerIpv6Address This property is required. string
The PeerIpv6Address param.
SameAsPrimary This property is required. bool
The SameAsPrimary param.
Secret This property is required. string
The Secret param.
LocalIpAddress This property is required. string
The LocalIpAddress param.
LocalIpv6Address This property is required. string
The LocalIpv6Address param.
PeerIpAddress This property is required. string
The PeerIpAddress param.
PeerIpv6Address This property is required. string
The PeerIpv6Address param.
SameAsPrimary This property is required. bool
The SameAsPrimary param.
Secret This property is required. string
The Secret param.
localIpAddress This property is required. String
The LocalIpAddress param.
localIpv6Address This property is required. String
The LocalIpv6Address param.
peerIpAddress This property is required. String
The PeerIpAddress param.
peerIpv6Address This property is required. String
The PeerIpv6Address param.
sameAsPrimary This property is required. Boolean
The SameAsPrimary param.
secret This property is required. String
The Secret param.
localIpAddress This property is required. string
The LocalIpAddress param.
localIpv6Address This property is required. string
The LocalIpv6Address param.
peerIpAddress This property is required. string
The PeerIpAddress param.
peerIpv6Address This property is required. string
The PeerIpv6Address param.
sameAsPrimary This property is required. boolean
The SameAsPrimary param.
secret This property is required. string
The Secret param.
local_ip_address This property is required. str
The LocalIpAddress param.
local_ipv6_address This property is required. str
The LocalIpv6Address param.
peer_ip_address This property is required. str
The PeerIpAddress param.
peer_ipv6_address This property is required. str
The PeerIpv6Address param.
same_as_primary This property is required. bool
The SameAsPrimary param.
secret This property is required. str
The Secret param.
localIpAddress This property is required. String
The LocalIpAddress param.
localIpv6Address This property is required. String
The LocalIpv6Address param.
peerIpAddress This property is required. String
The PeerIpAddress param.
peerIpv6Address This property is required. String
The PeerIpv6Address param.
sameAsPrimary This property is required. Boolean
The SameAsPrimary param.
secret This property is required. String
The Secret param.

GetServiceConnectionProtocol

Bgp This property is required. GetServiceConnectionProtocolBgp
The Bgp param.
Bgp This property is required. GetServiceConnectionProtocolBgp
The Bgp param.
bgp This property is required. GetServiceConnectionProtocolBgp
The Bgp param.
bgp This property is required. GetServiceConnectionProtocolBgp
The Bgp param.
bgp This property is required. GetServiceConnectionProtocolBgp
The Bgp param.
bgp This property is required. Property Map
The Bgp param.

GetServiceConnectionProtocolBgp

DoNotExportRoutes This property is required. bool
The DoNotExportRoutes param.
Enable This property is required. bool
The Enable param.
FastFailover This property is required. bool
The FastFailover param.
LocalIpAddress This property is required. string
The LocalIpAddress param.
OriginateDefaultRoute This property is required. bool
The OriginateDefaultRoute param.
PeerAs This property is required. string
The PeerAs param.
PeerIpAddress This property is required. string
The PeerIpAddress param.
Secret This property is required. string
The Secret param.
SummarizeMobileUserRoutes This property is required. bool
The SummarizeMobileUserRoutes param.
DoNotExportRoutes This property is required. bool
The DoNotExportRoutes param.
Enable This property is required. bool
The Enable param.
FastFailover This property is required. bool
The FastFailover param.
LocalIpAddress This property is required. string
The LocalIpAddress param.
OriginateDefaultRoute This property is required. bool
The OriginateDefaultRoute param.
PeerAs This property is required. string
The PeerAs param.
PeerIpAddress This property is required. string
The PeerIpAddress param.
Secret This property is required. string
The Secret param.
SummarizeMobileUserRoutes This property is required. bool
The SummarizeMobileUserRoutes param.
doNotExportRoutes This property is required. Boolean
The DoNotExportRoutes param.
enable This property is required. Boolean
The Enable param.
fastFailover This property is required. Boolean
The FastFailover param.
localIpAddress This property is required. String
The LocalIpAddress param.
originateDefaultRoute This property is required. Boolean
The OriginateDefaultRoute param.
peerAs This property is required. String
The PeerAs param.
peerIpAddress This property is required. String
The PeerIpAddress param.
secret This property is required. String
The Secret param.
summarizeMobileUserRoutes This property is required. Boolean
The SummarizeMobileUserRoutes param.
doNotExportRoutes This property is required. boolean
The DoNotExportRoutes param.
enable This property is required. boolean
The Enable param.
fastFailover This property is required. boolean
The FastFailover param.
localIpAddress This property is required. string
The LocalIpAddress param.
originateDefaultRoute This property is required. boolean
The OriginateDefaultRoute param.
peerAs This property is required. string
The PeerAs param.
peerIpAddress This property is required. string
The PeerIpAddress param.
secret This property is required. string
The Secret param.
summarizeMobileUserRoutes This property is required. boolean
The SummarizeMobileUserRoutes param.
do_not_export_routes This property is required. bool
The DoNotExportRoutes param.
enable This property is required. bool
The Enable param.
fast_failover This property is required. bool
The FastFailover param.
local_ip_address This property is required. str
The LocalIpAddress param.
originate_default_route This property is required. bool
The OriginateDefaultRoute param.
peer_as This property is required. str
The PeerAs param.
peer_ip_address This property is required. str
The PeerIpAddress param.
secret This property is required. str
The Secret param.
summarize_mobile_user_routes This property is required. bool
The SummarizeMobileUserRoutes param.
doNotExportRoutes This property is required. Boolean
The DoNotExportRoutes param.
enable This property is required. Boolean
The Enable param.
fastFailover This property is required. Boolean
The FastFailover param.
localIpAddress This property is required. String
The LocalIpAddress param.
originateDefaultRoute This property is required. Boolean
The OriginateDefaultRoute param.
peerAs This property is required. String
The PeerAs param.
peerIpAddress This property is required. String
The PeerIpAddress param.
secret This property is required. String
The Secret param.
summarizeMobileUserRoutes This property is required. Boolean
The SummarizeMobileUserRoutes param.

GetServiceConnectionQos

Enable This property is required. bool
The Enable param.
QosProfile This property is required. string
The QosProfile param.
Enable This property is required. bool
The Enable param.
QosProfile This property is required. string
The QosProfile param.
enable This property is required. Boolean
The Enable param.
qosProfile This property is required. String
The QosProfile param.
enable This property is required. boolean
The Enable param.
qosProfile This property is required. string
The QosProfile param.
enable This property is required. bool
The Enable param.
qos_profile This property is required. str
The QosProfile param.
enable This property is required. Boolean
The Enable param.
qosProfile This property is required. String
The QosProfile param.

Package Details

Repository
scm pulumi/pulumi-scm
License
Apache-2.0
Notes
This Pulumi package is based on the scm Terraform Provider.
Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-scm