connectors

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

Overview

Name	connectors
Type	Resource
Id	azure.impact_reporting.connectors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
connectorId	string	unique id of the connector. Required.
connectorType	string	connector type. Required. "AzureMonitor" (AzureMonitor)
lastRunTimeStamp	string (date-time)	last run time stamp of this connector in UTC time zone. Required.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	tenant id of this connector. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
connectorId	string	unique id of the connector. Required.
connectorType	string	connector type. Required. "AzureMonitor" (AzureMonitor)
lastRunTimeStamp	string (date-time)	last run time stamp of this connector in UTC time zone. Required.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	tenant id of this connector. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	connector_name, subscription_id		Get a Connector.
list_by_subscription	select	subscription_id		List Connector resources by subscription ID.
create_or_update	insert	connector_name, subscription_id		Create a Connector.
update	update	connector_name, subscription_id		Update a Connector.
create_or_update	replace	connector_name, subscription_id		Create a Connector.
delete	delete	connector_name, subscription_id		Delete a Connector.

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
connector_name	string	The name of the connector. Required.
subscription_id	string

SELECT examples

get

Get a Connector.

SELECT
id,
name,
connectorId,
connectorType,
lastRunTimeStamp,
provisioningState,
systemData,
tenantId,
type
FROM azure.impact_reporting.connectors
WHERE connector_name = '{{ connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Connector resources by subscription ID.

SELECT
id,
name,
connectorId,
connectorType,
lastRunTimeStamp,
provisioningState,
systemData,
tenantId,
type
FROM azure.impact_reporting.connectors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Connector.

INSERT INTO azure.impact_reporting.connectors (
properties,
connector_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ connector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connectors
props:
  - name: connector_name
    value: "{{ connector_name }}"
    description: Required parameter for the connectors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connectors resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      connectorId: "{{ connectorId }}"
      tenantId: "{{ tenantId }}"
      connectorType: "{{ connectorType }}"
      lastRunTimeStamp: "{{ lastRunTimeStamp }}"

UPDATE examples

update

Update a Connector.

UPDATE azure.impact_reporting.connectors
SET 
properties = '{{ properties }}'
WHERE 
connector_name = '{{ connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a Connector.

REPLACE azure.impact_reporting.connectors
SET 
properties = '{{ properties }}'
WHERE 
connector_name = '{{ connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Connector.

DELETE FROM azure.impact_reporting.connectors
WHERE connector_name = '{{ connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;