1. Registry
  2. Packages
  3. Strata Cloud Manager Provider
  4. API Docs
  5. getBgpAuthProfile
Viewing docs for Strata Cloud Manager v1.2.1
published on Friday, Oct 16, 2026 by Pulumi
scm logo Strata Cloud Manager
Viewing docs for Strata Cloud Manager v1.2.1
published on Friday, Oct 16, 2026 by Pulumi

    BgpAuthProfile data source

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    // Look up BGP Auth Profile by its ID.
    const scmBgpAuthProfileDs = scm.getBgpAuthProfile({
        id: "f2ffd626-e92d-4de6-8ac1-37742fe80fb9",
    });
    export const bgpAuthProfileDataSourceResults = {
        id: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.id),
        name: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.name),
        secret: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.secret),
        folder: scmBgpAuthProfileDs.then(scmBgpAuthProfileDs => scmBgpAuthProfileDs.folder),
    };
    
    import pulumi
    import pulumi_scm as scm
    
    # Look up BGP Auth Profile by its ID.
    scm_bgp_auth_profile_ds = scm.get_bgp_auth_profile(id="f2ffd626-e92d-4de6-8ac1-37742fe80fb9")
    pulumi.export("bgpAuthProfileDataSourceResults", {
        "id": scm_bgp_auth_profile_ds.id,
        "name": scm_bgp_auth_profile_ds.name,
        "secret": scm_bgp_auth_profile_ds.secret,
        "folder": scm_bgp_auth_profile_ds.folder,
    })
    
    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 {
    		// Look up BGP Auth Profile by its ID.
    		scmBgpAuthProfileDs, err := scm.GetBgpAuthProfile(ctx, &scm.LookupBgpAuthProfileArgs{
    			Id: "f2ffd626-e92d-4de6-8ac1-37742fe80fb9",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("bgpAuthProfileDataSourceResults", pulumi.StringMap{
    			"id":     scmBgpAuthProfileDs.Id,
    			"name":   scmBgpAuthProfileDs.Name,
    			"secret": scmBgpAuthProfileDs.Secret,
    			"folder": scmBgpAuthProfileDs.Folder,
    		})
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        // Look up BGP Auth Profile by its ID.
        var scmBgpAuthProfileDs = Scm.GetBgpAuthProfile.Invoke(new()
        {
            Id = "f2ffd626-e92d-4de6-8ac1-37742fe80fb9",
        });
    
        return new Dictionary<string, object?>
        {
            ["bgpAuthProfileDataSourceResults"] = new Dictionary<string, object?>
            {
                ["id"] = scmBgpAuthProfileDs.Apply(getBgpAuthProfileResult => getBgpAuthProfileResult.Id),
                ["name"] = scmBgpAuthProfileDs.Apply(getBgpAuthProfileResult => getBgpAuthProfileResult.Name),
                ["secret"] = scmBgpAuthProfileDs.Apply(getBgpAuthProfileResult => getBgpAuthProfileResult.Secret),
                ["folder"] = scmBgpAuthProfileDs.Apply(getBgpAuthProfileResult => getBgpAuthProfileResult.Folder),
            },
        };
    });
    
    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.GetBgpAuthProfileArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            // Look up BGP Auth Profile by its ID.
            final var scmBgpAuthProfileDs = ScmFunctions.getBgpAuthProfile(GetBgpAuthProfileArgs.builder()
                .id("f2ffd626-e92d-4de6-8ac1-37742fe80fb9")
                .build());
    
            ctx.export("bgpAuthProfileDataSourceResults", Map.ofEntries(
                Map.entry("id", scmBgpAuthProfileDs.id()),
                Map.entry("name", scmBgpAuthProfileDs.name()),
                Map.entry("secret", scmBgpAuthProfileDs.secret()),
                Map.entry("folder", scmBgpAuthProfileDs.folder())
            ));
        }
    }
    
    variables:
      # Look up BGP Auth Profile by its ID.
      scmBgpAuthProfileDs:
        fn::invoke:
          function: scm:getBgpAuthProfile
          arguments:
            id: f2ffd626-e92d-4de6-8ac1-37742fe80fb9
    outputs:
      # Output various attributes from the found bgp auth profile to verify the lookups were successful.
      bgpAuthProfileDataSourceResults:
        id: ${scmBgpAuthProfileDs.id}
        name: ${scmBgpAuthProfileDs.name}
        secret: ${scmBgpAuthProfileDs.secret}
        folder: ${scmBgpAuthProfileDs.folder}
    
    terraform {
      required_providers {
        scm = {
          source = "pulumi/scm"
        }
      }
    }
    
    data "scm_bgp_auth_profile" "scmBgpAuthProfileDs" {
      id = "f2ffd626-e92d-4de6-8ac1-37742fe80fb9"
    }
    
    # Look up BGP Auth Profile by its ID.
    # Output various attributes from the found bgp auth profile to verify the lookups were successful.
    output "bgpAuthProfileDataSourceResults" {
      value = {
        "id"     = data.scm_bgp_auth_profile.scmBgpAuthProfileDs.id
        "name"   = data.scm_bgp_auth_profile.scmBgpAuthProfileDs.name
        "secret" = data.scm_bgp_auth_profile.scmBgpAuthProfileDs.secret
        "folder" = data.scm_bgp_auth_profile.scmBgpAuthProfileDs.folder
      }
    }
    

    Using getBgpAuthProfile

    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 getBgpAuthProfile(args: GetBgpAuthProfileArgs, opts?: InvokeOptions): Promise<GetBgpAuthProfileResult>
    function getBgpAuthProfileOutput(args: GetBgpAuthProfileOutputArgs, opts?: InvokeOutputOptions): Output<GetBgpAuthProfileResult>
    def get_bgp_auth_profile(device: Optional[str] = None,
                             folder: Optional[str] = None,
                             id: Optional[str] = None,
                             name: Optional[str] = None,
                             snippet: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetBgpAuthProfileResult
    def get_bgp_auth_profile_output(device: pulumi.Input[Optional[str]] = None,
                             folder: pulumi.Input[Optional[str]] = None,
                             id: pulumi.Input[Optional[str]] = None,
                             name: pulumi.Input[Optional[str]] = None,
                             snippet: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOutputOptions] = None) -> Output[GetBgpAuthProfileResult]
    func LookupBgpAuthProfile(ctx *Context, args *LookupBgpAuthProfileArgs, opts ...InvokeOption) (*LookupBgpAuthProfileResult, error)
    func LookupBgpAuthProfileOutput(ctx *Context, args *LookupBgpAuthProfileOutputArgs, opts ...InvokeOption) LookupBgpAuthProfileResultOutput

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

    public static class GetBgpAuthProfile 
    {
        public static Task<GetBgpAuthProfileResult> InvokeAsync(GetBgpAuthProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetBgpAuthProfileResult> Invoke(GetBgpAuthProfileInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetBgpAuthProfileResult> Invoke(GetBgpAuthProfileInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetBgpAuthProfileResult> getBgpAuthProfile(GetBgpAuthProfileArgs args, InvokeOptions options)
    public static Output<GetBgpAuthProfileResult> getBgpAuthProfile(GetBgpAuthProfileArgs args, InvokeOptions options)
    public static Output<GetBgpAuthProfileResult> getBgpAuthProfile(GetBgpAuthProfileArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: scm:index/getBgpAuthProfile:getBgpAuthProfile
      arguments:
        # arguments dictionary
    data "scm_get_bgp_auth_profile" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    UUID of the resource
    Device string
    The device in which the resource is defined
    Folder string
    The folder in which the resource is defined
    Name string
    Profile name
    Snippet string
    The snippet in which the resource is defined
    Id string
    UUID of the resource
    Device string
    The device in which the resource is defined
    Folder string
    The folder in which the resource is defined
    Name string
    Profile name
    Snippet string
    The snippet in which the resource is defined
    id string
    UUID of the resource
    device string
    The device in which the resource is defined
    folder string
    The folder in which the resource is defined
    name string
    Profile name
    snippet string
    The snippet in which the resource is defined
    id String
    UUID of the resource
    device String
    The device in which the resource is defined
    folder String
    The folder in which the resource is defined
    name String
    Profile name
    snippet String
    The snippet in which the resource is defined
    id string
    UUID of the resource
    device string
    The device in which the resource is defined
    folder string
    The folder in which the resource is defined
    name string
    Profile name
    snippet string
    The snippet in which the resource is defined
    id str
    UUID of the resource
    device str
    The device in which the resource is defined
    folder str
    The folder in which the resource is defined
    name str
    Profile name
    snippet str
    The snippet in which the resource is defined
    id String
    UUID of the resource
    device String
    The device in which the resource is defined
    folder String
    The folder in which the resource is defined
    name String
    Profile name
    snippet String
    The snippet in which the resource is defined

    getBgpAuthProfile Result

    The following output properties are available:

    Device string
    The device in which the resource is defined
    EncryptedValues Dictionary<string, string>
    Map of sensitive values returned from the API.
    Folder string
    The folder in which the resource is defined
    Id string
    UUID of the resource
    Name string
    Profile name
    Secret string
    BGP authentication key
    Snippet string
    The snippet in which the resource is defined
    Tfid string
    The Terraform ID.
    Device string
    The device in which the resource is defined
    EncryptedValues map[string]string
    Map of sensitive values returned from the API.
    Folder string
    The folder in which the resource is defined
    Id string
    UUID of the resource
    Name string
    Profile name
    Secret string
    BGP authentication key
    Snippet string
    The snippet in which the resource is defined
    Tfid string
    The Terraform ID.
    device string
    The device in which the resource is defined
    encrypted_values map(string)
    Map of sensitive values returned from the API.
    folder string
    The folder in which the resource is defined
    id string
    UUID of the resource
    name string
    Profile name
    secret string
    BGP authentication key
    snippet string
    The snippet in which the resource is defined
    tfid string
    The Terraform ID.
    device String
    The device in which the resource is defined
    encryptedValues Map<String,String>
    Map of sensitive values returned from the API.
    folder String
    The folder in which the resource is defined
    id String
    UUID of the resource
    name String
    Profile name
    secret String
    BGP authentication key
    snippet String
    The snippet in which the resource is defined
    tfid String
    The Terraform ID.
    device string
    The device in which the resource is defined
    encryptedValues {[key: string]: string}
    Map of sensitive values returned from the API.
    folder string
    The folder in which the resource is defined
    id string
    UUID of the resource
    name string
    Profile name
    secret string
    BGP authentication key
    snippet string
    The snippet in which the resource is defined
    tfid string
    The Terraform ID.
    device str
    The device in which the resource is defined
    encrypted_values Mapping[str, str]
    Map of sensitive values returned from the API.
    folder str
    The folder in which the resource is defined
    id str
    UUID of the resource
    name str
    Profile name
    secret str
    BGP authentication key
    snippet str
    The snippet in which the resource is defined
    tfid str
    The Terraform ID.
    device String
    The device in which the resource is defined
    encryptedValues Map<String>
    Map of sensitive values returned from the API.
    folder String
    The folder in which the resource is defined
    id String
    UUID of the resource
    name String
    Profile name
    secret String
    BGP authentication key
    snippet String
    The snippet in which the resource is defined
    tfid String
    The Terraform ID.

    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
    Viewing docs for Strata Cloud Manager v1.2.1
    published on Friday, Oct 16, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial