contacts

Creates, updates, deletes, gets or lists a contacts resource.

Overview

Name	contacts
Type	Resource
Id	azure_extras.orbital.contacts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	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.
antennaConfiguration	object	The configuration associated with the allocated antenna.
contactProfile	object	The reference to the contact profile resource. Required.
endAzimuthDegrees	number	Azimuth of the antenna at the end of the contact in decimal degrees.
endElevationDegrees	number	Spacecraft elevation above the horizon at contact end.
errorMessage	string	Any error message while scheduling a contact.
groundStationName	string	Azure Ground Station name. Required.
maximumElevationDegrees	number	Maximum elevation of the antenna during the contact in decimal degrees.
provisioningState	string	The current state of the resource's creation, deletion, or modification. Known values are: "creating", "succeeded", "failed", "canceled", "updating", and "deleting".
reservationEndTime	string (date-time)	Reservation end time of a contact (ISO 8601 UTC standard). Required.
reservationStartTime	string (date-time)	Reservation start time of a contact (ISO 8601 UTC standard). Required.
rxEndTime	string (date-time)	Receive end time of a contact (ISO 8601 UTC standard).
rxStartTime	string (date-time)	Receive start time of a contact (ISO 8601 UTC standard).
startAzimuthDegrees	number	Azimuth of the antenna at the start of the contact in decimal degrees.
startElevationDegrees	number	Spacecraft elevation above the horizon at contact start.
status	string	Status of a contact. Known values are: "scheduled", "cancelled", "succeeded", "failed", and "providerCancelled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
txEndTime	string (date-time)	Transmit end time of a contact (ISO 8601 UTC standard).
txStartTime	string (date-time)	Transmit start time of a contact (ISO 8601 UTC standard).
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	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.
antennaConfiguration	object	The configuration associated with the allocated antenna.
contactProfile	object	The reference to the contact profile resource. Required.
endAzimuthDegrees	number	Azimuth of the antenna at the end of the contact in decimal degrees.
endElevationDegrees	number	Spacecraft elevation above the horizon at contact end.
errorMessage	string	Any error message while scheduling a contact.
groundStationName	string	Azure Ground Station name. Required.
maximumElevationDegrees	number	Maximum elevation of the antenna during the contact in decimal degrees.
provisioningState	string	The current state of the resource's creation, deletion, or modification. Known values are: "creating", "succeeded", "failed", "canceled", "updating", and "deleting".
reservationEndTime	string (date-time)	Reservation end time of a contact (ISO 8601 UTC standard). Required.
reservationStartTime	string (date-time)	Reservation start time of a contact (ISO 8601 UTC standard). Required.
rxEndTime	string (date-time)	Receive end time of a contact (ISO 8601 UTC standard).
rxStartTime	string (date-time)	Receive start time of a contact (ISO 8601 UTC standard).
startAzimuthDegrees	number	Azimuth of the antenna at the start of the contact in decimal degrees.
startElevationDegrees	number	Spacecraft elevation above the horizon at contact start.
status	string	Status of a contact. Known values are: "scheduled", "cancelled", "succeeded", "failed", and "providerCancelled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
txEndTime	string (date-time)	Transmit end time of a contact (ISO 8601 UTC standard).
txStartTime	string (date-time)	Transmit start time of a contact (ISO 8601 UTC standard).
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, spacecraft_name, contact_name, subscription_id		Gets the specified contact in a specified resource group.
list	select	resource_group_name, spacecraft_name, subscription_id	$skiptoken	Returns list of contacts by spacecraftName.
create	insert	resource_group_name, spacecraft_name, contact_name, subscription_id, properties		Creates a contact.
delete	delete	resource_group_name, spacecraft_name, contact_name, subscription_id		Deletes a specified contact.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
contact_name	string	Contact name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
spacecraft_name	string	Spacecraft ID. Required.
subscription_id	string
$skiptoken	string	An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Default value is None.

SELECT examples

get

Gets the specified contact in a specified resource group.

SELECT
id,
name,
antennaConfiguration,
contactProfile,
endAzimuthDegrees,
endElevationDegrees,
errorMessage,
groundStationName,
maximumElevationDegrees,
provisioningState,
reservationEndTime,
reservationStartTime,
rxEndTime,
rxStartTime,
startAzimuthDegrees,
startElevationDegrees,
status,
systemData,
txEndTime,
txStartTime,
type
FROM azure_extras.orbital.contacts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND spacecraft_name = '{{ spacecraft_name }}' -- required
AND contact_name = '{{ contact_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns list of contacts by spacecraftName.

SELECT
id,
name,
antennaConfiguration,
contactProfile,
endAzimuthDegrees,
endElevationDegrees,
errorMessage,
groundStationName,
maximumElevationDegrees,
provisioningState,
reservationEndTime,
reservationStartTime,
rxEndTime,
rxStartTime,
startAzimuthDegrees,
startElevationDegrees,
status,
systemData,
txEndTime,
txStartTime,
type
FROM azure_extras.orbital.contacts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND spacecraft_name = '{{ spacecraft_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create

Creates a contact.

INSERT INTO azure_extras.orbital.contacts (
properties,
resource_group_name,
spacecraft_name,
contact_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ spacecraft_name }}',
'{{ contact_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: contacts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the contacts resource.
  - name: spacecraft_name
    value: "{{ spacecraft_name }}"
    description: Required parameter for the contacts resource.
  - name: contact_name
    value: "{{ contact_name }}"
    description: Required parameter for the contacts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the contacts resource.
  - name: properties
    value:
      provisioningState: "{{ provisioningState }}"
      reservationStartTime: "{{ reservationStartTime }}"
      reservationEndTime: "{{ reservationEndTime }}"
      groundStationName: "{{ groundStationName }}"
      contactProfile:
        id: "{{ id }}"

DELETE examples

delete

Deletes a specified contact.

DELETE FROM azure_extras.orbital.contacts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND spacecraft_name = '{{ spacecraft_name }}' --required
AND contact_name = '{{ contact_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;