contact_profiles

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

Overview

Name	contact_profiles
Type	Resource
Id	azure_extras.orbital.contact_profiles

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.
autoTrackingConfiguration	string	Auto-tracking configuration. Known values are: "disabled", "xBand", and "sBand".
eventHubUri	string	ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub.
links	array	Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. Required.
location	string	The geo-location where the resource lives. Required.
minimumElevationDegrees	number	Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station.
minimumViableContactDuration	string	Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station.
networkConfiguration	object	Network configuration of customer virtual network. Required.
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.
thirdPartyConfigurations	array	Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
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.
autoTrackingConfiguration	string	Auto-tracking configuration. Known values are: "disabled", "xBand", and "sBand".
eventHubUri	string	ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub.
links	array	Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. Required.
location	string	The geo-location where the resource lives. Required.
minimumElevationDegrees	number	Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station.
minimumViableContactDuration	string	Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station.
networkConfiguration	object	Network configuration of customer virtual network. Required.
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.
thirdPartyConfigurations	array	Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
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.
autoTrackingConfiguration	string	Auto-tracking configuration. Known values are: "disabled", "xBand", and "sBand".
eventHubUri	string	ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub.
links	array	Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. Required.
location	string	The geo-location where the resource lives. Required.
minimumElevationDegrees	number	Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station.
minimumViableContactDuration	string	Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station.
networkConfiguration	object	Network configuration of customer virtual network. Required.
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.
thirdPartyConfigurations	array	Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
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, contact_profile_name, subscription_id		Gets the specified contact Profile in a specified resource group.
list	select	resource_group_name, subscription_id	$skiptoken	Returns list of contact profiles by Resource Group.
list_by_subscription	select	subscription_id	$skiptoken	Returns list of contact profiles by Subscription.
create_or_update	insert	resource_group_name, contact_profile_name, subscription_id, subnetId		Creates or updates a contact profile.
update_tags	update	resource_group_name, contact_profile_name, subscription_id		Updates the specified contact profile tags.
create_or_update	replace	resource_group_name, contact_profile_name, subscription_id, subnetId		Creates or updates a contact profile.
delete	delete	resource_group_name, contact_profile_name, subscription_id		Deletes a specified contact profile 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
contact_profile_name	string	Contact Profile name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. 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 Profile in a specified resource group.

SELECT
id,
name,
autoTrackingConfiguration,
eventHubUri,
links,
location,
minimumElevationDegrees,
minimumViableContactDuration,
networkConfiguration,
provisioningState,
systemData,
tags,
thirdPartyConfigurations,
type
FROM azure_extras.orbital.contact_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND contact_profile_name = '{{ contact_profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns list of contact profiles by Resource Group.

SELECT
id,
name,
autoTrackingConfiguration,
eventHubUri,
links,
location,
minimumElevationDegrees,
minimumViableContactDuration,
networkConfiguration,
provisioningState,
systemData,
tags,
thirdPartyConfigurations,
type
FROM azure_extras.orbital.contact_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

list_by_subscription

Returns list of contact profiles by Subscription.

SELECT
id,
name,
autoTrackingConfiguration,
eventHubUri,
links,
location,
minimumElevationDegrees,
minimumViableContactDuration,
networkConfiguration,
provisioningState,
systemData,
tags,
thirdPartyConfigurations,
type
FROM azure_extras.orbital.contact_profiles
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Creates or updates a contact profile.

INSERT INTO azure_extras.orbital.contact_profiles (
subnetId,
resource_group_name,
contact_profile_name,
subscription_id
)
SELECT 
'{{ subnetId }}' /* required */,
'{{ resource_group_name }}',
'{{ contact_profile_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: contact_profiles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the contact_profiles resource.
  - name: contact_profile_name
    value: "{{ contact_profile_name }}"
    description: Required parameter for the contact_profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the contact_profiles resource.
  - name: subnetId
    value: "{{ subnetId }}"
    description: |
      ARM resource identifier of the subnet delegated to the Microsoft.Orbital/orbitalGateways. Needs to be at least a class C subnet, and should not have any IP created in it. Required.

UPDATE examples

update_tags

Updates the specified contact profile tags.

UPDATE azure_extras.orbital.contact_profiles
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND contact_profile_name = '{{ contact_profile_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 contact profile.

REPLACE azure_extras.orbital.contact_profiles
SET 
subnetId = '{{ subnetId }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND contact_profile_name = '{{ contact_profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND subnetId = '{{ subnetId }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a specified contact profile resource.

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