Share via

OperationsDiscovery interface

  • Reference
Package:
@azure/arm-resourcemover

Operations discovery class.

Properties

display

Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.
isDataAction

Indicates whether the operation is a data action
name

Gets or sets Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include:

  • Microsoft.Compute/virtualMachine/capture/action
  • Microsoft.Compute/virtualMachine/restart/action
  • Microsoft.Compute/virtualMachine/write
  • Microsoft.Compute/virtualMachine/read
  • Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the "{Resource Provider Namespace}/register/action" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release).
origin

Gets or sets 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".
properties

ClientDiscovery properties.

Property Details

display

Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.

display?: Display

Property Value

Display

isDataAction

Indicates whether the operation is a data action

isDataAction?: boolean

Property Value

boolean

name

Gets or sets Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include:

  • Microsoft.Compute/virtualMachine/capture/action
  • Microsoft.Compute/virtualMachine/restart/action
  • Microsoft.Compute/virtualMachine/write
  • Microsoft.Compute/virtualMachine/read
  • Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the "{Resource Provider Namespace}/register/action" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release).
name?: string

Property Value

string

origin

Gets or sets 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".

origin?: string

Property Value

string

properties

ClientDiscovery properties.

properties?: Record<string, unknown>

Property Value

Record<string, unknown>