buildpack_binding

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

Overview

Name	buildpack_binding
Type	Resource
Id	azure_extras.app_platform.buildpack_binding

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.
bindingType	string	Buildpack Binding Type. Known values are: "ApplicationInsights", "ApacheSkyWalking", "AppDynamics", "Dynatrace", "NewRelic", and "ElasticAPM".
launchProperties	object	The object describes the buildpack binding launch properties.
provisioningState	string	State of the Buildpack Binding. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
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.
bindingType	string	Buildpack Binding Type. Known values are: "ApplicationInsights", "ApacheSkyWalking", "AppDynamics", "Dynatrace", "NewRelic", and "ElasticAPM".
launchProperties	object	The object describes the buildpack binding launch properties.
provisioningState	string	State of the Buildpack Binding. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list_for_cluster

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
bindingType	string	Buildpack Binding Type. Known values are: "ApplicationInsights", "ApacheSkyWalking", "AppDynamics", "Dynatrace", "NewRelic", and "ElasticAPM".
launchProperties	object	The object describes the buildpack binding launch properties.
provisioningState	string	State of the Buildpack Binding. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
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, buildpack_binding_name, subscription_id		Get a buildpack binding by name.
list	select	resource_group_name, service_name, build_service_name, builder_name, subscription_id		Handles requests to list all buildpack bindings in a builder.
list_for_cluster	select	resource_group_name, service_name, subscription_id		Get collection of buildpack bindings under all builders.
create_or_update	insert	resource_group_name, service_name, build_service_name, builder_name, buildpack_binding_name, subscription_id		Create or update a buildpack binding.
create_or_update	replace	resource_group_name, service_name, build_service_name, builder_name, buildpack_binding_name, subscription_id		Create or update a buildpack binding.
delete	delete	resource_group_name, service_name, build_service_name, builder_name, buildpack_binding_name, subscription_id		Operation to delete a Buildpack Binding.

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.
buildpack_binding_name	string	The name of the Buildpack Binding Name. 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 buildpack binding by name.

SELECT
id,
name,
bindingType,
launchProperties,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.buildpack_binding
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 buildpack_binding_name = '{{ buildpack_binding_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Handles requests to list all buildpack bindings in a builder.

SELECT
id,
name,
bindingType,
launchProperties,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.buildpack_binding
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_for_cluster

Get collection of buildpack bindings under all builders.

SELECT
id,
name,
bindingType,
launchProperties,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.buildpack_binding
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

Create or update a buildpack binding.

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

Manifest

# Description fields are for documentation purposes
- name: buildpack_binding
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the buildpack_binding resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the buildpack_binding resource.
  - name: build_service_name
    value: "{{ build_service_name }}"
    description: Required parameter for the buildpack_binding resource.
  - name: builder_name
    value: "{{ builder_name }}"
    description: Required parameter for the buildpack_binding resource.
  - name: buildpack_binding_name
    value: "{{ buildpack_binding_name }}"
    description: Required parameter for the buildpack_binding resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the buildpack_binding resource.
  - name: properties
    description: |
      Properties of a buildpack binding.
    value:
      bindingType: "{{ bindingType }}"
      provisioningState: "{{ provisioningState }}"
      launchProperties:
        properties: "{{ properties }}"
        secrets: "{{ secrets }}"

REPLACE examples

create_or_update

Create or update a buildpack binding.

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

DELETE examples

delete

Operation to delete a Buildpack Binding.

DELETE FROM azure_extras.app_platform.buildpack_binding
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 buildpack_binding_name = '{{ buildpack_binding_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;