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

Name	Datatype	Description
id	string	The association id.
name	string	The association name.
provisioningState	string	The provisioning state of the association. Known values are: "Accepted", "Deleting", "Running", "Succeeded", and "Failed".
targetResourceId	string	The REST resource instance of the target resource for this association.
type	string	The association type.

list_all

Name	Datatype	Description
id	string	The association id.
name	string	The association name.
provisioningState	string	The provisioning state of the association. Known values are: "Accepted", "Deleting", "Running", "Succeeded", and "Failed".
targetResourceId	string	The REST resource instance of the target resource for this 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, association_name		Get an association.
list_all	select	scope		Gets all association for the given scope.
create_or_update	insert	scope, association_name		Create or update an association.
create_or_update	replace	scope, association_name		Create or update an association.
delete	delete	scope, association_name		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
association_name	string	The name of the association. Required.
scope	string	The scope of the association. Required.

SELECT examples

get

Get an association.

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

list_all

Gets all association for the given scope.

SELECT
id,
name,
provisioningState,
targetResourceId,
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 (
properties,
scope,
association_name
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ association_name }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: associations
props:
  - name: scope
    value: "{{ scope }}"
    description: Required parameter for the associations resource.
  - name: association_name
    value: "{{ association_name }}"
    description: Required parameter for the associations resource.
  - name: properties
    value:
      targetResourceId: "{{ targetResourceId }}"

REPLACE examples

create_or_update

Create or update an association.

REPLACE azure.custom_providers.associations
SET 
properties = '{{ properties }}'
WHERE 
scope = '{{ scope }}' --required
AND association_name = '{{ association_name }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Delete an association.

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