build_service_builder

Creates, updates, deletes, gets or lists a build_service_builder resource.

Overview

Name	build_service_builder
Type	Resource
Id	azure_extras.app_platform.build_service_builder

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
buildpackGroups	array	Builder buildpack groups.
provisioningState	string	Builder provision status. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
stack	object	Builder cluster stack property.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
buildpackGroups	array	Builder buildpack groups.
provisioningState	string	Builder provision status. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
stack	object	Builder cluster stack property.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, build_service_name, builder_name, subscription_id		Get a KPack builder.
list	select	resource_group_name, service_name, build_service_name, subscription_id		List KPack builders result.
create_or_update	insert	resource_group_name, service_name, build_service_name, builder_name, subscription_id		Create or update a KPack builder.
create_or_update	replace	resource_group_name, service_name, build_service_name, builder_name, subscription_id		Create or update a KPack builder.
delete	delete	resource_group_name, service_name, build_service_name, builder_name, subscription_id		Delete a KPack builder.
list_deployments	exec	resource_group_name, service_name, build_service_name, builder_name, subscription_id		List deployments that are using the builder.

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
build_service_name	string	The name of the build service resource. Required.
builder_name	string	The name of the builder resource. Required.
resource_group_name	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string

SELECT examples

get

Get a KPack builder.

SELECT
id,
name,
buildpackGroups,
provisioningState,
stack,
systemData,
type
FROM azure_extras.app_platform.build_service_builder
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND build_service_name = '{{ build_service_name }}' -- required
AND builder_name = '{{ builder_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List KPack builders result.

SELECT
id,
name,
buildpackGroups,
provisioningState,
stack,
systemData,
type
FROM azure_extras.app_platform.build_service_builder
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND build_service_name = '{{ build_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a KPack builder.

INSERT INTO azure_extras.app_platform.build_service_builder (
properties,
resource_group_name,
service_name,
build_service_name,
builder_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ build_service_name }}',
'{{ builder_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: build_service_builder
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the build_service_builder resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the build_service_builder resource.
  - name: build_service_name
    value: "{{ build_service_name }}"
    description: Required parameter for the build_service_builder resource.
  - name: builder_name
    value: "{{ builder_name }}"
    description: Required parameter for the build_service_builder resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the build_service_builder resource.
  - name: properties
    description: |
      Property of the Builder resource.
    value:
      provisioningState: "{{ provisioningState }}"
      stack:
        id: "{{ id }}"
        version: "{{ version }}"
      buildpackGroups:
        - name: "{{ name }}"
          buildpacks: "{{ buildpacks }}"

REPLACE examples

create_or_update

Create or update a KPack builder.

REPLACE azure_extras.app_platform.build_service_builder
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND build_service_name = '{{ build_service_name }}' --required
AND builder_name = '{{ builder_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a KPack builder.

DELETE FROM azure_extras.app_platform.build_service_builder
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND build_service_name = '{{ build_service_name }}' --required
AND builder_name = '{{ builder_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_deployments

List deployments that are using the builder.

EXEC azure_extras.app_platform.build_service_builder.list_deployments 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@build_service_name='{{ build_service_name }}' --required, 
@builder_name='{{ builder_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;