Standard Assignments - List

Service:

Defender for Cloud

API Version:

2024-08-01

Get a list of all relevant standard assignments over a scope

GET https://management.azure.com/{scope}/providers/Microsoft.Security/standardAssignments?api-version=2024-08-01

URI Parameters

Name	In	Required	Type	Description
scope	path	True	string	The fully qualified Azure Resource manager identifier of the resource.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	StandardAssignmentsList	Azure operation completed successfully.
Other Status Codes	ErrorResponse	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

List standard assignments

Sample request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/standardAssignments?api-version=2024-08-01

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: 2024-08-01/StandardAssignments/ListStandardAssignments.json
func ExampleStandardAssignmentsClient_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("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewStandardAssignmentsClient().NewListPager("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector", 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.StandardAssignmentsClientListResponse{
		// 	StandardAssignmentsList: armsecurity.StandardAssignmentsList{
		// 		Value: []*armsecurity.StandardAssignment{
		// 			{
		// 				Name: to.Ptr("1f3afdf9-d0c9-4c3d-847f-89da613e70a8"),
		// 				Type: to.Ptr("Microsoft.Security/standardAssignments"),
		// 				ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/standardAssignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a8"),
		// 				Properties: &armsecurity.StandardAssignmentProperties{
		// 					Description: to.Ptr("Set of policies monitored by Azure Security Center for cross cloud"),
		// 					AssignedStandard: &armsecurity.AssignedStandardItem{
		// 						ID: to.Ptr("/providers/Microsoft.Security/securityStandards/1f3afdf9-d0c9-4c3d-847f-89da613e70a8"),
		// 					},
		// 					DisplayName: to.Ptr("ASC Default"),
		// 					Effect: to.Ptr(armsecurity.EffectAudit),
		// 					ExcludedScopes: []*string{
		// 					},
		// 					Metadata: &armsecurity.StandardAssignmentMetadata{
		// 						CreatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 						CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.7993124Z"); return t}()),
		// 						LastUpdatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 						LastUpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.7993124Z"); return t}()),
		// 					},
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("1f3afdf9-d0c9-4c3d-847f-89da613e70a8"),
		// 				Type: to.Ptr("Microsoft.Security/standardAssignments"),
		// 				ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/standardAssignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a9"),
		// 				Properties: &armsecurity.StandardAssignmentProperties{
		// 					Description: to.Ptr("Exemption description"),
		// 					AssignedStandard: &armsecurity.AssignedStandardItem{
		// 						ID: to.Ptr("/providers/Microsoft.Security/securityStandards/1f3afdf9-d0c9-4c3d-847f-89da613e70a8"),
		// 					},
		// 					DisplayName: to.Ptr("Test exemption"),
		// 					Effect: to.Ptr(armsecurity.EffectExempt),
		// 					ExemptionData: &armsecurity.StandardAssignmentPropertiesExemptionData{
		// 						AssignedAssessment: &armsecurity.AssignedAssessmentItem{
		// 							AssessmentKey: to.Ptr("1195afff-c881-495e-9bc5-1486211ae03f"),
		// 						},
		// 						ExemptionCategory: to.Ptr(armsecurity.ExemptionCategoryWaiver),
		// 					},
		// 					ExpiresOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-05-01T19:50:47.083633Z"); return t}()),
		// 					Metadata: &armsecurity.StandardAssignmentMetadata{
		// 						CreatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 						CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.7993124Z"); return t}()),
		// 						LastUpdatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 						LastUpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.7993124Z"); return t}()),
		// 					},
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

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 get a list of all relevant standard assignments over a scope
 *
 * @summary get a list of all relevant standard assignments over a scope
 * x-ms-original-file: 2024-08-01/StandardAssignments/ListStandardAssignments.json
 */
async function listStandardAssignments() {
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const resArray = new Array();
  for await (const item of client.standardAssignments.list(
    "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector",
  )) {
    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": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
      "type": "Microsoft.Security/standardAssignments",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/standardAssignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
      "properties": {
        "description": "Set of policies monitored by Azure Security Center for cross cloud",
        "assignedStandard": {
          "id": "/providers/Microsoft.Security/securityStandards/1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
        },
        "displayName": "ASC Default",
        "effect": "Audit",
        "excludedScopes": [],
        "metadata": {
          "createdBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "createdOn": "2022-11-10T08:31:26.7993124Z",
          "lastUpdatedBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "lastUpdatedOn": "2022-11-10T08:31:26.7993124Z"
        }
      }
    },
    {
      "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
      "type": "Microsoft.Security/standardAssignments",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/standardAssignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a9",
      "properties": {
        "description": "Exemption description",
        "assignedStandard": {
          "id": "/providers/Microsoft.Security/securityStandards/1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
        },
        "displayName": "Test exemption",
        "effect": "Exempt",
        "exemptionData": {
          "assignedAssessment": {
            "assessmentKey": "1195afff-c881-495e-9bc5-1486211ae03f"
          },
          "exemptionCategory": "waiver"
        },
        "expiresOn": "2022-05-01T19:50:47.083633Z",
        "metadata": {
          "createdBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "createdOn": "2022-11-10T08:31:26.7993124Z",
          "lastUpdatedBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "lastUpdatedOn": "2022-11-10T08:31:26.7993124Z"
        }
      }
    }
  ]
}

Definitions

Name	Description
AssignedAssessmentItem	Describe the properties of a security assessment object reference (by key)
attestationComplianceState	Attest category of this assignment
AttestationEvidence	Describe the properties of a assignment attestation
Common.AssignedStandardItem	Describe the properties of a of a standard assignments object reference
createdByType	The type of identity that created the resource.
Effect	Expected effect of this assignment (Audit/Exempt/Attest)
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExemptionCategory	Exemption category of this assignment
StandardAssignment	Security Assignment on a resource group over a given scope
StandardAssignmentMetadata	The standard assignment metadata
StandardAssignmentPropertiesAttestationData	Additional data about assignment that has Attest effect
StandardAssignmentPropertiesExemptionData	Additional data about assignment that has Exempt effect
StandardAssignmentsList	Page of a standard assignment list
systemData	Metadata pertaining to creation and last modification of the resource.

AssignedAssessmentItem

Object

Describe the properties of a security assessment object reference (by key)

Name	Type	Description
assessmentKey	string	Unique key to a security assessment object

attestationComplianceState

Enumeration

Attest category of this assignment

Value	Description
unknown	unknown
compliant	compliant
nonCompliant	nonCompliant

AttestationEvidence

Object

Describe the properties of a assignment attestation

Name	Type	Description
description	string	The description of the evidence
sourceUrl	string	The source url of the evidence

Common.AssignedStandardItem

Object

Describe the properties of a of a standard assignments object reference

Name	Type	Description
id	string	Full resourceId of the Microsoft.Security/standard object

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

Effect

Enumeration

Expected effect of this assignment (Audit/Exempt/Attest)

Value	Description
Audit	Audit
Exempt	Exempt
Attest	Attest

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

The error detail.

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

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExemptionCategory

Enumeration

Exemption category of this assignment

Value	Description
waiver	waiver
mitigated	mitigated

StandardAssignment

Object

Security Assignment on a resource group over a given scope

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.assignedStandard	Common.AssignedStandardItem	Standard item with key as applied to this standard assignment over the given scope
properties.attestationData	StandardAssignmentPropertiesAttestationData	Additional data about assignment that has Attest effect
properties.description	string	Description of the standardAssignment
properties.displayName	string	Display name of the standardAssignment
properties.effect	Effect	Expected effect of this assignment (Audit/Exempt/Attest)
properties.excludedScopes	string[]	Excluded scopes, filter out the descendants of the scope (on management scopes)
properties.exemptionData	StandardAssignmentPropertiesExemptionData	Additional data about assignment that has Exempt effect
properties.expiresOn	string (date-time)	Expiration date of this assignment as a full ISO date
properties.metadata	StandardAssignmentMetadata	The standard assignment metadata.
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"

StandardAssignmentMetadata

Object

The standard assignment metadata

Name	Type	Description
createdBy	string	Standard assignment Created by object id (GUID)
createdOn	string (date-time)	Standard assignment creation date
lastUpdatedBy	string	Standard assignment last updated by object id (GUID)
lastUpdatedOn	string (date-time)	Standard assignment last update date

StandardAssignmentPropertiesAttestationData

Object

Additional data about assignment that has Attest effect

Name	Type	Description
assignedAssessment	AssignedAssessmentItem	Component item with key as applied to this standard assignment over the given scope
complianceDate	string (date-time)	Attestation compliance date
complianceState	attestationComplianceState	Attest category of this assignment
evidence	AttestationEvidence[]	Array of links to attestation evidence

StandardAssignmentPropertiesExemptionData

Object

Additional data about assignment that has Exempt effect

Name	Type	Description
assignedAssessment	AssignedAssessmentItem	Component item with key as applied to this standard assignment over the given scope
exemptionCategory	ExemptionCategory	Exemption category of this assignment

StandardAssignmentsList

Object

Page of a standard assignment list

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

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.