Azure Native
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:
- Peering
Name string The name of the peering.
- Resource
Group stringName The name of the resource group.
- Peering
Name string The name of the peering.
- Resource
Group stringName The name of the resource group.
- peering
Name String The name of the peering.
- resource
Group StringName The name of the resource group.
- peering
Name string The name of the peering.
- resource
Group stringName The name of the resource group.
- peering_
name str The name of the peering.
- resource_
group_ strname The name of the resource group.
- peering
Name String The name of the peering.
- resource
Group StringName 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.
- Provisioning
State string The provisioning state of the resource.
- Sku
Pulumi.
Azure Native. Peering. Outputs. Peering Sku Response The SKU that defines the tier and kind of the peering.
- Type string
The type of the resource.
- Direct
Pulumi.
Azure Native. Peering. Outputs. Peering Properties Direct Response The properties that define a direct peering.
- Exchange
Pulumi.
Azure Native. Peering. Outputs. Peering Properties Exchange Response The properties that define an exchange peering.
- Peering
Location string The location of the peering.
- 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.
- Provisioning
State string The provisioning state of the resource.
- Sku
Peering
Sku Response The SKU that defines the tier and kind of the peering.
- Type string
The type of the resource.
- Direct
Peering
Properties Direct Response The properties that define a direct peering.
- Exchange
Peering
Properties Exchange Response The properties that define an exchange peering.
- Peering
Location string The location of the peering.
- 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.
- provisioning
State String The provisioning state of the resource.
- sku
Peering
Sku Response The SKU that defines the tier and kind of the peering.
- type String
The type of the resource.
- direct
Peering
Properties Direct Response The properties that define a direct peering.
- exchange
Peering
Properties Exchange Response The properties that define an exchange peering.
- peering
Location String The location of the peering.
- 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.
- provisioning
State string The provisioning state of the resource.
- sku
Peering
Sku Response The SKU that defines the tier and kind of the peering.
- type string
The type of the resource.
- direct
Peering
Properties Direct Response The properties that define a direct peering.
- exchange
Peering
Properties Exchange Response The properties that define an exchange peering.
- peering
Location string The location of the peering.
- {[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
Peering
Sku Response The SKU that defines the tier and kind of the peering.
- type str
The type of the resource.
- direct
Peering
Properties Direct Response The properties that define a direct peering.
- exchange
Peering
Properties Exchange Response The properties that define an exchange peering.
- peering_
location str The location of the peering.
- 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.
- provisioning
State 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.
- peering
Location String The location of the peering.
- Map<String>
The resource tags.
Supporting Types
BgpSessionResponse
- Session
State stringV4 The state of the IPv4 session.
- Session
State stringV6 The state of the IPv6 session.
- Max
Prefixes intAdvertised V4 The maximum number of prefixes advertised over the IPv4 session.
- Max
Prefixes intAdvertised V6 The maximum number of prefixes advertised over the IPv6 session.
- Md5Authentication
Key string The MD5 authentication key of the session.
- Microsoft
Session stringIPv4Address The IPv4 session address on Microsoft's end.
- Microsoft
Session stringIPv6Address The IPv6 session address on Microsoft's end.
- Peer
Session stringIPv4Address The IPv4 session address on peer's end.
- Peer
Session stringIPv6Address The IPv6 session address on peer's end.
- Session
Prefix stringV4 The IPv4 prefix that contains both ends' IPv4 addresses.
- Session
Prefix stringV6 The IPv6 prefix that contains both ends' IPv6 addresses.
- Session
State stringV4 The state of the IPv4 session.
- Session
State stringV6 The state of the IPv6 session.
- Max
Prefixes intAdvertised V4 The maximum number of prefixes advertised over the IPv4 session.
- Max
Prefixes intAdvertised V6 The maximum number of prefixes advertised over the IPv6 session.
- Md5Authentication
Key string The MD5 authentication key of the session.
- Microsoft
Session stringIPv4Address The IPv4 session address on Microsoft's end.
- Microsoft
Session stringIPv6Address The IPv6 session address on Microsoft's end.
- Peer
Session stringIPv4Address The IPv4 session address on peer's end.
- Peer
Session stringIPv6Address The IPv6 session address on peer's end.
- Session
Prefix stringV4 The IPv4 prefix that contains both ends' IPv4 addresses.
- Session
Prefix stringV6 The IPv6 prefix that contains both ends' IPv6 addresses.
- session
State StringV4 The state of the IPv4 session.
- session
State StringV6 The state of the IPv6 session.
- max
Prefixes IntegerAdvertised V4 The maximum number of prefixes advertised over the IPv4 session.
- max
Prefixes IntegerAdvertised V6 The maximum number of prefixes advertised over the IPv6 session.
- md5Authentication
Key String The MD5 authentication key of the session.
- microsoft
Session StringIPv4Address The IPv4 session address on Microsoft's end.
- microsoft
Session StringIPv6Address The IPv6 session address on Microsoft's end.
- peer
Session StringIPv4Address The IPv4 session address on peer's end.
- peer
Session StringIPv6Address The IPv6 session address on peer's end.
- session
Prefix StringV4 The IPv4 prefix that contains both ends' IPv4 addresses.
- session
Prefix StringV6 The IPv6 prefix that contains both ends' IPv6 addresses.
- session
State stringV4 The state of the IPv4 session.
- session
State stringV6 The state of the IPv6 session.
- max
Prefixes numberAdvertised V4 The maximum number of prefixes advertised over the IPv4 session.
- max
Prefixes numberAdvertised V6 The maximum number of prefixes advertised over the IPv6 session.
- md5Authentication
Key string The MD5 authentication key of the session.
- microsoft
Session stringIPv4Address The IPv4 session address on Microsoft's end.
- microsoft
Session stringIPv6Address The IPv6 session address on Microsoft's end.
- peer
Session stringIPv4Address The IPv4 session address on peer's end.
- peer
Session stringIPv6Address The IPv6 session address on peer's end.
- session
Prefix stringV4 The IPv4 prefix that contains both ends' IPv4 addresses.
- session
Prefix stringV6 The IPv6 prefix that contains both ends' IPv6 addresses.
- session_
state_ strv4 The state of the IPv4 session.
- session_
state_ strv6 The state of the IPv6 session.
- max_
prefixes_ intadvertised_ v4 The maximum number of prefixes advertised over the IPv4 session.
- max_
prefixes_ intadvertised_ v6 The maximum number of prefixes advertised over the IPv6 session.
- md5_
authentication_ strkey The MD5 authentication key of the session.
- microsoft_
session_ stri_ pv4_ address The IPv4 session address on Microsoft's end.
- microsoft_
session_ stri_ pv6_ address The IPv6 session address on Microsoft's end.
- peer_
session_ stri_ pv4_ address The IPv4 session address on peer's end.
- peer_
session_ stri_ pv6_ address The IPv6 session address on peer's end.
- session_
prefix_ strv4 The IPv4 prefix that contains both ends' IPv4 addresses.
- session_
prefix_ strv6 The IPv6 prefix that contains both ends' IPv6 addresses.
- session
State StringV4 The state of the IPv4 session.
- session
State StringV6 The state of the IPv6 session.
- max
Prefixes NumberAdvertised V4 The maximum number of prefixes advertised over the IPv4 session.
- max
Prefixes NumberAdvertised V6 The maximum number of prefixes advertised over the IPv6 session.
- md5Authentication
Key String The MD5 authentication key of the session.
- microsoft
Session StringIPv4Address The IPv4 session address on Microsoft's end.
- microsoft
Session StringIPv6Address The IPv6 session address on Microsoft's end.
- peer
Session StringIPv4Address The IPv4 session address on peer's end.
- peer
Session StringIPv6Address The IPv6 session address on peer's end.
- session
Prefix StringV4 The IPv4 prefix that contains both ends' IPv4 addresses.
- session
Prefix StringV6 The IPv6 prefix that contains both ends' IPv6 addresses.
DirectConnectionResponse
- Connection
State string The state of the connection.
- Error
Message string The error message related to the connection state, if any.
- Microsoft
Tracking stringId The ID used within Microsoft's peering provisioning system to track the connection
- Provisioned
Bandwidth intIn Mbps The bandwidth that is actually provisioned.
- Bandwidth
In intMbps The bandwidth of the connection.
- Bgp
Session Pulumi.Azure Native. Peering. Inputs. Bgp Session Response The BGP session associated with the connection.
- Connection
Identifier string The unique identifier (GUID) for the connection.
- Peering
DBFacility intId The PeeringDB.com ID of the facility at which the connection has to be set up.
- Session
Address stringProvider The field indicating if Microsoft provides session ip addresses.
- Use
For boolPeering Service The flag that indicates whether or not the connection is used for peering service.
- Connection
State string The state of the connection.
- Error
Message string The error message related to the connection state, if any.
- Microsoft
Tracking stringId The ID used within Microsoft's peering provisioning system to track the connection
- Provisioned
Bandwidth intIn Mbps The bandwidth that is actually provisioned.
- Bandwidth
In intMbps The bandwidth of the connection.
- Bgp
Session BgpSession Response The BGP session associated with the connection.
- Connection
Identifier string The unique identifier (GUID) for the connection.
- Peering
DBFacility intId The PeeringDB.com ID of the facility at which the connection has to be set up.
- Session
Address stringProvider The field indicating if Microsoft provides session ip addresses.
- Use
For boolPeering Service The flag that indicates whether or not the connection is used for peering service.
- connection
State String The state of the connection.
- error
Message String The error message related to the connection state, if any.
- microsoft
Tracking StringId The ID used within Microsoft's peering provisioning system to track the connection
- provisioned
Bandwidth IntegerIn Mbps The bandwidth that is actually provisioned.
- bandwidth
In IntegerMbps The bandwidth of the connection.
- bgp
Session BgpSession Response The BGP session associated with the connection.
- connection
Identifier String The unique identifier (GUID) for the connection.
- peering
DBFacility IntegerId The PeeringDB.com ID of the facility at which the connection has to be set up.
- session
Address StringProvider The field indicating if Microsoft provides session ip addresses.
- use
For BooleanPeering Service The flag that indicates whether or not the connection is used for peering service.
- connection
State string The state of the connection.
- error
Message string The error message related to the connection state, if any.
- microsoft
Tracking stringId The ID used within Microsoft's peering provisioning system to track the connection
- provisioned
Bandwidth numberIn Mbps The bandwidth that is actually provisioned.
- bandwidth
In numberMbps The bandwidth of the connection.
- bgp
Session BgpSession Response The BGP session associated with the connection.
- connection
Identifier string The unique identifier (GUID) for the connection.
- peering
DBFacility numberId The PeeringDB.com ID of the facility at which the connection has to be set up.
- session
Address stringProvider The field indicating if Microsoft provides session ip addresses.
- use
For booleanPeering Service 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_ strid The ID used within Microsoft's peering provisioning system to track the connection
- provisioned_
bandwidth_ intin_ mbps The bandwidth that is actually provisioned.
- bandwidth_
in_ intmbps The bandwidth of the connection.
- bgp_
session BgpSession Response The BGP session associated with the connection.
- connection_
identifier str The unique identifier (GUID) for the connection.
- peering_
db_ intfacility_ id The PeeringDB.com ID of the facility at which the connection has to be set up.
- session_
address_ strprovider The field indicating if Microsoft provides session ip addresses.
- use_
for_ boolpeering_ service The flag that indicates whether or not the connection is used for peering service.
- connection
State String The state of the connection.
- error
Message String The error message related to the connection state, if any.
- microsoft
Tracking StringId The ID used within Microsoft's peering provisioning system to track the connection
- provisioned
Bandwidth NumberIn Mbps The bandwidth that is actually provisioned.
- bandwidth
In NumberMbps The bandwidth of the connection.
- bgp
Session Property Map The BGP session associated with the connection.
- connection
Identifier String The unique identifier (GUID) for the connection.
- peering
DBFacility NumberId The PeeringDB.com ID of the facility at which the connection has to be set up.
- session
Address StringProvider The field indicating if Microsoft provides session ip addresses.
- use
For BooleanPeering Service The flag that indicates whether or not the connection is used for peering service.
ExchangeConnectionResponse
- Connection
State string The state of the connection.
- Error
Message string The error message related to the connection state, if any.
- Bgp
Session Pulumi.Azure Native. Peering. Inputs. Bgp Session Response The BGP session associated with the connection.
- Connection
Identifier string The unique identifier (GUID) for the connection.
- Peering
DBFacility intId The PeeringDB.com ID of the facility at which the connection has to be set up.
- Connection
State string The state of the connection.
- Error
Message string The error message related to the connection state, if any.
- Bgp
Session BgpSession Response The BGP session associated with the connection.
- Connection
Identifier string The unique identifier (GUID) for the connection.
- Peering
DBFacility intId The PeeringDB.com ID of the facility at which the connection has to be set up.
- connection
State String The state of the connection.
- error
Message String The error message related to the connection state, if any.
- bgp
Session BgpSession Response The BGP session associated with the connection.
- connection
Identifier String The unique identifier (GUID) for the connection.
- peering
DBFacility IntegerId The PeeringDB.com ID of the facility at which the connection has to be set up.
- connection
State string The state of the connection.
- error
Message string The error message related to the connection state, if any.
- bgp
Session BgpSession Response The BGP session associated with the connection.
- connection
Identifier string The unique identifier (GUID) for the connection.
- peering
DBFacility numberId 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 BgpSession Response The BGP session associated with the connection.
- connection_
identifier str The unique identifier (GUID) for the connection.
- peering_
db_ intfacility_ id The PeeringDB.com ID of the facility at which the connection has to be set up.
- connection
State String The state of the connection.
- error
Message String The error message related to the connection state, if any.
- bgp
Session Property Map The BGP session associated with the connection.
- connection
Identifier String The unique identifier (GUID) for the connection.
- peering
DBFacility NumberId The PeeringDB.com ID of the facility at which the connection has to be set up.
PeeringPropertiesDirectResponse
- Use
For boolPeering Service The flag that indicates whether or not the peering is used for peering service.
- Connections
List<Pulumi.
Azure Native. Peering. Inputs. Direct Connection Response> The set of connections that constitute a direct peering.
- Direct
Peering stringType The type of direct peering.
- Peer
Asn Pulumi.Azure Native. Peering. Inputs. Sub Resource Response The reference of the peer ASN.
- Use
For boolPeering Service The flag that indicates whether or not the peering is used for peering service.
- Connections
[]Direct
Connection Response The set of connections that constitute a direct peering.
- Direct
Peering stringType The type of direct peering.
- Peer
Asn SubResource Response The reference of the peer ASN.
- use
For BooleanPeering Service The flag that indicates whether or not the peering is used for peering service.
- connections
List<Direct
Connection Response> The set of connections that constitute a direct peering.
- direct
Peering StringType The type of direct peering.
- peer
Asn SubResource Response The reference of the peer ASN.
- use
For booleanPeering Service The flag that indicates whether or not the peering is used for peering service.
- connections
Direct
Connection Response[] The set of connections that constitute a direct peering.
- direct
Peering stringType The type of direct peering.
- peer
Asn SubResource Response The reference of the peer ASN.
- use_
for_ boolpeering_ service The flag that indicates whether or not the peering is used for peering service.
- connections
Sequence[Direct
Connection Response] The set of connections that constitute a direct peering.
- direct_
peering_ strtype The type of direct peering.
- peer_
asn SubResource Response The reference of the peer ASN.
- use
For BooleanPeering Service 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.
- direct
Peering StringType The type of direct peering.
- peer
Asn Property Map The reference of the peer ASN.
PeeringPropertiesExchangeResponse
- Connections
List<Pulumi.
Azure Native. Peering. Inputs. Exchange Connection Response> The set of connections that constitute an exchange peering.
- Peer
Asn Pulumi.Azure Native. Peering. Inputs. Sub Resource Response The reference of the peer ASN.
- Connections
[]Exchange
Connection Response The set of connections that constitute an exchange peering.
- Peer
Asn SubResource Response The reference of the peer ASN.
- connections
List<Exchange
Connection Response> The set of connections that constitute an exchange peering.
- peer
Asn SubResource Response The reference of the peer ASN.
- connections
Exchange
Connection Response[] The set of connections that constitute an exchange peering.
- peer
Asn SubResource Response The reference of the peer ASN.
- connections
Sequence[Exchange
Connection Response] The set of connections that constitute an exchange peering.
- peer_
asn SubResource Response The reference of the peer ASN.
- connections List<Property Map>
The set of connections that constitute an exchange peering.
- peer
Asn Property Map The reference of the peer ASN.
PeeringSkuResponse
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