Azure Native

v1.87.0 published on Tuesday, Nov 22, 2022 by Pulumi

getPeering

Peering is a logical representation of a set of connections to the Microsoft Cloud Edge at a location. API Version: 2021-01-01.

Using getPeering

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 getPeering(args: GetPeeringArgs, opts?: InvokeOptions): Promise<GetPeeringResult>
function getPeeringOutput(args: GetPeeringOutputArgs, opts?: InvokeOptions): Output<GetPeeringResult>

def get_peering(peering_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetPeeringResult
def get_peering_output(peering_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetPeeringResult]

func LookupPeering(ctx *Context, args *LookupPeeringArgs, opts ...InvokeOption) (*LookupPeeringResult, error)
func LookupPeeringOutput(ctx *Context, args *LookupPeeringOutputArgs, opts ...InvokeOption) LookupPeeringResultOutput

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

public static class GetPeering 
{
    public static Task<GetPeeringResult> InvokeAsync(GetPeeringArgs args, InvokeOptions? opts = null)
    public static Output<GetPeeringResult> Invoke(GetPeeringInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPeeringResult> getPeering(GetPeeringArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:peering:getPeering
  arguments:
    # arguments dictionary

The following arguments are supported:

PeeringName string: The name of the peering.
ResourceGroupName string: The name of the resource group.

PeeringName string: The name of the peering.
ResourceGroupName string: The name of the resource group.

peeringName String: The name of the peering.
resourceGroupName String: The name of the resource group.

peeringName string: The name of the peering.
resourceGroupName string: The name of the resource group.

peering_name str: The name of the peering.
resource_group_name str: The name of the resource group.

peeringName String: The name of the peering.
resourceGroupName String: The name of the resource group.

getPeering Result

The following output properties are available:

Id string: The ID of the resource.
Kind string: The kind of the peering.
Location string: The location of the resource.
Name string: The name of the resource.
ProvisioningState string: The provisioning state of the resource.
Sku Pulumi.AzureNative.Peering.Outputs.PeeringSkuResponse: The SKU that defines the tier and kind of the peering.
Type string: The type of the resource.
Direct Pulumi.AzureNative.Peering.Outputs.PeeringPropertiesDirectResponse: The properties that define a direct peering.
Exchange Pulumi.AzureNative.Peering.Outputs.PeeringPropertiesExchangeResponse: The properties that define an exchange peering.
PeeringLocation string: The location of the peering.
Tags Dictionary<string, string>: The resource tags.

Id string: The ID of the resource.
Kind string: The kind of the peering.
Location string: The location of the resource.
Name string: The name of the resource.
ProvisioningState string: The provisioning state of the resource.
Sku PeeringSkuResponse: The SKU that defines the tier and kind of the peering.
Type string: The type of the resource.
Direct PeeringPropertiesDirectResponse: The properties that define a direct peering.
Exchange PeeringPropertiesExchangeResponse: The properties that define an exchange peering.
PeeringLocation string: The location of the peering.
Tags map[string]string: The resource tags.

id String: The ID of the resource.
kind String: The kind of the peering.
location String: The location of the resource.
name String: The name of the resource.
provisioningState String: The provisioning state of the resource.
sku PeeringSkuResponse: The SKU that defines the tier and kind of the peering.
type String: The type of the resource.
direct PeeringPropertiesDirectResponse: The properties that define a direct peering.
exchange PeeringPropertiesExchangeResponse: The properties that define an exchange peering.
peeringLocation String: The location of the peering.
tags Map<String,String>: The resource tags.

id string: The ID of the resource.
kind string: The kind of the peering.
location string: The location of the resource.
name string: The name of the resource.
provisioningState string: The provisioning state of the resource.
sku PeeringSkuResponse: The SKU that defines the tier and kind of the peering.
type string: The type of the resource.
direct PeeringPropertiesDirectResponse: The properties that define a direct peering.
exchange PeeringPropertiesExchangeResponse: The properties that define an exchange peering.
peeringLocation string: The location of the peering.
tags {[key: string]: string}: The resource tags.

id str: The ID of the resource.
kind str: The kind of the peering.
location str: The location of the resource.
name str: The name of the resource.
provisioning_state str: The provisioning state of the resource.
sku PeeringSkuResponse: The SKU that defines the tier and kind of the peering.
type str: The type of the resource.
direct PeeringPropertiesDirectResponse: The properties that define a direct peering.
exchange PeeringPropertiesExchangeResponse: The properties that define an exchange peering.
peering_location str: The location of the peering.
tags Mapping[str, str]: The resource tags.

id String: The ID of the resource.
kind String: The kind of the peering.
location String: The location of the resource.
name String: The name of the resource.
provisioningState String: The provisioning state of the resource.
sku Property Map: The SKU that defines the tier and kind of the peering.
type String: The type of the resource.
direct Property Map: The properties that define a direct peering.
exchange Property Map: The properties that define an exchange peering.
peeringLocation String: The location of the peering.
tags Map<String>: The resource tags.

Supporting Types

BgpSessionResponse

SessionStateV4 string: The state of the IPv4 session.
SessionStateV6 string: The state of the IPv6 session.
MaxPrefixesAdvertisedV4 int: The maximum number of prefixes advertised over the IPv4 session.
MaxPrefixesAdvertisedV6 int: The maximum number of prefixes advertised over the IPv6 session.
Md5AuthenticationKey string: The MD5 authentication key of the session.
MicrosoftSessionIPv4Address string: The IPv4 session address on Microsoft's end.
MicrosoftSessionIPv6Address string: The IPv6 session address on Microsoft's end.
PeerSessionIPv4Address string: The IPv4 session address on peer's end.
PeerSessionIPv6Address string: The IPv6 session address on peer's end.
SessionPrefixV4 string: The IPv4 prefix that contains both ends' IPv4 addresses.
SessionPrefixV6 string: The IPv6 prefix that contains both ends' IPv6 addresses.

SessionStateV4 string: The state of the IPv4 session.
SessionStateV6 string: The state of the IPv6 session.
MaxPrefixesAdvertisedV4 int: The maximum number of prefixes advertised over the IPv4 session.
MaxPrefixesAdvertisedV6 int: The maximum number of prefixes advertised over the IPv6 session.
Md5AuthenticationKey string: The MD5 authentication key of the session.
MicrosoftSessionIPv4Address string: The IPv4 session address on Microsoft's end.
MicrosoftSessionIPv6Address string: The IPv6 session address on Microsoft's end.
PeerSessionIPv4Address string: The IPv4 session address on peer's end.
PeerSessionIPv6Address string: The IPv6 session address on peer's end.
SessionPrefixV4 string: The IPv4 prefix that contains both ends' IPv4 addresses.
SessionPrefixV6 string: The IPv6 prefix that contains both ends' IPv6 addresses.

sessionStateV4 String: The state of the IPv4 session.
sessionStateV6 String: The state of the IPv6 session.
maxPrefixesAdvertisedV4 Integer: The maximum number of prefixes advertised over the IPv4 session.
maxPrefixesAdvertisedV6 Integer: The maximum number of prefixes advertised over the IPv6 session.
md5AuthenticationKey String: The MD5 authentication key of the session.
microsoftSessionIPv4Address String: The IPv4 session address on Microsoft's end.
microsoftSessionIPv6Address String: The IPv6 session address on Microsoft's end.
peerSessionIPv4Address String: The IPv4 session address on peer's end.
peerSessionIPv6Address String: The IPv6 session address on peer's end.
sessionPrefixV4 String: The IPv4 prefix that contains both ends' IPv4 addresses.
sessionPrefixV6 String: The IPv6 prefix that contains both ends' IPv6 addresses.

sessionStateV4 string: The state of the IPv4 session.
sessionStateV6 string: The state of the IPv6 session.
maxPrefixesAdvertisedV4 number: The maximum number of prefixes advertised over the IPv4 session.
maxPrefixesAdvertisedV6 number: The maximum number of prefixes advertised over the IPv6 session.
md5AuthenticationKey string: The MD5 authentication key of the session.
microsoftSessionIPv4Address string: The IPv4 session address on Microsoft's end.
microsoftSessionIPv6Address string: The IPv6 session address on Microsoft's end.
peerSessionIPv4Address string: The IPv4 session address on peer's end.
peerSessionIPv6Address string: The IPv6 session address on peer's end.
sessionPrefixV4 string: The IPv4 prefix that contains both ends' IPv4 addresses.
sessionPrefixV6 string: The IPv6 prefix that contains both ends' IPv6 addresses.

session_state_v4 str: The state of the IPv4 session.
session_state_v6 str: The state of the IPv6 session.
max_prefixes_advertised_v4 int: The maximum number of prefixes advertised over the IPv4 session.
max_prefixes_advertised_v6 int: The maximum number of prefixes advertised over the IPv6 session.
md5_authentication_key str: The MD5 authentication key of the session.
microsoft_session_i_pv4_address str: The IPv4 session address on Microsoft's end.
microsoft_session_i_pv6_address str: The IPv6 session address on Microsoft's end.
peer_session_i_pv4_address str: The IPv4 session address on peer's end.
peer_session_i_pv6_address str: The IPv6 session address on peer's end.
session_prefix_v4 str: The IPv4 prefix that contains both ends' IPv4 addresses.
session_prefix_v6 str: The IPv6 prefix that contains both ends' IPv6 addresses.

sessionStateV4 String: The state of the IPv4 session.
sessionStateV6 String: The state of the IPv6 session.
maxPrefixesAdvertisedV4 Number: The maximum number of prefixes advertised over the IPv4 session.
maxPrefixesAdvertisedV6 Number: The maximum number of prefixes advertised over the IPv6 session.
md5AuthenticationKey String: The MD5 authentication key of the session.
microsoftSessionIPv4Address String: The IPv4 session address on Microsoft's end.
microsoftSessionIPv6Address String: The IPv6 session address on Microsoft's end.
peerSessionIPv4Address String: The IPv4 session address on peer's end.
peerSessionIPv6Address String: The IPv6 session address on peer's end.
sessionPrefixV4 String: The IPv4 prefix that contains both ends' IPv4 addresses.
sessionPrefixV6 String: The IPv6 prefix that contains both ends' IPv6 addresses.

DirectConnectionResponse

ConnectionState string: The state of the connection.
ErrorMessage string: The error message related to the connection state, if any.
MicrosoftTrackingId string: The ID used within Microsoft's peering provisioning system to track the connection
ProvisionedBandwidthInMbps int: The bandwidth that is actually provisioned.
BandwidthInMbps int: The bandwidth of the connection.
BgpSession Pulumi.AzureNative.Peering.Inputs.BgpSessionResponse: The BGP session associated with the connection.
ConnectionIdentifier string: The unique identifier (GUID) for the connection.
PeeringDBFacilityId int: The PeeringDB.com ID of the facility at which the connection has to be set up.
SessionAddressProvider string: The field indicating if Microsoft provides session ip addresses.
UseForPeeringService bool: The flag that indicates whether or not the connection is used for peering service.

ConnectionState string: The state of the connection.
ErrorMessage string: The error message related to the connection state, if any.
MicrosoftTrackingId string: The ID used within Microsoft's peering provisioning system to track the connection
ProvisionedBandwidthInMbps int: The bandwidth that is actually provisioned.
BandwidthInMbps int: The bandwidth of the connection.
BgpSession BgpSessionResponse: The BGP session associated with the connection.
ConnectionIdentifier string: The unique identifier (GUID) for the connection.
PeeringDBFacilityId int: The PeeringDB.com ID of the facility at which the connection has to be set up.
SessionAddressProvider string: The field indicating if Microsoft provides session ip addresses.
UseForPeeringService bool: The flag that indicates whether or not the connection is used for peering service.

connectionState String: The state of the connection.
errorMessage String: The error message related to the connection state, if any.
microsoftTrackingId String: The ID used within Microsoft's peering provisioning system to track the connection
provisionedBandwidthInMbps Integer: The bandwidth that is actually provisioned.
bandwidthInMbps Integer: The bandwidth of the connection.
bgpSession BgpSessionResponse: The BGP session associated with the connection.
connectionIdentifier String: The unique identifier (GUID) for the connection.
peeringDBFacilityId Integer: The PeeringDB.com ID of the facility at which the connection has to be set up.
sessionAddressProvider String: The field indicating if Microsoft provides session ip addresses.
useForPeeringService Boolean: The flag that indicates whether or not the connection is used for peering service.

connectionState string: The state of the connection.
errorMessage string: The error message related to the connection state, if any.
microsoftTrackingId string: The ID used within Microsoft's peering provisioning system to track the connection
provisionedBandwidthInMbps number: The bandwidth that is actually provisioned.
bandwidthInMbps number: The bandwidth of the connection.
bgpSession BgpSessionResponse: The BGP session associated with the connection.
connectionIdentifier string: The unique identifier (GUID) for the connection.
peeringDBFacilityId number: The PeeringDB.com ID of the facility at which the connection has to be set up.
sessionAddressProvider string: The field indicating if Microsoft provides session ip addresses.
useForPeeringService boolean: The flag that indicates whether or not the connection is used for peering service.

connection_state str: The state of the connection.
error_message str: The error message related to the connection state, if any.
microsoft_tracking_id str: The ID used within Microsoft's peering provisioning system to track the connection
provisioned_bandwidth_in_mbps int: The bandwidth that is actually provisioned.
bandwidth_in_mbps int: The bandwidth of the connection.
bgp_session BgpSessionResponse: The BGP session associated with the connection.
connection_identifier str: The unique identifier (GUID) for the connection.
peering_db_facility_id int: The PeeringDB.com ID of the facility at which the connection has to be set up.
session_address_provider str: The field indicating if Microsoft provides session ip addresses.
use_for_peering_service bool: The flag that indicates whether or not the connection is used for peering service.

connectionState String: The state of the connection.
errorMessage String: The error message related to the connection state, if any.
microsoftTrackingId String: The ID used within Microsoft's peering provisioning system to track the connection
provisionedBandwidthInMbps Number: The bandwidth that is actually provisioned.
bandwidthInMbps Number: The bandwidth of the connection.
bgpSession Property Map: The BGP session associated with the connection.
connectionIdentifier String: The unique identifier (GUID) for the connection.
peeringDBFacilityId Number: The PeeringDB.com ID of the facility at which the connection has to be set up.
sessionAddressProvider String: The field indicating if Microsoft provides session ip addresses.
useForPeeringService Boolean: The flag that indicates whether or not the connection is used for peering service.

ExchangeConnectionResponse

ConnectionState string: The state of the connection.
ErrorMessage string: The error message related to the connection state, if any.
BgpSession Pulumi.AzureNative.Peering.Inputs.BgpSessionResponse: The BGP session associated with the connection.
ConnectionIdentifier string: The unique identifier (GUID) for the connection.
PeeringDBFacilityId int: The PeeringDB.com ID of the facility at which the connection has to be set up.

ConnectionState string: The state of the connection.
ErrorMessage string: The error message related to the connection state, if any.
BgpSession BgpSessionResponse: The BGP session associated with the connection.
ConnectionIdentifier string: The unique identifier (GUID) for the connection.
PeeringDBFacilityId int: The PeeringDB.com ID of the facility at which the connection has to be set up.

connectionState String: The state of the connection.
errorMessage String: The error message related to the connection state, if any.
bgpSession BgpSessionResponse: The BGP session associated with the connection.
connectionIdentifier String: The unique identifier (GUID) for the connection.
peeringDBFacilityId Integer: The PeeringDB.com ID of the facility at which the connection has to be set up.

connectionState string: The state of the connection.
errorMessage string: The error message related to the connection state, if any.
bgpSession BgpSessionResponse: The BGP session associated with the connection.
connectionIdentifier string: The unique identifier (GUID) for the connection.
peeringDBFacilityId number: The PeeringDB.com ID of the facility at which the connection has to be set up.

connection_state str: The state of the connection.
error_message str: The error message related to the connection state, if any.
bgp_session BgpSessionResponse: The BGP session associated with the connection.
connection_identifier str: The unique identifier (GUID) for the connection.
peering_db_facility_id int: The PeeringDB.com ID of the facility at which the connection has to be set up.

connectionState String: The state of the connection.
errorMessage String: The error message related to the connection state, if any.
bgpSession Property Map: The BGP session associated with the connection.
connectionIdentifier String: The unique identifier (GUID) for the connection.
peeringDBFacilityId Number: The PeeringDB.com ID of the facility at which the connection has to be set up.

PeeringPropertiesDirectResponse

UseForPeeringService bool: The flag that indicates whether or not the peering is used for peering service.
Connections List<Pulumi.AzureNative.Peering.Inputs.DirectConnectionResponse>: The set of connections that constitute a direct peering.
DirectPeeringType string: The type of direct peering.
PeerAsn Pulumi.AzureNative.Peering.Inputs.SubResourceResponse: The reference of the peer ASN.

UseForPeeringService bool: The flag that indicates whether or not the peering is used for peering service.
Connections []DirectConnectionResponse: The set of connections that constitute a direct peering.
DirectPeeringType string: The type of direct peering.
PeerAsn SubResourceResponse: The reference of the peer ASN.

useForPeeringService Boolean: The flag that indicates whether or not the peering is used for peering service.
connections List<DirectConnectionResponse>: The set of connections that constitute a direct peering.
directPeeringType String: The type of direct peering.
peerAsn SubResourceResponse: The reference of the peer ASN.

useForPeeringService boolean: The flag that indicates whether or not the peering is used for peering service.
connections DirectConnectionResponse[]: The set of connections that constitute a direct peering.
directPeeringType string: The type of direct peering.
peerAsn SubResourceResponse: The reference of the peer ASN.

use_for_peering_service bool: The flag that indicates whether or not the peering is used for peering service.
connections Sequence[DirectConnectionResponse]: The set of connections that constitute a direct peering.
direct_peering_type str: The type of direct peering.
peer_asn SubResourceResponse: The reference of the peer ASN.

useForPeeringService Boolean: The flag that indicates whether or not the peering is used for peering service.
connections List<Property Map>: The set of connections that constitute a direct peering.
directPeeringType String: The type of direct peering.
peerAsn Property Map: The reference of the peer ASN.

PeeringPropertiesExchangeResponse

Connections List<Pulumi.AzureNative.Peering.Inputs.ExchangeConnectionResponse>: The set of connections that constitute an exchange peering.
PeerAsn Pulumi.AzureNative.Peering.Inputs.SubResourceResponse: The reference of the peer ASN.

Connections []ExchangeConnectionResponse: The set of connections that constitute an exchange peering.
PeerAsn SubResourceResponse: The reference of the peer ASN.

connections List<ExchangeConnectionResponse>: The set of connections that constitute an exchange peering.
peerAsn SubResourceResponse: The reference of the peer ASN.

connections ExchangeConnectionResponse[]: The set of connections that constitute an exchange peering.
peerAsn SubResourceResponse: The reference of the peer ASN.

connections Sequence[ExchangeConnectionResponse]: The set of connections that constitute an exchange peering.
peer_asn SubResourceResponse: The reference of the peer ASN.

connections List<Property Map>: The set of connections that constitute an exchange peering.
peerAsn Property Map: The reference of the peer ASN.

PeeringSkuResponse

Family string: The family of the peering SKU.
Name string: The name of the peering SKU.
Size string: The size of the peering SKU.
Tier string: The tier of the peering SKU.

Family string: The family of the peering SKU.
Name string: The name of the peering SKU.
Size string: The size of the peering SKU.
Tier string: The tier of the peering SKU.

family String: The family of the peering SKU.
name String: The name of the peering SKU.
size String: The size of the peering SKU.
tier String: The tier of the peering SKU.

family string: The family of the peering SKU.
name string: The name of the peering SKU.
size string: The size of the peering SKU.
tier string: The tier of the peering SKU.

family str: The family of the peering SKU.
name str: The name of the peering SKU.
size str: The size of the peering SKU.
tier str: The tier of the peering SKU.

family String: The family of the peering SKU.
name String: The name of the peering SKU.
size String: The size of the peering SKU.
tier String: The tier of the peering SKU.

SubResourceResponse

Id string: The identifier of the referenced resource.

Id string: The identifier of the referenced resource.

id String: The identifier of the referenced resource.

id string: The identifier of the referenced resource.

id str: The identifier of the referenced resource.

id String: The identifier of the referenced resource.

Package Details

Repository: https://github.com/pulumi/pulumi-azure-native
License: Apache-2.0