Assignments - Get

Get a specific standard assignment for the requested scope by resourceId

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

URI Parameters

Name In Required Type Description
assignmentId
path True

string

The security assignment key - unique key for the standard assignment

resourceGroupName
path True

string

The name of the resource group within the user's subscription. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

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

Responses

Name Type Description
200 OK

Assignment

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 security standardAssignments by by specific standardAssignmentId

Sample Request

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myResourceGroup/providers/Microsoft.Security/assignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a8?api-version=2021-08-01-preview

Sample Response

{
  "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myResourceGroup/providers/Microsoft.Security/assignments/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
  "type": "Microsoft.Security/assignments",
  "location": "East US",
  "etag": "etag value",
  "properties": {
    "displayName": "ASC Default",
    "description": "Set of policies monitored by Azure Security Center for cross cloud",
    "assignedStandard": {
      "id": "/providers/Microsoft.Security/Standards/1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
    },
    "effect": "Exempt",
    "expiresOn": "2022-05-01T19:50:47.083633Z",
    "additionalData": {
      "exemptionCategory": "waiver"
    },
    "metadata": {
      "ticketId": 12345
    },
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/ResourceGroup/rg"
  },
  "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
AdditionalData

Additional data about the assignment

AssignedComponentItem

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

AssignedStandardItem

describe the properties of a of a security standard object reference

Assignment

Security Assignment on a resource group over a given scope

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.

systemData

Metadata pertaining to creation and last modification of the resource.

AdditionalData

Additional data about the assignment

Name Type Description
exemptionCategory

string

Exemption category of this assignment

AssignedComponentItem

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

Name Type Description
key

string

unique key to a security assessment object

AssignedStandardItem

describe the properties of a of a security standard object reference

Name Type Description
id

string

full resourceId of the Microsoft.Security/standard object

Assignment

Security Assignment on a resource group over a given scope

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

AdditionalData

Additional data about the assignment

properties.assignedComponent

AssignedComponentItem

Component item with key as applied to this standard assignment over the given scope

properties.assignedStandard

AssignedStandardItem

Standard item with key as applied to this standard assignment over the given scope

properties.description

string

description of the standardAssignment

properties.displayName

string

display name of the standardAssignment

properties.effect

string

expected effect of this assignment (Disable/Exempt/etc)

properties.expiresOn

string

Expiration date of this assignment as a full ISO date

properties.metadata

object

The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

properties.scope

string

Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription

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

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.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

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

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.