Regulatory Compliance Standards - List

Service:

Defender for Cloud

API Version:

2019-01-01-preview

Supported regulatory compliance standards details and state

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/regulatoryComplianceStandards?api-version=2019-01-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/regulatoryComplianceStandards?api-version=2019-01-01-preview&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	OData filter. Optional.

Responses

Name	Type	Description
200 OK	RegulatoryComplianceStandardList	Azure operation completed successfully.
Other Status Codes	Common.CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get all supported regulatory compliance standards details and state

Sample request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards?api-version=2019-01-01-preview

Go

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: 2019-01-01-preview/RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json
func ExampleRegulatoryComplianceStandardsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRegulatoryComplianceStandardsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armsecurity.RegulatoryComplianceStandardsClientListResponse{
		// 	RegulatoryComplianceStandardList: armsecurity.RegulatoryComplianceStandardList{
		// 		Value: []*armsecurity.RegulatoryComplianceStandard{
		// 			{
		// 				Name: to.Ptr("PCI-DSS-3.2"),
		// 				Type: to.Ptr("Microsoft.Security/regulatoryComplianceStandard"),
		// 				ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2"),
		// 				Properties: &armsecurity.RegulatoryComplianceStandardProperties{
		// 					FailedControls: to.Ptr[int32](4),
		// 					PassedControls: to.Ptr[int32](7),
		// 					SkippedControls: to.Ptr[int32](0),
		// 					State: to.Ptr(armsecurity.StateFailed),
		// 					UnsupportedControls: to.Ptr[int32](0),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("ISO-27001"),
		// 				Type: to.Ptr("Microsoft.Security/regulatoryComplianceStandard"),
		// 				ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/ISO-27001"),
		// 				Properties: &armsecurity.RegulatoryComplianceStandardProperties{
		// 					FailedControls: to.Ptr[int32](0),
		// 					PassedControls: to.Ptr[int32](0),
		// 					SkippedControls: to.Ptr[int32](10),
		// 					State: to.Ptr(armsecurity.StateSkipped),
		// 					UnsupportedControls: to.Ptr[int32](0),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("AZURE-CIS"),
		// 				Type: to.Ptr("Microsoft.Security/regulatoryComplianceStandard"),
		// 				ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/AZURE-CIS"),
		// 				Properties: &armsecurity.RegulatoryComplianceStandardProperties{
		// 					FailedControls: to.Ptr[int32](0),
		// 					PassedControls: to.Ptr[int32](0),
		// 					SkippedControls: to.Ptr[int32](0),
		// 					State: to.Ptr(armsecurity.StateUnsupported),
		// 					UnsupportedControls: to.Ptr[int32](0),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("SOC-TSP"),
		// 				Type: to.Ptr("Microsoft.Security/regulatoryComplianceStandard"),
		// 				ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/SOC-TSP"),
		// 				Properties: &armsecurity.RegulatoryComplianceStandardProperties{
		// 					FailedControls: to.Ptr[int32](0),
		// 					PassedControls: to.Ptr[int32](15),
		// 					SkippedControls: to.Ptr[int32](0),
		// 					State: to.Ptr(armsecurity.StatePassed),
		// 					UnsupportedControls: to.Ptr[int32](0),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to supported regulatory compliance standards details and state
 *
 * @summary supported regulatory compliance standards details and state
 * x-ms-original-file: 2019-01-01-preview/RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json
 */
async function getAllSupportedRegulatoryComplianceStandardsDetailsAndState() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.regulatoryComplianceStandards.list()) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "name": "PCI-DSS-3.2",
      "type": "Microsoft.Security/regulatoryComplianceStandard",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2",
      "properties": {
        "failedControls": 4,
        "passedControls": 7,
        "skippedControls": 0,
        "state": "Failed",
        "unsupportedControls": 0
      }
    },
    {
      "name": "ISO-27001",
      "type": "Microsoft.Security/regulatoryComplianceStandard",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/ISO-27001",
      "properties": {
        "failedControls": 0,
        "passedControls": 0,
        "skippedControls": 10,
        "state": "Skipped",
        "unsupportedControls": 0
      }
    },
    {
      "name": "AZURE-CIS",
      "type": "Microsoft.Security/regulatoryComplianceStandard",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/AZURE-CIS",
      "properties": {
        "failedControls": 0,
        "passedControls": 0,
        "skippedControls": 0,
        "state": "Unsupported",
        "unsupportedControls": 0
      }
    },
    {
      "name": "SOC-TSP",
      "type": "Microsoft.Security/regulatoryComplianceStandard",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/SOC-TSP",
      "properties": {
        "failedControls": 0,
        "passedControls": 15,
        "skippedControls": 0,
        "state": "Passed",
        "unsupportedControls": 0
      }
    }
  ]
}

Definitions

Name	Description
Common.CloudError	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
Common.CloudErrorBody	The error detail.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
RegulatoryComplianceStandard	Regulatory compliance standard details and state
RegulatoryComplianceStandardList	List of regulatory compliance standards response
State	Aggregative state based on the assessment's scanned resources states
systemData	Metadata pertaining to creation and last modification of the resource.

Common.CloudError

Object

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	The error additional info.
error.code	string	The error code.
error.details	Common.CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

Common.CloudErrorBody

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	Common.CloudErrorBody[]	The error details.
message	string	The error message.
target	string	The error target.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

RegulatoryComplianceStandard

Object

Regulatory compliance standard details and state

Name	Type	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
properties.failedControls	integer (int32)	The number of supported regulatory compliance controls of the given standard with a failed state
properties.passedControls	integer (int32)	The number of supported regulatory compliance controls of the given standard with a passed state
properties.skippedControls	integer (int32)	The number of supported regulatory compliance controls of the given standard with a skipped state
properties.state	State	Aggregative state based on the standard's supported controls states
properties.unsupportedControls	integer (int32)	The number of regulatory compliance controls of the given standard which are unsupported by automated assessments
systemData	systemData	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"

RegulatoryComplianceStandardList

Object

List of regulatory compliance standards response

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	RegulatoryComplianceStandard[]	The RegulatoryComplianceStandard items on this page

State

Enumeration

Aggregative state based on the assessment's scanned resources states

Value	Description
Passed	All supported regulatory compliance controls in the given standard have a passed state
Failed	At least one supported regulatory compliance control in the given standard has a state of failed
Skipped	All supported regulatory compliance controls in the given standard have a state of skipped
Unsupported	No supported regulatory compliance data for the given standard
On	Send notification on new alerts to the subscription's admins
Off	Don't send notification on new alerts to the subscription's admins

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.