contact_profiles

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

Overview

Name	contact_profiles
Type	Resource
Id	azure.orbital.contact_profiles

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting ContactProfile resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	List of Contact Profile Resource Properties.
tags	object	Resource tags.

list

Request successful. The operation returns a list of contact profile resources.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	List of Contact Profile Resource Properties.
tags	object	Resource tags.

list_by_subscription

Request successful. The operation returns a list of contact profile resources.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	List of Contact Profile Resource 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, contactProfileName		Gets the specified contact Profile in a specified resource group.
list	select	resourceGroupName, subscriptionId	$skiptoken	Returns list of contact profiles by Resource Group.
list_by_subscription	select	subscriptionId	$skiptoken	Returns list of contact profiles by Subscription.
create_or_update	insert	resourceGroupName, subscriptionId, contactProfileName, data__properties		Creates or updates a contact profile.
delete	delete	resourceGroupName, subscriptionId, contactProfileName		Deletes a specified contact profile resource.
update_tags	exec	resourceGroupName, subscriptionId, contactProfileName		Updates the specified contact profile 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
contactProfileName	string	Contact Profile name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
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 Profile in a specified resource group.

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

list

Returns list of contact profiles by Resource Group.

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

list_by_subscription

Returns list of contact profiles by Subscription.

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

INSERT examples

create_or_update

Creates or updates a contact profile.

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

Manifest

# Description fields are for documentation purposes
- name: contact_profiles
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the contact_profiles resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the contact_profiles resource.
    - name: contactProfileName
      value: string
      description: Required parameter for the contact_profiles resource.
    - name: properties
      value: object
      description: |
        List of Contact Profile Resource 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 contact profile resource.

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

Lifecycle Methods

update_tags

Updates the specified contact profile tags.

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