Edit

Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions interface

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the collection of Excel.SensitivityLabelDetails objects.

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

abacAttributeValues

For EACH ITEM in the collection: Gets the ABAC (attribute-based access control) attribute values associated with this label.

children

For EACH ITEM in the collection: Gets the sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.

color

For EACH ITEM in the collection: Gets the color of the sensitivity label.

id

For EACH ITEM in the collection: Gets the unique identifier (GUID) of the sensitivity label.

isAbacAttributesRequired

For EACH ITEM in the collection: Gets a value indicating whether ABAC (attribute-based access control) attributes are required for this label.

isAbacEnabled

For EACH ITEM in the collection: Gets a value indicating whether ABAC (attribute-based access control) is enabled for this label.

isEnabled

For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.

name

For EACH ITEM in the collection: Gets the name of the sensitivity label.

order

For EACH ITEM in the collection: Gets the priority of the sensitivity label, with 0 as lowest priority.

protectionType

For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.

siteId

For EACH ITEM in the collection: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.

tooltip

For EACH ITEM in the collection: Gets the description of the sensitivity label.

Property Details

$all

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

abacAttributeValues

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets the ABAC (attribute-based access control) attribute values associated with this label.

abacAttributeValues?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

children

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets the sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.

children?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

color

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets the color of the sensitivity label.

color?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

id

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets the unique identifier (GUID) of the sensitivity label.

id?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

isAbacAttributesRequired

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets a value indicating whether ABAC (attribute-based access control) attributes are required for this label.

isAbacAttributesRequired?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

isAbacEnabled

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets a value indicating whether ABAC (attribute-based access control) is enabled for this label.

isAbacEnabled?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

isEnabled

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.

isEnabled?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

name

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets the name of the sensitivity label.

name?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

order

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets the priority of the sensitivity label, with 0 as lowest priority.

order?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

protectionType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.

protectionType?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

siteId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.

siteId?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

tooltip

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets the description of the sensitivity label.

tooltip?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)