Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. kubernetesruntime
  5. getBgpPeer
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.kubernetesruntime.getBgpPeer

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a BgpPeer Azure REST API version: 2024-03-01.

Other available API versions: 2023-10-01-preview.

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>
Copy
def get_bgp_peer(bgp_peer_name: Optional[str] = None,
                 resource_uri: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetBgpPeerResult
def get_bgp_peer_output(bgp_peer_name: Optional[pulumi.Input[str]] = None,
                 resource_uri: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetBgpPeerResult]
Copy
func LookupBgpPeer(ctx *Context, args *LookupBgpPeerArgs, opts ...InvokeOption) (*LookupBgpPeerResult, error)
func LookupBgpPeerOutput(ctx *Context, args *LookupBgpPeerOutputArgs, opts ...InvokeOption) LookupBgpPeerResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetBgpPeerResult> getBgpPeer(GetBgpPeerArgs args, InvokeOptions options)
public static Output<GetBgpPeerResult> getBgpPeer(GetBgpPeerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:kubernetesruntime:getBgpPeer
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BgpPeerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the BgpPeer
ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the resource.
BgpPeerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the BgpPeer
ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the resource.
bgpPeerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the BgpPeer
resourceUri
This property is required.
Changes to this property will trigger replacement.
String
The fully qualified Azure Resource manager identifier of the resource.
bgpPeerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the BgpPeer
resourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the resource.
bgp_peer_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the BgpPeer
resource_uri
This property is required.
Changes to this property will trigger replacement.
str
The fully qualified Azure Resource manager identifier of the resource.
bgpPeerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the BgpPeer
resourceUri
This property is required.
Changes to this property will trigger replacement.
String
The fully qualified Azure Resource manager identifier of the resource.

getBgpPeer Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
MyAsn int
My ASN
Name string
The name of the resource
PeerAddress string
Peer Address
PeerAsn int
Peer ASN
ProvisioningState string
Resource provision state
SystemData Pulumi.AzureNative.KubernetesRuntime.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
MyAsn int
My ASN
Name string
The name of the resource
PeerAddress string
Peer Address
PeerAsn int
Peer ASN
ProvisioningState string
Resource provision state
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
myAsn Integer
My ASN
name String
The name of the resource
peerAddress String
Peer Address
peerAsn Integer
Peer ASN
provisioningState String
Resource provision state
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
myAsn number
My ASN
name string
The name of the resource
peerAddress string
Peer Address
peerAsn number
Peer ASN
provisioningState string
Resource provision state
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
my_asn int
My ASN
name str
The name of the resource
peer_address str
Peer Address
peer_asn int
Peer ASN
provisioning_state str
Resource provision state
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
myAsn Number
My ASN
name String
The name of the resource
peerAddress String
Peer Address
peerAsn Number
Peer ASN
provisioningState String
Resource provision state
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native