server_vulnerability_assessments_settings

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

Overview

Name	server_vulnerability_assessments_settings
Type	Resource
Id	azure.security.server_vulnerability_assessments_settings

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.
kind	string	The kind of the server vulnerability assessments setting. Required. "AzureServersSetting"
properties	object	The resource-specific properties for this resource.
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_by_subscription

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.
kind	string	The kind of the server vulnerability assessments setting. Required. "AzureServersSetting"
properties	object	The resource-specific properties for this resource.
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	setting_kind, subscription_id		Get a server vulnerability assessments setting of the requested kind, that is set on the subscription.
list_by_subscription	select	subscription_id		Get a list of all the server vulnerability assessments settings over a subscription level scope.
create_or_update	insert	setting_kind, subscription_id, kind		Create or update a server vulnerability assessments setting of the requested kind on the subscription.
create_or_update	replace	setting_kind, subscription_id, kind		Create or update a server vulnerability assessments setting of the requested kind on the subscription.
delete	delete	setting_kind, subscription_id		Delete the server vulnerability assessments setting of the requested kind from 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
setting_kind	string	The kind of the server vulnerability assessments setting. "azureServersSetting" Required.
subscription_id	string

SELECT examples

get

Get a server vulnerability assessments setting of the requested kind, that is set on the subscription.

SELECT
id,
name,
kind,
properties,
systemData,
type
FROM azure.security.server_vulnerability_assessments_settings
WHERE setting_kind = '{{ setting_kind }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get a list of all the server vulnerability assessments settings over a subscription level scope.

SELECT
id,
name,
kind,
properties,
systemData,
type
FROM azure.security.server_vulnerability_assessments_settings
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a server vulnerability assessments setting of the requested kind on the subscription.

INSERT INTO azure.security.server_vulnerability_assessments_settings (
properties,
kind,
setting_kind,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ kind }}' /* required */,
'{{ setting_kind }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_vulnerability_assessments_settings
props:
  - name: setting_kind
    value: "{{ setting_kind }}"
    description: Required parameter for the server_vulnerability_assessments_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_vulnerability_assessments_settings resource.
  - name: properties
    value: "{{ properties }}"
    description: |
      The resource-specific properties for this resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of the server vulnerability assessments setting. Required. "AzureServersSetting"

REPLACE examples

create_or_update

Create or update a server vulnerability assessments setting of the requested kind on the subscription.

REPLACE azure.security.server_vulnerability_assessments_settings
SET 
properties = '{{ properties }}',
kind = '{{ kind }}'
WHERE 
setting_kind = '{{ setting_kind }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
kind,
properties,
systemData,
type;

DELETE examples

delete

Delete the server vulnerability assessments setting of the requested kind from the subscription.

DELETE FROM azure.security.server_vulnerability_assessments_settings
WHERE setting_kind = '{{ setting_kind }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;