spacecrafts

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

Overview

Name	spacecrafts
Type	Resource
Id	azure_extras.orbital.spacecrafts

Fields

The following fields are returned by SELECT queries:

list_available_contacts

Name	Datatype	Description
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.
groundStationName	string	Name of Azure Ground Station.
maximumElevationDegrees	number	Maximum elevation of the antenna during the contact in decimal degrees.
rxEndTime	string (date-time)	Time to lost receiving a signal (ISO 8601 UTC standard).
rxStartTime	string (date-time)	Earliest time to receive a signal (ISO 8601 UTC standard).
spacecraft	object	The reference to the spacecraft resource.
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.
txEndTime	string (date-time)	Time at which antenna transmit will be disabled (ISO 8601 UTC standard).
txStartTime	string (date-time)	Time at which antenna transmit will be enabled (ISO 8601 UTC standard).

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.
links	array	Immutable list of Spacecraft links. Required.
location	string	The geo-location where the resource lives. Required.
noradId	string	NORAD ID of the spacecraft.
provisioningState	string	The current state of the resource's creation, deletion, or modification. Known values are: "creating", "succeeded", "failed", "canceled", "updating", and "deleting".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
titleLine	string	Title line of the two-line element set (TLE). Required.
tleLine1	string	Line 1 of the two-line element set (TLE). Required.
tleLine2	string	Line 2 of the two-line element set (TLE). Required.
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.
links	array	Immutable list of Spacecraft links. Required.
location	string	The geo-location where the resource lives. Required.
noradId	string	NORAD ID of the spacecraft.
provisioningState	string	The current state of the resource's creation, deletion, or modification. Known values are: "creating", "succeeded", "failed", "canceled", "updating", and "deleting".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
titleLine	string	Title line of the two-line element set (TLE). Required.
tleLine1	string	Line 1 of the two-line element set (TLE). Required.
tleLine2	string	Line 2 of the two-line element set (TLE). Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
links	array	Immutable list of Spacecraft links. Required.
location	string	The geo-location where the resource lives. Required.
noradId	string	NORAD ID of the spacecraft.
provisioningState	string	The current state of the resource's creation, deletion, or modification. Known values are: "creating", "succeeded", "failed", "canceled", "updating", and "deleting".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
titleLine	string	Title line of the two-line element set (TLE). Required.
tleLine1	string	Line 1 of the two-line element set (TLE). Required.
tleLine2	string	Line 2 of the two-line element set (TLE). Required.
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
list_available_contacts	select	resource_group_name, spacecraft_name, subscription_id		Returns list of available contacts. A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile.
get	select	resource_group_name, spacecraft_name, subscription_id		Gets the specified spacecraft in a specified resource group.
list	select	resource_group_name, subscription_id	$skiptoken	Returns list of spacecrafts by resource group.
list_by_subscription	select	subscription_id	$skiptoken	Returns list of spacecrafts by subscription.
create_or_update	insert	resource_group_name, spacecraft_name, subscription_id, name, centerFrequencyMHz, bandwidthMHz, direction, polarization		Creates or updates a spacecraft resource.
update_tags	update	resource_group_name, spacecraft_name, subscription_id		Updates the specified spacecraft tags.
create_or_update	replace	resource_group_name, spacecraft_name, subscription_id, name, centerFrequencyMHz, bandwidthMHz, direction, polarization		Creates or updates a spacecraft resource.
delete	delete	resource_group_name, spacecraft_name, subscription_id		Deletes a specified spacecraft resource.

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

list_available_contacts

Returns list of available contacts. A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile.

SELECT
endAzimuthDegrees,
endElevationDegrees,
groundStationName,
maximumElevationDegrees,
rxEndTime,
rxStartTime,
spacecraft,
startAzimuthDegrees,
startElevationDegrees,
txEndTime,
txStartTime
FROM azure_extras.orbital.spacecrafts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND spacecraft_name = '{{ spacecraft_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets the specified spacecraft in a specified resource group.

SELECT
id,
name,
links,
location,
noradId,
provisioningState,
systemData,
tags,
titleLine,
tleLine1,
tleLine2,
type
FROM azure_extras.orbital.spacecrafts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND spacecraft_name = '{{ spacecraft_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns list of spacecrafts by resource group.

SELECT
id,
name,
links,
location,
noradId,
provisioningState,
systemData,
tags,
titleLine,
tleLine1,
tleLine2,
type
FROM azure_extras.orbital.spacecrafts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

list_by_subscription

Returns list of spacecrafts by subscription.

SELECT
id,
name,
links,
location,
noradId,
provisioningState,
systemData,
tags,
titleLine,
tleLine1,
tleLine2,
type
FROM azure_extras.orbital.spacecrafts
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Creates or updates a spacecraft resource.

INSERT INTO azure_extras.orbital.spacecrafts (
name,
centerFrequencyMHz,
bandwidthMHz,
direction,
polarization,
resource_group_name,
spacecraft_name,
subscription_id
)
SELECT 
'{{ name }}' /* required */,
{{ centerFrequencyMHz }} /* required */,
{{ bandwidthMHz }} /* required */,
'{{ direction }}' /* required */,
'{{ polarization }}' /* required */,
'{{ resource_group_name }}',
'{{ spacecraft_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: spacecrafts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the spacecrafts resource.
  - name: spacecraft_name
    value: "{{ spacecraft_name }}"
    description: Required parameter for the spacecrafts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the spacecrafts resource.
  - name: name
    value: "{{ name }}"
    description: |
      Link name. Required.
  - name: centerFrequencyMHz
    value: {{ centerFrequencyMHz }}
    description: |
      Center Frequency in MHz. Required.
  - name: bandwidthMHz
    value: {{ bandwidthMHz }}
    description: |
      Bandwidth in MHz. Required.
  - name: direction
    value: "{{ direction }}"
    description: |
      Direction (Uplink or Downlink). Required. Known values are: "Uplink" and "Downlink".
  - name: polarization
    value: "{{ polarization }}"
    description: |
      Polarization. e.g. (RHCP, LHCP). Required. Known values are: "RHCP", "LHCP", "linearVertical", and "linearHorizontal".

UPDATE examples

update_tags

Updates the specified spacecraft tags.

UPDATE azure_extras.orbital.spacecrafts
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND spacecraft_name = '{{ spacecraft_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a spacecraft resource.

REPLACE azure_extras.orbital.spacecrafts
SET 
name = '{{ name }}',
centerFrequencyMHz = {{ centerFrequencyMHz }},
bandwidthMHz = {{ bandwidthMHz }},
direction = '{{ direction }}',
polarization = '{{ polarization }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND spacecraft_name = '{{ spacecraft_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND name = '{{ name }}' --required
AND centerFrequencyMHz = '{{ centerFrequencyMHz }}' --required
AND bandwidthMHz = '{{ bandwidthMHz }}' --required
AND direction = '{{ direction }}' --required
AND polarization = '{{ polarization }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a specified spacecraft resource.

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