Spacecrafts - Create Or Update

Creates or updates a spacecraft resource.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}?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
location True

string

The geo-location where the resource lives

properties.links True

SpacecraftLink[]

Immutable list of Spacecraft links.

properties.titleLine True

string

Title line of the two-line element set (TLE).

properties.tleLine1 True

string

Line 1 of the two-line element set (TLE).

properties.tleLine2 True

string

Line 2 of the two-line element set (TLE).

properties.noradId

string

NORAD ID of the spacecraft.

properties.provisioningState

ProvisioningState

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

tags

object

Resource tags.

Responses

Name Type Description
200 OK

Spacecraft

Update successful. The operation returns the resulting spacecraft resource.

201 Created

Spacecraft

Create successful. The operation returns the resulting spacecraft resource.

Headers

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Examples

Create a spacecraft

Sample request

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

{
  "location": "eastus2",
  "properties": {
    "noradId": "36411",
    "titleLine": "CONTOSO_SAT",
    "tleLine1": "1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994",
    "tleLine2": "2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982",
    "links": [
      {
        "name": "uplink_lhcp1",
        "centerFrequencyMHz": 2250,
        "bandwidthMHz": 2,
        "direction": "Uplink",
        "polarization": "LHCP"
      },
      {
        "name": "downlink_rhcp1",
        "centerFrequencyMHz": 8160,
        "bandwidthMHz": 15,
        "direction": "Downlink",
        "polarization": "RHCP"
      }
    ]
  }
}

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/spacecrafts/CONTOSO_SAT",
  "name": "CONTOSO_SAT",
  "type": "Microsoft.Orbital/spacecrafts",
  "properties": {
    "provisioningState": "updating",
    "noradId": "36411",
    "titleLine": "CONTOSO_SAT",
    "tleLine1": "1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994",
    "tleLine2": "2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982",
    "links": [
      {
        "name": "uplink_lhcp1",
        "centerFrequencyMHz": 2250,
        "bandwidthMHz": 2,
        "direction": "Uplink",
        "polarization": "LHCP",
        "authorizations": [
          {
            "groundStation": "EASTUS2_0",
            "expirationDate": "2023-06-02"
          }
        ]
      },
      {
        "name": "downlink_rhcp1",
        "centerFrequencyMHz": 8160,
        "bandwidthMHz": 15,
        "direction": "Downlink",
        "polarization": "RHCP",
        "authorizations": [
          {
            "groundStation": "EASTUS2_0",
            "expirationDate": "2023-06-02"
          }
        ]
      }
    ]
  }
}
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/spacecrafts/CONTOSO_SAT",
  "name": "CONTOSO_SAT",
  "type": "Microsoft.Orbital/spacecrafts",
  "properties": {
    "provisioningState": "creating",
    "noradId": "36411",
    "titleLine": "CONTOSO_SAT",
    "tleLine1": "1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994",
    "tleLine2": "2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982",
    "links": [
      {
        "name": "uplink_lhcp1",
        "centerFrequencyMHz": 2250,
        "bandwidthMHz": 2,
        "direction": "Uplink",
        "polarization": "LHCP",
        "authorizations": [
          {
            "groundStation": "EASTUS2_0",
            "expirationDate": "2023-06-02"
          }
        ]
      },
      {
        "name": "downlink_rhcp1",
        "centerFrequencyMHz": 8160,
        "bandwidthMHz": 15,
        "direction": "Downlink",
        "polarization": "RHCP",
        "authorizations": [
          {
            "groundStation": "EASTUS2_0",
            "expirationDate": "2023-06-02"
          }
        ]
      }
    ]
  }
}

Definitions

Name Description
AuthorizedGroundstation

Authorized groundstation.

createdByType

The type of identity that created the resource.

direction

Direction (Uplink or Downlink).

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

polarization

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

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.

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

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.

polarization

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

Name Type Description
LHCP

string

RHCP

string

linearHorizontal

string

linearVertical

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"

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.