Standard Assignments - Create

Service:: Defender for Cloud

API Version:: 2024-08-01

This operation creates or updates a standard assignment with the given scope and name. standard assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.

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

URI Parameters

Name	In	Required	Type	Description
resourceId	path	True	string	The fully qualified Azure Resource manager identifier of the resource.
standardAssignmentName	path	True	string pattern: [{]?[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$	The standard assignments assignment key - unique key for the standard assignment
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
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.

Responses

Name	Type	Description
200 OK	StandardAssignment	Resource 'StandardAssignment' update operation succeeded
201 Created	StandardAssignment	Resource 'StandardAssignment' create operation succeeded
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

Put an audit standard assignment

Put exemption standard assignment

Put an audit standard assignment

Sample request

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/standardAssignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a8?api-version=2024-08-01

{
  "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": []
  }
}

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/PutStandardAssignment.json
func ExampleStandardAssignmentsClient_Create_putAnAuditStandardAssignment() {
	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)
	}
	res, err := clientFactory.NewStandardAssignmentsClient().Create(ctx, "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", armsecurity.StandardAssignment{
		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{},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsecurity.StandardAssignmentsClientCreateResponse{
	// 	StandardAssignment: 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/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}()),
	// 			},
	// 		},
	// 	},
	// }
}

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 this operation creates or updates a standard assignment with the given scope and name. standard assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
 *
 * @summary this operation creates or updates a standard assignment with the given scope and name. standard assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
 * x-ms-original-file: 2024-08-01/StandardAssignments/PutStandardAssignment.json
 */
async function putAnAuditStandardAssignment() {
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.standardAssignments.create(
    "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
    "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
    {
      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: [],
    },
  );
  console.log(result);
}

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

{
  "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "type": "Microsoft.Security/standardAssignments",
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/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"
    }
  }
}

Status code:: 201

{
  "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "type": "Microsoft.Security/standardAssignments",
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/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"
    }
  }
}

Put exemption standard assignment

Sample request

PUT https://management.azure.com/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/ANAT_TEST_RG/providers/Microsoft.Compute/virtualMachines/anatTestE2LA/providers/Microsoft.Security/standardAssignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a8?api-version=2024-08-01

{
  "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"
  }
}

package armsecurity_test

import (
	"context"
	"log"
	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/PutExemptionStandardAssignment.json
func ExampleStandardAssignmentsClient_Create_putExemptionStandardAssignment() {
	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)
	}
	res, err := clientFactory.NewStandardAssignmentsClient().Create(ctx, "subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/ANAT_TEST_RG/providers/Microsoft.Compute/virtualMachines/anatTestE2LA", "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", armsecurity.StandardAssignment{
		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 }()),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsecurity.StandardAssignmentsClientCreateResponse{
	// 	StandardAssignment: armsecurity.StandardAssignment{
	// 		Name: to.Ptr("1f3afdf9-d0c9-4c3d-847f-89da613e70a8"),
	// 		Type: to.Ptr("Microsoft.Security/standardAssignments"),
	// 		ID: to.Ptr("/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/ANAT_TEST_RG/providers/Microsoft.Compute/virtualMachines/anatTestE2LA/providers/Microsoft.Security/standardAssignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a8"),
	// 		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

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

/**
 * This sample demonstrates how to this operation creates or updates a standard assignment with the given scope and name. standard assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
 *
 * @summary this operation creates or updates a standard assignment with the given scope and name. standard assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
 * x-ms-original-file: 2024-08-01/StandardAssignments/PutExemptionStandardAssignment.json
 */
async function putExemptionStandardAssignment() {
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.standardAssignments.create(
    "subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/ANAT_TEST_RG/providers/Microsoft.Compute/virtualMachines/anatTestE2LA",
    "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
    {
      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: new Date("2022-05-01T19:50:47.083633Z"),
    },
  );
  console.log(result);
}

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

{
  "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "type": "Microsoft.Security/standardAssignments",
  "id": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/ANAT_TEST_RG/providers/Microsoft.Compute/virtualMachines/anatTestE2LA/providers/Microsoft.Security/standardAssignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "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"
    }
  }
}

Status code:: 201

{
  "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "type": "Microsoft.Security/standardAssignments",
  "id": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/ANAT_TEST_RG/providers/Microsoft.Compute/virtualMachines/anatTestE2LA/providers/Microsoft.Security/standardAssignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "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
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