bindings

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

Overview

Name	bindings
Type	Resource
Id	azure_extras.app_platform.bindings

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.
bindingParameters	object	Binding parameters of the Binding resource.
createdAt	string	Creation time of the Binding resource.
generatedProperties	string	The generated Spring Boot property file for this binding. The secret will be deducted.
key	string	The key of the bound resource.
resourceId	string	The Azure resource id of the bound resource.
resourceName	string	The name of the bound resource.
resourceType	string	The standard Azure resource type of the bound resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.
updatedAt	string	Update time of the Binding resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
bindingParameters	object	Binding parameters of the Binding resource.
createdAt	string	Creation time of the Binding resource.
generatedProperties	string	The generated Spring Boot property file for this binding. The secret will be deducted.
key	string	The key of the bound resource.
resourceId	string	The Azure resource id of the bound resource.
resourceName	string	The name of the bound resource.
resourceType	string	The standard Azure resource type of the bound resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.
updatedAt	string	Update time of the Binding 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, app_name, binding_name, subscription_id		Get a Binding and its properties.
list	select	resource_group_name, service_name, app_name, subscription_id		Handles requests to list all resources in an App.
create_or_update	insert	resource_group_name, service_name, app_name, binding_name, subscription_id		Create a new Binding or update an exiting Binding.
update	update	resource_group_name, service_name, app_name, binding_name, subscription_id		Operation to update an exiting Binding.
create_or_update	replace	resource_group_name, service_name, app_name, binding_name, subscription_id		Create a new Binding or update an exiting Binding.
delete	delete	resource_group_name, service_name, app_name, binding_name, subscription_id		Operation to delete a 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
app_name	string	The name of the App resource. Required.
binding_name	string	The name of the Binding 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 Binding and its properties.

SELECT
id,
name,
bindingParameters,
createdAt,
generatedProperties,
key,
resourceId,
resourceName,
resourceType,
systemData,
type,
updatedAt
FROM azure_extras.app_platform.bindings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND app_name = '{{ app_name }}' -- required
AND binding_name = '{{ binding_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Handles requests to list all resources in an App.

SELECT
id,
name,
bindingParameters,
createdAt,
generatedProperties,
key,
resourceId,
resourceName,
resourceType,
systemData,
type,
updatedAt
FROM azure_extras.app_platform.bindings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND app_name = '{{ app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a new Binding or update an exiting Binding.

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

Manifest

# Description fields are for documentation purposes
- name: bindings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the bindings resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the bindings resource.
  - name: app_name
    value: "{{ app_name }}"
    description: Required parameter for the bindings resource.
  - name: binding_name
    value: "{{ binding_name }}"
    description: Required parameter for the bindings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the bindings resource.
  - name: properties
    description: |
      Properties of the Binding resource.
    value:
      resourceName: "{{ resourceName }}"
      resourceType: "{{ resourceType }}"
      resourceId: "{{ resourceId }}"
      key: "{{ key }}"
      bindingParameters: "{{ bindingParameters }}"
      generatedProperties: "{{ generatedProperties }}"
      createdAt: "{{ createdAt }}"
      updatedAt: "{{ updatedAt }}"

UPDATE examples

update

Operation to update an exiting Binding.

UPDATE azure_extras.app_platform.bindings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND app_name = '{{ app_name }}' --required
AND binding_name = '{{ binding_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a new Binding or update an exiting Binding.

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

DELETE examples

delete

Operation to delete a Binding.

DELETE FROM azure_extras.app_platform.bindings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND app_name = '{{ app_name }}' --required
AND binding_name = '{{ binding_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;