published_blueprints
Creates, updates, deletes, gets or lists a published_blueprints
resource.
Overview
Name | published_blueprints |
Type | Resource |
Id | azure.blueprints.published_blueprints |
Fields
The following fields are returned by SELECT
queries:
- get
- list
OK -- published blueprint definition retrieved.
Name | Datatype | Description |
---|---|---|
id | string | String Id used to locate any resource on Azure. |
name | string | Name of this resource. |
properties | object | Detailed properties for published blueprint. |
type | string | Type of this resource. |
OK -- all published versions of blueprint definition retrieved.
Name | Datatype | Description |
---|---|---|
id | string | String Id used to locate any resource on Azure. |
name | string | Name of this resource. |
properties | object | Detailed properties for published blueprint. |
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 , versionId | Get a published version of a blueprint definition. | |
list | select | resourceScope , blueprintName | List published versions of given blueprint definition. | |
create | insert | resourceScope , blueprintName , versionId , data__properties | Publish a new version of the blueprint definition with the latest artifacts. Published blueprint definitions are immutable. | |
delete | delete | resourceScope , blueprintName , versionId | Delete a published version of a blueprint definition. |
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 |
---|---|---|
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}'). |
versionId | string | Version of the published blueprint definition. |
SELECT
examples
- get
- list
Get a published version of a blueprint definition.
SELECT
id,
name,
properties,
type
FROM azure.blueprints.published_blueprints
WHERE resourceScope = '{{ resourceScope }}' -- required
AND blueprintName = '{{ blueprintName }}' -- required
AND versionId = '{{ versionId }}' -- required
;
List published versions of given blueprint definition.
SELECT
id,
name,
properties,
type
FROM azure.blueprints.published_blueprints
WHERE resourceScope = '{{ resourceScope }}' -- required
AND blueprintName = '{{ blueprintName }}' -- required
;
INSERT
examples
- create
- Manifest
Publish a new version of the blueprint definition with the latest artifacts. Published blueprint definitions are immutable.
INSERT INTO azure.blueprints.published_blueprints (
data__properties,
resourceScope,
blueprintName,
versionId
)
SELECT
'{{ properties }}' /* required */,
'{{ resourceScope }}',
'{{ blueprintName }}',
'{{ versionId }}'
RETURNING
id,
name,
properties,
type
;
# Description fields are for documentation purposes
- name: published_blueprints
props:
- name: resourceScope
value: string
description: Required parameter for the published_blueprints resource.
- name: blueprintName
value: string
description: Required parameter for the published_blueprints resource.
- name: versionId
value: string
description: Required parameter for the published_blueprints resource.
- name: properties
value: object
description: |
Detailed properties for published blueprint.
DELETE
examples
- delete
Delete a published version of a blueprint definition.
DELETE FROM azure.blueprints.published_blueprints
WHERE resourceScope = '{{ resourceScope }}' --required
AND blueprintName = '{{ blueprintName }}' --required
AND versionId = '{{ versionId }}' --required
;