PolicyDefinition Interface

Package:

com.azure.resourcemanager.resources.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resources:2.45.0

Implements

HasId HasName HasInnerModel<PolicyDefinitionInner> Indexable Refreshable<PolicyDefinition> Updatable<Update>

public interface PolicyDefinition
extends HasName, HasId, Indexable, Refreshable<PolicyDefinition>, Updatable<Update>, HasInnerModel<PolicyDefinitionInner>

An immutable client-side representation of an Azure policy.

Method Summary

Modifier and Type	Method and Description
abstract String	description()
abstract String	displayName()
abstract Object	metadata() Gets the policy definition metadata.
abstract String	mode() Gets the policy definition mode.
abstract Map<String,ParameterDefinitionsValue>	parameters()
abstract Object	policyRule()
abstract PolicyType	policyType()

Method Details

description

public abstract String description()

Returns:

the policy definition description

displayName

public abstract String displayName()

Returns:

the policy definition display name

metadata

public abstract Object metadata()

Gets the policy definition metadata. Metadata is an open-ended object and is typically a collection of key value pairs.

Returns:

the policy definition metadata.

mode

public abstract String mode()

Gets the policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.

Returns:

the policy definition mode.

parameters

public abstract Map parameters()

Returns:

the parameters of the policy definition

policyRule

public abstract Object policyRule()

Returns:

the policy rule

policyType

public abstract PolicyType policyType()

Returns:

the type of the policy definition