Contact Profiles - Create Or Update

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

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"
            }
          }
        ]
      }
    ]
  }
}

Sample response

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
          }
        ]
      }
    ]
  }
}
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"

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.