profiles

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

Overview

Name	profiles
Type	Resource
Id	azure_extras.customer_insights.profiles

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the profile.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The profile type definition.
type	string	Resource type.

list_by_hub

OK. Successfully get all the profiles in the hub.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The profile type definition.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, hubName, profileName, subscriptionId	locale-code	Gets information about the specified profile.
list_by_hub	select	resourceGroupName, hubName, subscriptionId	locale-code	Gets all profile in the hub.
create_or_update	insert	resourceGroupName, hubName, profileName, subscriptionId		Creates a profile within a Hub, or updates an existing profile.
delete	delete	resourceGroupName, hubName, profileName, subscriptionId	locale-code	Deletes a profile within a hub

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
hubName	string	The name of the hub.
profileName	string	The name of the profile.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
locale-code	string	Locale of profile to retrieve, default is en-us.

SELECT examples

get

Gets information about the specified profile.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND locale-code = '{{ locale-code }}'
;

list_by_hub

Gets all profile in the hub.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND locale-code = '{{ locale-code }}'
;

INSERT examples

create_or_update

Creates a profile within a Hub, or updates an existing profile.

INSERT INTO azure_extras.customer_insights.profiles (
data__properties,
resourceGroupName,
hubName,
profileName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ hubName }}',
'{{ profileName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: profiles
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the profiles resource.
    - name: hubName
      value: string
      description: Required parameter for the profiles resource.
    - name: profileName
      value: string
      description: Required parameter for the profiles resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the profiles resource.
    - name: properties
      value: object
      description: |
        The profile type definition.

DELETE examples

delete

Deletes a profile within a hub

DELETE FROM azure_extras.customer_insights.profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND hubName = '{{ hubName }}' --required
AND profileName = '{{ profileName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND locale-code = '{{ locale-code }}'
;