associations

Creates, updates, deletes, gets or lists an associations resource.

Overview

Name	associations
Type	Resource
Id	azure.custom_providers.associations

Fields

The following fields are returned by SELECT queries:

get

OK. Returns association.

Name	Datatype	Description
id	string	The association id.
name	string	The association name.
properties	object	The properties of the association.
type	string	The association type.

list_all

OK. Returns all associations for the given scope.

Name	Datatype	Description
id	string	The association id.
name	string	The association name.
properties	object	The properties of the association.
type	string	The association type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, associationName		Get an association.
list_all	select	scope		Gets all association for the given scope.
create_or_update	insert	scope, associationName		Create or update an association.
delete	delete	scope, associationName		Delete an association.

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
associationName	string	The name of the association.
scope	string	The scope of the association.

SELECT examples

get

Get an association.

SELECT
id,
name,
properties,
type
FROM azure.custom_providers.associations
WHERE scope = '{{ scope }}' -- required
AND associationName = '{{ associationName }}' -- required
;

list_all

Gets all association for the given scope.

SELECT
id,
name,
properties,
type
FROM azure.custom_providers.associations
WHERE scope = '{{ scope }}' -- required
;

INSERT examples

create_or_update

Create or update an association.

INSERT INTO azure.custom_providers.associations (
data__properties,
scope,
associationName
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ associationName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: associations
  props:
    - name: scope
      value: string
      description: Required parameter for the associations resource.
    - name: associationName
      value: string
      description: Required parameter for the associations resource.
    - name: properties
      value: object
      description: |
        The properties of the association.

DELETE examples

delete

Delete an association.

DELETE FROM azure.custom_providers.associations
WHERE scope = '{{ scope }}' --required
AND associationName = '{{ associationName }}' --required
;