Spacecrafts - Create Or Update

Service:

Orbital

API Version:

2022-11-01

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

HTTP

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

Java

import com.azure.resourcemanager.orbital.models.Direction;
import com.azure.resourcemanager.orbital.models.Polarization;
import com.azure.resourcemanager.orbital.models.SpacecraftLink;
import java.util.Arrays;

/**
 * Samples for Spacecrafts CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftCreate.json
     */
    /**
     * Sample code: Create a spacecraft.
     * 
     * @param manager Entry point to OrbitalManager.
     */
    public static void createASpacecraft(com.azure.resourcemanager.orbital.OrbitalManager manager) {
        manager.spacecrafts().define("CONTOSO_SAT").withRegion("eastus2").withExistingResourceGroup("contoso-Rgp")
            .withTitleLine("CONTOSO_SAT")
            .withTleLine1("1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994")
            .withTleLine2("2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982")
            .withLinks(Arrays.asList(
                new SpacecraftLink().withName("uplink_lhcp1").withCenterFrequencyMHz(2250f).withBandwidthMHz(2f)
                    .withDirection(Direction.UPLINK).withPolarization(Polarization.LHCP),
                new SpacecraftLink().withName("downlink_rhcp1").withCenterFrequencyMHz(8160f).withBandwidthMHz(15f)
                    .withDirection(Direction.DOWNLINK).withPolarization(Polarization.RHCP)))
            .withNoradId("36411").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/SpacecraftCreate.json
func ExampleSpacecraftsClient_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.NewSpacecraftsClient().BeginCreateOrUpdate(ctx, "contoso-Rgp", "CONTOSO_SAT", armorbital.Spacecraft{
		Location: to.Ptr("eastus2"),
		Properties: &armorbital.SpacecraftsProperties{
			Links: []*armorbital.SpacecraftLink{
				{
					Name:               to.Ptr("uplink_lhcp1"),
					BandwidthMHz:       to.Ptr[float32](2),
					CenterFrequencyMHz: to.Ptr[float32](2250),
					Direction:          to.Ptr(armorbital.DirectionUplink),
					Polarization:       to.Ptr(armorbital.PolarizationLHCP),
				},
				{
					Name:               to.Ptr("downlink_rhcp1"),
					BandwidthMHz:       to.Ptr[float32](15),
					CenterFrequencyMHz: to.Ptr[float32](8160),
					Direction:          to.Ptr(armorbital.DirectionDownlink),
					Polarization:       to.Ptr(armorbital.PolarizationRHCP),
				}},
			NoradID:   to.Ptr("36411"),
			TitleLine: to.Ptr("CONTOSO_SAT"),
			TleLine1:  to.Ptr("1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994"),
			TleLine2:  to.Ptr("2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982"),
		},
	}, 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.Spacecraft = armorbital.Spacecraft{
	// 	Name: to.Ptr("CONTOSO_SAT"),
	// 	Type: to.Ptr("Microsoft.Orbital/spacecrafts"),
	// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"),
	// 	Location: to.Ptr("eastus2"),
	// 	Properties: &armorbital.SpacecraftsProperties{
	// 		Links: []*armorbital.SpacecraftLink{
	// 			{
	// 				Name: to.Ptr("uplink_lhcp1"),
	// 				Authorizations: []*armorbital.AuthorizedGroundstation{
	// 					{
	// 						ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
	// 						GroundStation: to.Ptr("EASTUS2_0"),
	// 				}},
	// 				BandwidthMHz: to.Ptr[float32](2),
	// 				CenterFrequencyMHz: to.Ptr[float32](2250),
	// 				Direction: to.Ptr(armorbital.DirectionUplink),
	// 				Polarization: to.Ptr(armorbital.PolarizationLHCP),
	// 			},
	// 			{
	// 				Name: to.Ptr("downlink_rhcp1"),
	// 				Authorizations: []*armorbital.AuthorizedGroundstation{
	// 					{
	// 						ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
	// 						GroundStation: to.Ptr("EASTUS2_0"),
	// 				}},
	// 				BandwidthMHz: to.Ptr[float32](15),
	// 				CenterFrequencyMHz: to.Ptr[float32](8160),
	// 				Direction: to.Ptr(armorbital.DirectionDownlink),
	// 				Polarization: to.Ptr(armorbital.PolarizationRHCP),
	// 		}},
	// 		NoradID: to.Ptr("36411"),
	// 		ProvisioningState: to.Ptr(armorbital.SpacecraftsPropertiesProvisioningState("Succeeded")),
	// 		TitleLine: to.Ptr("CONTOSO_SAT"),
	// 		TleLine1: to.Ptr("1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994"),
	// 		TleLine2: to.Ptr("2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982"),
	// 	},
	// }
}

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 spacecraft resource.
 *
 * @summary Creates or updates a spacecraft resource.
 * x-ms-original-file: specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftCreate.json
 */
async function createASpacecraft() {
  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 location = "eastus2";
  const titleLine = "CONTOSO_SAT";
  const tleLine1 = "1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994";
  const tleLine2 = "2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982";
  const links = [
    {
      name: "uplink_lhcp1",
      centerFrequencyMHz: 2250.0,
      bandwidthMHz: 2.0,
      direction: "Uplink",
      polarization: "LHCP",
    },
    {
      name: "downlink_rhcp1",
      centerFrequencyMHz: 8160.0,
      bandwidthMHz: 15.0,
      direction: "Downlink",
      polarization: "RHCP",
    },
  ];
  const credential = new DefaultAzureCredential();
  const client = new AzureOrbital(credential, subscriptionId);
  const result = await client.spacecrafts.beginCreateOrUpdateAndWait(
    resourceGroupName,
    spacecraftName,
    location,
    titleLine,
    tleLine1,
    tleLine2,
    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/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"
          }
        ]
      }
    ]
  }
}

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/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"

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.