Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Display

Package version

interface

An interface representing Display.

Hierarchy

  • Display

Index

Properties

Optional description

description: undefined | string
member

{string} [description] The localized friendly description for the operation as shown to the user. This description should be thorough, yet concise. It will be used in tool-tips and detailed views.

Optional operation

operation: undefined | string
member

{string} [operation] The localized friendly name for the operation as shown to the user. This name should be concise (to fit in drop downs), but clear (self-documenting). Use Title Casing and include the entity/resource to which it applies.

Optional origin

origin: undefined | string
member

{string} [origin] The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is 'user,system'

Optional provider

provider: undefined | string
member

{string} [provider] The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with "Microsoft" for 1st party services.

Optional resource

resource: undefined | string
member

{string} [resource] The localized friendly form of the resource type related to this action/operation. This form should match the public documentation for the resource provider. Use Title Casing. For examples, refer to the "name" section.

Generated using TypeDoc