@azure/arm-peering package

Classes

PeeringManagementClient

Interfaces

BgpSession	The properties that define a BGP session.
CdnPeeringPrefix	The CDN peering prefix
CdnPeeringPrefixProperties	The properties that define a CDN peering prefix
CdnPeeringPrefixesListOptionalParams	Optional parameters.
CdnPeeringPrefixesOperations	Interface representing a CdnPeeringPrefixes operations.
CheckServiceProviderAvailabilityInput	Class for CheckServiceProviderAvailabilityInput
CheckServiceProviderAvailabilityOptionalParams	Optional parameters.
ConnectionMonitorTest	The Connection Monitor Test class.
ConnectionMonitorTestProperties	The properties that define a Connection Monitor Test.
ConnectionMonitorTestsCreateOrUpdateOptionalParams	Optional parameters.
ConnectionMonitorTestsDeleteOptionalParams	Optional parameters.
ConnectionMonitorTestsGetOptionalParams	Optional parameters.
ConnectionMonitorTestsListByPeeringServiceOptionalParams	Optional parameters.
ConnectionMonitorTestsOperations	Interface representing a ConnectionMonitorTests operations.
ConnectivityProbe	Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping tests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint IP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the Connectivity probe blade of their peering.
ContactDetail	The contact detail class.
DirectConnection	The properties that define a direct connection.
DirectPeeringFacility	The properties that define a direct peering facility.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExchangeConnection	The properties that define an exchange connection.
ExchangePeeringFacility	The properties that define an exchange peering facility.
LegacyPeeringsListOptionalParams	Optional parameters.
LegacyPeeringsOperations	Interface representing a LegacyPeerings operations.
LogAnalyticsWorkspaceProperties	The properties that define a Log Analytics Workspace.
LookingGlassInvokeOptionalParams	Optional parameters.
LookingGlassOperations	Interface representing a LookingGlass operations.
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.
OperationProperties	The properties of the operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PeerAsn	The essential information related to the peer's ASN.
PeerAsnProperties	The properties that define a peer's ASN.
PeerAsnsCreateOrUpdateOptionalParams	Optional parameters.
PeerAsnsDeleteOptionalParams	Optional parameters.
PeerAsnsGetOptionalParams	Optional parameters.
PeerAsnsListBySubscriptionOptionalParams	Optional parameters.
PeerAsnsOperations	Interface representing a PeerAsns operations.
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.
PeeringLocation	Peering location is where connectivity could be established to the Microsoft Cloud Edge.
PeeringLocationProperties	The properties that define a peering location.
PeeringLocationPropertiesDirect	The properties that define a direct peering location.
PeeringLocationPropertiesExchange	The properties that define an exchange peering location.
PeeringLocationsListOptionalParams	Optional parameters.
PeeringLocationsOperations	Interface representing a PeeringLocations operations.
PeeringManagementClientOptionalParams	Optional parameters for the client.
PeeringProperties	The properties that define connectivity to the Microsoft Cloud Edge.
PeeringPropertiesDirect	The properties that define a direct peering.
PeeringPropertiesExchange	The properties that define an exchange peering.
PeeringReceivedRoute	The properties that define a received route.
PeeringRegisteredAsn	The customer's ASN that is registered by the peering service provider.
PeeringRegisteredAsnProperties	The properties that define a registered ASN.
PeeringRegisteredPrefix	The customer's prefix that is registered by the peering service provider.
PeeringRegisteredPrefixProperties	The properties that define a registered prefix.
PeeringService	Peering Service
PeeringServiceCountriesListOptionalParams	Optional parameters.
PeeringServiceCountriesOperations	Interface representing a PeeringServiceCountries operations.
PeeringServiceCountry	The peering service country.
PeeringServiceLocation	The peering service location.
PeeringServiceLocationProperties	The properties that define connectivity to the Peering Service Location.
PeeringServiceLocationsListOptionalParams	Optional parameters.
PeeringServiceLocationsOperations	Interface representing a PeeringServiceLocations operations.
PeeringServicePrefix	The peering service prefix class.
PeeringServicePrefixEvent	The details of the event associated with a prefix.
PeeringServicePrefixProperties	The peering service prefix properties class.
PeeringServiceProperties	The properties that define connectivity to the Peering Service.
PeeringServiceProvider	PeeringService provider
PeeringServiceProviderProperties	The properties that define connectivity to the Peering Service Provider.
PeeringServiceProvidersListOptionalParams	Optional parameters.
PeeringServiceProvidersOperations	Interface representing a PeeringServiceProviders operations.
PeeringServiceSku	The SKU that defines the type of the peering service.
PeeringServicesCreateOrUpdateOptionalParams	Optional parameters.
PeeringServicesDeleteOptionalParams	Optional parameters.
PeeringServicesGetOptionalParams	Optional parameters.
PeeringServicesInitializeConnectionMonitorOptionalParams	Optional parameters.
PeeringServicesListByResourceGroupOptionalParams	Optional parameters.
PeeringServicesListBySubscriptionOptionalParams	Optional parameters.
PeeringServicesOperations	Interface representing a PeeringServices operations.
PeeringServicesUpdateOptionalParams	Optional parameters.
PeeringSku	The SKU that defines the tier and kind of the peering.
PeeringsCreateOrUpdateOptionalParams	Optional parameters.
PeeringsDeleteOptionalParams	Optional parameters.
PeeringsGetOptionalParams	Optional parameters.
PeeringsListByResourceGroupOptionalParams	Optional parameters.
PeeringsListBySubscriptionOptionalParams	Optional parameters.
PeeringsOperations	Interface representing a Peerings operations.
PeeringsUpdateOptionalParams	Optional parameters.
PrefixesCreateOrUpdateOptionalParams	Optional parameters.
PrefixesDeleteOptionalParams	Optional parameters.
PrefixesGetOptionalParams	Optional parameters.
PrefixesListByPeeringServiceOptionalParams	Optional parameters.
PrefixesOperations	Interface representing a Prefixes operations.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
ReceivedRoutesListByPeeringOptionalParams	Optional parameters.
ReceivedRoutesOperations	Interface representing a ReceivedRoutes operations.
RegisteredAsnsCreateOrUpdateOptionalParams	Optional parameters.
RegisteredAsnsDeleteOptionalParams	Optional parameters.
RegisteredAsnsGetOptionalParams	Optional parameters.
RegisteredAsnsListByPeeringOptionalParams	Optional parameters.
RegisteredAsnsOperations	Interface representing a RegisteredAsns operations.
RegisteredPrefixesCreateOrUpdateOptionalParams	Optional parameters.
RegisteredPrefixesDeleteOptionalParams	Optional parameters.
RegisteredPrefixesGetOptionalParams	Optional parameters.
RegisteredPrefixesListByPeeringOptionalParams	Optional parameters.
RegisteredPrefixesOperations	Interface representing a RegisteredPrefixes operations.
RegisteredPrefixesValidateOptionalParams	Optional parameters.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceTags	The resource tags.
RpUnbilledPrefix	The Routing Preference unbilled prefix
RpUnbilledPrefixesListOptionalParams	Optional parameters.
RpUnbilledPrefixesOperations	Interface representing a RpUnbilledPrefixes operations.
ServiceSpecification	Service specification payload.
SubResource	The sub resource.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

AzureSupportedClouds	The supported values for cloud setting as a string literal type
CheckServiceProviderAvailabilityResponse
Command	Invoked 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
ConnectionState	The state of the connection. 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 TypeChangeRequested TypeChangeInProgress ExternalBlocker
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DirectPeeringType	The type of direct peering. 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 EdgeZoneForOperators PeerProp
Enum0	Response for checking service provider availability KnownEnum0 can be used interchangeably with Enum0, this enum contains the known values that the service supports. Known values supported by the service Available: available Unavailable: unavailable
Family	The family of the peering SKU. 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	The kind of the peering. 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	The prefix learned type 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	Type of LegacyPeeringsKind
LookingGlassCommand	Type of LookingGlassCommand
LookingGlassSourceType	Type of LookingGlassSourceType
PeeringLocationsDirectPeeringType	Type of PeeringLocationsDirectPeeringType
PeeringLocationsKind	Type of PeeringLocationsKind
PrefixValidationState	The prefix validation state. 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
Protocol	The protocol of the traffic that will be sent for the connectivity probe. KnownProtocol can be used interchangeably with Protocol, this enum contains the known values that the service supports. Known values supported by the service None ICMP TCP
ProvisioningState	The provisioning state of the resource. 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 Canceled
Role	The role of the contact. 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	The field indicating if Microsoft provides session ip addresses. 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	The state of the IPv4 session. 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	The state of the IPv6 session. 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	The size of the peering SKU. 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	The tier of the peering SKU. 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	The validation state of the ASN associated with the peer. 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

AzureClouds	An enum to describe Azure Cloud environments.
KnownCommand	Invoked command
KnownConnectionState	The state of the connection.
KnownCreatedByType	The kind of entity that created the resource.
KnownDirectPeeringType	The type of direct peering.
KnownEnum0	Response for checking service provider availability
KnownFamily	The family of the peering SKU.
KnownKind	The kind of the peering.
KnownLearnedType	The prefix learned type
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	The prefix validation state.
KnownProtocol	The protocol of the traffic that will be sent for the connectivity probe.
KnownProvisioningState	The provisioning state of the resource.
KnownRole	The role of the contact.
KnownSessionAddressProvider	The field indicating if Microsoft provides session ip addresses.
KnownSessionStateV4	The state of the IPv4 session.
KnownSessionStateV6	The state of the IPv6 session.
KnownSize	The size of the peering SKU.
KnownTier	The tier of the peering SKU.
KnownValidationState	The validation state of the ASN associated with the peer.
KnownVersions	The available API versions.