build_service_agent_pool

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

Overview

Name	build_service_agent_pool
Type	Resource
Id	azure_extras.app_platform.build_service_agent_pool

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.
poolSize	object	build service agent pool size properties.
provisioningState	string	Provisioning state of the build service agent pool.
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.
poolSize	object	build service agent pool size properties.
provisioningState	string	Provisioning state of the build service agent pool.
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, agent_pool_name, subscription_id		Get build service agent pool.
list	select	resource_group_name, service_name, build_service_name, subscription_id		List build service agent pool.
update_put	exec	resource_group_name, service_name, build_service_name, agent_pool_name, subscription_id		Create or update build service agent pool.

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
agent_pool_name	string	The name of the build service agent pool resource. Required.
build_service_name	string	The name of the build service 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 build service agent pool.

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

list

List build service agent pool.

SELECT
id,
name,
poolSize,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.build_service_agent_pool
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
;

Lifecycle Methods

update_put

Create or update build service agent pool.

EXEC azure_extras.app_platform.build_service_agent_pool.update_put 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@build_service_name='{{ build_service_name }}' --required, 
@agent_pool_name='{{ agent_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;