artifact_sources

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

Overview

Name	artifact_sources
Type	Resource
Id	azure.dev_test_labs.artifact_sources

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
armTemplateFolderPath	string	The folder containing Azure Resource Manager templates.
branchRef	string	The artifact source's branch reference.
createdDate	string (date-time)	The artifact source's creation date.
displayName	string	The artifact source's display name.
folderPath	string	The folder containing artifacts.
location	string	The location of the resource.
provisioningState	string	The provisioning status of the resource.
securityToken	string	The security token to authenticate to the artifact source.
sourceType	string	The artifact source's type. Known values are: "VsoGit", "GitHub", and "StorageAccount".
status	string	Indicates if the artifact source is enabled (values: Enabled, Disabled). Known values are: "Enabled" and "Disabled".
tags	object	The tags of the resource.
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
uri	string	The artifact source's URI.

list

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
armTemplateFolderPath	string	The folder containing Azure Resource Manager templates.
branchRef	string	The artifact source's branch reference.
createdDate	string (date-time)	The artifact source's creation date.
displayName	string	The artifact source's display name.
folderPath	string	The folder containing artifacts.
location	string	The location of the resource.
provisioningState	string	The provisioning status of the resource.
securityToken	string	The security token to authenticate to the artifact source.
sourceType	string	The artifact source's type. Known values are: "VsoGit", "GitHub", and "StorageAccount".
status	string	Indicates if the artifact source is enabled (values: Enabled, Disabled). Known values are: "Enabled" and "Disabled".
tags	object	The tags of the resource.
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
uri	string	The artifact source's URI.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, lab_name, name, subscription_id	$expand	Get artifact source.
list	select	resource_group_name, lab_name, subscription_id	$expand, $filter, $top, $orderby	List artifact sources in a given lab.
create_or_update	insert	resource_group_name, lab_name, name, subscription_id		Create or replace an existing artifact source.
update	update	resource_group_name, lab_name, name, subscription_id		Allows modifying tags of artifact sources. All other properties will be ignored.
create_or_update	replace	resource_group_name, lab_name, name, subscription_id		Create or replace an existing artifact source.
delete	delete	resource_group_name, lab_name, name, subscription_id		Delete artifact source.

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
lab_name	string	The name of the lab. Required.
name	string	The name of the artifact source. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
$expand	string	Specify the $expand query. Example: 'properties($select=displayName)'. Default value is None.
$filter	string	The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.
$orderby	string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get artifact source.

SELECT
id,
name,
armTemplateFolderPath,
branchRef,
createdDate,
displayName,
folderPath,
location,
provisioningState,
securityToken,
sourceType,
status,
tags,
type,
uniqueIdentifier,
uri
FROM azure.dev_test_labs.artifact_sources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

List artifact sources in a given lab.

SELECT
id,
name,
armTemplateFolderPath,
branchRef,
createdDate,
displayName,
folderPath,
location,
provisioningState,
securityToken,
sourceType,
status,
tags,
type,
uniqueIdentifier,
uri
FROM azure.dev_test_labs.artifact_sources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create_or_update

Create or replace an existing artifact source.

INSERT INTO azure.dev_test_labs.artifact_sources (
location,
tags,
properties,
resource_group_name,
lab_name,
name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ lab_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: artifact_sources
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the artifact_sources resource.
  - name: lab_name
    value: "{{ lab_name }}"
    description: Required parameter for the artifact_sources resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the artifact_sources resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the artifact_sources resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the resource.
  - name: properties
    value:
      displayName: "{{ displayName }}"
      uri: "{{ uri }}"
      sourceType: "{{ sourceType }}"
      folderPath: "{{ folderPath }}"
      armTemplateFolderPath: "{{ armTemplateFolderPath }}"
      branchRef: "{{ branchRef }}"
      securityToken: "{{ securityToken }}"
      status: "{{ status }}"

UPDATE examples

update

Allows modifying tags of artifact sources. All other properties will be ignored.

UPDATE azure.dev_test_labs.artifact_sources
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Create or replace an existing artifact source.

REPLACE azure.dev_test_labs.artifact_sources
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete artifact source.

DELETE FROM azure.dev_test_labs.artifact_sources
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;