Contact Profiles - Create Or Update

Service:

Orbital

API Version:

2022-11-01

Creates or updates a contact profile.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}?api-version=2022-11-01

URI Parameters

Name	In	Required	Type	Description
contactProfileName	path	True	string	Contact Profile name.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
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
location	True	string	The geo-location where the resource lives
properties.links	True	ContactProfileLink[]	Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
properties.networkConfiguration	True	NetworkConfiguration	Network configuration of customer virtual network.
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.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.provisioningState		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.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	ContactProfile	Update successful. The operation returns the resulting ContactProfile resource.
201 Created	ContactProfile	Create successful. The operation returns the resulting ContactProfile resource. Headers Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

Create a contact profile

Sample request

HTTP

PUT https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP?api-version=2022-11-01

{
  "location": "eastus2",
  "properties": {
    "minimumViableContactDuration": "PT1M",
    "minimumElevationDegrees": 5,
    "autoTrackingConfiguration": "disabled",
    "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub",
    "networkConfiguration": {
      "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"
    },
    "thirdPartyConfigurations": [
      {
        "providerName": "KSAT",
        "missionConfiguration": "Ksat_MissionConfiguration"
      },
      {
        "providerName": "VIASAT",
        "missionConfiguration": "Viasat_Configuration"
      }
    ],
    "links": [
      {
        "name": "contoso-uplink",
        "polarization": "LHCP",
        "direction": "Uplink",
        "gainOverTemperature": 0,
        "eirpdBW": 45,
        "channels": [
          {
            "name": "contoso-uplink-channel",
            "centerFrequencyMHz": 2250,
            "bandwidthMHz": 2,
            "endPoint": {
              "ipAddress": "10.1.0.4",
              "endPointName": "ContosoTest_Uplink",
              "port": "50000",
              "protocol": "TCP"
            }
          }
        ]
      },
      {
        "name": "contoso-downlink",
        "polarization": "RHCP",
        "direction": "Downlink",
        "gainOverTemperature": 25,
        "eirpdBW": 0,
        "channels": [
          {
            "name": "contoso-downlink-channel",
            "centerFrequencyMHz": 8160,
            "bandwidthMHz": 15,
            "endPoint": {
              "ipAddress": "10.1.0.5",
              "endPointName": "ContosoTest_Downlink",
              "port": "50001",
              "protocol": "UDP"
            }
          }
        ]
      }
    ]
  }
}

Java

import com.azure.resourcemanager.orbital.models.AutoTrackingConfiguration;
import com.azure.resourcemanager.orbital.models.ContactProfileLink;
import com.azure.resourcemanager.orbital.models.ContactProfileLinkChannel;
import com.azure.resourcemanager.orbital.models.ContactProfileThirdPartyConfiguration;
import com.azure.resourcemanager.orbital.models.ContactProfilesPropertiesNetworkConfiguration;
import com.azure.resourcemanager.orbital.models.Direction;
import com.azure.resourcemanager.orbital.models.EndPoint;
import com.azure.resourcemanager.orbital.models.Polarization;
import com.azure.resourcemanager.orbital.models.Protocol;
import java.util.Arrays;

/** Samples for ContactProfiles CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileCreate.json
     */
    /**
     * Sample code: Create a contact profile.
     *
     * @param manager Entry point to OrbitalManager.
     */
    public static void createAContactProfile(com.azure.resourcemanager.orbital.OrbitalManager manager) {
        manager
            .contactProfiles()
            .define("CONTOSO-CP")
            .withRegion("eastus2")
            .withExistingResourceGroup("contoso-Rgp")
            .withNetworkConfiguration(
                new ContactProfilesPropertiesNetworkConfiguration()
                    .withSubnetId(
                        "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"))
            .withLinks(
                Arrays
                    .asList(
                        new ContactProfileLink()
                            .withName("contoso-uplink")
                            .withPolarization(Polarization.LHCP)
                            .withDirection(Direction.UPLINK)
                            .withGainOverTemperature(0.0F)
                            .withEirpdBW(45.0F)
                            .withChannels(
                                Arrays
                                    .asList(
                                        new ContactProfileLinkChannel()
                                            .withName("contoso-uplink-channel")
                                            .withCenterFrequencyMHz(2250f)
                                            .withBandwidthMHz(2f)
                                            .withEndPoint(
                                                new EndPoint()
                                                    .withIpAddress("10.1.0.4")
                                                    .withEndPointName("ContosoTest_Uplink")
                                                    .withPort("50000")
                                                    .withProtocol(Protocol.TCP)))),
                        new ContactProfileLink()
                            .withName("contoso-downlink")
                            .withPolarization(Polarization.RHCP)
                            .withDirection(Direction.DOWNLINK)
                            .withGainOverTemperature(25.0F)
                            .withEirpdBW(0.0F)
                            .withChannels(
                                Arrays
                                    .asList(
                                        new ContactProfileLinkChannel()
                                            .withName("contoso-downlink-channel")
                                            .withCenterFrequencyMHz(8160f)
                                            .withBandwidthMHz(15f)
                                            .withEndPoint(
                                                new EndPoint()
                                                    .withIpAddress("10.1.0.5")
                                                    .withEndPointName("ContosoTest_Downlink")
                                                    .withPort("50001")
                                                    .withProtocol(Protocol.UDP))))))
            .withMinimumViableContactDuration("PT1M")
            .withMinimumElevationDegrees(5.0F)
            .withAutoTrackingConfiguration(AutoTrackingConfiguration.DISABLED)
            .withEventHubUri(
                "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub")
            .withThirdPartyConfigurations(
                Arrays
                    .asList(
                        new ContactProfileThirdPartyConfiguration()
                            .withProviderName("KSAT")
                            .withMissionConfiguration("Ksat_MissionConfiguration"),
                        new ContactProfileThirdPartyConfiguration()
                            .withProviderName("VIASAT")
                            .withMissionConfiguration("Viasat_Configuration")))
            .create();
    }
}

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"

	"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/ContactProfileCreate.json
func ExampleContactProfilesClient_BeginCreateOrUpdate() {
	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.NewContactProfilesClient().BeginCreateOrUpdate(ctx, "contoso-Rgp", "CONTOSO-CP", armorbital.ContactProfile{
		Location: to.Ptr("eastus2"),
		Properties: &armorbital.ContactProfileProperties{
			AutoTrackingConfiguration: to.Ptr(armorbital.AutoTrackingConfigurationDisabled),
			EventHubURI:               to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub"),
			Links: []*armorbital.ContactProfileLink{
				{
					Name: to.Ptr("contoso-uplink"),
					Channels: []*armorbital.ContactProfileLinkChannel{
						{
							Name:               to.Ptr("contoso-uplink-channel"),
							BandwidthMHz:       to.Ptr[float32](2),
							CenterFrequencyMHz: to.Ptr[float32](2250),
							EndPoint: &armorbital.EndPoint{
								EndPointName: to.Ptr("ContosoTest_Uplink"),
								IPAddress:    to.Ptr("10.1.0.4"),
								Port:         to.Ptr("50000"),
								Protocol:     to.Ptr(armorbital.ProtocolTCP),
							},
						}},
					Direction:           to.Ptr(armorbital.DirectionUplink),
					EirpdBW:             to.Ptr[float32](45),
					GainOverTemperature: to.Ptr[float32](0),
					Polarization:        to.Ptr(armorbital.PolarizationLHCP),
				},
				{
					Name: to.Ptr("contoso-downlink"),
					Channels: []*armorbital.ContactProfileLinkChannel{
						{
							Name:               to.Ptr("contoso-downlink-channel"),
							BandwidthMHz:       to.Ptr[float32](15),
							CenterFrequencyMHz: to.Ptr[float32](8160),
							EndPoint: &armorbital.EndPoint{
								EndPointName: to.Ptr("ContosoTest_Downlink"),
								IPAddress:    to.Ptr("10.1.0.5"),
								Port:         to.Ptr("50001"),
								Protocol:     to.Ptr(armorbital.ProtocolUDP),
							},
						}},
					Direction:           to.Ptr(armorbital.DirectionDownlink),
					EirpdBW:             to.Ptr[float32](0),
					GainOverTemperature: to.Ptr[float32](25),
					Polarization:        to.Ptr(armorbital.PolarizationRHCP),
				}},
			MinimumElevationDegrees:      to.Ptr[float32](5),
			MinimumViableContactDuration: to.Ptr("PT1M"),
			NetworkConfiguration: &armorbital.ContactProfilesPropertiesNetworkConfiguration{
				SubnetID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"),
			},
			ThirdPartyConfigurations: []*armorbital.ContactProfileThirdPartyConfiguration{
				{
					MissionConfiguration: to.Ptr("Ksat_MissionConfiguration"),
					ProviderName:         to.Ptr("KSAT"),
				},
				{
					MissionConfiguration: to.Ptr("Viasat_Configuration"),
					ProviderName:         to.Ptr("VIASAT"),
				}},
		},
	}, 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)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ContactProfile = armorbital.ContactProfile{
	// 	Name: to.Ptr("CONTOSO-CP"),
	// 	Type: to.Ptr("Microsoft.Orbital/contactProfiles"),
	// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
	// 	Location: to.Ptr("eastus2"),
	// 	Properties: &armorbital.ContactProfileProperties{
	// 		AutoTrackingConfiguration: to.Ptr(armorbital.AutoTrackingConfigurationDisabled),
	// 		EventHubURI: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub"),
	// 		Links: []*armorbital.ContactProfileLink{
	// 			{
	// 				Name: to.Ptr("contoso-uplink"),
	// 				Channels: []*armorbital.ContactProfileLinkChannel{
	// 					{
	// 						Name: to.Ptr("contoso-uplink-channel"),
	// 						BandwidthMHz: to.Ptr[float32](2),
	// 						CenterFrequencyMHz: to.Ptr[float32](2250),
	// 						EndPoint: &armorbital.EndPoint{
	// 							EndPointName: to.Ptr("ContosoTest_Uplink"),
	// 							IPAddress: to.Ptr("10.1.0.4"),
	// 							Port: to.Ptr("50000"),
	// 							Protocol: to.Ptr(armorbital.ProtocolTCP),
	// 						},
	// 				}},
	// 				Direction: to.Ptr(armorbital.DirectionUplink),
	// 				EirpdBW: to.Ptr[float32](45),
	// 				GainOverTemperature: to.Ptr[float32](0),
	// 				Polarization: to.Ptr(armorbital.PolarizationLHCP),
	// 			},
	// 			{
	// 				Name: to.Ptr("contoso-downlink"),
	// 				Channels: []*armorbital.ContactProfileLinkChannel{
	// 					{
	// 						Name: to.Ptr("contoso-downlink-channel"),
	// 						BandwidthMHz: to.Ptr[float32](15),
	// 						CenterFrequencyMHz: to.Ptr[float32](8160),
	// 						EndPoint: &armorbital.EndPoint{
	// 							EndPointName: to.Ptr("ContosoTest_Downlink"),
	// 							IPAddress: to.Ptr("10.1.0.5"),
	// 							Port: to.Ptr("50001"),
	// 							Protocol: to.Ptr(armorbital.ProtocolUDP),
	// 						},
	// 				}},
	// 				Direction: to.Ptr(armorbital.DirectionDownlink),
	// 				EirpdBW: to.Ptr[float32](0),
	// 				GainOverTemperature: to.Ptr[float32](25),
	// 				Polarization: to.Ptr(armorbital.PolarizationRHCP),
	// 		}},
	// 		MinimumElevationDegrees: to.Ptr[float32](5),
	// 		MinimumViableContactDuration: to.Ptr("PT1M"),
	// 		NetworkConfiguration: &armorbital.ContactProfilesPropertiesNetworkConfiguration{
	// 			SubnetID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"),
	// 		},
	// 		ProvisioningState: to.Ptr(armorbital.ContactProfilesPropertiesProvisioningState("Succeeded")),
	// 		ThirdPartyConfigurations: []*armorbital.ContactProfileThirdPartyConfiguration{
	// 			{
	// 				MissionConfiguration: to.Ptr("Ksat_MissionConfiguration"),
	// 				ProviderName: to.Ptr("KSAT"),
	// 			},
	// 			{
	// 				MissionConfiguration: to.Ptr("Viasat_Configuration"),
	// 				ProviderName: to.Ptr("VIASAT"),
	// 		}},
	// 	},
	// }
}

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 Creates or updates a contact profile.
 *
 * @summary Creates or updates a contact profile.
 * x-ms-original-file: specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileCreate.json
 */
async function createAContactProfile() {
  const subscriptionId =
    process.env["ORBITAL_SUBSCRIPTION_ID"] || "c1be1141-a7c9-4aac-9608-3c2e2f1152c3";
  const resourceGroupName = process.env["ORBITAL_RESOURCE_GROUP"] || "contoso-Rgp";
  const contactProfileName = "CONTOSO-CP";
  const location = "eastus2";
  const networkConfiguration = {
    subnetId:
      "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet",
  };
  const links = [
    {
      name: "contoso-uplink",
      polarization: "LHCP",
      direction: "Uplink",
      gainOverTemperature: 0,
      eirpdBW: 45,
      channels: [
        {
          name: "contoso-uplink-channel",
          centerFrequencyMHz: 2250.0,
          bandwidthMHz: 2.0,
          endPoint: {
            ipAddress: "10.1.0.4",
            endPointName: "ContosoTest_Uplink",
            port: "50000",
            protocol: "TCP",
          },
        },
      ],
    },
    {
      name: "contoso-downlink",
      polarization: "RHCP",
      direction: "Downlink",
      gainOverTemperature: 25.0,
      eirpdBW: 0.0,
      channels: [
        {
          name: "contoso-downlink-channel",
          centerFrequencyMHz: 8160.0,
          bandwidthMHz: 15.0,
          endPoint: {
            ipAddress: "10.1.0.5",
            endPointName: "ContosoTest_Downlink",
            port: "50001",
            protocol: "UDP",
          },
        },
      ],
    },
  ];

  const credential = new DefaultAzureCredential();
  const client = new AzureOrbital(credential, subscriptionId);
  const result = await client.contactProfiles.beginCreateOrUpdateAndWait(
    resourceGroupName,
    contactProfileName,
    location,
    networkConfiguration,
    links
  );
  console.log(result);
}

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:

200

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

{
  "location": "eastus2",
  "tags": null,
  "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP",
  "name": "CONTOSO-CP",
  "type": "Microsoft.Orbital/contactProfiles",
  "properties": {
    "provisioningState": "updating",
    "minimumViableContactDuration": "PT1M",
    "minimumElevationDegrees": 5,
    "autoTrackingConfiguration": "disabled",
    "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub",
    "networkConfiguration": {
      "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"
    },
    "thirdPartyConfigurations": [
      {
        "providerName": "KSAT",
        "missionConfiguration": "Ksat_MissionConfiguration"
      },
      {
        "providerName": "VIASAT",
        "missionConfiguration": "Viasat_Configuration"
      }
    ],
    "links": [
      {
        "name": "contoso-uplink",
        "polarization": "LHCP",
        "direction": "Uplink",
        "gainOverTemperature": 0,
        "eirpdBW": 45,
        "channels": [
          {
            "name": "contoso-uplink-channel",
            "centerFrequencyMHz": 2250,
            "bandwidthMHz": 2,
            "endPoint": {
              "ipAddress": "10.1.0.4",
              "endPointName": "ContosoTest_Uplink",
              "port": "50000",
              "protocol": "TCP"
            },
            "modulationConfiguration": null,
            "demodulationConfiguration": null,
            "encodingConfiguration": null,
            "decodingConfiguration": null
          }
        ]
      },
      {
        "name": "contoso-downlink",
        "polarization": "RHCP",
        "direction": "Downlink",
        "gainOverTemperature": 25,
        "eirpdBW": 0,
        "channels": [
          {
            "name": "contoso-downlink-channel",
            "centerFrequencyMHz": 8160,
            "bandwidthMHz": 15,
            "endPoint": {
              "ipAddress": "10.1.0.5",
              "endPointName": "ContosoTest_Downlink",
              "port": "50001",
              "protocol": "UDP"
            },
            "modulationConfiguration": null,
            "demodulationConfiguration": null,
            "encodingConfiguration": null,
            "decodingConfiguration": null
          }
        ]
      }
    ]
  }
}

Status code:

201

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

{
  "location": "eastus2",
  "tags": null,
  "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP",
  "name": "CONTOSO-CP",
  "type": "Microsoft.Orbital/contactProfiles",
  "properties": {
    "provisioningState": "succeeded",
    "minimumViableContactDuration": "PT1M",
    "minimumElevationDegrees": 5,
    "autoTrackingConfiguration": "disabled",
    "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub",
    "networkConfiguration": {
      "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"
    },
    "thirdPartyConfigurations": [
      {
        "providerName": "KSAT",
        "missionConfiguration": "Ksat_MissionConfiguration"
      },
      {
        "providerName": "VIASAT",
        "missionConfiguration": "Viasat_Configuration"
      }
    ],
    "links": [
      {
        "name": "contoso-uplink",
        "polarization": "LHCP",
        "direction": "Uplink",
        "gainOverTemperature": 0,
        "eirpdBW": 45,
        "channels": [
          {
            "name": "contoso-uplink-channel",
            "centerFrequencyMHz": 2250,
            "bandwidthMHz": 2,
            "endPoint": {
              "ipAddress": "10.1.0.4",
              "endPointName": "ContosoTest_Uplink",
              "port": "50000",
              "protocol": "TCP"
            },
            "modulationConfiguration": null,
            "demodulationConfiguration": null,
            "encodingConfiguration": null,
            "decodingConfiguration": null
          }
        ]
      },
      {
        "name": "contoso-downlink",
        "polarization": "RHCP",
        "direction": "Downlink",
        "gainOverTemperature": 25,
        "eirpdBW": 0,
        "channels": [
          {
            "name": "contoso-downlink-channel",
            "centerFrequencyMHz": 8160,
            "bandwidthMHz": 15,
            "endPoint": {
              "ipAddress": "10.1.0.5",
              "endPointName": "ContosoTest_Downlink",
              "port": "50001",
              "protocol": "UDP"
            },
            "modulationConfiguration": null,
            "demodulationConfiguration": null,
            "encodingConfiguration": null,
            "decodingConfiguration": null
          }
        ]
      }
    ]
  }
}

Definitions

Name	Description
AutoTrackingConfiguration	Auto-tracking configuration.
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.
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.
systemData	Metadata pertaining to creation and last modification of the resource.

AutoTrackingConfiguration

Auto-tracking configuration.

Name	Type	Description
disabled	string
sBand	string
xBand	string

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	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.

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.

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.