connector_applications

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

Overview

Name	connector_applications
Type	Resource
Id	azure.security.connector_applications

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Properties of a security application
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Properties of a security application
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	subscriptionId, resourceGroupName, securityConnectorName, applicationId	api-version	Get a specific application for the requested scope by applicationId
list	select	subscriptionId, resourceGroupName, securityConnectorName	api-version	Get a list of all relevant applications over a security connector level scope
create_or_update	insert	subscriptionId, resourceGroupName, securityConnectorName, applicationId	api-version	Creates or update a security Application on the given security connector.
delete	delete	subscriptionId, resourceGroupName, securityConnectorName, applicationId	api-version	Delete an Application over a given scope

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
applicationId	string	The security Application key - unique key for the standard application
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

Get a specific application for the requested scope by applicationId

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.connector_applications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND securityConnectorName = '{{ securityConnectorName }}' -- required
AND applicationId = '{{ applicationId }}' -- required
AND api-version = '{{ api-version }}'
;

list

Get a list of all relevant applications over a security connector level scope

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.connector_applications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND securityConnectorName = '{{ securityConnectorName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or update a security Application on the given security connector.

INSERT INTO azure.security.connector_applications (
data__properties,
subscriptionId,
resourceGroupName,
securityConnectorName,
applicationId,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ securityConnectorName }}',
'{{ applicationId }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connector_applications
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the connector_applications resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the connector_applications resource.
    - name: securityConnectorName
      value: string
      description: Required parameter for the connector_applications resource.
    - name: applicationId
      value: string
      description: Required parameter for the connector_applications resource.
    - name: properties
      value: object
      description: |
        Properties of a security application
    - name: api-version
      value: string
      description: API version for the operation

DELETE examples

delete

Delete an Application over a given scope

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