extensions

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

Overview

Name	extensions
Type	Resource
Id	azure_extras.visual_studio.extensions

Fields

The following fields are returned by SELECT queries:

get

The operation succeeded. The response contains the extension resource details for the specified account.

Name	Datatype	Description
id	string	Unique identifier of the resource.
name	string	Resource name.
location	string	Resource location.
plan	object	The extension plan that was purchased.
properties	object	Resource properties.
tags	object	Resource tags.
type	string	Resource type.

list_by_account

The operation succeeded. The response contains all extension resource details for the specified account.

Name	Datatype	Description
id	string	Unique identifier of the resource.
name	string	Resource name.
location	string	Resource location.
plan	object	The extension plan that was purchased.
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, accountResourceName, extensionResourceName		Gets the details of an extension associated with a Visual Studio Team Services account resource.
list_by_account	select	resourceGroupName, subscriptionId, accountResourceName		Gets the details of the extension resources created within the resource group.
create	insert	resourceGroupName, subscriptionId, accountResourceName, extensionResourceName		Registers the extension with a Visual Studio Team Services account.
update	update	resourceGroupName, subscriptionId, accountResourceName, extensionResourceName		Updates an existing extension registration for the Visual Studio Team Services account.
delete	delete	resourceGroupName, subscriptionId, accountResourceName, extensionResourceName		Removes an extension resource registration for a Visual Studio Team Services account.

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
accountResourceName	string	The name of the Visual Studio Team Services account resource.
extensionResourceName	string	The name of the extension.
resourceGroupName	string	Name of the resource group within the Azure subscription.
subscriptionId	string	The Azure subscription identifier.

SELECT examples

get

Gets the details of an extension associated with a Visual Studio Team Services account resource.

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

list_by_account

Gets the details of the extension resources created within the resource group.

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

INSERT examples

create

Registers the extension with a Visual Studio Team Services account.

INSERT INTO azure_extras.visual_studio.extensions (
data__location,
data__plan,
data__properties,
data__tags,
resourceGroupName,
subscriptionId,
accountResourceName,
extensionResourceName
)
SELECT 
'{{ location }}',
'{{ plan }}',
'{{ properties }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ accountResourceName }}',
'{{ extensionResourceName }}'
RETURNING
id,
name,
location,
plan,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: extensions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the extensions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the extensions resource.
    - name: accountResourceName
      value: string
      description: Required parameter for the extensions resource.
    - name: extensionResourceName
      value: string
      description: Required parameter for the extensions resource.
    - name: location
      value: string
      description: |
        The Azure region of the Visual Studio account associated with this request (i.e 'southcentralus'.)
    - name: plan
      value: object
      description: |
        Extended information about the plan being purchased for this extension resource.
    - name: properties
      value: object
      description: |
        A dictionary of extended properties. This property is currently unused.
    - name: tags
      value: object
      description: |
        A dictionary of user-defined tags to be stored with the extension resource.

UPDATE examples

update

Updates an existing extension registration for the Visual Studio Team Services account.

UPDATE azure_extras.visual_studio.extensions
SET 
data__location = '{{ location }}',
data__plan = '{{ plan }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND accountResourceName = '{{ accountResourceName }}' --required
AND extensionResourceName = '{{ extensionResourceName }}' --required
RETURNING
id,
name,
location,
plan,
properties,
tags,
type;

DELETE examples

delete

Removes an extension resource registration for a Visual Studio Team Services account.

DELETE FROM azure_extras.visual_studio.extensions
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND accountResourceName = '{{ accountResourceName }}' --required
AND extensionResourceName = '{{ extensionResourceName }}' --required
;