Standard Assignments - Get

Reference

Service:: Defender for Cloud

API Version:: 2024-08-01

Retrieves a standard assignment.
This operation retrieves a single standard assignment, given its name and the scope it was created at.

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

URI Parameters

Name In Required Type Description

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

resourceId

path

True

string

The identifier of the resource.

standardAssignmentName

path

True

string

The standard assignments assignment key - unique key for the standard assignment

Regex pattern: [{]?[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$

api-version

query

True

string

The API version to use for this operation.

Responses

Name	Type	Description
200 OK	StandardAssignment	Returns information about the standard assignment.
Other Status Codes	ErrorResponse	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

Retrieve a standard assignment

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/standardAssignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a8?api-version=2024-08-01

Sample response

Status code:: 200

{
  "id": "/providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/securityStandards/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "type": "Microsoft.Security/standardAssignments",
  "properties": {
    "displayName": "Test exemption",
    "description": "Exemption description",
    "assignedStandard": {
      "id": "/providers/Microsoft.Security/securityStandards/1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
    },
    "effect": "Exempt",
    "expiresOn": "2022-05-01T19:50:47.083633Z",
    "exemptionData": {
      "exemptionCategory": "waiver",
      "assignedAssessment": {
        "assessmentKey": "1195afff-c881-495e-9bc5-1486211ae03f"
      }
    },
    "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)
AssignedStandardItem	Describe the properties of a of a standard assignments object reference
attestationComplianceState	Attest category of this assignment
AttestationData	Additional data about assignment that has Attest effect
AttestationEvidence	Describe the properties of a assignment attestation
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
ExemptionData	Additional data about assignment that has Exempt effect
StandardAssignment	Security Assignment on a resource group over a given scope
StandardAssignmentMetadata	The standard assignment metadata

AssignedAssessmentItem

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

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

AssignedStandardItem

Describe the properties of a of a standard assignments object reference

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

attestationComplianceState

Attest category of this assignment

Name	Type	Description
compliant	string
nonCompliant	string
unknown	string

AttestationData

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	Attestation compliance date
complianceState	attestationComplianceState	Attest category of this assignment
evidence	AttestationEvidence[]	Array of links to attestation evidence

AttestationEvidence

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

effect

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

Name	Type	Description
Attest	string
Audit	string
Exempt	string

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

exemptionCategory

Exemption category of this assignment

Name	Type	Description
mitigated	string
waiver	string

ExemptionData

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