ActionProperties interface
Model that represents the properties of an Action resource.
Properties
| action |
The short name of the action (e.g., "Shutdown"). |
| action |
The type of the action. |
| canonical |
Canonical identifier of the action (e.g., "microsoft-compute-shutdown/1.0"). |
| description | Description of what this action does. |
| display |
Human-readable display name of the action. |
| parameters |
JSON Schema describing the parameters for this action. |
| recommended |
Recommended Azure RBAC role definition GUIDs for this action. |
| supported |
List of target types supported by this action. |
| version | The version of the action (e.g., "1.0.0"). |
Property Details
actionName
The short name of the action (e.g., "Shutdown").
actionName?: stringProperty Value
string
actionType
The type of the action.
actionType?: stringProperty Value
string
canonicalId
Canonical identifier of the action (e.g., "microsoft-compute-shutdown/1.0").
canonicalId?: stringProperty Value
string
description
Description of what this action does.
description?: stringProperty Value
string
displayName
Human-readable display name of the action.
displayName?: stringProperty Value
string
parametersSchema
JSON Schema describing the parameters for this action.
parametersSchema?: Record<string, any>Property Value
Record<string, any>
recommendedRoles
Recommended Azure RBAC role definition GUIDs for this action.
recommendedRoles?: string[]Property Value
string[]
supportedTargetTypes
List of target types supported by this action.
supportedTargetTypes?: ActionSupportedTargetType[]Property Value
version
The version of the action (e.g., "1.0.0").
version?: stringProperty Value
string
