@azure/arm-peering package

Classes

PeeringManagementClient

Interfaces

BgpSession	The properties that define a BGP session.
CdnPeeringPrefix	The CDN peering prefix
CdnPeeringPrefixListResult	The paginated list of CDN peering prefixes.
CdnPeeringPrefixes	Interface representing a CdnPeeringPrefixes.
CdnPeeringPrefixesListNextOptionalParams	Optional parameters.
CdnPeeringPrefixesListOptionalParams	Optional parameters.
CheckServiceProviderAvailabilityInput	Class for CheckServiceProviderAvailabilityInput
CheckServiceProviderAvailabilityOptionalParams	Optional parameters.
ConnectionMonitorTest	The Connection Monitor Test class.
ConnectionMonitorTestListResult	The paginated list of [T].
ConnectionMonitorTests	Interface representing a ConnectionMonitorTests.
ConnectionMonitorTestsCreateOrUpdateOptionalParams	Optional parameters.
ConnectionMonitorTestsDeleteOptionalParams	Optional parameters.
ConnectionMonitorTestsGetOptionalParams	Optional parameters.
ConnectionMonitorTestsListByPeeringServiceNextOptionalParams	Optional parameters.
ConnectionMonitorTestsListByPeeringServiceOptionalParams	Optional parameters.
ContactDetail	The contact detail class.
DirectConnection	The properties that define a direct connection.
DirectPeeringFacility	The properties that define a direct peering facility.
ErrorDetail	The error detail that describes why an operation has failed.
ErrorResponse	The error response that indicates why an operation has failed.
ExchangeConnection	The properties that define an exchange connection.
ExchangePeeringFacility	The properties that define an exchange peering facility.
LegacyPeerings	Interface representing a LegacyPeerings.
LegacyPeeringsListNextOptionalParams	Optional parameters.
LegacyPeeringsListOptionalParams	Optional parameters.
LogAnalyticsWorkspaceProperties	The properties that define a Log Analytics Workspace.
LookingGlass	Interface representing a LookingGlass.
LookingGlassInvokeOptionalParams	Optional parameters.
LookingGlassOutput	Looking glass output model
MetricDimension	Dimensions of the metric.
MetricSpecification	Specifications of the Metrics for Azure Monitoring.
Operation	The peering API operation.
OperationDisplayInfo	The information related to the operation.
OperationListResult	The paginated list of peering API operations.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PeerAsn	The essential information related to the peer's ASN.
PeerAsnListResult	The paginated list of peer ASNs.
PeerAsns	Interface representing a PeerAsns.
PeerAsnsCreateOrUpdateOptionalParams	Optional parameters.
PeerAsnsDeleteOptionalParams	Optional parameters.
PeerAsnsGetOptionalParams	Optional parameters.
PeerAsnsListBySubscriptionNextOptionalParams	Optional parameters.
PeerAsnsListBySubscriptionOptionalParams	Optional parameters.
Peering	Peering is a logical representation of a set of connections to the Microsoft Cloud Edge at a location.
PeeringBandwidthOffer	The properties that define a peering bandwidth offer.
PeeringListResult	The paginated list of peerings.
PeeringLocation	Peering location is where connectivity could be established to the Microsoft Cloud Edge.
PeeringLocationListResult	The paginated list of peering locations.
PeeringLocationPropertiesDirect	The properties that define a direct peering location.
PeeringLocationPropertiesExchange	The properties that define an exchange peering location.
PeeringLocations	Interface representing a PeeringLocations.
PeeringLocationsListNextOptionalParams	Optional parameters.
PeeringLocationsListOptionalParams	Optional parameters.
PeeringManagementClientOptionalParams	Optional parameters.
PeeringPropertiesDirect	The properties that define a direct peering.
PeeringPropertiesExchange	The properties that define an exchange peering.
PeeringReceivedRoute	The properties that define a received route.
PeeringReceivedRouteListResult	The paginated list of received routes for the peering.
PeeringRegisteredAsn	The customer's ASN that is registered by the peering service provider.
PeeringRegisteredAsnListResult	The paginated list of peering registered ASNs.
PeeringRegisteredPrefix	The customer's prefix that is registered by the peering service provider.
PeeringRegisteredPrefixListResult	The paginated list of peering registered prefixes.
PeeringService	Peering Service
PeeringServiceCountries	Interface representing a PeeringServiceCountries.
PeeringServiceCountriesListNextOptionalParams	Optional parameters.
PeeringServiceCountriesListOptionalParams	Optional parameters.
PeeringServiceCountry	The peering service country.
PeeringServiceCountryListResult	The paginated list of peering service countries.
PeeringServiceListResult	The paginated list of peering services.
PeeringServiceLocation	The peering service location.
PeeringServiceLocationListResult	The paginated list of peering service locations.
PeeringServiceLocations	Interface representing a PeeringServiceLocations.
PeeringServiceLocationsListNextOptionalParams	Optional parameters.
PeeringServiceLocationsListOptionalParams	Optional parameters.
PeeringServicePrefix	The peering service prefix class.
PeeringServicePrefixEvent	The details of the event associated with a prefix.
PeeringServicePrefixListResult	The paginated list of peering service prefixes.
PeeringServiceProvider	PeeringService provider
PeeringServiceProviderListResult	The paginated list of peering service providers.
PeeringServiceProviders	Interface representing a PeeringServiceProviders.
PeeringServiceProvidersListNextOptionalParams	Optional parameters.
PeeringServiceProvidersListOptionalParams	Optional parameters.
PeeringServiceSku	The SKU that defines the type of the peering service.
PeeringServices	Interface representing a PeeringServices.
PeeringServicesCreateOrUpdateOptionalParams	Optional parameters.
PeeringServicesDeleteOptionalParams	Optional parameters.
PeeringServicesGetOptionalParams	Optional parameters.
PeeringServicesInitializeConnectionMonitorOptionalParams	Optional parameters.
PeeringServicesListByResourceGroupNextOptionalParams	Optional parameters.
PeeringServicesListByResourceGroupOptionalParams	Optional parameters.
PeeringServicesListBySubscriptionNextOptionalParams	Optional parameters.
PeeringServicesListBySubscriptionOptionalParams	Optional parameters.
PeeringServicesUpdateOptionalParams	Optional parameters.
PeeringSku	The SKU that defines the tier and kind of the peering.
Peerings	Interface representing a Peerings.
PeeringsCreateOrUpdateOptionalParams	Optional parameters.
PeeringsDeleteOptionalParams	Optional parameters.
PeeringsGetOptionalParams	Optional parameters.
PeeringsListByResourceGroupNextOptionalParams	Optional parameters.
PeeringsListByResourceGroupOptionalParams	Optional parameters.
PeeringsListBySubscriptionNextOptionalParams	Optional parameters.
PeeringsListBySubscriptionOptionalParams	Optional parameters.
PeeringsUpdateOptionalParams	Optional parameters.
Prefixes	Interface representing a Prefixes.
PrefixesCreateOrUpdateOptionalParams	Optional parameters.
PrefixesDeleteOptionalParams	Optional parameters.
PrefixesGetOptionalParams	Optional parameters.
PrefixesListByPeeringServiceNextOptionalParams	Optional parameters.
PrefixesListByPeeringServiceOptionalParams	Optional parameters.
ReceivedRoutes	Interface representing a ReceivedRoutes.
ReceivedRoutesListByPeeringNextOptionalParams	Optional parameters.
ReceivedRoutesListByPeeringOptionalParams	Optional parameters.
RegisteredAsns	Interface representing a RegisteredAsns.
RegisteredAsnsCreateOrUpdateOptionalParams	Optional parameters.
RegisteredAsnsDeleteOptionalParams	Optional parameters.
RegisteredAsnsGetOptionalParams	Optional parameters.
RegisteredAsnsListByPeeringNextOptionalParams	Optional parameters.
RegisteredAsnsListByPeeringOptionalParams	Optional parameters.
RegisteredPrefixes	Interface representing a RegisteredPrefixes.
RegisteredPrefixesCreateOrUpdateOptionalParams	Optional parameters.
RegisteredPrefixesDeleteOptionalParams	Optional parameters.
RegisteredPrefixesGetOptionalParams	Optional parameters.
RegisteredPrefixesListByPeeringNextOptionalParams	Optional parameters.
RegisteredPrefixesListByPeeringOptionalParams	Optional parameters.
Resource	The ARM resource class.
ResourceTags	The resource tags.
ServiceSpecification	Service specification payload.
SubResource	The sub resource.

Type Aliases

CdnPeeringPrefixesListNextResponse	Contains response data for the listNext operation.
CdnPeeringPrefixesListResponse	Contains response data for the list operation.
CheckServiceProviderAvailabilityResponse	Contains response data for the checkServiceProviderAvailability operation.
Command	Defines values for Command. KnownCommand can be used interchangeably with Command, this enum contains the known values that the service supports. Known values supported by the service Traceroute Ping BgpRoute
ConnectionMonitorTestsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ConnectionMonitorTestsGetResponse	Contains response data for the get operation.
ConnectionMonitorTestsListByPeeringServiceNextResponse	Contains response data for the listByPeeringServiceNext operation.
ConnectionMonitorTestsListByPeeringServiceResponse	Contains response data for the listByPeeringService operation.
ConnectionState	Defines values for ConnectionState. KnownConnectionState can be used interchangeably with ConnectionState, this enum contains the known values that the service supports. Known values supported by the service None PendingApproval Approved ProvisioningStarted ProvisioningFailed ProvisioningCompleted Validating Active
DirectPeeringType	Defines values for DirectPeeringType. KnownDirectPeeringType can be used interchangeably with DirectPeeringType, this enum contains the known values that the service supports. Known values supported by the service Edge Transit Cdn Internal Ix IxRs Voice
Enum0	Defines values for Enum0. KnownEnum0 can be used interchangeably with Enum0, this enum contains the known values that the service supports. Known values supported by the service Available Unavailable
Family	Defines values for Family. KnownFamily can be used interchangeably with Family, this enum contains the known values that the service supports. Known values supported by the service Direct Exchange
Kind	Defines values for Kind. KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports. Known values supported by the service Direct Exchange
LearnedType	Defines values for LearnedType. KnownLearnedType can be used interchangeably with LearnedType, this enum contains the known values that the service supports. Known values supported by the service None ViaServiceProvider ViaSession
LegacyPeeringsKind	Defines values for LegacyPeeringsKind. KnownLegacyPeeringsKind can be used interchangeably with LegacyPeeringsKind, this enum contains the known values that the service supports. Known values supported by the service Direct Exchange
LegacyPeeringsListNextResponse	Contains response data for the listNext operation.
LegacyPeeringsListResponse	Contains response data for the list operation.
LookingGlassCommand	Defines values for LookingGlassCommand. KnownLookingGlassCommand can be used interchangeably with LookingGlassCommand, this enum contains the known values that the service supports. Known values supported by the service Traceroute Ping BgpRoute
LookingGlassInvokeResponse	Contains response data for the invoke operation.
LookingGlassSourceType	Defines values for LookingGlassSourceType. KnownLookingGlassSourceType can be used interchangeably with LookingGlassSourceType, this enum contains the known values that the service supports. Known values supported by the service EdgeSite AzureRegion
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
PeerAsnsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PeerAsnsGetResponse	Contains response data for the get operation.
PeerAsnsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
PeerAsnsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
PeeringLocationsDirectPeeringType	Defines values for PeeringLocationsDirectPeeringType. KnownPeeringLocationsDirectPeeringType can be used interchangeably with PeeringLocationsDirectPeeringType, this enum contains the known values that the service supports. Known values supported by the service Edge Transit Cdn Internal Ix IxRs Voice
PeeringLocationsKind	Defines values for PeeringLocationsKind. KnownPeeringLocationsKind can be used interchangeably with PeeringLocationsKind, this enum contains the known values that the service supports. Known values supported by the service Direct Exchange
PeeringLocationsListNextResponse	Contains response data for the listNext operation.
PeeringLocationsListResponse	Contains response data for the list operation.
PeeringServiceCountriesListNextResponse	Contains response data for the listNext operation.
PeeringServiceCountriesListResponse	Contains response data for the list operation.
PeeringServiceLocationsListNextResponse	Contains response data for the listNext operation.
PeeringServiceLocationsListResponse	Contains response data for the list operation.
PeeringServiceProvidersListNextResponse	Contains response data for the listNext operation.
PeeringServiceProvidersListResponse	Contains response data for the list operation.
PeeringServicesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PeeringServicesGetResponse	Contains response data for the get operation.
PeeringServicesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
PeeringServicesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
PeeringServicesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
PeeringServicesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
PeeringServicesUpdateResponse	Contains response data for the update operation.
PeeringsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PeeringsGetResponse	Contains response data for the get operation.
PeeringsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
PeeringsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
PeeringsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
PeeringsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
PeeringsUpdateResponse	Contains response data for the update operation.
PrefixValidationState	Defines values for PrefixValidationState. KnownPrefixValidationState can be used interchangeably with PrefixValidationState, this enum contains the known values that the service supports. Known values supported by the service None Invalid Verified Failed Pending Warning Unknown
PrefixesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PrefixesGetResponse	Contains response data for the get operation.
PrefixesListByPeeringServiceNextResponse	Contains response data for the listByPeeringServiceNext operation.
PrefixesListByPeeringServiceResponse	Contains response data for the listByPeeringService operation.
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Updating Deleting Failed
ReceivedRoutesListByPeeringNextResponse	Contains response data for the listByPeeringNext operation.
ReceivedRoutesListByPeeringResponse	Contains response data for the listByPeering operation.
RegisteredAsnsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
RegisteredAsnsGetResponse	Contains response data for the get operation.
RegisteredAsnsListByPeeringNextResponse	Contains response data for the listByPeeringNext operation.
RegisteredAsnsListByPeeringResponse	Contains response data for the listByPeering operation.
RegisteredPrefixesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
RegisteredPrefixesGetResponse	Contains response data for the get operation.
RegisteredPrefixesListByPeeringNextResponse	Contains response data for the listByPeeringNext operation.
RegisteredPrefixesListByPeeringResponse	Contains response data for the listByPeering operation.
Role	Defines values for Role. KnownRole can be used interchangeably with Role, this enum contains the known values that the service supports. Known values supported by the service Noc Policy Technical Service Escalation Other
SessionAddressProvider	Defines values for SessionAddressProvider. KnownSessionAddressProvider can be used interchangeably with SessionAddressProvider, this enum contains the known values that the service supports. Known values supported by the service Microsoft Peer
SessionStateV4	Defines values for SessionStateV4. KnownSessionStateV4 can be used interchangeably with SessionStateV4, this enum contains the known values that the service supports. Known values supported by the service None Idle Connect Active OpenSent OpenConfirm OpenReceived Established PendingAdd PendingUpdate PendingRemove
SessionStateV6	Defines values for SessionStateV6. KnownSessionStateV6 can be used interchangeably with SessionStateV6, this enum contains the known values that the service supports. Known values supported by the service None Idle Connect Active OpenSent OpenConfirm OpenReceived Established PendingAdd PendingUpdate PendingRemove
Size	Defines values for Size. KnownSize can be used interchangeably with Size, this enum contains the known values that the service supports. Known values supported by the service Free Metered Unlimited
Tier	Defines values for Tier. KnownTier can be used interchangeably with Tier, this enum contains the known values that the service supports. Known values supported by the service Basic Premium
ValidationState	Defines values for ValidationState. KnownValidationState can be used interchangeably with ValidationState, this enum contains the known values that the service supports. Known values supported by the service None Pending Approved Failed

Enums

KnownCommand	Known values of Command that the service accepts.
KnownConnectionState	Known values of ConnectionState that the service accepts.
KnownDirectPeeringType	Known values of DirectPeeringType that the service accepts.
KnownEnum0	Known values of Enum0 that the service accepts.
KnownFamily	Known values of Family that the service accepts.
KnownKind	Known values of Kind that the service accepts.
KnownLearnedType	Known values of LearnedType that the service accepts.
KnownLegacyPeeringsKind	Known values of LegacyPeeringsKind that the service accepts.
KnownLookingGlassCommand	Known values of LookingGlassCommand that the service accepts.
KnownLookingGlassSourceType	Known values of LookingGlassSourceType that the service accepts.
KnownPeeringLocationsDirectPeeringType	Known values of PeeringLocationsDirectPeeringType that the service accepts.
KnownPeeringLocationsKind	Known values of PeeringLocationsKind that the service accepts.
KnownPrefixValidationState	Known values of PrefixValidationState that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownRole	Known values of Role that the service accepts.
KnownSessionAddressProvider	Known values of SessionAddressProvider that the service accepts.
KnownSessionStateV4	Known values of SessionStateV4 that the service accepts.
KnownSessionStateV6	Known values of SessionStateV6 that the service accepts.
KnownSize	Known values of Size that the service accepts.
KnownTier	Known values of Tier that the service accepts.
KnownValidationState	Known values of ValidationState that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

The continuation token that can be passed into byPage().