connectors

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

Overview

Name	connectors
Type	Resource
Id	azure.security.connectors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Security connector data
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Security connector data
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Security connector data
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, securityConnectorName	api-version	Retrieves details of a specific security connector
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	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.
list	select	subscriptionId	api-version	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.
create_or_update	insert	subscriptionId, resourceGroupName, securityConnectorName	api-version	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.
update	update	subscriptionId, resourceGroupName, securityConnectorName	api-version	Updates a security connector
delete	delete	subscriptionId, resourceGroupName, securityConnectorName	api-version	Deletes a security 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
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
securityConnectorName	string	The security connector name.
subscriptionId	string	Azure subscription ID
api-version	string	API version for the operation

SELECT examples

get

Retrieves details of a specific security connector

SELECT
location,
properties,
systemData,
tags
FROM azure.security.connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND securityConnectorName = '{{ securityConnectorName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

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.

SELECT
location,
properties,
systemData,
tags
FROM azure.security.connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list

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.

SELECT
location,
properties,
systemData,
tags
FROM azure.security.connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

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.

INSERT INTO azure.security.connectors (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
securityConnectorName,
api-version
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ securityConnectorName }}',
'{{ api-version }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: connectors
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the connectors resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the connectors resource.
    - name: securityConnectorName
      value: string
      description: Required parameter for the connectors resource.
    - name: properties
      value: object
      description: |
        Security connector data
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: api-version
      value: string
      description: API version for the operation

UPDATE examples

update

Updates a security connector

UPDATE azure.security.connectors
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}',
data__location = '{{ location }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND securityConnectorName = '{{ securityConnectorName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

Deletes a security connector.

DELETE FROM azure.security.connectors
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND securityConnectorName = '{{ securityConnectorName }}' --required
AND api-version = '{{ api-version }}'
;