build_service

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

Overview

Name	build_service
Type	Resource
Id	azure_extras.app_platform.build_service

Fields

The following fields are returned by SELECT queries:

get_build_result

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
buildPodName	string	The build pod name which can be used to get the build log streaming.
buildStages	array	All of the build stage (init-container and container) resources in build pod.
error	object	Error when build is failed.
image	string	The container registry image of this build result.
provisioningState	string	Provisioning state of the KPack build result. Known values are: "Queuing", "Building", "Succeeded", "Failed", and "Deleting".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list_build_results

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
buildPodName	string	The build pod name which can be used to get the build log streaming.
buildStages	array	All of the build stage (init-container and container) resources in build pod.
error	object	Error when build is failed.
image	string	The container registry image of this build result.
provisioningState	string	Provisioning state of the KPack build result. Known values are: "Queuing", "Building", "Succeeded", "Failed", and "Deleting".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

get_supported_buildpack

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
buildpackId	string	The id of supported buildpack.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

get_supported_stack

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
stackId	string	The id of supported stack.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.
version	string	The version of supported stack.

list_builds

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
agentPool	string	The resource id of agent pool.
apms	array	The APMs for this build.
builder	string	The resource id of builder to build the source code.
certificates	array	The CA Certificates for this build.
env	object	The environment variables for this build.
provisioningState	string	Provisioning state of the KPack build result. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
relativePath	string	The relative path of source code.
resourceRequests	object	The customized build resource for this build.
systemData	object	Metadata pertaining to creation and last modification of the resource.
triggeredBuildResult	object	The build result triggered by this build.
type	string	The type of the resource.

list_build_services

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
containerRegistry	string	The resource id of the container registry used in this build service.
kPackVersion	string	The installed KPack version in this build service.
provisioningState	string	Provisioning state of the KPack build service. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
resourceRequests	object	The runtime resource configuration of this build service.
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_build_result	select	resource_group_name, service_name, build_service_name, build_name, build_result_name, subscription_id		Get a KPack build result.
list_build_results	select	resource_group_name, service_name, build_service_name, build_name, subscription_id		List KPack build results.
get_supported_buildpack	select	resource_group_name, service_name, build_service_name, buildpack_name, subscription_id		Get the supported buildpack resource.
get_supported_stack	select	resource_group_name, service_name, build_service_name, stack_name, subscription_id		Get the supported stack resource.
list_builds	select	resource_group_name, service_name, build_service_name, subscription_id		List KPack builds.
list_build_services	select	resource_group_name, service_name, subscription_id		List build services resource.
create_or_update_build	insert	resource_group_name, service_name, build_service_name, build_name, subscription_id		Create or update a KPack build.
create_or_update	insert	resource_group_name, service_name, build_service_name, subscription_id		Create a build service resource.
create_or_update_build	replace	resource_group_name, service_name, build_service_name, build_name, subscription_id		Create or update a KPack build.
create_or_update	replace	resource_group_name, service_name, build_service_name, subscription_id		Create a build service resource.
delete_build	delete	resource_group_name, service_name, build_service_name, build_name, subscription_id		delete a KPack build.
get_build_service	exec	resource_group_name, service_name, build_service_name, subscription_id		Get a build service resource.
list_supported_buildpacks	exec	resource_group_name, service_name, build_service_name, subscription_id		Get all supported buildpacks.
list_supported_stacks	exec	resource_group_name, service_name, build_service_name, subscription_id		Get all supported stacks.
get_build	exec	resource_group_name, service_name, build_service_name, build_name, subscription_id		Get a KPack build.
get_build_result_log	exec	resource_group_name, service_name, build_service_name, build_name, build_result_name, subscription_id		Get a KPack build result log download URL.
get_resource_upload_url	exec	resource_group_name, service_name, build_service_name, subscription_id		Get an resource upload URL for build service, which may be artifacts or source archive.

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_name	string	The name of the build resource. Required.
build_result_name	string	The name of the build result resource. Required.
build_service_name	string	The name of the build service resource. Required.
buildpack_name	string	The name of the buildpack 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.
stack_name	string	The name of the stack resource. Required.
subscription_id	string

SELECT examples

get_build_result

Get a KPack build result.

SELECT
id,
name,
buildPodName,
buildStages,
error,
image,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.build_service
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND build_service_name = '{{ build_service_name }}' -- required
AND build_name = '{{ build_name }}' -- required
AND build_result_name = '{{ build_result_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_build_results

List KPack build results.

SELECT
id,
name,
buildPodName,
buildStages,
error,
image,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.build_service
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND build_service_name = '{{ build_service_name }}' -- required
AND build_name = '{{ build_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_supported_buildpack

Get the supported buildpack resource.

SELECT
id,
name,
buildpackId,
systemData,
type
FROM azure_extras.app_platform.build_service
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND build_service_name = '{{ build_service_name }}' -- required
AND buildpack_name = '{{ buildpack_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_supported_stack

Get the supported stack resource.

SELECT
id,
name,
stackId,
systemData,
type,
version
FROM azure_extras.app_platform.build_service
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND build_service_name = '{{ build_service_name }}' -- required
AND stack_name = '{{ stack_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_builds

List KPack builds.

SELECT
id,
name,
agentPool,
apms,
builder,
certificates,
env,
provisioningState,
relativePath,
resourceRequests,
systemData,
triggeredBuildResult,
type
FROM azure_extras.app_platform.build_service
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
;

list_build_services

List build services resource.

SELECT
id,
name,
containerRegistry,
kPackVersion,
provisioningState,
resourceRequests,
systemData,
type
FROM azure_extras.app_platform.build_service
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update_build

Create or update a KPack build.

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

create_or_update

Create a build service resource.

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

Manifest

# Description fields are for documentation purposes
- name: build_service
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the build_service resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the build_service resource.
  - name: build_service_name
    value: "{{ build_service_name }}"
    description: Required parameter for the build_service resource.
  - name: build_name
    value: "{{ build_name }}"
    description: Required parameter for the build_service resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the build_service resource.
  - name: properties
    description: |
      Properties of the build resource.
    value:
      containerRegistry: "{{ containerRegistry }}"
      kPackVersion: "{{ kPackVersion }}"
      provisioningState: "{{ provisioningState }}"
      resourceRequests:
        cpu: "{{ cpu }}"
        memory: "{{ memory }}"

REPLACE examples

create_or_update_build

Create or update a KPack build.

REPLACE azure_extras.app_platform.build_service
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 build_name = '{{ build_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

create_or_update

Create a build service resource.

REPLACE azure_extras.app_platform.build_service
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete_build

delete a KPack build.

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

Lifecycle Methods

get_build_service

Get a build service resource.

EXEC azure_extras.app_platform.build_service.get_build_service 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@build_service_name='{{ build_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_supported_buildpacks

Get all supported buildpacks.

EXEC azure_extras.app_platform.build_service.list_supported_buildpacks 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@build_service_name='{{ build_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_supported_stacks

Get all supported stacks.

EXEC azure_extras.app_platform.build_service.list_supported_stacks 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@build_service_name='{{ build_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_build

Get a KPack build.

EXEC azure_extras.app_platform.build_service.get_build 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@build_service_name='{{ build_service_name }}' --required, 
@build_name='{{ build_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_build_result_log

Get a KPack build result log download URL.

EXEC azure_extras.app_platform.build_service.get_build_result_log 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@build_service_name='{{ build_service_name }}' --required, 
@build_name='{{ build_name }}' --required, 
@build_result_name='{{ build_result_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_resource_upload_url

Get an resource upload URL for build service, which may be artifacts or source archive.

EXEC azure_extras.app_platform.build_service.get_resource_upload_url 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@build_service_name='{{ build_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;