Contacts - Create

Service:

Orbital

API Version:

2022-11-01

Creates a contact.

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

URI Parameters

Name	In	Required	Type	Description
contactName	path	True	string	Contact name.
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
properties.contactProfile	True	ContactProfile	The reference to the contact profile resource.
properties.groundStationName	True	string	Azure Ground Station name.
properties.reservationEndTime	True	string	Reservation end time of a contact (ISO 8601 UTC standard).
properties.reservationStartTime	True	string	Reservation start time of a contact (ISO 8601 UTC standard).
properties.provisioningState		ProvisioningState	The current state of the resource's creation, deletion, or modification.

Responses

Name	Type	Description
200 OK	Contact	OK.
201 Created	Contact	Create successful. The operation returns the resulting contact resource. Headers Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

Create a contact

Sample request

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

Sample response

Status code:

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

Status code:

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

Definitions

Name	Description
AntennaConfiguration	The configuration associated with the allocated antenna.
Contact	Customer creates a contact resource for a spacecraft resource.
ContactProfile	The reference to the contact profile resource.
ContactsStatus	Status of a contact.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProvisioningState	The current state of the resource's creation, deletion, or modification.
systemData	Metadata pertaining to creation and last modification of the resource.

AntennaConfiguration

The configuration associated with the allocated antenna.

Name	Type	Description
destinationIp	string	The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to.
sourceIps	string[]	List of Source IP

Contact

Customer creates a contact resource for a spacecraft resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.antennaConfiguration	AntennaConfiguration	The configuration associated with the allocated antenna.
properties.contactProfile	ContactProfile	The reference to the contact profile resource.
properties.endAzimuthDegrees	number	Azimuth of the antenna at the end of the contact in decimal degrees.
properties.endElevationDegrees	number	Spacecraft elevation above the horizon at contact end.
properties.errorMessage	string	Any error message while scheduling a contact.
properties.groundStationName	string	Azure Ground Station name.
properties.maximumElevationDegrees	number	Maximum elevation of the antenna during the contact in decimal degrees.
properties.provisioningState	ProvisioningState	The current state of the resource's creation, deletion, or modification.
properties.reservationEndTime	string	Reservation end time of a contact (ISO 8601 UTC standard).
properties.reservationStartTime	string	Reservation start time of a contact (ISO 8601 UTC standard).
properties.rxEndTime	string	Receive end time of a contact (ISO 8601 UTC standard).
properties.rxStartTime	string	Receive start time of a contact (ISO 8601 UTC standard).
properties.startAzimuthDegrees	number	Azimuth of the antenna at the start of the contact in decimal degrees.
properties.startElevationDegrees	number	Spacecraft elevation above the horizon at contact start.
properties.status	ContactsStatus	Status of a contact.
properties.txEndTime	string	Transmit end time of a contact (ISO 8601 UTC standard).
properties.txStartTime	string	Transmit start time of a contact (ISO 8601 UTC standard).
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ContactProfile

The reference to the contact profile resource.

Name	Type	Description
id	string	Resource ID.

ContactsStatus

Status of a contact.

Name	Type	Description
cancelled	string
failed	string
providerCancelled	string
scheduled	string
succeeded	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	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.

ProvisioningState

The current state of the resource's creation, deletion, or modification.

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.