accounts

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

Overview

Name	accounts
Type	Resource
Id	azure_extras.visual_studio.accounts

Fields

The following fields are returned by SELECT queries:

get

The operation succeeded. The response contains the details of the Visual Studio Team Services account resource.

Name	Datatype	Description
id	string	Unique identifier of the resource.
name	string	Resource name.
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

The operation succeeded. The response contains the details of the Visual Studio Team Services account resources linked to the Azure subscription.

Name	Datatype	Description
id	string	Unique identifier of the resource.
name	string	Resource name.
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, resourceName		Gets the Visual Studio Team Services account resource details.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all Visual Studio Team Services account resources under the resource group linked to the specified Azure subscription.
create_or_update	insert	resourceGroupName, subscriptionId, resourceName		Creates or updates a Visual Studio Team Services account resource.
update	update	resourceGroupName, subscriptionId, resourceName		Updates tags for Visual Studio Team Services account resource.
delete	delete	resourceGroupName, subscriptionId, resourceName		Deletes a Visual Studio Team Services account resource.
check_name_availability	exec	subscriptionId		Checks if the specified Visual Studio Team Services account name is available. Resource name can be either an account name or an account name and PUID.

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
resourceGroupName	string	Name of the resource group within the Azure subscription.
resourceName	string	Name of the resource.
subscriptionId	string	The Azure subscription identifier.

SELECT examples

get

Gets the Visual Studio Team Services account resource details.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_extras.visual_studio.accounts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

Gets all Visual Studio Team Services account resources under the resource group linked to the specified Azure subscription.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_extras.visual_studio.accounts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Visual Studio Team Services account resource.

INSERT INTO azure_extras.visual_studio.accounts (
data__accountName,
data__location,
data__operationType,
data__properties,
data__tags,
resourceGroupName,
subscriptionId,
resourceName
)
SELECT 
'{{ accountName }}',
'{{ location }}',
'{{ operationType }}',
'{{ properties }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ resourceName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: accounts
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the accounts resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the accounts resource.
    - name: resourceName
      value: string
      description: Required parameter for the accounts resource.
    - name: accountName
      value: string
      description: |
        The account name.
    - name: location
      value: string
      description: |
        The Azure instance location.
    - name: operationType
      value: string
      description: |
        The type of the operation.
      valid_values: ['unknown', 'create', 'update', 'link']
    - name: properties
      value: object
      description: |
        The custom properties of the resource.
    - name: tags
      value: object
      description: |
        The custom tags of the resource.

UPDATE examples

update

Updates tags for Visual Studio Team Services account resource.

UPDATE azure_extras.visual_studio.accounts
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a Visual Studio Team Services account resource.

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

Lifecycle Methods

check_name_availability

Checks if the specified Visual Studio Team Services account name is available. Resource name can be either an account name or an account name and PUID.

EXEC azure_extras.visual_studio.accounts.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"resourceName": "{{ resourceName }}", 
"resourceType": "{{ resourceType }}"
}'
;