Contacts - Create

Referencia

Servicio:: Orbital

Versión de la API:: 2022-11-01

Crea un contacto.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
contactName	path	True	string	Nombre del contacto.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
spacecraftName	path	True	string	Id. de nave espacial.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.contactProfile	True	ContactProfile	Referencia al recurso de perfil de contacto.
properties.groundStationName	True	string	Nombre de la estación terrestre de Azure.
properties.reservationEndTime	True	string	Hora de finalización de la reserva de un contacto (estándar ISO 8601 UTC).
properties.reservationStartTime	True	string	Hora de inicio de la reserva de un contacto (estándar ISO 8601 UTC).
properties.provisioningState		ProvisioningState	Estado actual de la creación, eliminación o modificación del recurso.

Respuestas

Nombre	Tipo	Description
200 OK	Contact	Aceptar.
201 Created	Contact	Cree correctamente. La operación devuelve el recurso de contacto resultante. Encabezados Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Nombre

Tipo

Description

200 OK

Contact

Aceptar.

201 Created

Contact

Cree correctamente. La operación devuelve el recurso de contacto resultante.

Encabezados

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Ejemplos

Create a contact

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
AntennaConfiguration	Configuración asociada a la antena asignada.
Contact	El cliente crea un recurso de contacto para un recurso de nave espacial.
ContactProfile	Referencia al recurso de perfil de contacto.
ContactsStatus	Estado de un contacto.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ProvisioningState	Estado actual de la creación, eliminación o modificación del recurso.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

AntennaConfiguration

Configuración asociada a la antena asignada.

Nombre	Tipo	Description
destinationIp	string	Dirección IP de destino a la que se puede enviar un paquete. Por ejemplo, sería el punto de conexión TCP al que enviaría datos.
sourceIps	string[]	Lista de direcciones IP de origen

Contact

El cliente crea un recurso de contacto para un recurso de nave espacial.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.antennaConfiguration	AntennaConfiguration	Configuración asociada a la antena asignada.
properties.contactProfile	ContactProfile	Referencia al recurso de perfil de contacto.
properties.endAzimuthDegrees	number	Azimuth de la antena al final del contacto en grados decimales.
properties.endElevationDegrees	number	Elevación de la nave espacial por encima del horizonte al final del contacto.
properties.errorMessage	string	Cualquier mensaje de error al programar un contacto.
properties.groundStationName	string	Nombre de la estación terrestre de Azure.
properties.maximumElevationDegrees	number	Elevación máxima de la antena durante el contacto en grados decimales.
properties.provisioningState	ProvisioningState	Estado actual de la creación, eliminación o modificación del recurso.
properties.reservationEndTime	string	Hora de finalización de la reserva de un contacto (estándar ISO 8601 UTC).
properties.reservationStartTime	string	Hora de inicio de la reserva de un contacto (estándar ISO 8601 UTC).
properties.rxEndTime	string	Recibe la hora de finalización de un contacto (estándar ISO 8601 UTC).
properties.rxStartTime	string	Recibe la hora de inicio de un contacto (estándar ISO 8601 UTC).
properties.startAzimuthDegrees	number	Azimuth de la antena al principio del contacto en grados decimales.
properties.startElevationDegrees	number	Elevación de la nave espacial por encima del horizonte en el inicio del contacto.
properties.status	ContactsStatus	Estado de un contacto.
properties.txEndTime	string	Transmitir la hora de finalización de un contacto (estándar ISO 8601 UTC).
properties.txStartTime	string	Transmitir la hora de inicio de un contacto (estándar UTC ISO 8601).
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ContactProfile

Referencia al recurso de perfil de contacto.

Nombre	Tipo	Description
id	string	Identificador del recurso.

ContactsStatus

Estado de un contacto.

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

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ProvisioningState

Estado actual de la creación, eliminación o modificación del recurso.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Contacts - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Create a contact

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AntennaConfiguration

Contact

ContactProfile

ContactsStatus

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

systemData

Recursos adicionales