security_connectors

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

Overview

Name	security_connectors
Type	Resource
Id	azure.security.security_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.
environmentData	object	The security connector environment data.
environmentName	string	The multi cloud resource's cloud name. Known values are: "Azure", "AWS", "GCP", "Github", "AzureDevOps", "GitLab", "DockerHub", and "JFrog". (Azure, AWS, GCP, Github, AzureDevOps, GitLab, DockerHub, JFrog)
etag	string	Entity tag is used for comparing two or more entities from the same requested resource.
hierarchyIdentifier	string	The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector).
hierarchyIdentifierTrialEndDate	string (date-time)	The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings.
kind	string	Kind of the resource.
location	string	The geo-location where the resource lives.
offerings	array	A collection of offerings for the security connector.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
environmentData	object	The security connector environment data.
environmentName	string	The multi cloud resource's cloud name. Known values are: "Azure", "AWS", "GCP", "Github", "AzureDevOps", "GitLab", "DockerHub", and "JFrog". (Azure, AWS, GCP, Github, AzureDevOps, GitLab, DockerHub, JFrog)
etag	string	Entity tag is used for comparing two or more entities from the same requested resource.
hierarchyIdentifier	string	The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector).
hierarchyIdentifierTrialEndDate	string (date-time)	The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings.
kind	string	Kind of the resource.
location	string	The geo-location where the resource lives.
offerings	array	A collection of offerings for the security connector.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
environmentData	object	The security connector environment data.
environmentName	string	The multi cloud resource's cloud name. Known values are: "Azure", "AWS", "GCP", "Github", "AzureDevOps", "GitLab", "DockerHub", and "JFrog". (Azure, AWS, GCP, Github, AzureDevOps, GitLab, DockerHub, JFrog)
etag	string	Entity tag is used for comparing two or more entities from the same requested resource.
hierarchyIdentifier	string	The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector).
hierarchyIdentifierTrialEndDate	string (date-time)	The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings.
kind	string	Kind of the resource.
location	string	The geo-location where the resource lives.
offerings	array	A collection of offerings for the security connector.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, subscription_id		Retrieves details of a specific security connector.
list_by_resource_group	select	resource_group_name, subscription_id		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	subscription_id		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	resource_group_name, security_connector_name, subscription_id		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	resource_group_name, security_connector_name, subscription_id		Updates a security connector.
create_or_update	replace	resource_group_name, security_connector_name, subscription_id		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	resource_group_name, security_connector_name, subscription_id		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
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

Retrieves details of a specific security connector.

SELECT
id,
name,
environmentData,
environmentName,
etag,
hierarchyIdentifier,
hierarchyIdentifierTrialEndDate,
kind,
location,
offerings,
systemData,
tags,
type
FROM azure.security.security_connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND security_connector_name = '{{ security_connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

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
id,
name,
environmentData,
environmentName,
etag,
hierarchyIdentifier,
hierarchyIdentifierTrialEndDate,
kind,
location,
offerings,
systemData,
tags,
type
FROM azure.security.security_connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

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
id,
name,
environmentData,
environmentName,
etag,
hierarchyIdentifier,
hierarchyIdentifierTrialEndDate,
kind,
location,
offerings,
systemData,
tags,
type
FROM azure.security.security_connectors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

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.security_connectors (
properties,
tags,
location,
kind,
etag,
resource_group_name,
security_connector_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ kind }}',
'{{ etag }}',
'{{ resource_group_name }}',
'{{ security_connector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: security_connectors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the security_connectors resource.
  - name: security_connector_name
    value: "{{ security_connector_name }}"
    description: Required parameter for the security_connectors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the security_connectors resource.
  - name: properties
    description: |
      Security connector data.
    value:
      hierarchyIdentifier: "{{ hierarchyIdentifier }}"
      hierarchyIdentifierTrialEndDate: "{{ hierarchyIdentifierTrialEndDate }}"
      environmentName: "{{ environmentName }}"
      offerings:
        - offeringType: "{{ offeringType }}"
          description: "{{ description }}"
      environmentData:
        environmentType: "{{ environmentType }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of the resource.
  - name: etag
    value: "{{ etag }}"
    description: |
      Entity tag is used for comparing two or more entities from the same requested resource.

UPDATE examples

update

Updates a security connector.

UPDATE azure.security.security_connectors
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}',
kind = '{{ kind }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND security_connector_name = '{{ security_connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE 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.

REPLACE azure.security.security_connectors
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}',
kind = '{{ kind }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND security_connector_name = '{{ security_connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a security connector.

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