Package-level declarations

Types

Link copied to clipboard
data class AuthorizedGroundstationResponse(val expirationDate: String, val groundStation: String)

Authorized groundstation.

Link copied to clipboard
data class AvailableContactsResponse(val endAzimuthDegrees: Double, val endElevationDegrees: Double, val groundStationName: String, val maximumElevationDegrees: Double, val rxEndTime: String, val rxStartTime: String, val spacecraft: AvailableContactsResponseSpacecraft? = null, val startAzimuthDegrees: Double, val startElevationDegrees: Double, val txEndTime: String, val txStartTime: String)

Customer retrieves list of Available Contacts for a spacecraft resource. Later, one of the available contact can be selected to create a contact.

Link copied to clipboard

The reference to the spacecraft resource.

Link copied to clipboard
data class ContactProfileLinkChannelResponse(val bandwidthMHz: Double, val centerFrequencyMHz: Double, val decodingConfiguration: String? = null, val demodulationConfiguration: String? = null, val encodingConfiguration: String? = null, val endPoint: EndPointResponse, val modulationConfiguration: String? = null, val name: String)

Contact Profile Link Channel.

Link copied to clipboard
data class ContactProfileLinkResponse(val channels: List<ContactProfileLinkChannelResponse>, val direction: String, val eirpdBW: Double? = null, val gainOverTemperature: Double? = null, val name: String, val polarization: String)

Contact Profile Link.

Network configuration of customer virtual network.

data class ContactProfileThirdPartyConfigurationResponse(val missionConfiguration: String, val providerName: String)

Contact Profile third-party partner configuration.

data class ContactsPropertiesResponseAntennaConfiguration(val destinationIp: String? = null, val sourceIps: List<String>? = null)

The configuration associated with the allocated antenna.

Link copied to clipboard

The reference to the contact profile resource.

A reference to global communications site.

Link copied to clipboard
data class EndPointResponse(val endPointName: String, val ipAddress: String, val port: String, val protocol: String)

Customer end point to store and retrieve data during a contact with the spacecraft.

Link copied to clipboard
data class GetContactProfileResult(val autoTrackingConfiguration: String? = null, val eventHubUri: String? = null, val id: String, val links: List<ContactProfileLinkResponse>, val location: String, val minimumElevationDegrees: Double? = null, val minimumViableContactDuration: String? = null, val name: String, val networkConfiguration: ContactProfilesPropertiesResponseNetworkConfiguration, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val thirdPartyConfigurations: List<ContactProfileThirdPartyConfigurationResponse>? = null, val type: String)

Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact.

Link copied to clipboard
data class GetContactResult(val antennaConfiguration: ContactsPropertiesResponseAntennaConfiguration, val contactProfile: ContactsPropertiesResponseContactProfile, val endAzimuthDegrees: Double, val endElevationDegrees: Double, val errorMessage: String, val groundStationName: String, val id: String, val maximumElevationDegrees: Double, val name: String, val reservationEndTime: String, val reservationStartTime: String, val rxEndTime: String, val rxStartTime: String, val startAzimuthDegrees: Double, val startElevationDegrees: Double, val status: String, val systemData: SystemDataResponse, val txEndTime: String, val txStartTime: String, val type: String)

Customer creates a contact resource for a spacecraft resource.

Link copied to clipboard
data class GetEdgeSiteResult(val globalCommunicationsSite: EdgeSitesPropertiesResponseGlobalCommunicationsSite, val id: String, val location: String, val name: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A customer's reference to a global communications site site.

Link copied to clipboard
data class GetGroundStationResult(val altitudeMeters: Double? = null, val capabilities: List<String>, val city: String? = null, val globalCommunicationsSite: GroundStationsPropertiesResponseGlobalCommunicationsSite, val id: String, val latitudeDegrees: Double? = null, val location: String, val longitudeDegrees: Double? = null, val name: String, val providerName: String? = null, val releaseMode: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Ground Station contains one or more antennas.

Link copied to clipboard
data class GetL2ConnectionResult(val circuitId: String, val edgeSite: L2ConnectionsPropertiesResponseEdgeSite, val groundStation: L2ConnectionsPropertiesResponseGroundStation, val id: String, val location: String, val name: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vlanId: Int)

Connects an edge site to an orbital gateway and describes what layer 2 traffic to forward between them.

Link copied to clipboard
data class GetSpacecraftResult(val id: String, val links: List<SpacecraftLinkResponse>, val location: String, val name: String, val noradId: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val titleLine: String, val tleLine1: String, val tleLine2: String, val type: String)

Customer creates a spacecraft resource to schedule a contact.

A reference to global communications site.

Link copied to clipboard

A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.

A reference to an Microsoft.Orbital/groundStations resource to route traffic for.

Link copied to clipboard
data class ListEdgeSiteL2ConnectionsResult(val nextLink: String, val value: List<ResourceIdListResultResponseValue>? = null)

Response for an API service call that lists the resource IDs of resources associated with another resource.

Link copied to clipboard

Response for an API service call that lists the resource IDs of resources associated with another resource.

Link copied to clipboard
data class ListSpacecraftAvailableContactsResult(val nextLink: String, val value: List<AvailableContactsResponse>? = null)

Response for the ListAvailableContacts API service call.

Link copied to clipboard
data class ResourceIdListResultResponseValue(val id: String? = null)
Link copied to clipboard
data class SpacecraftLinkResponse(val authorizations: List<AuthorizedGroundstationResponse>, val bandwidthMHz: Double, val centerFrequencyMHz: Double, val direction: String, val name: String, val polarization: String)

List of authorized spacecraft links per ground station and the expiration date of the authorization.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.