blueprints
Creates, updates, deletes, gets or lists a blueprints
resource.
Overview
Name | blueprints |
Type | Resource |
Id | azure.blueprints.blueprints |
Fields
- vw_blueprints
- blueprints
Name | Datatype | Description |
---|---|---|
id | text | String Id used to locate any resource on Azure. |
name | text | Name of this resource. |
blueprintName | text | field from the properties object |
layout | text | field from the properties object |
parameters | text | field from the properties object |
resourceScope | text | field from the properties object |
resource_groups | text | field from the properties object |
status | text | field from the properties object |
target_scope | text | field from the properties object |
type | text | Type of this resource. |
versions | text | field from the properties object |
Name | Datatype | Description |
---|---|---|
id | string | String Id used to locate any resource on Azure. |
name | string | Name of this resource. |
properties | object | Schema for blueprint definition properties. |
type | string | Type of this resource. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | blueprintName, resourceScope | Get a blueprint definition. |
list | SELECT | resourceScope | List blueprint definitions. |
create_or_update | INSERT | blueprintName, resourceScope, data__properties | Create or update a blueprint definition. |
delete | DELETE | blueprintName, resourceScope | Delete a blueprint definition. |
SELECT
examples
List blueprint definitions.
- vw_blueprints
- blueprints
SELECT
id,
name,
blueprintName,
layout,
parameters,
resourceScope,
resource_groups,
status,
target_scope,
type,
versions
FROM azure.blueprints.vw_blueprints
WHERE resourceScope = '{{ resourceScope }}';
SELECT
id,
name,
properties,
type
FROM azure.blueprints.blueprints
WHERE resourceScope = '{{ resourceScope }}';
INSERT
example
Use the following StackQL query and manifest file to create a new blueprints
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.blueprints.blueprints (
blueprintName,
resourceScope,
data__properties,
properties
)
SELECT
'{{ blueprintName }}',
'{{ resourceScope }}',
'{{ data__properties }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: id
value: string
- name: type
value: string
- name: name
value: string
- name: properties
value:
- name: status
value:
- name: timeCreated
value: string
- name: lastModified
value: string
- name: targetScope
value: string
- name: parameters
value: object
- name: resourceGroups
value: object
- name: versions
value: object
- name: layout
value: object
DELETE
example
Deletes the specified blueprints
resource.
/*+ delete */
DELETE FROM azure.blueprints.blueprints
WHERE blueprintName = '{{ blueprintName }}'
AND resourceScope = '{{ resourceScope }}';