contacts

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

Overview

Name	contacts
Type	Resource
Id	azure.security.contacts

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	Security contact data
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	Security contact data
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, securityContactName	api-version	Get Default Security contact configurations for the subscription
list	select	subscriptionId	api-version	List all security contact configurations for the subscription
create	insert	subscriptionId, securityContactName	api-version	Create security contact configurations for the subscription
delete	delete	subscriptionId, securityContactName	api-version	Delete security contact configurations for the subscription

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
securityContactName	string	Name of the security contact object
subscriptionId	string	Azure subscription ID
api-version	string	API version for the operation

SELECT examples

get

Get Default Security contact configurations for the subscription

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

list

List all security contact configurations for the subscription

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

INSERT examples

create

Create security contact configurations for the subscription

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

Manifest

# Description fields are for documentation purposes
- name: contacts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the contacts resource.
    - name: securityContactName
      value: string
      description: Required parameter for the contacts resource.
    - name: properties
      value: object
      description: |
        Security contact data
    - name: api-version
      value: string
      description: API version for the operation

DELETE examples

delete

Delete security contact configurations for the subscription

DELETE FROM azure.security.contacts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND securityContactName = '{{ securityContactName }}' --required
AND api-version = '{{ api-version }}'
;