Standards - List

Service:: Defender for Cloud

API Version:: 2021-08-01-preview

Get security standards on all your resources inside a scope

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/standards?api-version=2021-08-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	path	True	string pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$	Azure subscription ID
api-version	query	True	string	API version for the operation

Responses

Name	Type	Description
200 OK	StandardList	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

List security standards

Sample request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myResourceGroup/providers/Microsoft.Security/standards?api-version=2021-08-01-preview

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myResourceGroup/providers/Microsoft.Security/standards/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
      "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
      "type": "Microsoft.Security/standards",
      "location": "East US",
      "etag": "etag value",
      "properties": {
        "displayName": "Cross cloud standard 1",
        "standardType": "Custom",
        "description": "Controls and security data implementing security recommendations defined in Azure Security",
        "category": "SecurityCenter",
        "components": [
          {
            "key": "1195afff-c881-495e-9bc5-1486211ae03f"
          },
          {
            "key": "dbd0cb49-b563-45e7-9724-889e799fa648"
          }
        ],
        "supportedClouds": [
          "GCP"
        ]
      },
      "systemData": {
        "createdBy": "user@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-08-31T13:47:50.328Z",
        "lastModifiedBy": "user@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-31T13:47:50.328Z"
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myResourceGroup/providers/Microsoft.Security/standards/155afdf9-d239-4a5c-847f-89da613e7143",
      "name": "155afdf9-d239-4a5c-847f-89da613e7143",
      "type": "Microsoft.Security/standards",
      "location": "East US",
      "etag": "etag value",
      "properties": {
        "displayName": "Cross cloud standard 2",
        "standardType": "Custom",
        "description": "Controls and security data implementing security recommendations defined in Azure Security",
        "category": "SecurityCenter",
        "components": [
          {
            "key": "1195afff-c881-495e-9bc5-1486211ae03f"
          },
          {
            "key": "dbd0cb49-b563-45e7-9724-889e799fa648"
          }
        ]
      },
      "systemData": {
        "createdBy": "user@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-08-31T13:47:50.328Z",
        "lastModifiedBy": "user@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-31T13:47:50.328Z"
      }
    }
  ]
}

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.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
Standard	Security Standard on a resource
StandardComponentProperties	Describes properties of an component as related to the standard
StandardList	Page of a Standard list
StandardSupportedClouds	The cloud that the standard is supported on.
systemData	Metadata pertaining to creation and last modification of the resource.

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	CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

CloudErrorBody

Object

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.

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.

Standard

Object

Security Standard on a resource

Name	Type	Description
etag	string	Entity tag is used for comparing two or more entities from the same requested resource.
id	string	Resource Id
kind	string	Kind of the resource
location	string	Location where the resource is stored
name	string	Resource name
properties.category	string	category of the standard provided
properties.components	StandardComponentProperties[]	List of component objects containing component unique keys (such as assessment keys) to apply to standard scope. Currently only supports assessment keys.
properties.description	string	description of the standard
properties.displayName	string	display name of the standard, equivalent to the standardId
properties.standardType	string	standard type (Custom or BuiltIn only currently)
properties.supportedClouds	StandardSupportedClouds[]	List of all standard supported clouds.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	A list of key value pairs that describe the resource.
type	string	Resource type

StandardComponentProperties

Object

Describes properties of an component as related to the standard

Name	Type	Description
key	string	Component Key matching componentMetadata

StandardList

Object

Page of a Standard list

Name	Type	Description
nextLink	string	The URI to fetch the next page
value	Standard[]	Collection of standards in this page

StandardSupportedClouds

Enumeration

The cloud that the standard is supported on.

Value	Description
AWS
GCP

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.

Share via

Standards - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List security standards

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

createdByType

ErrorAdditionalInfo

Standard

StandardComponentProperties

StandardList

StandardSupportedClouds

systemData