Regulatory Compliance Standards - List

Reference

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

Name	In	Required	Type	Description
subscriptionId	path	True	string	Azure subscription ID Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	API version for the operation
$filter	query		string	OData filter. Optional.

subscriptionId

path

True

string

Azure subscription ID

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

API version for the operation

$filter

query

string

OData filter. Optional.

Responses

Name	Type	Description
200 OK	RegulatoryComplianceStandardList	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

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

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


/**
 * Samples for RegulatoryComplianceStandards List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/
     * RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json
     */
    /**
     * Sample code: Get all supported regulatory compliance standards details and state.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getAllSupportedRegulatoryComplianceStandardsDetailsAndState(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.regulatoryComplianceStandards().list(null, com.azure.core.util.Context.NONE);
    }
}

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

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: https://github.com/Azure/azure-rest-api-specs/blob/b43974e07d3204c4b6f8396627f5430994a7f7c9/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/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("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRegulatoryComplianceStandardsClient().NewListPager(&armsecurity.RegulatoryComplianceStandardsClientListOptions{Filter: 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.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

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: specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json
 */
async function getAllSupportedRegulatoryComplianceStandardsDetailsAndState() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let 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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json
// this example is just showing the usage of "RegulatoryComplianceStandards_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this RegulatoryComplianceStandardResource
RegulatoryComplianceStandardCollection collection = subscriptionResource.GetRegulatoryComplianceStandards();

// invoke the operation and iterate over the result
await foreach (RegulatoryComplianceStandardResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    RegulatoryComplianceStandardData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Definitions

Name	Description
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.).
CloudErrorBody	The error detail.
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 standard's supported controls states

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.).

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

CloudErrorBody

The error detail.

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

ErrorAdditionalInfo

The resource management error additional info.

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