accounts

Creates, updates, deletes, gets or lists an accounts resource.

Overview

Name	accounts
Type	Resource
Id	azure_extras.intelligent_recommendations.accounts

Fields

The following fields are returned by SELECT queries:

get

Account details.

Name	Datatype	Description
identity	object	The identity used for the resource.
location	string	The geo-location where the resource lives
properties	object	Account resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_resource_group

Account resources list.

Name	Datatype	Description
identity	object	The identity used for the resource.
location	string	The geo-location where the resource lives
properties	object	Account resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_subscription

Account resources list.

Name	Datatype	Description
identity	object	The identity used for the resource.
location	string	The geo-location where the resource lives
properties	object	Account resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName		Returns RecommendationsService Account resource for a given name.
list_by_resource_group	select	subscriptionId, resourceGroupName		Returns list of RecommendationsService Account resources.
list_by_subscription	select	subscriptionId		Returns list of RecommendationsService Account resources.
create_or_update	insert	subscriptionId, resourceGroupName, accountName		Creates or updates RecommendationsService Account resource.
update	update	subscriptionId, resourceGroupName, accountName		Updates RecommendationsService Account details.
delete	delete	subscriptionId, resourceGroupName, accountName		Deletes RecommendationsService Account resource.
check_name_availability	exec	subscriptionId		Checks that the RecommendationsService Account name is valid and is not already in use.

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

SELECT examples

get

Returns RecommendationsService Account resource for a given name.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure_extras.intelligent_recommendations.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

list_by_resource_group

Returns list of RecommendationsService Account resources.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure_extras.intelligent_recommendations.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Returns list of RecommendationsService Account resources.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure_extras.intelligent_recommendations.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates RecommendationsService Account resource.

INSERT INTO azure_extras.intelligent_recommendations.accounts (
data__tags,
data__location,
data__properties,
data__identity,
subscriptionId,
resourceGroupName,
accountName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}'
RETURNING
identity,
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: accounts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the accounts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the accounts resource.
    - name: accountName
      value: string
      description: Required parameter for the accounts resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Account resource properties.
    - name: identity
      value: object
      description: |
        The identity used for the resource.

UPDATE examples

update

Updates RecommendationsService Account details.

UPDATE azure_extras.intelligent_recommendations.accounts
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
RETURNING
identity,
location,
properties,
systemData,
tags;

DELETE examples

delete

Deletes RecommendationsService Account resource.

DELETE FROM azure_extras.intelligent_recommendations.accounts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
;

Lifecycle Methods

check_name_availability

Checks that the RecommendationsService Account name is valid and is not already in use.

EXEC azure_extras.intelligent_recommendations.accounts.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;