Spacecrafts - Create Or Update

Service:

Orbital

API Version:

2022-11-01

Crea o aggiorna una risorsa spaziale.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
spacecraftName	path	True	string	ID veicolo spaziale.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui vive la risorsa
properties.links	True	SpacecraftLink[]	Elenco non modificabile dei collegamenti del veicolo spaziale.
properties.titleLine	True	string	Riga titolo del set di elementi a due righe (TLE).
properties.tleLine1	True	string	Riga 1 del set di elementi a due righe (TLE).
properties.tleLine2	True	string	Riga 2 del set di elementi a due righe (TLE).
properties.noradId		string	NORAD ID del veicolo spaziale.
properties.provisioningState		ProvisioningState	Stato corrente della creazione, eliminazione o modifica della risorsa.
tags		object	Tag di risorse.

Risposte

Nome	Tipo	Descrizione
200 OK	Spacecraft	Aggiornamento riuscito. L'operazione restituisce la risorsa del veicolo spaziale risultante.
201 Created	Spacecraft	Creare correttamente. L'operazione restituisce la risorsa del veicolo spaziale risultante. Headers Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Esempio

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

Response Body

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

Response Body

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

Definizioni

Nome	Descrizione
AuthorizedGroundstation	Stazione di terra autorizzata.
createdByType	Tipo di identità che ha creato la risorsa.
direction	Direzione (Uplink o Downlink).
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
polarization	Polarizzazione. ad esempio (RHCP, LHCP).
ProvisioningState	Stato corrente della creazione, eliminazione o modifica della risorsa.
Spacecraft	Il cliente crea una risorsa spaziale per pianificare un contatto.
SpacecraftLink	Elenco dei collegamenti di veicoli spaziali autorizzati per stazione di terra e la data di scadenza dell'autorizzazione.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

AuthorizedGroundstation

Stazione di terra autorizzata.

Nome	Tipo	Descrizione
expirationDate	string	Data di scadenza dell'autorizzazione.
groundStation	string	Nome della stazione di terra.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

direction

Direzione (Uplink o Downlink).

Nome	Tipo	Descrizione
Downlink	string
Uplink	string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

polarization

Polarizzazione. ad esempio (RHCP, LHCP).

Nome	Tipo	Descrizione
LHCP	string
RHCP	string
linearHorizontal	string
linearVertical	string

ProvisioningState

Stato corrente della creazione, eliminazione o modifica della risorsa.

Spacecraft

Il cliente crea una risorsa spaziale per pianificare un contatto.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui vive la risorsa
name	string	nome della risorsa.
properties.links	SpacecraftLink[]	Elenco non modificabile dei collegamenti del veicolo spaziale.
properties.noradId	string	NORAD ID del veicolo spaziale.
properties.provisioningState	ProvisioningState	Stato corrente della creazione, eliminazione o modifica della risorsa.
properties.titleLine	string	Riga titolo del set di elementi a due righe (TLE).
properties.tleLine1	string	Riga 1 del set di elementi a due righe (TLE).
properties.tleLine2	string	Riga 2 del set di elementi a due righe (TLE).
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createBy e modificateBy.
tags	object	Tag di risorse.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SpacecraftLink

Elenco dei collegamenti di veicoli spaziali autorizzati per stazione di terra e la data di scadenza dell'autorizzazione.

Nome	Tipo	Descrizione
authorizations	AuthorizedGroundstation[]	Stazioni di terra autorizzate
bandwidthMHz	number	Larghezza di banda in MHz.
centerFrequencyMHz	number	Frequenza centrale in MHz.
direction	direction	Direzione (Uplink o Downlink).
name	string	Nome collegamento.
polarization	polarization	Polarizzazione. ad esempio (RHCP, LHCP).

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.