SecurityGroupEntity interface

Represents a security group entity.

Extends

Properties

additionalData

A bag of custom fields that should be part of the entity and will be presented to the user. NOTE: This property will not be serialized. It can only be populated by the server.

distinguishedName

The group distinguished name NOTE: This property will not be serialized. It can only be populated by the server.

friendlyName

The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. NOTE: This property will not be serialized. It can only be populated by the server.

kind

Polymorphic discriminator, which specifies the different types this object can be

objectGuid

A single-value attribute that is the unique identifier for the object, assigned by active directory. NOTE: This property will not be serialized. It can only be populated by the server.

sid

The SID attribute is a single-value attribute that specifies the security identifier (SID) of the group NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

additionalData

A bag of custom fields that should be part of the entity and will be presented to the user. NOTE: This property will not be serialized. It can only be populated by the server.

additionalData?: {[propertyName: string]: Record<string, unknown>}

Property Value

{[propertyName: string]: Record<string, unknown>}

distinguishedName

The group distinguished name NOTE: This property will not be serialized. It can only be populated by the server.

distinguishedName?: string

Property Value

string

friendlyName

The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. NOTE: This property will not be serialized. It can only be populated by the server.

friendlyName?: string

Property Value

string

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "SecurityGroup"

Property Value

"SecurityGroup"

objectGuid

A single-value attribute that is the unique identifier for the object, assigned by active directory. NOTE: This property will not be serialized. It can only be populated by the server.

objectGuid?: string

Property Value

string

sid

The SID attribute is a single-value attribute that specifies the security identifier (SID) of the group NOTE: This property will not be serialized. It can only be populated by the server.

sid?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Entity.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Entity.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

Inherited From Entity.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Entity.type