Package-level declarations

Types

Link copied to clipboard
data class BgpSessionResponse(val maxPrefixesAdvertisedV4: Int? = null, val maxPrefixesAdvertisedV6: Int? = null, val md5AuthenticationKey: String? = null, val microsoftSessionIPv4Address: String? = null, val microsoftSessionIPv6Address: String? = null, val peerSessionIPv4Address: String? = null, val peerSessionIPv6Address: String? = null, val sessionPrefixV4: String? = null, val sessionPrefixV6: String? = null, val sessionStateV4: String, val sessionStateV6: String)

The properties that define a BGP session.

Link copied to clipboard
data class ContactDetailResponse(val email: String? = null, val phone: String? = null, val role: String? = null)

The contact detail class.

Link copied to clipboard
data class DirectConnectionResponse(val bandwidthInMbps: Int? = null, val bgpSession: BgpSessionResponse? = null, val connectionIdentifier: String? = null, val connectionState: String, val errorMessage: String, val microsoftTrackingId: String, val peeringDBFacilityId: Int? = null, val provisionedBandwidthInMbps: Int, val sessionAddressProvider: String? = null, val useForPeeringService: Boolean? = null)

The properties that define a direct connection.

Link copied to clipboard
data class ExchangeConnectionResponse(val bgpSession: BgpSessionResponse? = null, val connectionIdentifier: String? = null, val connectionState: String, val errorMessage: String, val peeringDBFacilityId: Int? = null)

The properties that define an exchange connection.

Link copied to clipboard
data class GetConnectionMonitorTestResult(val destination: String? = null, val destinationPort: Int? = null, val id: String, val isTestSuccessful: Boolean, val name: String, val path: List<String>, val provisioningState: String, val sourceAgent: String? = null, val testFrequencyInSec: Int? = null, val type: String)

The Connection Monitor Test class.

Link copied to clipboard
data class GetPeerAsnResult(val errorMessage: String, val id: String, val name: String, val peerAsn: Int? = null, val peerContactDetail: List<ContactDetailResponse>? = null, val peerName: String? = null, val type: String, val validationState: String? = null)

The essential information related to the peer's ASN.

Link copied to clipboard
data class GetPeeringResult(val direct: PeeringPropertiesDirectResponse? = null, val exchange: PeeringPropertiesExchangeResponse? = null, val id: String, val kind: String, val location: String, val name: String, val peeringLocation: String? = null, val provisioningState: String, val sku: PeeringSkuResponse, val tags: Map<String, String>? = null, val type: String)

Peering is a logical representation of a set of connections to the Microsoft Cloud Edge at a location.

Link copied to clipboard
data class GetPeeringServiceResult(val id: String, val location: String, val name: String, val peeringServiceLocation: String? = null, val peeringServiceProvider: String? = null, val providerBackupPeeringLocation: String? = null, val providerPrimaryPeeringLocation: String? = null, val provisioningState: String, val sku: PeeringServiceSkuResponse? = null, val tags: Map<String, String>? = null, val type: String)

Peering Service

Link copied to clipboard
data class GetPrefixResult(val errorMessage: String, val events: List<PeeringServicePrefixEventResponse>, val id: String, val learnedType: String, val name: String, val peeringServicePrefixKey: String? = null, val prefix: String? = null, val prefixValidationState: String, val provisioningState: String, val type: String)

The peering service prefix class.

Link copied to clipboard
data class GetRegisteredAsnResult(val asn: Int? = null, val id: String, val name: String, val peeringServicePrefixKey: String, val provisioningState: String, val type: String)

The customer's ASN that is registered by the peering service provider.

Link copied to clipboard
data class GetRegisteredPrefixResult(val errorMessage: String, val id: String, val name: String, val peeringServicePrefixKey: String, val prefix: String? = null, val prefixValidationState: String, val provisioningState: String, val type: String)

The customer's prefix that is registered by the peering service provider.

Link copied to clipboard
data class PeeringPropertiesDirectResponse(val connections: List<DirectConnectionResponse>? = null, val directPeeringType: String? = null, val peerAsn: SubResourceResponse? = null, val useForPeeringService: Boolean)

The properties that define a direct peering.

Link copied to clipboard
data class PeeringPropertiesExchangeResponse(val connections: List<ExchangeConnectionResponse>? = null, val peerAsn: SubResourceResponse? = null)

The properties that define an exchange peering.

Link copied to clipboard
data class PeeringServicePrefixEventResponse(val eventDescription: String, val eventLevel: String, val eventSummary: String, val eventTimestamp: String, val eventType: String)

The details of the event associated with a prefix.

Link copied to clipboard
data class PeeringServiceSkuResponse(val name: String? = null)

The SKU that defines the type of the peering service.

Link copied to clipboard
data class PeeringSkuResponse(val family: String? = null, val name: String? = null, val size: String? = null, val tier: String? = null)

The SKU that defines the tier and kind of the peering.

Link copied to clipboard
data class SubResourceResponse(val id: String? = null)

The sub resource.