DataManifestCustomResourceFunctionDefinition interface

Package:

@azure/arm-policy

The custom resource function definition.

Properties

allowCustomProperties	A value indicating whether the custom properties within the property bag are allowed. Needs api-version to be specified in the policy rule eg - vault('2019-06-01').
defaultProperties	The top-level properties that can be selected on the function's output. eg - [ "name", "location" ] if vault().name and vault().location are supported
fullyQualifiedResourceType	The fully qualified control plane resource type that this function represents. eg - 'Microsoft.KeyVault/vaults'.
name	The function name as it will appear in the policy rule. eg - 'vault'.

Property Details

allowCustomProperties

A value indicating whether the custom properties within the property bag are allowed. Needs api-version to be specified in the policy rule eg - vault('2019-06-01').

allowCustomProperties?: boolean

Property Value

boolean

defaultProperties

The top-level properties that can be selected on the function's output. eg - [ "name", "location" ] if vault().name and vault().location are supported

defaultProperties?: string[]

Property Value

string[]

fullyQualifiedResourceType

The fully qualified control plane resource type that this function represents. eg - 'Microsoft.KeyVault/vaults'.

fullyQualifiedResourceType?: string

Property Value

string

name

The function name as it will appear in the policy rule. eg - 'vault'.

name?: string

Property Value

string