spacecrafts

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

Overview

Name	spacecrafts
Type	Resource
Id	azure.orbital.spacecrafts

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting Spacecraft resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Spacecraft Properties
tags	object	Resource tags.

list

Request successful. The operation returns a list of spacecraft resources.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Spacecraft Properties
tags	object	Resource tags.

list_by_subscription

Request successful. The operation returns a list of spacecraft resources.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Spacecraft Properties
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, spacecraftName		Gets the specified spacecraft in a specified resource group.
list	select	resourceGroupName, subscriptionId	$skiptoken	Returns list of spacecrafts by resource group.
list_by_subscription	select	subscriptionId	$skiptoken	Returns list of spacecrafts by subscription.
create_or_update	insert	resourceGroupName, subscriptionId, spacecraftName, data__properties		Creates or updates a spacecraft resource.
delete	delete	resourceGroupName, subscriptionId, spacecraftName		Deletes a specified spacecraft resource.
update_tags	exec	resourceGroupName, subscriptionId, spacecraftName		Updates the specified spacecraft tags.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
spacecraftName	string	Spacecraft ID.
subscriptionId	string	The ID of the target subscription.
$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.

SELECT examples

get

Gets the specified spacecraft in a specified resource group.

SELECT
location,
properties,
tags
FROM azure.orbital.spacecrafts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND spacecraftName = '{{ spacecraftName }}' -- required
;

list

Returns list of spacecrafts by resource group.

SELECT
location,
properties,
tags
FROM azure.orbital.spacecrafts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

list_by_subscription

Returns list of spacecrafts by subscription.

SELECT
location,
properties,
tags
FROM azure.orbital.spacecrafts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Creates or updates a spacecraft resource.

INSERT INTO azure.orbital.spacecrafts (
data__properties,
data__tags,
data__location,
resourceGroupName,
subscriptionId,
spacecraftName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ spacecraftName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: spacecrafts
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the spacecrafts resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the spacecrafts resource.
    - name: spacecraftName
      value: string
      description: Required parameter for the spacecrafts resource.
    - name: properties
      value: object
      description: |
        Spacecraft Properties
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

Deletes a specified spacecraft resource.

DELETE FROM azure.orbital.spacecrafts
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND spacecraftName = '{{ spacecraftName }}' --required
;

Lifecycle Methods

update_tags

Updates the specified spacecraft tags.

EXEC azure.orbital.spacecrafts.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@spacecraftName='{{ spacecraftName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;