Assignment interface
Security Assignment on a resource group over a given scope
- Extends
Properties
| additional |
Additional data about the assignment |
| assigned |
Component item with key as applied to this standard assignment over the given scope |
| assigned |
Standard item with key as applied to this standard assignment over the given scope |
| description | description of the standardAssignment |
| display |
display name of the standardAssignment |
| effect | expected effect of this assignment (Disable/Exempt/etc) |
| etag | Entity tag is used for comparing two or more entities from the same requested resource. |
| expires |
Expiration date of this assignment as a full ISO date |
| kind | Kind of the resource |
| location | The geo-location where the resource lives |
| metadata | The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. |
| scope | Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription |
| tags | Resource tags. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
additionalData
Additional data about the assignment
additionalData?: AssignmentPropertiesAdditionalData
Property Value
assignedComponent
Component item with key as applied to this standard assignment over the given scope
assignedComponent?: AssignedComponentItem
Property Value
assignedStandard
Standard item with key as applied to this standard assignment over the given scope
assignedStandard?: AssignedStandardItem
Property Value
description
description of the standardAssignment
description?: string
Property Value
string
displayName
display name of the standardAssignment
displayName?: string
Property Value
string
effect
expected effect of this assignment (Disable/Exempt/etc)
effect?: string
Property Value
string
etag
Entity tag is used for comparing two or more entities from the same requested resource.
etag?: string
Property Value
string
expiresOn
Expiration date of this assignment as a full ISO date
expiresOn?: Date
Property Value
Date
kind
Kind of the resource
kind?: string
Property Value
string
location
The geo-location where the resource lives
location?: string
Property Value
string
metadata
The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.
metadata?: any
Property Value
any
scope
Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription
scope?: string
Property Value
string
tags
Resource tags.
tags?: Record<string, string>
Property Value
Record<string, string>
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: string
Property Value
string
Inherited From ProxyResource.id
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemData
Property Value
Inherited From ProxyResource.systemData
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: string
Property Value
string
Inherited From ProxyResource.type