Viewing docs for Volcengine v0.0.46
published on Friday, Feb 27, 2026 by Volcengine
published on Friday, Feb 27, 2026 by Volcengine
Viewing docs for Volcengine v0.0.46
published on Friday, Feb 27, 2026 by Volcengine
published on Friday, Feb 27, 2026 by Volcengine
Deprecated: volcengine.direct_connect.BgpPeers has been deprecated in favor of volcengine.direct_connect.getBgpPeers
Use this data source to query detailed information of direct connect bgp peers
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
const foo = volcengine.direct_connect.getBgpPeers({
ids: ["bgp-171w6pn39ruo04d1w33iq****"],
});
import pulumi
import pulumi_volcengine as volcengine
foo = volcengine.direct_connect.get_bgp_peers(ids=["bgp-171w6pn39ruo04d1w33iq****"])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/direct_connect"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := direct_connect.GetBgpPeers(ctx, &direct_connect.GetBgpPeersArgs{
Ids: []string{
"bgp-171w6pn39ruo04d1w33iq****",
},
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var foo = Volcengine.Direct_connect.GetBgpPeers.Invoke(new()
{
Ids = new[]
{
"bgp-171w6pn39ruo04d1w33iq****",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.direct_connect.Direct_connectFunctions;
import com.pulumi.volcengine.direct_connect.inputs.GetBgpPeersArgs;
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 foo = Direct_connectFunctions.getBgpPeers(GetBgpPeersArgs.builder()
.ids("bgp-171w6pn39ruo04d1w33iq****")
.build());
}
}
variables:
foo:
fn::invoke:
Function: volcengine:direct_connect:getBgpPeers
Arguments:
ids:
- bgp-171w6pn39ruo04d1w33iq****
Using BgpPeers
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 bgpPeers(args: BgpPeersArgs, opts?: InvokeOptions): Promise<BgpPeersResult>
function bgpPeersOutput(args: BgpPeersOutputArgs, opts?: InvokeOptions): Output<BgpPeersResult>def bgp_peers(bgp_peer_name: Optional[str] = None,
direct_connect_gateway_id: Optional[str] = None,
ids: Optional[Sequence[str]] = None,
name_regex: Optional[str] = None,
output_file: Optional[str] = None,
remote_asn: Optional[int] = None,
virtual_interface_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> BgpPeersResult
def bgp_peers_output(bgp_peer_name: Optional[pulumi.Input[str]] = None,
direct_connect_gateway_id: Optional[pulumi.Input[str]] = None,
ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name_regex: Optional[pulumi.Input[str]] = None,
output_file: Optional[pulumi.Input[str]] = None,
remote_asn: Optional[pulumi.Input[int]] = None,
virtual_interface_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[BgpPeersResult]func BgpPeers(ctx *Context, args *BgpPeersArgs, opts ...InvokeOption) (*BgpPeersResult, error)
func BgpPeersOutput(ctx *Context, args *BgpPeersOutputArgs, opts ...InvokeOption) BgpPeersResultOutputpublic static class BgpPeers
{
public static Task<BgpPeersResult> InvokeAsync(BgpPeersArgs args, InvokeOptions? opts = null)
public static Output<BgpPeersResult> Invoke(BgpPeersInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<BgpPeersResult> bgpPeers(BgpPeersArgs args, InvokeOptions options)
public static Output<BgpPeersResult> bgpPeers(BgpPeersArgs args, InvokeOptions options)
fn::invoke:
function: volcengine:direct_connect:BgpPeers
arguments:
# arguments dictionaryThe following arguments are supported:
- Bgp
Peer stringName - The name of bgp peer.
- Direct
Connect stringGateway Id - The id of direct connect gateway.
- Ids List<string>
- A list of IDs.
- Name
Regex string - A Name Regex of Resource.
- Output
File string - File name where to save data source results.
- Remote
Asn int - The remote asn of bgp peer.
- Virtual
Interface stringId - The id of virtual interface.
- Bgp
Peer stringName - The name of bgp peer.
- Direct
Connect stringGateway Id - The id of direct connect gateway.
- Ids []string
- A list of IDs.
- Name
Regex string - A Name Regex of Resource.
- Output
File string - File name where to save data source results.
- Remote
Asn int - The remote asn of bgp peer.
- Virtual
Interface stringId - The id of virtual interface.
- bgp
Peer StringName - The name of bgp peer.
- direct
Connect StringGateway Id - The id of direct connect gateway.
- ids List<String>
- A list of IDs.
- name
Regex String - A Name Regex of Resource.
- output
File String - File name where to save data source results.
- remote
Asn Integer - The remote asn of bgp peer.
- virtual
Interface StringId - The id of virtual interface.
- bgp
Peer stringName - The name of bgp peer.
- direct
Connect stringGateway Id - The id of direct connect gateway.
- ids string[]
- A list of IDs.
- name
Regex string - A Name Regex of Resource.
- output
File string - File name where to save data source results.
- remote
Asn number - The remote asn of bgp peer.
- virtual
Interface stringId - The id of virtual interface.
- bgp_
peer_ strname - The name of bgp peer.
- direct_
connect_ strgateway_ id - The id of direct connect gateway.
- ids Sequence[str]
- A list of IDs.
- name_
regex str - A Name Regex of Resource.
- output_
file str - File name where to save data source results.
- remote_
asn int - The remote asn of bgp peer.
- virtual_
interface_ strid - The id of virtual interface.
- bgp
Peer StringName - The name of bgp peer.
- direct
Connect StringGateway Id - The id of direct connect gateway.
- ids List<String>
- A list of IDs.
- name
Regex String - A Name Regex of Resource.
- output
File String - File name where to save data source results.
- remote
Asn Number - The remote asn of bgp peer.
- virtual
Interface StringId - The id of virtual interface.
BgpPeers Result
The following output properties are available:
- Bgp
Peers List<BgpPeers Bgp Peer> - The collection of query.
- Id string
- The provider-assigned unique ID for this managed resource.
- Total
Count int - The total count of query.
- Bgp
Peer stringName - The name of bgp peer.
- Direct
Connect stringGateway Id - Ids List<string>
- Name
Regex string - Output
File string - Remote
Asn int - The remote asn of bgp peer.
- Virtual
Interface stringId - The id of virtual interface.
- Bgp
Peers []BgpPeers Bgp Peer - The collection of query.
- Id string
- The provider-assigned unique ID for this managed resource.
- Total
Count int - The total count of query.
- Bgp
Peer stringName - The name of bgp peer.
- Direct
Connect stringGateway Id - Ids []string
- Name
Regex string - Output
File string - Remote
Asn int - The remote asn of bgp peer.
- Virtual
Interface stringId - The id of virtual interface.
- bgp
Peers List<BgpPeers Bgp Peer> - The collection of query.
- id String
- The provider-assigned unique ID for this managed resource.
- total
Count Integer - The total count of query.
- bgp
Peer StringName - The name of bgp peer.
- direct
Connect StringGateway Id - ids List<String>
- name
Regex String - output
File String - remote
Asn Integer - The remote asn of bgp peer.
- virtual
Interface StringId - The id of virtual interface.
- bgp
Peers BgpPeers Bgp Peer[] - The collection of query.
- id string
- The provider-assigned unique ID for this managed resource.
- total
Count number - The total count of query.
- bgp
Peer stringName - The name of bgp peer.
- direct
Connect stringGateway Id - ids string[]
- name
Regex string - output
File string - remote
Asn number - The remote asn of bgp peer.
- virtual
Interface stringId - The id of virtual interface.
- bgp_
peers Sequence[BgpPeers Bgp Peer] - The collection of query.
- id str
- The provider-assigned unique ID for this managed resource.
- total_
count int - The total count of query.
- bgp_
peer_ strname - The name of bgp peer.
- direct_
connect_ strgateway_ id - ids Sequence[str]
- name_
regex str - output_
file str - remote_
asn int - The remote asn of bgp peer.
- virtual_
interface_ strid - The id of virtual interface.
- bgp
Peers List<Property Map> - The collection of query.
- id String
- The provider-assigned unique ID for this managed resource.
- total
Count Number - The total count of query.
- bgp
Peer StringName - The name of bgp peer.
- direct
Connect StringGateway Id - ids List<String>
- name
Regex String - output
File String - remote
Asn Number - The remote asn of bgp peer.
- virtual
Interface StringId - The id of virtual interface.
Supporting Types
BgpPeersBgpPeer
- Account
Id string - The id of account.
- Auth
Key string - The key of auth.
- Bgp
Peer stringId - The id of bgp peer.
- Bgp
Peer stringName - The name of bgp peer.
- Creation
Time string - The create time of bgp peer.
- Description string
- The Description of bgp peer.
- Local
Asn int - The local asn of bgp peer.
- Remote
Asn int - The remote asn of bgp peer.
- Session
Status string - The session status of bgp peer.
- Status string
- The status of bgp peer.
- Update
Time string - The update time of bgp peer.
- Virtual
Interface stringId - The id of virtual interface.
- Account
Id string - The id of account.
- Auth
Key string - The key of auth.
- Bgp
Peer stringId - The id of bgp peer.
- Bgp
Peer stringName - The name of bgp peer.
- Creation
Time string - The create time of bgp peer.
- Description string
- The Description of bgp peer.
- Local
Asn int - The local asn of bgp peer.
- Remote
Asn int - The remote asn of bgp peer.
- Session
Status string - The session status of bgp peer.
- Status string
- The status of bgp peer.
- Update
Time string - The update time of bgp peer.
- Virtual
Interface stringId - The id of virtual interface.
- account
Id String - The id of account.
- auth
Key String - The key of auth.
- bgp
Peer StringId - The id of bgp peer.
- bgp
Peer StringName - The name of bgp peer.
- creation
Time String - The create time of bgp peer.
- description String
- The Description of bgp peer.
- local
Asn Integer - The local asn of bgp peer.
- remote
Asn Integer - The remote asn of bgp peer.
- session
Status String - The session status of bgp peer.
- status String
- The status of bgp peer.
- update
Time String - The update time of bgp peer.
- virtual
Interface StringId - The id of virtual interface.
- account
Id string - The id of account.
- auth
Key string - The key of auth.
- bgp
Peer stringId - The id of bgp peer.
- bgp
Peer stringName - The name of bgp peer.
- creation
Time string - The create time of bgp peer.
- description string
- The Description of bgp peer.
- local
Asn number - The local asn of bgp peer.
- remote
Asn number - The remote asn of bgp peer.
- session
Status string - The session status of bgp peer.
- status string
- The status of bgp peer.
- update
Time string - The update time of bgp peer.
- virtual
Interface stringId - The id of virtual interface.
- account_
id str - The id of account.
- auth_
key str - The key of auth.
- bgp_
peer_ strid - The id of bgp peer.
- bgp_
peer_ strname - The name of bgp peer.
- creation_
time str - The create time of bgp peer.
- description str
- The Description of bgp peer.
- local_
asn int - The local asn of bgp peer.
- remote_
asn int - The remote asn of bgp peer.
- session_
status str - The session status of bgp peer.
- status str
- The status of bgp peer.
- update_
time str - The update time of bgp peer.
- virtual_
interface_ strid - The id of virtual interface.
- account
Id String - The id of account.
- auth
Key String - The key of auth.
- bgp
Peer StringId - The id of bgp peer.
- bgp
Peer StringName - The name of bgp peer.
- creation
Time String - The create time of bgp peer.
- description String
- The Description of bgp peer.
- local
Asn Number - The local asn of bgp peer.
- remote
Asn Number - The remote asn of bgp peer.
- session
Status String - The session status of bgp peer.
- status String
- The status of bgp peer.
- update
Time String - The update time of bgp peer.
- virtual
Interface StringId - The id of virtual interface.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengineTerraform Provider.
Viewing docs for Volcengine v0.0.46
published on Friday, Feb 27, 2026 by Volcengine
published on Friday, Feb 27, 2026 by Volcengine
