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 (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
kind	string	The kind of the server vulnerability assessments setting.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_subscription

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
kind	string	The kind of the server vulnerability assessments setting.
systemData	object	Metadata pertaining to creation and last modification of the resource.
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, settingKind		Get a server vulnerability assessments setting of the requested kind, that is set on the subscription
list_by_subscription	select	subscriptionId		Get a list of all the server vulnerability assessments settings over a subscription level scope
create_or_update	insert	subscriptionId, settingKind, data__kind		Create or update a server vulnerability assessments setting of the requested kind on the subscription
delete	delete	subscriptionId, settingKind		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
settingKind	string	The kind of the server vulnerability assessments setting
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

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

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

list_by_subscription

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

SELECT
id,
name,
kind,
systemData,
type
FROM azure.security.server_vulnerability_assessments_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- 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 (
data__kind,
subscriptionId,
settingKind
)
SELECT 
'{{ kind }}' /* required */,
'{{ subscriptionId }}',
'{{ settingKind }}'
RETURNING
id,
name,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_vulnerability_assessments_settings
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the server_vulnerability_assessments_settings resource.
    - name: settingKind
      value: string
      description: Required parameter for the server_vulnerability_assessments_settings resource.
    - name: kind
      value: string
      description: |
        The kind of the server vulnerability assessments setting.
      valid_values: ['AzureServersSetting']

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 subscriptionId = '{{ subscriptionId }}' --required
AND settingKind = '{{ settingKind }}' --required
;