1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. directconnect
  6. getBgpPeer
Viewing docs for volcenginecc v0.0.42
published on Thursday, Jun 11, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.42
published on Thursday, Jun 11, 2026 by Volcengine

    Data Source schema for Volcengine::DirectConnect::BgpPeer

    Using getBgpPeer

    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 getBgpPeer(args: GetBgpPeerArgs, opts?: InvokeOptions): Promise<GetBgpPeerResult>
    function getBgpPeerOutput(args: GetBgpPeerOutputArgs, opts?: InvokeOptions): Output<GetBgpPeerResult>
    def get_bgp_peer(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetBgpPeerResult
    def get_bgp_peer_output(id: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetBgpPeerResult]
    func LookupBgpPeer(ctx *Context, args *LookupBgpPeerArgs, opts ...InvokeOption) (*LookupBgpPeerResult, error)
    func LookupBgpPeerOutput(ctx *Context, args *LookupBgpPeerOutputArgs, opts ...InvokeOption) LookupBgpPeerResultOutput

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

    public static class GetBgpPeer 
    {
        public static Task<GetBgpPeerResult> InvokeAsync(GetBgpPeerArgs args, InvokeOptions? opts = null)
        public static Output<GetBgpPeerResult> Invoke(GetBgpPeerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBgpPeerResult> getBgpPeer(GetBgpPeerArgs args, InvokeOptions options)
    public static Output<GetBgpPeerResult> getBgpPeer(GetBgpPeerArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:directconnect/getBgpPeer:getBgpPeer
      arguments:
        # arguments dictionary
    data "volcenginecc_directconnect_getbgppeer" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getBgpPeer Result

    The following output properties are available:

    AccountId string
    ID of the account to which the BGP neighbor belongs.
    AuthKey string
    Authentication key of the BGP neighbor.
    BgpPeerId string
    ID of the BGP neighbor.
    BgpPeerName string
    Name of the BGP neighbor.
    CreationTime string
    Time when the BGP neighbor was created.
    Description string
    Description of the BGP neighbor.
    Id string
    Uniquely identifies the resource.
    IpVersion string
    IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
    LocalAsn int
    ASN of the Volcano side.
    RemoteAsn int
    Peer ASN of the BGP neighbor.
    SessionStatus string
    Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
    Status string
    Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
    UpdateTime string
    Time when the BGP neighbor was updated.
    VirtualInterfaceId string
    ID of the virtual interface where the BGP neighbor is located.
    AccountId string
    ID of the account to which the BGP neighbor belongs.
    AuthKey string
    Authentication key of the BGP neighbor.
    BgpPeerId string
    ID of the BGP neighbor.
    BgpPeerName string
    Name of the BGP neighbor.
    CreationTime string
    Time when the BGP neighbor was created.
    Description string
    Description of the BGP neighbor.
    Id string
    Uniquely identifies the resource.
    IpVersion string
    IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
    LocalAsn int
    ASN of the Volcano side.
    RemoteAsn int
    Peer ASN of the BGP neighbor.
    SessionStatus string
    Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
    Status string
    Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
    UpdateTime string
    Time when the BGP neighbor was updated.
    VirtualInterfaceId string
    ID of the virtual interface where the BGP neighbor is located.
    account_id string
    ID of the account to which the BGP neighbor belongs.
    auth_key string
    Authentication key of the BGP neighbor.
    bgp_peer_id string
    ID of the BGP neighbor.
    bgp_peer_name string
    Name of the BGP neighbor.
    creation_time string
    Time when the BGP neighbor was created.
    description string
    Description of the BGP neighbor.
    id string
    Uniquely identifies the resource.
    ip_version string
    IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
    local_asn number
    ASN of the Volcano side.
    remote_asn number
    Peer ASN of the BGP neighbor.
    session_status string
    Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
    status string
    Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
    update_time string
    Time when the BGP neighbor was updated.
    virtual_interface_id string
    ID of the virtual interface where the BGP neighbor is located.
    accountId String
    ID of the account to which the BGP neighbor belongs.
    authKey String
    Authentication key of the BGP neighbor.
    bgpPeerId String
    ID of the BGP neighbor.
    bgpPeerName String
    Name of the BGP neighbor.
    creationTime String
    Time when the BGP neighbor was created.
    description String
    Description of the BGP neighbor.
    id String
    Uniquely identifies the resource.
    ipVersion String
    IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
    localAsn Integer
    ASN of the Volcano side.
    remoteAsn Integer
    Peer ASN of the BGP neighbor.
    sessionStatus String
    Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
    status String
    Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
    updateTime String
    Time when the BGP neighbor was updated.
    virtualInterfaceId String
    ID of the virtual interface where the BGP neighbor is located.
    accountId string
    ID of the account to which the BGP neighbor belongs.
    authKey string
    Authentication key of the BGP neighbor.
    bgpPeerId string
    ID of the BGP neighbor.
    bgpPeerName string
    Name of the BGP neighbor.
    creationTime string
    Time when the BGP neighbor was created.
    description string
    Description of the BGP neighbor.
    id string
    Uniquely identifies the resource.
    ipVersion string
    IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
    localAsn number
    ASN of the Volcano side.
    remoteAsn number
    Peer ASN of the BGP neighbor.
    sessionStatus string
    Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
    status string
    Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
    updateTime string
    Time when the BGP neighbor was updated.
    virtualInterfaceId string
    ID of the virtual interface where the BGP neighbor is located.
    account_id str
    ID of the account to which the BGP neighbor belongs.
    auth_key str
    Authentication key of the BGP neighbor.
    bgp_peer_id str
    ID of the BGP neighbor.
    bgp_peer_name str
    Name of the BGP neighbor.
    creation_time str
    Time when the BGP neighbor was created.
    description str
    Description of the BGP neighbor.
    id str
    Uniquely identifies the resource.
    ip_version str
    IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
    local_asn int
    ASN of the Volcano side.
    remote_asn int
    Peer ASN of the BGP neighbor.
    session_status str
    Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
    status str
    Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
    update_time str
    Time when the BGP neighbor was updated.
    virtual_interface_id str
    ID of the virtual interface where the BGP neighbor is located.
    accountId String
    ID of the account to which the BGP neighbor belongs.
    authKey String
    Authentication key of the BGP neighbor.
    bgpPeerId String
    ID of the BGP neighbor.
    bgpPeerName String
    Name of the BGP neighbor.
    creationTime String
    Time when the BGP neighbor was created.
    description String
    Description of the BGP neighbor.
    id String
    Uniquely identifies the resource.
    ipVersion String
    IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
    localAsn Number
    ASN of the Volcano side.
    remoteAsn Number
    Peer ASN of the BGP neighbor.
    sessionStatus String
    Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
    status String
    Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
    updateTime String
    Time when the BGP neighbor was updated.
    virtualInterfaceId String
    ID of the virtual interface where the BGP neighbor is located.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.42
    published on Thursday, Jun 11, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial