Contacts - Create

Referência

Service:: Orbital

API Version:: 2022-11-01

Cria um contacto.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
contactName	path	True	string	Nome do contacto.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
spacecraftName	path	True	string	ID da nave espacial.
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.contactProfile	True	ContactProfile	A referência ao recurso do perfil de contacto.
properties.groundStationName	True	string	Nome da Estação Terrestre do Azure.
properties.reservationEndTime	True	string	Hora de fim da reserva de um contacto (NORMA ISO 8601 UTC).
properties.reservationStartTime	True	string	Hora de início da reserva de um contacto (NORMA ISO 8601 UTC).
properties.provisioningState		ProvisioningState	O estado atual da criação, eliminação ou modificação do recurso.

Respostas

Name	Tipo	Description
200 OK	Contact	OK.
201 Created	Contact	Crie com êxito. A operação devolve o recurso de contacto resultante. Headers Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Name

Tipo

Description

200 OK

Contact

OK.

201 Created

Contact

Crie com êxito. A operação devolve o recurso de contacto resultante.

Headers

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

Create a contact

Sample Request

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

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

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

Response Body

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

Definições

Name	Description
AntennaConfiguration	A configuração associada à antena alocada.
Contact	O cliente cria um recurso de contacto para um recurso de nave espacial.
ContactProfile	A referência ao recurso do perfil de contacto.
ContactsStatus	Estado de um contacto.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
ProvisioningState	O estado atual da criação, eliminação ou modificação do recurso.
systemData	Metadados relativos à criação e última modificação do recurso.

AntennaConfiguration

A configuração associada à antena alocada.

Name	Tipo	Description
destinationIp	string	O IP de destino para o qual um pacote pode ser enviado. Este seria, por exemplo, o ponto final TCP para o qual enviaria dados.
sourceIps	string[]	Lista de IP de Origem

Contact

O cliente cria um recurso de contacto para um recurso de nave espacial.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.antennaConfiguration	AntennaConfiguration	A configuração associada à antena alocada.
properties.contactProfile	ContactProfile	A referência ao recurso do perfil de contacto.
properties.endAzimuthDegrees	number	Azimuth da antena no final do contacto em graus decimais.
properties.endElevationDegrees	number	Elevação de naves espaciais acima do horizonte no final do contacto.
properties.errorMessage	string	Qualquer mensagem de erro ao agendar um contacto.
properties.groundStationName	string	Nome da Estação Terrestre do Azure.
properties.maximumElevationDegrees	number	Elevação máxima da antena durante o contacto em graus decimais.
properties.provisioningState	ProvisioningState	O estado atual da criação, eliminação ou modificação do recurso.
properties.reservationEndTime	string	Hora de fim da reserva de um contacto (NORMA ISO 8601 UTC).
properties.reservationStartTime	string	Hora de início da reserva de um contacto (NORMA ISO 8601 UTC).
properties.rxEndTime	string	Receber a hora de fim de um contacto (NORMA ISO 8601 UTC).
properties.rxStartTime	string	Receber a hora de início de um contacto (NORMA ISO 8601 UTC).
properties.startAzimuthDegrees	number	Azimuth da antena no início do contacto em graus decimais.
properties.startElevationDegrees	number	Elevação de naves espaciais acima do horizonte no início do contacto.
properties.status	ContactsStatus	Estado de um contacto.
properties.txEndTime	string	Transmitir a hora de fim de um contacto (norma ISO 8601 UTC).
properties.txStartTime	string	Transmita a hora de início de um contacto (norma ISO 8601 UTC).
systemData	systemData	O Azure Resource Manager metadados que contêm informações createdBy e modifiedBy.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ContactProfile

A referência ao recurso do perfil de contacto.

Name	Tipo	Description
id	string	ID do Recurso.

ContactsStatus

Estado de um contacto.

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

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ProvisioningState

O estado atual da criação, eliminação ou modificação do recurso.

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Contacts - Create

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Create a contact

Sample Request

Sample Response

Definições

AntennaConfiguration

Contact

ContactProfile

ContactsStatus

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

systemData

Recursos adicionais