artifacts

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

Overview

Name	artifacts
Type	Resource
Id	azure.blueprints.artifacts

Fields

The following fields are returned by SELECT queries:

get

OK -- blueprint artifact retrieved.

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
kind	string	Specifies the kind of blueprint artifact.
type	string	Type of this resource.

list

OK -- blueprint artifacts retrieved.

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
kind	string	Specifies the kind of blueprint artifact.
type	string	Type of this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceScope, blueprintName, artifactName		Get a blueprint artifact.
list	select	resourceScope, blueprintName		List artifacts for a given blueprint definition.
create_or_update	insert	resourceScope, blueprintName, artifactName, data__kind		Create or update blueprint artifact.
delete	delete	resourceScope, blueprintName, artifactName		Delete a blueprint artifact.

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
artifactName	string	Name of the blueprint artifact.
blueprintName	string	Name of the blueprint definition.
resourceScope	string	The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').

SELECT examples

get

Get a blueprint artifact.

SELECT
id,
name,
kind,
type
FROM azure.blueprints.artifacts
WHERE resourceScope = '{{ resourceScope }}' -- required
AND blueprintName = '{{ blueprintName }}' -- required
AND artifactName = '{{ artifactName }}' -- required
;

list

List artifacts for a given blueprint definition.

SELECT
id,
name,
kind,
type
FROM azure.blueprints.artifacts
WHERE resourceScope = '{{ resourceScope }}' -- required
AND blueprintName = '{{ blueprintName }}' -- required
;

INSERT examples

create_or_update

Create or update blueprint artifact.

INSERT INTO azure.blueprints.artifacts (
data__kind,
resourceScope,
blueprintName,
artifactName
)
SELECT 
'{{ kind }}' /* required */,
'{{ resourceScope }}',
'{{ blueprintName }}',
'{{ artifactName }}'
RETURNING
id,
name,
kind,
type
;

Manifest

# Description fields are for documentation purposes
- name: artifacts
  props:
    - name: resourceScope
      value: string
      description: Required parameter for the artifacts resource.
    - name: blueprintName
      value: string
      description: Required parameter for the artifacts resource.
    - name: artifactName
      value: string
      description: Required parameter for the artifacts resource.
    - name: kind
      value: string
      description: |
        Specifies the kind of blueprint artifact.
      valid_values: ['template', 'roleAssignment', 'policyAssignment']

DELETE examples

delete

Delete a blueprint artifact.

DELETE FROM azure.blueprints.artifacts
WHERE resourceScope = '{{ resourceScope }}' --required
AND blueprintName = '{{ blueprintName }}' --required
AND artifactName = '{{ artifactName }}' --required
;