security_settings

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

Overview

Name	security_settings
Type	Resource
Id	azure_stack.azure_stack_hci.security_settings

Fields

The following fields are returned by SELECT queries:

get

ARM operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_clusters

ARM operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, securitySettingsName		Get a SecuritySetting
list_by_clusters	select	subscriptionId, resourceGroupName, clusterName		List SecuritySetting resources by Clusters
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, securitySettingsName		Create a security setting
delete	delete	subscriptionId, resourceGroupName, clusterName, securitySettingsName		Delete a SecuritySetting

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
clusterName	string	The name of the cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
securitySettingsName	string	Name of security setting
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a SecuritySetting

SELECT
properties
FROM azure_stack.azure_stack_hci.security_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND securitySettingsName = '{{ securitySettingsName }}' -- required
;

list_by_clusters

List SecuritySetting resources by Clusters

SELECT
properties
FROM azure_stack.azure_stack_hci.security_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

INSERT examples

create_or_update

Create a security setting

INSERT INTO azure_stack.azure_stack_hci.security_settings (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
securitySettingsName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ securitySettingsName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: security_settings
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the security_settings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the security_settings resource.
    - name: clusterName
      value: string
      description: Required parameter for the security_settings resource.
    - name: securitySettingsName
      value: string
      description: Required parameter for the security_settings resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete a SecuritySetting

DELETE FROM azure_stack.azure_stack_hci.security_settings
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND securitySettingsName = '{{ securitySettingsName }}' --required
;