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

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.
provisioningState	string	The status of the last operation. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
securedCoreComplianceAssignment	string	Secured Core Compliance Assignment. Known values are: "Audit" and "ApplyAndAutoCorrect". (Audit, ApplyAndAutoCorrect)
securityComplianceStatus	object	Security Compliance Status.
smbEncryptionForIntraClusterTrafficComplianceAssignment	string	SMB encryption for intra-cluster traffic Compliance Assignment. Known values are: "Audit" and "ApplyAndAutoCorrect". (Audit, ApplyAndAutoCorrect)
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".
wdacComplianceAssignment	string	WDAC Compliance Assignment. Known values are: "Audit" and "ApplyAndAutoCorrect". (Audit, ApplyAndAutoCorrect)

list_by_clusters

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.
provisioningState	string	The status of the last operation. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
securedCoreComplianceAssignment	string	Secured Core Compliance Assignment. Known values are: "Audit" and "ApplyAndAutoCorrect". (Audit, ApplyAndAutoCorrect)
securityComplianceStatus	object	Security Compliance Status.
smbEncryptionForIntraClusterTrafficComplianceAssignment	string	SMB encryption for intra-cluster traffic Compliance Assignment. Known values are: "Audit" and "ApplyAndAutoCorrect". (Audit, ApplyAndAutoCorrect)
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".
wdacComplianceAssignment	string	WDAC Compliance Assignment. Known values are: "Audit" and "ApplyAndAutoCorrect". (Audit, ApplyAndAutoCorrect)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, subscription_id, security_settings_name		Get a SecuritySetting.
list_by_clusters	select	resource_group_name, cluster_name, subscription_id		List SecuritySetting resources by Clusters.
create_or_update	insert	resource_group_name, cluster_name, subscription_id, security_settings_name		Create a security setting.
create_or_update	replace	resource_group_name, cluster_name, subscription_id, security_settings_name		Create a security setting.
delete	delete	resource_group_name, cluster_name, subscription_id, security_settings_name		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
cluster_name	string	The name of the cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
security_settings_name	string	Name of security setting. Default value is "default".
subscription_id	string

SELECT examples

get

Get a SecuritySetting.

SELECT
id,
name,
provisioningState,
securedCoreComplianceAssignment,
securityComplianceStatus,
smbEncryptionForIntraClusterTrafficComplianceAssignment,
systemData,
type,
wdacComplianceAssignment
FROM azure_stack.azure_stack_hci.security_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND security_settings_name = '{{ security_settings_name }}' -- required
;

list_by_clusters

List SecuritySetting resources by Clusters.

SELECT
id,
name,
provisioningState,
securedCoreComplianceAssignment,
securityComplianceStatus,
smbEncryptionForIntraClusterTrafficComplianceAssignment,
systemData,
type,
wdacComplianceAssignment
FROM azure_stack.azure_stack_hci.security_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a security setting.

INSERT INTO azure_stack.azure_stack_hci.security_settings (
properties,
resource_group_name,
cluster_name,
subscription_id,
security_settings_name
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}',
'{{ security_settings_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: security_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the security_settings resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the security_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the security_settings resource.
  - name: security_settings_name
    value: "{{ security_settings_name }}"
    description: Required parameter for the security_settings resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      securedCoreComplianceAssignment: "{{ securedCoreComplianceAssignment }}"
      wdacComplianceAssignment: "{{ wdacComplianceAssignment }}"
      smbEncryptionForIntraClusterTrafficComplianceAssignment: "{{ smbEncryptionForIntraClusterTrafficComplianceAssignment }}"
      securityComplianceStatus:
        securedCoreCompliance: "{{ securedCoreCompliance }}"
        wdacCompliance: "{{ wdacCompliance }}"
        dataAtRestEncrypted: "{{ dataAtRestEncrypted }}"
        dataInTransitProtected: "{{ dataInTransitProtected }}"
        lastUpdated: "{{ lastUpdated }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create a security setting.

REPLACE azure_stack.azure_stack_hci.security_settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND security_settings_name = '{{ security_settings_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a SecuritySetting.

DELETE FROM azure_stack.azure_stack_hci.security_settings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND security_settings_name = '{{ security_settings_name }}' --required
;