Spacecrafts - Create Or Update

リファレンス

サービス:: Orbital

API バージョン:: 2022-11-01

宇宙船リソースを作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
spacecraftName	path	True	string	宇宙船 ID。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
location	True	string	リソースが保存されている地理的な場所
properties.links	True	SpacecraftLink[]	宇宙船リンクの不変リスト。
properties.titleLine	True	string	2 行要素セット (TLE) のタイトル行。
properties.tleLine1	True	string	2 行要素セット (TLE) の 1 行目。
properties.tleLine2	True	string	2 行要素セット (TLE) の 2 行目。
properties.noradId		string	宇宙船の NORAD ID。
properties.provisioningState		ProvisioningState	リソースの作成、削除、または変更の現在の状態。
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	Spacecraft	更新が成功しました。この操作は、結果の宇宙船リソースを返します。
201 Created	Spacecraft	正常に作成します。この操作は、結果の宇宙船リソースを返します。ヘッダー Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

Spacecraft

更新が成功しました。この操作は、結果の宇宙船リソースを返します。

201 Created

Spacecraft

正常に作成します。この操作は、結果の宇宙船リソースを返します。

ヘッダー

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

例

Create a spacecraft

要求のサンプル

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

応答のサンプル

状態コード:: 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"
          }
        ]
      }
    ]
  }
}

状態コード:: 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"
          }
        ]
      }
    ]
  }
}

定義

名前	説明
AuthorizedGroundstation	認可された地上局。
createdByType	リソースを作成した ID の種類。
direction	方向 (アップリンクまたはダウンリンク)。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
polarization	偏光。例: (RHCP、LHCP)。
ProvisioningState	リソースの作成、削除、または変更の現在の状態。
Spacecraft	顧客は、連絡先をスケジュールする宇宙船リソースを作成します。
SpacecraftLink	地上局ごとの認可された宇宙船リンクの一覧と認可の有効期限。
systemData	リソースの作成と最後の変更に関連するメタデータ。

AuthorizedGroundstation

認可された地上局。

名前	型	説明
expirationDate	string	承認の有効期限の日付。
groundStation	string	グランドステーション名。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

direction

方向 (アップリンクまたはダウンリンク)。

名前	型	説明
Downlink	string
Uplink	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

polarization

偏光。例: (RHCP、LHCP)。

名前	型	説明
LHCP	string
RHCP	string
linearHorizontal	string
linearVertical	string

ProvisioningState

リソースの作成、削除、または変更の現在の状態。

Spacecraft

顧客は、連絡先をスケジュールする宇宙船リソースを作成します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	リソースが保存されている地理的な場所
name	string	リソースの名前
properties.links	SpacecraftLink[]	宇宙船リンクの不変リスト。
properties.noradId	string	宇宙船の NORAD ID。
properties.provisioningState	ProvisioningState	リソースの作成、削除、または変更の現在の状態。
properties.titleLine	string	2 行要素セット (TLE) のタイトル行。
properties.tleLine1	string	2 行要素セット (TLE) の 1 行目。
properties.tleLine2	string	2 行要素セット (TLE) の 2 行目。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SpacecraftLink

地上局ごとの認可された宇宙船リンクの一覧と認可の有効期限。

名前	型	説明
authorizations	AuthorizedGroundstation[]	認可された地上局
bandwidthMHz	number	MHz の帯域幅。
centerFrequencyMHz	number	MHz の中心周波数。
direction	direction	方向 (アップリンクまたはダウンリンク)。
name	string	リンク名。
polarization	polarization	偏光。例: (RHCP、LHCP)。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Spacecrafts - Create Or Update

URI パラメーター

要求本文

応答

例

Create a spacecraft

要求のサンプル

応答のサンプル

定義

AuthorizedGroundstation

createdByType

direction

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

polarization

ProvisioningState

Spacecraft

SpacecraftLink

systemData

その他のリソース