connectors

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

Overview

Name	connectors
Type	Resource
Id	azure.security.connectors

Fields

vw_connectors

Name	Datatype	Description
environment_data	text	field from the properties object
environment_name	text	field from the properties object
hierarchy_identifier	text	field from the properties object
hierarchy_identifier_trial_end_date	text	field from the properties object
offerings	text	field from the properties object
resourceGroupName	text	field from the properties object
securityConnectorName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object

connectors

Name	Datatype	Description
properties	object	A set of properties that defines the security connector configuration.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, securityConnectorName, subscriptionId	Retrieves details of a specific security connector
list	SELECT	subscriptionId	Lists all the security connectors in the specified subscription. Use the 'nextLink' property in the response to get the next page of security connectors for the specified subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all the security connectors in the specified resource group. Use the 'nextLink' property in the response to get the next page of security connectors for the specified resource group.
create_or_update	INSERT	resourceGroupName, securityConnectorName, subscriptionId	Creates or updates a security connector. If a security connector is already created and a subsequent request is issued for the same security connector id, then it will be updated.
delete	DELETE	resourceGroupName, securityConnectorName, subscriptionId	Deletes a security connector.
update	UPDATE	resourceGroupName, securityConnectorName, subscriptionId	Updates a security connector

SELECT examples

Lists all the security connectors in the specified subscription. Use the 'nextLink' property in the response to get the next page of security connectors for the specified subscription.

vw_connectors

SELECT
environment_data,
environment_name,
hierarchy_identifier,
hierarchy_identifier_trial_end_date,
offerings,
resourceGroupName,
securityConnectorName,
subscriptionId,
system_data
FROM azure.security.vw_connectors
WHERE subscriptionId = '{{ subscriptionId }}';

connectors

SELECT
properties,
systemData
FROM azure.security.connectors
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new connectors resource.

All Properties

/*+ create */
INSERT INTO azure.security.connectors (
resourceGroupName,
securityConnectorName,
subscriptionId,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ securityConnectorName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: hierarchyIdentifier
          value: string
        - name: hierarchyIdentifierTrialEndDate
          value: string
        - name: environmentName
          value: string
        - name: offerings
          value:
            - - name: offeringType
                value: string
              - name: description
                value: string
        - name: environmentData
          value:
            - name: environmentType
              value: string

UPDATE example

Updates a connectors resource.

/*+ update */
UPDATE azure.security.connectors
SET 
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND securityConnectorName = '{{ securityConnectorName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified connectors resource.

/*+ delete */
DELETE FROM azure.security.connectors
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND securityConnectorName = '{{ securityConnectorName }}'
AND subscriptionId = '{{ subscriptionId }}';