Strata Cloud Manager v0.1.1 published on Friday, May 31, 2024 by Pulumi
scm.getServiceConnection
Explore with Pulumi AI
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",
});
import pulumi
import pulumi_scm as scm
example = scm.get_service_connection(id="1234-56-789",
    folder="Service Connections")
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
	})
}
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",
    });
});
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());
    }
}
variables:
  example:
    fn::invoke:
      Function: scm:getServiceConnection
      Arguments:
        id: 1234-56-789
        folder: Service Connections
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>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]func LookupServiceConnection(ctx *Context, args *LookupServiceConnectionArgs, opts ...InvokeOption) (*LookupServiceConnectionResult, error)
func LookupServiceConnectionOutput(ctx *Context, args *LookupServiceConnectionOutputArgs, opts ...InvokeOption) LookupServiceConnectionResultOutput> 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)
}public static CompletableFuture<GetServiceConnectionResult> getServiceConnection(GetServiceConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: scm:index/getServiceConnection:getServiceConnection
  arguments:
    # arguments dictionaryThe following arguments are supported:
getServiceConnection Result
The following output properties are available:
- Backup
SC string - The BackupSC param.
 - Bgp
Peer GetService Connection Bgp Peer  - 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.
 - Ipsec
Tunnel string - The IpsecTunnel param.
 - Name string
 - The Name param.
 - Nat
Pool string - The NatPool param.
 - No
Export stringCommunity  - The NoExportCommunity param. String must be one of these: 
"Disabled","Enabled-In","Enabled-Out","Enabled-Both". - Onboarding
Type string - The OnboardingType param. String must be one of these: 
"classic". Default:"classic". - Protocol
Get
Service Connection Protocol  - The Protocol param.
 - Qos
Get
Service Connection Qos  - The Qos param.
 - Region string
 - The Region param.
 - Secondary
Ipsec stringTunnel  - The SecondaryIpsecTunnel param.
 - Source
Nat bool - The SourceNat param.
 - Subnets List<string>
 - The Subnets param.
 - Tfid string
 
- Backup
SC string - The BackupSC param.
 - Bgp
Peer GetService Connection Bgp Peer  - 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.
 - Ipsec
Tunnel string - The IpsecTunnel param.
 - Name string
 - The Name param.
 - Nat
Pool string - The NatPool param.
 - No
Export stringCommunity  - The NoExportCommunity param. String must be one of these: 
"Disabled","Enabled-In","Enabled-Out","Enabled-Both". - Onboarding
Type string - The OnboardingType param. String must be one of these: 
"classic". Default:"classic". - Protocol
Get
Service Connection Protocol  - The Protocol param.
 - Qos
Get
Service Connection Qos  - The Qos param.
 - Region string
 - The Region param.
 - Secondary
Ipsec stringTunnel  - The SecondaryIpsecTunnel param.
 - Source
Nat bool - The SourceNat param.
 - Subnets []string
 - The Subnets param.
 - Tfid string
 
- backup
SC String - The BackupSC param.
 - bgp
Peer GetService Connection Bgp Peer  - 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.
 - ipsec
Tunnel String - The IpsecTunnel param.
 - name String
 - The Name param.
 - nat
Pool String - The NatPool param.
 - no
Export StringCommunity  - The NoExportCommunity param. String must be one of these: 
"Disabled","Enabled-In","Enabled-Out","Enabled-Both". - onboarding
Type String - The OnboardingType param. String must be one of these: 
"classic". Default:"classic". - protocol
Get
Service Connection Protocol  - The Protocol param.
 - qos
Get
Service Connection Qos  - The Qos param.
 - region String
 - The Region param.
 - secondary
Ipsec StringTunnel  - The SecondaryIpsecTunnel param.
 - source
Nat Boolean - The SourceNat param.
 - subnets List<String>
 - The Subnets param.
 - tfid String
 
- backup
SC string - The BackupSC param.
 - bgp
Peer GetService Connection Bgp Peer  - 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.
 - ipsec
Tunnel string - The IpsecTunnel param.
 - name string
 - The Name param.
 - nat
Pool string - The NatPool param.
 - no
Export stringCommunity  - The NoExportCommunity param. String must be one of these: 
"Disabled","Enabled-In","Enabled-Out","Enabled-Both". - onboarding
Type string - The OnboardingType param. String must be one of these: 
"classic". Default:"classic". - protocol
Get
Service Connection Protocol  - The Protocol param.
 - qos
Get
Service Connection Qos  - The Qos param.
 - region string
 - The Region param.
 - secondary
Ipsec stringTunnel  - The SecondaryIpsecTunnel param.
 - source
Nat boolean - The SourceNat param.
 - subnets string[]
 - The Subnets param.
 - tfid string
 
- backup_
sc str - The BackupSC param.
 - bgp_
peer GetService Connection Bgp Peer  - 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_ strcommunity  - 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
Get
Service Connection Protocol  - The Protocol param.
 - qos
Get
Service Connection Qos  - The Qos param.
 - region str
 - The Region param.
 - secondary_
ipsec_ strtunnel  - The SecondaryIpsecTunnel param.
 - source_
nat bool - The SourceNat param.
 - subnets Sequence[str]
 - The Subnets param.
 - tfid str
 
- backup
SC String - The BackupSC param.
 - bgp
Peer 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.
 - ipsec
Tunnel String - The IpsecTunnel param.
 - name String
 - The Name param.
 - nat
Pool String - The NatPool param.
 - no
Export StringCommunity  - The NoExportCommunity param. String must be one of these: 
"Disabled","Enabled-In","Enabled-Out","Enabled-Both". - onboarding
Type 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.
 - secondary
Ipsec StringTunnel  - The SecondaryIpsecTunnel param.
 - source
Nat Boolean - The SourceNat param.
 - subnets List<String>
 - The Subnets param.
 - tfid String
 
Supporting Types
GetServiceConnectionBgpPeer    
- Local
Ip stringAddress  - The LocalIpAddress param.
 - Local
Ipv6Address string - The LocalIpv6Address param.
 - Peer
Ip stringAddress  - The PeerIpAddress param.
 - Peer
Ipv6Address string - The PeerIpv6Address param.
 - Same
As boolPrimary  - The SameAsPrimary param.
 - Secret string
 - The Secret param.
 
- Local
Ip stringAddress  - The LocalIpAddress param.
 - Local
Ipv6Address string - The LocalIpv6Address param.
 - Peer
Ip stringAddress  - The PeerIpAddress param.
 - Peer
Ipv6Address string - The PeerIpv6Address param.
 - Same
As boolPrimary  - The SameAsPrimary param.
 - Secret string
 - The Secret param.
 
- local
Ip StringAddress  - The LocalIpAddress param.
 - local
Ipv6Address String - The LocalIpv6Address param.
 - peer
Ip StringAddress  - The PeerIpAddress param.
 - peer
Ipv6Address String - The PeerIpv6Address param.
 - same
As BooleanPrimary  - The SameAsPrimary param.
 - secret String
 - The Secret param.
 
- local
Ip stringAddress  - The LocalIpAddress param.
 - local
Ipv6Address string - The LocalIpv6Address param.
 - peer
Ip stringAddress  - The PeerIpAddress param.
 - peer
Ipv6Address string - The PeerIpv6Address param.
 - same
As booleanPrimary  - The SameAsPrimary param.
 - secret string
 - The Secret param.
 
- local_
ip_ straddress  - The LocalIpAddress param.
 - local_
ipv6_ straddress  - The LocalIpv6Address param.
 - peer_
ip_ straddress  - The PeerIpAddress param.
 - peer_
ipv6_ straddress  - The PeerIpv6Address param.
 - same_
as_ boolprimary  - The SameAsPrimary param.
 - secret str
 - The Secret param.
 
- local
Ip StringAddress  - The LocalIpAddress param.
 - local
Ipv6Address String - The LocalIpv6Address param.
 - peer
Ip StringAddress  - The PeerIpAddress param.
 - peer
Ipv6Address String - The PeerIpv6Address param.
 - same
As BooleanPrimary  - The SameAsPrimary param.
 - secret String
 - The Secret param.
 
GetServiceConnectionProtocol   
- Bgp
Get
Service Connection Protocol Bgp  - The Bgp param.
 
- Bgp
Get
Service Connection Protocol Bgp  - The Bgp param.
 
- bgp
Get
Service Connection Protocol Bgp  - The Bgp param.
 
- bgp
Get
Service Connection Protocol Bgp  - The Bgp param.
 
- bgp
Get
Service Connection Protocol Bgp  - The Bgp param.
 
- bgp Property Map
 - The Bgp param.
 
GetServiceConnectionProtocolBgp    
- Do
Not boolExport Routes  - The DoNotExportRoutes param.
 - Enable bool
 - The Enable param.
 - Fast
Failover bool - The FastFailover param.
 - Local
Ip stringAddress  - The LocalIpAddress param.
 - Originate
Default boolRoute  - The OriginateDefaultRoute param.
 - Peer
As string - The PeerAs param.
 - Peer
Ip stringAddress  - The PeerIpAddress param.
 - Secret string
 - The Secret param.
 - Summarize
Mobile boolUser Routes  - The SummarizeMobileUserRoutes param.
 
- Do
Not boolExport Routes  - The DoNotExportRoutes param.
 - Enable bool
 - The Enable param.
 - Fast
Failover bool - The FastFailover param.
 - Local
Ip stringAddress  - The LocalIpAddress param.
 - Originate
Default boolRoute  - The OriginateDefaultRoute param.
 - Peer
As string - The PeerAs param.
 - Peer
Ip stringAddress  - The PeerIpAddress param.
 - Secret string
 - The Secret param.
 - Summarize
Mobile boolUser Routes  - The SummarizeMobileUserRoutes param.
 
- do
Not BooleanExport Routes  - The DoNotExportRoutes param.
 - enable Boolean
 - The Enable param.
 - fast
Failover Boolean - The FastFailover param.
 - local
Ip StringAddress  - The LocalIpAddress param.
 - originate
Default BooleanRoute  - The OriginateDefaultRoute param.
 - peer
As String - The PeerAs param.
 - peer
Ip StringAddress  - The PeerIpAddress param.
 - secret String
 - The Secret param.
 - summarize
Mobile BooleanUser Routes  - The SummarizeMobileUserRoutes param.
 
- do
Not booleanExport Routes  - The DoNotExportRoutes param.
 - enable boolean
 - The Enable param.
 - fast
Failover boolean - The FastFailover param.
 - local
Ip stringAddress  - The LocalIpAddress param.
 - originate
Default booleanRoute  - The OriginateDefaultRoute param.
 - peer
As string - The PeerAs param.
 - peer
Ip stringAddress  - The PeerIpAddress param.
 - secret string
 - The Secret param.
 - summarize
Mobile booleanUser Routes  - The SummarizeMobileUserRoutes param.
 
- do_
not_ boolexport_ routes  - The DoNotExportRoutes param.
 - enable bool
 - The Enable param.
 - fast_
failover bool - The FastFailover param.
 - local_
ip_ straddress  - The LocalIpAddress param.
 - originate_
default_ boolroute  - The OriginateDefaultRoute param.
 - peer_
as str - The PeerAs param.
 - peer_
ip_ straddress  - The PeerIpAddress param.
 - secret str
 - The Secret param.
 - summarize_
mobile_ booluser_ routes  - The SummarizeMobileUserRoutes param.
 
- do
Not BooleanExport Routes  - The DoNotExportRoutes param.
 - enable Boolean
 - The Enable param.
 - fast
Failover Boolean - The FastFailover param.
 - local
Ip StringAddress  - The LocalIpAddress param.
 - originate
Default BooleanRoute  - The OriginateDefaultRoute param.
 - peer
As String - The PeerAs param.
 - peer
Ip StringAddress  - The PeerIpAddress param.
 - secret String
 - The Secret param.
 - summarize
Mobile BooleanUser Routes  - The SummarizeMobileUserRoutes param.
 
GetServiceConnectionQos   
- Enable bool
 - The Enable param.
 - Qos
Profile string - The QosProfile param.
 
- Enable bool
 - The Enable param.
 - Qos
Profile string - The QosProfile param.
 
- enable Boolean
 - The Enable param.
 - qos
Profile String - The QosProfile param.
 
- enable boolean
 - The Enable param.
 - qos
Profile string - The QosProfile param.
 
- enable bool
 - The Enable param.
 - qos_
profile str - The QosProfile param.
 
- enable Boolean
 - The Enable param.
 - qos
Profile String - The QosProfile param.
 
Package Details
- Repository
 - scm pulumi/pulumi-scm
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
scmTerraform Provider.