Spacecrafts - List Available Contacts

Service:

Orbital

API Version:

2022-11-01

Returns list of available contacts. A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/listAvailableContacts?api-version=2022-11-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
spacecraftName	path	True	string	Spacecraft ID.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
contactProfile	True	ContactProfile	The reference to the contact profile resource.
endTime	True	string	End time of a contact (ISO 8601 UTC standard).
groundStationName	True	string	Name of Azure Ground Station.
startTime	True	string	Start time of a contact (ISO 8601 UTC standard).

Responses

Name	Type	Description
200 OK	AvailableContactsListResult	Request successful. The operation returns a list of available contacts resources.
202 Accepted		Accepted and the operation will complete asynchronously. Headers Location: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.

Examples

List of Contact

Sample request

HTTP

POST https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/listAvailableContacts?api-version=2022-11-01

{
  "contactProfile": {
    "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
  },
  "groundStationName": "EASTUS2_0",
  "startTime": "2022-11-01T11:30:00Z",
  "endTime": "2022-11-02T11:30:00Z"
}

Java

import com.azure.resourcemanager.orbital.models.ContactParameters;
import com.azure.resourcemanager.orbital.models.ContactParametersContactProfile;
import java.time.OffsetDateTime;

/** Samples for Spacecrafts ListAvailableContacts. */
public final class Main {
    /*
     * x-ms-original-file: specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableContactsList.json
     */
    /**
     * Sample code: List of Contact.
     *
     * @param manager Entry point to OrbitalManager.
     */
    public static void listOfContact(com.azure.resourcemanager.orbital.OrbitalManager manager) {
        manager
            .spacecrafts()
            .listAvailableContacts(
                "contoso-Rgp",
                "CONTOSO_SAT",
                new ContactParameters()
                    .withContactProfile(
                        new ContactParametersContactProfile()
                            .withId(
                                "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"))
                    .withGroundStationName("EASTUS2_0")
                    .withStartTime(OffsetDateTime.parse("2022-11-01T11:30:00Z"))
                    .withEndTime(OffsetDateTime.parse("2022-11-02T11:30:00Z")),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armorbital_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableContactsList.json
func ExampleSpacecraftsClient_BeginListAvailableContacts() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSpacecraftsClient().BeginListAvailableContacts(ctx, "contoso-Rgp", "CONTOSO_SAT", armorbital.ContactParameters{
		ContactProfile: &armorbital.ContactParametersContactProfile{
			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
		},
		EndTime:           to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-02T11:30:00.000Z"); return t }()),
		GroundStationName: to.Ptr("EASTUS2_0"),
		StartTime:         to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T11:30:00.000Z"); return t }()),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	for res.More() {
		page, err := res.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AvailableContactsListResult = armorbital.AvailableContactsListResult{
		// 	Value: []*armorbital.AvailableContacts{
		// 		{
		// 			GroundStationName: to.Ptr("EASTUS2_0"),
		// 			Properties: &armorbital.AvailableContactsProperties{
		// 				EndAzimuthDegrees: to.Ptr[float32](330.489627),
		// 				EndElevationDegrees: to.Ptr[float32](5.040625),
		// 				MaximumElevationDegrees: to.Ptr[float32](26.617297),
		// 				RxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T12:05:25.000Z"); return t}()),
		// 				RxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T11:55:01.000Z"); return t}()),
		// 				StartAzimuthDegrees: to.Ptr[float32](201.340472),
		// 				StartElevationDegrees: to.Ptr[float32](5),
		// 				TxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T12:05:25.000Z"); return t}()),
		// 				TxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T11:55:01.000Z"); return t}()),
		// 			},
		// 			Spacecraft: &armorbital.AvailableContactsSpacecraft{
		// 				ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"),
		// 			},
		// 		},
		// 		{
		// 			GroundStationName: to.Ptr("EASTUS2_0"),
		// 			Properties: &armorbital.AvailableContactsProperties{
		// 				EndAzimuthDegrees: to.Ptr[float32](345.848482),
		// 				EndElevationDegrees: to.Ptr[float32](5.048656),
		// 				MaximumElevationDegrees: to.Ptr[float32](85.9796),
		// 				RxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-02T11:10:45.000Z"); return t}()),
		// 				RxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-02T10:58:30.000Z"); return t}()),
		// 				StartAzimuthDegrees: to.Ptr[float32](165.758896),
		// 				StartElevationDegrees: to.Ptr[float32](5),
		// 				TxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-02T11:10:45.000Z"); return t}()),
		// 				TxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-02T10:58:30.000Z"); return t}()),
		// 			},
		// 			Spacecraft: &armorbital.AvailableContactsSpacecraft{
		// 				ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureOrbital } = require("@azure/arm-orbital");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns list of available contacts. A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile.
 *
 * @summary Returns list of available contacts. A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile.
 * x-ms-original-file: specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableContactsList.json
 */
async function listOfContact() {
  const subscriptionId =
    process.env["ORBITAL_SUBSCRIPTION_ID"] || "c1be1141-a7c9-4aac-9608-3c2e2f1152c3";
  const resourceGroupName = process.env["ORBITAL_RESOURCE_GROUP"] || "contoso-Rgp";
  const spacecraftName = "CONTOSO_SAT";
  const contactProfile = {
    id: "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP",
  };
  const groundStationName = "EASTUS2_0";
  const startTime = new Date("2022-11-01T11:30:00Z");
  const endTime = new Date("2022-11-02T11:30:00Z");
  const credential = new DefaultAzureCredential();
  const client = new AzureOrbital(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.spacecrafts.beginListAvailableContactsAndWait(
    resourceGroupName,
    spacecraftName,
    contactProfile,
    groundStationName,
    startTime,
    endTime
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

202

Location: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01

Status code:

200

{
  "value": [
    {
      "spacecraft": {
        "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"
      },
      "groundStationName": "EASTUS2_0",
      "properties": {
        "maximumElevationDegrees": 26.617297,
        "txStartTime": "2022-11-01T11:55:01Z",
        "txEndTime": "2022-11-01T12:05:25Z",
        "rxStartTime": "2022-11-01T11:55:01Z",
        "rxEndTime": "2022-11-01T12:05:25Z",
        "startAzimuthDegrees": 201.340472,
        "endAzimuthDegrees": 330.489627,
        "startElevationDegrees": 5,
        "endElevationDegrees": 5.040625
      }
    },
    {
      "spacecraft": {
        "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"
      },
      "groundStationName": "EASTUS2_0",
      "properties": {
        "maximumElevationDegrees": 85.9796,
        "txStartTime": "2022-11-02T10:58:30Z",
        "txEndTime": "2022-11-02T11:10:45Z",
        "rxStartTime": "2022-11-02T10:58:30Z",
        "rxEndTime": "2022-11-02T11:10:45Z",
        "startAzimuthDegrees": 165.758896,
        "endAzimuthDegrees": 345.848482,
        "startElevationDegrees": 5,
        "endElevationDegrees": 5.048656
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/listAvailableContacts?api-version=2022-11-01&$skiptoken=opaqueString"
}

Definitions

Name	Description
AuthorizedGroundstation	Authorized groundstation.
AutoTrackingConfiguration	Auto-tracking configuration.
AvailableContacts	Customer retrieves list of Available Contacts for a spacecraft resource. Later, one of the available contact can be selected to create a contact.
AvailableContactsListResult	Response for the ListAvailableContacts API service call.
ContactParameters	Parameters that define the contact resource.
ContactParameters.ContactProfile	The reference to the contact profile resource.
ContactProfile	Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact.
ContactProfileLink	Contact Profile Link.
ContactProfileLinkChannel	Contact Profile Link Channel.
ContactProfilesProperties.ProvisioningState	The current state of the resource's creation, deletion, or modification.
ContactProfileThirdPartyConfiguration	Contact Profile third-party partner configuration.
createdByType	The type of identity that created the resource.
direction	Direction (Uplink or Downlink).
EndPoint	Customer end point to store and retrieve data during a contact with the spacecraft.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
NetworkConfiguration	Network configuration of customer virtual network.
polarization	Polarization. e.g. (RHCP, LHCP).
protocol	Protocol either UDP or TCP.
ProvisioningState	The current state of the resource's creation, deletion, or modification.
Spacecraft	Customer creates a spacecraft resource to schedule a contact.
SpacecraftLink	List of authorized spacecraft links per ground station and the expiration date of the authorization.
systemData	Metadata pertaining to creation and last modification of the resource.

AuthorizedGroundstation

Authorized groundstation.

Name	Type	Description
expirationDate	string	Date of authorization expiration.
groundStation	string	Groundstation name.

AutoTrackingConfiguration

Auto-tracking configuration.

Name	Type	Description
disabled	string
sBand	string
xBand	string

AvailableContacts

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

Name	Type	Description
groundStationName	string	Name of Azure Ground Station.
properties.endAzimuthDegrees	number	Azimuth of the antenna at the end of the contact in decimal degrees.
properties.endElevationDegrees	number	Spacecraft elevation above the horizon at contact end.
properties.maximumElevationDegrees	number	Maximum elevation of the antenna during the contact in decimal degrees.
properties.rxEndTime	string	Time to lost receiving a signal (ISO 8601 UTC standard).
properties.rxStartTime	string	Earliest time to receive a signal (ISO 8601 UTC standard).
properties.startAzimuthDegrees	number	Azimuth of the antenna at the start of the contact in decimal degrees.
properties.startElevationDegrees	number	Spacecraft elevation above the horizon at contact start.
properties.txEndTime	string	Time at which antenna transmit will be disabled (ISO 8601 UTC standard).
properties.txStartTime	string	Time at which antenna transmit will be enabled (ISO 8601 UTC standard).
spacecraft	Spacecraft	The reference to the spacecraft resource.

AvailableContactsListResult

Response for the ListAvailableContacts API service call.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	AvailableContacts[]	A list of available contacts.

ContactParameters

Parameters that define the contact resource.

Name	Type	Description
contactProfile	ContactProfile	The reference to the contact profile resource.
endTime	string	End time of a contact (ISO 8601 UTC standard).
groundStationName	string	Name of Azure Ground Station.
startTime	string	Start time of a contact (ISO 8601 UTC standard).

ContactParameters.ContactProfile

The reference to the contact profile resource.

Name	Type	Description
id	string	Resource ID.

ContactProfile

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

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.autoTrackingConfiguration	AutoTrackingConfiguration	Auto-tracking configuration.
properties.eventHubUri	string	ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub.
properties.links	ContactProfileLink[]	Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
properties.minimumElevationDegrees	number	Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station.
properties.minimumViableContactDuration	string	Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station.
properties.networkConfiguration	NetworkConfiguration	Network configuration of customer virtual network.
properties.provisioningState	ContactProfilesProperties.ProvisioningState	The current state of the resource's creation, deletion, or modification.
properties.thirdPartyConfigurations	ContactProfileThirdPartyConfiguration[]	Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ContactProfileLink

Contact Profile Link.

Name	Type	Description
channels	ContactProfileLinkChannel[]	Contact Profile Link Channel.
direction	direction	Direction (Uplink or Downlink).
eirpdBW	number	Effective Isotropic Radiated Power (EIRP) in dBW. It is the required EIRP by the customer. Not used yet.
gainOverTemperature	number	Gain to noise temperature in db/K. It is the required G/T by the customer. Not used yet.
name	string	Link name.
polarization	polarization	Polarization. e.g. (RHCP, LHCP).

ContactProfileLinkChannel

Contact Profile Link Channel.

Name	Type	Description
bandwidthMHz	number	Bandwidth in MHz.
centerFrequencyMHz	number	Center Frequency in MHz.
decodingConfiguration	string	Currently unused.
demodulationConfiguration	string	Copy of the modem configuration file such as Kratos QRadio or Kratos QuantumRx. Only valid for downlink directions. If provided, the modem connects to the customer endpoint and sends demodulated data instead of a VITA.49 stream.
encodingConfiguration	string	Currently unused.
endPoint	EndPoint	Customer end point to store and retrieve data during a contact with the spacecraft.
modulationConfiguration	string	Copy of the modem configuration file such as Kratos QRadio. Only valid for uplink directions. If provided, the modem connects to the customer endpoint and accepts commands from the customer instead of a VITA.49 stream.
name	string	Channel name.

ContactProfilesProperties.ProvisioningState

The current state of the resource's creation, deletion, or modification.

ContactProfileThirdPartyConfiguration

Contact Profile third-party partner configuration.

Name	Type	Description
missionConfiguration	string	Name of string referencing the configuration describing contact set-up for a particular mission. Expected values are those which have been created in collaboration with the partner network.
providerName	string	Name of the third-party provider.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

direction

Direction (Uplink or Downlink).

Name	Type	Description
Downlink	string
Uplink	string

EndPoint

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

Name	Type	Description
endPointName	string	Name of an end point.
ipAddress	string	IP Address (IPv4).
port	string	TCP port to listen on to receive data.
protocol	protocol	Protocol either UDP or TCP.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

NetworkConfiguration

Network configuration of customer virtual network.

Name	Type	Description
subnetId	string	ARM resource identifier of the subnet delegated to the Microsoft.Orbital/orbitalGateways. Needs to be at least a class C subnet, and should not have any IP created in it.

polarization

Polarization. e.g. (RHCP, LHCP).

Name	Type	Description
LHCP	string
RHCP	string
linearHorizontal	string
linearVertical	string

protocol

Protocol either UDP or TCP.

Name	Type	Description
TCP	string
UDP	string

ProvisioningState

The current state of the resource's creation, deletion, or modification.

Spacecraft

Customer creates a spacecraft resource to schedule a contact.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.links	SpacecraftLink[]	Immutable list of Spacecraft links.
properties.noradId	string	NORAD ID of the spacecraft.
properties.provisioningState	ProvisioningState	The current state of the resource's creation, deletion, or modification.
properties.titleLine	string	Title line of the two-line element set (TLE).
properties.tleLine1	string	Line 1 of the two-line element set (TLE).
properties.tleLine2	string	Line 2 of the two-line element set (TLE).
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SpacecraftLink

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

Name	Type	Description
authorizations	AuthorizedGroundstation[]	Authorized Ground Stations
bandwidthMHz	number	Bandwidth in MHz.
centerFrequencyMHz	number	Center Frequency in MHz.
direction	direction	Direction (Uplink or Downlink).
name	string	Link name.
polarization	polarization	Polarization. e.g. (RHCP, LHCP).

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.