Contacts - Create

リファレンス

サービス:: Orbital

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

連絡先を作成します。

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

URI パラメーター

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

要求本文

名前	必須	型	説明
properties.contactProfile	True	ContactProfile	連絡先プロファイルリソースへの参照。
properties.groundStationName	True	string	Azure グラウンドステーション名。
properties.reservationEndTime	True	string	連絡先の予約終了時刻 (ISO 8601 UTC 標準)。
properties.reservationStartTime	True	string	連絡先の予約開始時刻 (ISO 8601 UTC 標準)。
properties.provisioningState		ProvisioningState	リソースの作成、削除、または変更の現在の状態。

応答

名前	型	説明
200 OK	Contact	OK です。
201 Created	Contact	正常に作成されます。操作は、結果の連絡先リソースを返します。ヘッダー Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

Contact

OK です。

201 Created

Contact

正常に作成されます。操作は、結果の連絡先リソースを返します。

ヘッダー

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

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

例

Create a contact

要求のサンプル

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

{
  "properties": {
    "reservationStartTime": "2023-02-22T10:58:30Z",
    "reservationEndTime": "2023-02-22T11:10:45Z",
    "groundStationName": "EASTUS2_0",
    "contactProfile": {
      "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
    }
  }
}

import com.azure.resourcemanager.orbital.models.ContactsPropertiesContactProfile;
import java.time.OffsetDateTime;

/** Samples for Contacts Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactCreate.json
     */
    /**
     * Sample code: Create a contact.
     *
     * @param manager Entry point to OrbitalManager.
     */
    public static void createAContact(com.azure.resourcemanager.orbital.OrbitalManager manager) {
        manager
            .contacts()
            .define("contact1")
            .withExistingSpacecraft("contoso-Rgp", "CONTOSO_SAT")
            .withReservationStartTime(OffsetDateTime.parse("2023-02-22T10:58:30Z"))
            .withReservationEndTime(OffsetDateTime.parse("2023-02-22T11:10:45Z"))
            .withGroundStationName("EASTUS2_0")
            .withContactProfile(
                new ContactsPropertiesContactProfile()
                    .withId(
                        "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.orbital import AzureOrbital

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-orbital
# USAGE
    python contact_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureOrbital(
        credential=DefaultAzureCredential(),
        subscription_id="c1be1141-a7c9-4aac-9608-3c2e2f1152c3",
    )

    response = client.contacts.begin_create(
        resource_group_name="contoso-Rgp",
        spacecraft_name="CONTOSO_SAT",
        contact_name="contact1",
        parameters={
            "properties": {
                "contactProfile": {
                    "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
                },
                "groundStationName": "EASTUS2_0",
                "reservationEndTime": "2023-02-22T11:10:45Z",
                "reservationStartTime": "2023-02-22T10:58:30Z",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactCreate.json
if __name__ == "__main__":
    main()

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"

	"time"

	"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/ContactCreate.json
func ExampleContactsClient_BeginCreate() {
	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.NewContactsClient().BeginCreate(ctx, "contoso-Rgp", "CONTOSO_SAT", "contact1", armorbital.Contact{
		Properties: &armorbital.ContactsProperties{
			ContactProfile: &armorbital.ContactsPropertiesContactProfile{
				ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
			},
			GroundStationName:    to.Ptr("EASTUS2_0"),
			ReservationEndTime:   to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T11:10:45.000Z"); return t }()),
			ReservationStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T10:58:30.000Z"); return t }()),
		},
	}, 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.Contact = armorbital.Contact{
	// 	Name: to.Ptr("contact1"),
	// 	Type: to.Ptr("Microsoft.Orbital/spacecrafts/contacts"),
	// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1"),
	// 	Properties: &armorbital.ContactsProperties{
	// 		ContactProfile: &armorbital.ContactsPropertiesContactProfile{
	// 			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
	// 		},
	// 		EndAzimuthDegrees: to.Ptr[float32](345.848482),
	// 		EndElevationDegrees: to.Ptr[float32](5.048656),
	// 		GroundStationName: to.Ptr("EASTUS2_0"),
	// 		MaximumElevationDegrees: to.Ptr[float32](85.9796),
	// 		ReservationEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T11:10:45.000Z"); return t}()),
	// 		ReservationStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T10:58:30.000Z"); return t}()),
	// 		RxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T11:10:45.000Z"); return t}()),
	// 		RxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T10:58:30.000Z"); return t}()),
	// 		StartAzimuthDegrees: to.Ptr[float32](165.758896),
	// 		StartElevationDegrees: to.Ptr[float32](5),
	// 		Status: to.Ptr(armorbital.ContactsStatusScheduled),
	// 		TxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T11:10:45.000Z"); return t}()),
	// 		TxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T10:58:30.000Z"); return t}()),
	// 	},
	// }
}

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 a contact.
 *
 * @summary Creates a contact.
 * x-ms-original-file: specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactCreate.json
 */
async function createAContact() {
  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 contactName = "contact1";
  const parameters = {
    contactProfile: {
      id: "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP",
    },
    groundStationName: "EASTUS2_0",
    reservationEndTime: new Date("2023-02-22T11:10:45Z"),
    reservationStartTime: new Date("2023-02-22T10:58:30Z"),
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureOrbital(credential, subscriptionId);
  const result = await client.contacts.beginCreateAndWait(
    resourceGroupName,
    spacecraftName,
    contactName,
    parameters
  );
  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

{
  "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1",
  "name": "contact1",
  "type": "Microsoft.Orbital/spacecrafts/contacts",
  "properties": {
    "status": "scheduled",
    "reservationStartTime": "2023-02-22T10:58:30Z",
    "reservationEndTime": "2023-02-22T11:10:45Z",
    "errorMessage": null,
    "groundStationName": "EASTUS2_0",
    "contactProfile": {
      "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
    },
    "antennaConfiguration": null,
    "maximumElevationDegrees": 85.9796,
    "txStartTime": "2023-02-22T10:58:30Z",
    "txEndTime": "2023-02-22T11:10:45Z",
    "rxStartTime": "2023-02-22T10:58:30Z",
    "rxEndTime": "2023-02-22T11:10:45Z",
    "startAzimuthDegrees": 165.758896,
    "endAzimuthDegrees": 345.848482,
    "startElevationDegrees": 5,
    "endElevationDegrees": 5.048656
  }
}

状態コード:: 201

Azure-AsyncOperation: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01

{
  "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1",
  "name": "contact1",
  "type": "Microsoft.Orbital/spacecrafts/contacts",
  "properties": {
    "status": "scheduled",
    "reservationStartTime": "2023-02-22T10:58:30Z",
    "reservationEndTime": "2023-02-22T11:10:45Z",
    "errorMessage": null,
    "groundStationName": "EASTUS2_0",
    "contactProfile": {
      "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
    },
    "antennaConfiguration": null,
    "maximumElevationDegrees": 0,
    "txStartTime": null,
    "txEndTime": null,
    "rxStartTime": null,
    "rxEndTime": null,
    "startAzimuthDegrees": 0,
    "endAzimuthDegrees": 0,
    "startElevationDegrees": 0,
    "endElevationDegrees": 0
  }
}

定義

名前	説明
AntennaConfiguration	割り当てられたアンテナに関連付けられている構成。
Contact	顧客は宇宙船リソースの連絡先リソースを作成します。
ContactProfile	連絡先プロファイルリソースへの参照。
ContactsStatus	連絡先の状態。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ProvisioningState	リソースの作成、削除、または変更の現在の状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。

AntennaConfiguration

割り当てられたアンテナに関連付けられている構成。

名前	型	説明
destinationIp	string	パケットの送信先 IP。たとえば、データを送信する TCP エンドポイントです。
sourceIps	string[]	ソース IP の一覧

Contact

顧客は宇宙船リソースの連絡先リソースを作成します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.antennaConfiguration	AntennaConfiguration	割り当てられたアンテナに関連付けられている構成。
properties.contactProfile	ContactProfile	連絡先プロファイルリソースへの参照。
properties.endAzimuthDegrees	number	接触の終点にあるアンテナの方位角 (10 進度)。
properties.endElevationDegrees	number	接触端の水平線の上の宇宙船の標高。
properties.errorMessage	string	連絡先のスケジュール中のエラーメッセージ。
properties.groundStationName	string	Azure グラウンドステーション名。
properties.maximumElevationDegrees	number	接触時のアンテナの最大標高 (10 進度)。
properties.provisioningState	ProvisioningState	リソースの作成、削除、または変更の現在の状態。
properties.reservationEndTime	string	連絡先の予約終了時刻 (ISO 8601 UTC 標準)。
properties.reservationStartTime	string	連絡先の予約開始時刻 (ISO 8601 UTC 標準)。
properties.rxEndTime	string	連絡先の終了時刻を受け取ります (ISO 8601 UTC 標準)。
properties.rxStartTime	string	連絡先の開始時刻を受け取ります (ISO 8601 UTC 標準)。
properties.startAzimuthDegrees	number	接触の開始時のアンテナの方位角 (10 進度)。
properties.startElevationDegrees	number	接触開始時の水平線の上の宇宙船の標高。
properties.status	ContactsStatus	連絡先の状態。
properties.txEndTime	string	連絡先の送信終了時刻 (ISO 8601 UTC 標準)。
properties.txStartTime	string	連絡先の送信開始時刻 (ISO 8601 UTC 標準)。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ContactProfile

連絡先プロファイルリソースへの参照。

名前	型	説明
id	string	リソースの ID

ContactsStatus

連絡先の状態。

名前	型	説明
cancelled	string
failed	string
providerCancelled	string
scheduled	string
succeeded	string

createdByType

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

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

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

ProvisioningState

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

systemData

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

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

次の方法で共有

Contacts - Create

URI パラメーター

要求本文

応答

例

Create a contact

要求のサンプル

応答のサンプル

定義

AntennaConfiguration

Contact

ContactProfile

ContactsStatus

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

systemData

その他のリソース