contacts

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

Overview

Name	contacts
Type	Resource
Id	azure.orbital.contacts

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting Contact resource.

Name	Datatype	Description
properties	object	Properties of the Contact Resource.

list

Request successful. The operation returns a list of contacts by spacecraftName.

Name	Datatype	Description
properties	object	Properties of the Contact Resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, spacecraftName, contactName		Gets the specified contact in a specified resource group.
list	select	resourceGroupName, subscriptionId, spacecraftName	$skiptoken	Returns list of contacts by spacecraftName.
create	insert	resourceGroupName, subscriptionId, spacecraftName, contactName, data__properties		Creates a contact.
delete	delete	resourceGroupName, subscriptionId, spacecraftName, contactName		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
contactName	string	Contact name.
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 contact in a specified resource group.

SELECT
properties
FROM azure.orbital.contacts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND spacecraftName = '{{ spacecraftName }}' -- required
AND contactName = '{{ contactName }}' -- required
;

list

Returns list of contacts by spacecraftName.

SELECT
properties
FROM azure.orbital.contacts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND spacecraftName = '{{ spacecraftName }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create

Creates a contact.

INSERT INTO azure.orbital.contacts (
data__properties,
resourceGroupName,
subscriptionId,
spacecraftName,
contactName
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ spacecraftName }}',
'{{ contactName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: contacts
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the contacts resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the contacts resource.
    - name: spacecraftName
      value: string
      description: Required parameter for the contacts resource.
    - name: contactName
      value: string
      description: Required parameter for the contacts resource.
    - name: properties
      value: object
      description: |
        Properties of the Contact Resource.

DELETE examples

delete

Deletes a specified contact.

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