security_connector_application

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

Overview

Name	security_connector_application
Type	Resource
Id	azure.security.security_connector_application

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.
conditionSets	array	The application conditionSets - see examples. Required.
description	string	description of the application.
displayName	string	display name of the application.
sourceResourceType	string	The application source, what it affects, e.g. Assessments. Required. "Assessments" (Assessments)
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	resource_group_name, security_connector_name, application_id, subscription_id		Get a specific application for the requested scope by applicationId.
create_or_update	insert	resource_group_name, security_connector_name, application_id, subscription_id		Creates or update a security Application on the given security connector.
create_or_update	replace	resource_group_name, security_connector_name, application_id, subscription_id		Creates or update a security Application on the given security connector.
delete	delete	resource_group_name, security_connector_name, application_id, subscription_id		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
application_id	string	The security Application key - unique key for the standard application. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
security_connector_name	string	The security connector name. Required.
subscription_id	string

SELECT examples

get

Get a specific application for the requested scope by applicationId.

SELECT
id,
name,
conditionSets,
description,
displayName,
sourceResourceType,
systemData,
type
FROM azure.security.security_connector_application
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND security_connector_name = '{{ security_connector_name }}' -- required
AND application_id = '{{ application_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.security.security_connector_application (
properties,
resource_group_name,
security_connector_name,
application_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ security_connector_name }}',
'{{ application_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: security_connector_application
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the security_connector_application resource.
  - name: security_connector_name
    value: "{{ security_connector_name }}"
    description: Required parameter for the security_connector_application resource.
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the security_connector_application resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the security_connector_application resource.
  - name: properties
    description: |
      Properties of a security application.
    value:
      displayName: "{{ displayName }}"
      description: "{{ description }}"
      sourceResourceType: "{{ sourceResourceType }}"
      conditionSets: "{{ conditionSets }}"

REPLACE examples

create_or_update

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

REPLACE azure.security.security_connector_application
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND security_connector_name = '{{ security_connector_name }}' --required
AND application_id = '{{ application_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete an Application over a given scope.

DELETE FROM azure.security.security_connector_application
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND security_connector_name = '{{ security_connector_name }}' --required
AND application_id = '{{ application_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;