Share via


Microsoft.Security securityStandards

Bicep resource definition

The securityStandards resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/securityStandards resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Security/securityStandards@2024-08-01' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    assessments: [
      {
        assessmentKey: 'string'
      }
    ]
    cloudProviders: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    metadata: {}
    policySetDefinitionId: 'string'
  }
}

Property Values

Microsoft.Security/securityStandards

Name Description Value
name The resource name string

Constraints:
Pattern = [{]?[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$ (required)
properties Properties of a security standard StandardProperties
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.

PartialAssessmentProperties

Name Description Value
assessmentKey The assessment key string

StandardMetadata

Name Description Value

StandardProperties

Name Description Value
assessments List of assessment keys to apply to standard scope. PartialAssessmentProperties[]
cloudProviders List of all standard supported clouds. String array containing any of:
'AWS'
'Azure'
'GCP'
description Description of the standard string
displayName Display name of the standard, equivalent to the standardId string
metadata The security standard metadata. StandardMetadata
policySetDefinitionId The policy set definition id associated with the standard. string

ARM template resource definition

The securityStandards resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/securityStandards resource, add the following JSON to your template.

{
  "type": "Microsoft.Security/securityStandards",
  "apiVersion": "2024-08-01",
  "name": "string",
  "properties": {
    "assessments": [
      {
        "assessmentKey": "string"
      }
    ],
    "cloudProviders": [ "string" ],
    "description": "string",
    "displayName": "string",
    "metadata": {
    },
    "policySetDefinitionId": "string"
  }
}

Property Values

Microsoft.Security/securityStandards

Name Description Value
apiVersion The api version '2024-08-01'
name The resource name string

Constraints:
Pattern = [{]?[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$ (required)
properties Properties of a security standard StandardProperties
type The resource type 'Microsoft.Security/securityStandards'

PartialAssessmentProperties

Name Description Value
assessmentKey The assessment key string

StandardMetadata

Name Description Value

StandardProperties

Name Description Value
assessments List of assessment keys to apply to standard scope. PartialAssessmentProperties[]
cloudProviders List of all standard supported clouds. String array containing any of:
'AWS'
'Azure'
'GCP'
description Description of the standard string
displayName Display name of the standard, equivalent to the standardId string
metadata The security standard metadata. StandardMetadata
policySetDefinitionId The policy set definition id associated with the standard. string

Usage Examples

Terraform (AzAPI provider) resource definition

The securityStandards resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/securityStandards resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/securityStandards@2024-08-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      assessments = [
        {
          assessmentKey = "string"
        }
      ]
      cloudProviders = [
        "string"
      ]
      description = "string"
      displayName = "string"
      metadata = {
      }
      policySetDefinitionId = "string"
    }
  }
}

Property Values

Microsoft.Security/securityStandards

Name Description Value
name The resource name string

Constraints:
Pattern = [{]?[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$ (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties Properties of a security standard StandardProperties
type The resource type "Microsoft.Security/securityStandards@2024-08-01"

PartialAssessmentProperties

Name Description Value
assessmentKey The assessment key string

StandardMetadata

Name Description Value

StandardProperties

Name Description Value
assessments List of assessment keys to apply to standard scope. PartialAssessmentProperties[]
cloudProviders List of all standard supported clouds. String array containing any of:
'AWS'
'Azure'
'GCP'
description Description of the standard string
displayName Display name of the standard, equivalent to the standardId string
metadata The security standard metadata. StandardMetadata
policySetDefinitionId The policy set definition id associated with the standard. string