Spacecrafts - Create Or Update

參考

Service:: Orbital

API Version:: 2022-11-01

建立或更新新資源。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
spacecraftName	path	True	string	新月標識碼。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源所在的地理位置
properties.links	True	SpacecraftLink[]	不可變的連結清單。
properties.titleLine	True	string	兩行專案集的標題行 (TLE) 。
properties.tleLine1	True	string	兩行元素集的第 1 行 (TLE) 。
properties.tleLine2	True	string	兩行元素集的第 2 行 (TLE) 。
properties.noradId		string	NORAD 識別碼。
properties.provisioningState		ProvisioningState	資源的建立、刪除或修改目前狀態。
tags		object	資源標籤。

回應

名稱	類型	Description
200 OK	Spacecraft	更新成功。此作業會傳回產生的擷取資源。
201 Created	Spacecraft	建立成功。此作業會傳回產生的擷取資源。 Headers Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

名稱

類型

Description

200 OK

Spacecraft

更新成功。此作業會傳回產生的擷取資源。

201 Created

Spacecraft

建立成功。此作業會傳回產生的擷取資源。

Headers

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

範例

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

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

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

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

定義

名稱	Description
AuthorizedGroundstation	授權的地面站。
createdByType	建立資源的身分識別類型。
direction	上行 (或下行連結) 方向。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
polarization	極化。例如 (RHCP、LHCP) 。
ProvisioningState	資源的建立、刪除或修改目前狀態。
Spacecraft	客戶會建立一個排程聯繫人的預約資源。
SpacecraftLink	每個地面站的授權連結清單和授權的到期日。
systemData	與建立和上次修改資源相關的元數據。

AuthorizedGroundstation

授權的地面站。

名稱	類型	Description
expirationDate	string	授權到期日。
groundStation	string	地面站名稱。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

direction

上行 (或下行連結) 方向。

名稱	類型	Description
Downlink	string
Uplink	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

polarization

極化。例如 (RHCP、LHCP) 。

名稱	類型	Description
LHCP	string
RHCP	string
linearHorizontal	string
linearVertical	string

ProvisioningState

資源的建立、刪除或修改目前狀態。

Spacecraft

客戶會建立一個排程聯繫人的預約資源。

名稱	類型	Description
id	string	資源的完整資源識別碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	資源所在的地理位置
name	string	資源的名稱
properties.links	SpacecraftLink[]	不可變的連結清單。
properties.noradId	string	NORAD 識別碼。
properties.provisioningState	ProvisioningState	資源的建立、刪除或修改目前狀態。
properties.titleLine	string	兩行專案集的標題行 (TLE) 。
properties.tleLine1	string	兩行元素集的第 1 行 (TLE) 。
properties.tleLine2	string	兩行元素集的第 2 行 (TLE) 。
systemData	systemData	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
tags	object	資源標籤。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SpacecraftLink

每個地面站的授權連結清單和授權的到期日。

名稱	類型	Description
authorizations	AuthorizedGroundstation[]	授權的地面站
bandwidthMHz	number	MHz 中的頻寬。
centerFrequencyMHz	number	MHz 中的中心頻率。
direction	direction	上行 (或下行連結) 方向。
name	string	連結名稱。
polarization	polarization	極化。例如 (RHCP、LHCP) 。

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

共用方式為

Spacecrafts - Create Or Update

URI 參數

要求本文

回應

範例

Create a spacecraft

Sample Request

Sample Response

定義

AuthorizedGroundstation

createdByType

direction

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

polarization

ProvisioningState

Spacecraft

SpacecraftLink

systemData

其他資源