PolicyDefinitionReference Class

Package:

com.azure.resourcemanager.resources.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resources:2.52.0

• java.lang.Object
• • com.azure.resourcemanager.resources.models.PolicyDefinitionReference

Implements

JsonSerializable<PolicyDefinitionReference>

public final class PolicyDefinitionReference
implements JsonSerializable<PolicyDefinitionReference>

The policy definition reference.

Constructor Summary

Constructor	Description
PolicyDefinitionReference()	Creates an instance of PolicyDefinitionReference class.

Method Summary

Modifier and Type	Method and Description
String	definitionVersion() Get the definitionVersion property: The version of the policy definition to use.
String	effectiveDefinitionVersion() Get the effectiveDefinitionVersion property: The effective version of the policy definition in use.
static PolicyDefinitionReference	fromJson(JsonReader jsonReader) Reads an instance of PolicyDefinitionReference from the JsonReader.
List<String>	groupNames() Get the groupNames property: The name of the groups that this policy definition reference belongs to.
String	latestDefinitionVersion() Get the latestDefinitionVersion property: The latest version of the policy definition available.
Map<String,ParameterValuesValue>	parameters() Get the parameters property: The parameter values for the referenced policy rule.
String	policyDefinitionId() Get the policyDefinitionId property: The ID of the policy definition or policy set definition.
String	policyDefinitionReferenceId() Get the policyDefinitionReferenceId property: A unique id (within the policy set definition) for this policy definition reference.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
PolicyDefinitionReference	withDefinitionVersion(String definitionVersion) Set the definitionVersion property: The version of the policy definition to use.
PolicyDefinitionReference	withGroupNames(List<String> groupNames) Set the groupNames property: The name of the groups that this policy definition reference belongs to.
PolicyDefinitionReference	withParameters(Map<String,ParameterValuesValue> parameters) Set the parameters property: The parameter values for the referenced policy rule.
PolicyDefinitionReference	withPolicyDefinitionId(String policyDefinitionId) Set the policyDefinitionId property: The ID of the policy definition or policy set definition.
PolicyDefinitionReference	withPolicyDefinitionReferenceId(String policyDefinitionReferenceId) Set the policyDefinitionReferenceId property: A unique id (within the policy set definition) for this policy definition reference.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PolicyDefinitionReference

public PolicyDefinitionReference()

Creates an instance of PolicyDefinitionReference class.

Method Details

definitionVersion

public String definitionVersion()

Get the definitionVersion property: The version of the policy definition to use.

Returns:

the definitionVersion value.

effectiveDefinitionVersion

public String effectiveDefinitionVersion()

Get the effectiveDefinitionVersion property: The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.

Returns:

the effectiveDefinitionVersion value.

fromJson

public static PolicyDefinitionReference fromJson(JsonReader jsonReader)

Reads an instance of PolicyDefinitionReference from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PolicyDefinitionReference if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

groupNames

public List groupNames()

Get the groupNames property: The name of the groups that this policy definition reference belongs to.

Returns:

the groupNames value.

latestDefinitionVersion

public String latestDefinitionVersion()

Get the latestDefinitionVersion property: The latest version of the policy definition available. This is only present if requested via the $expand query parameter.

Returns:

the latestDefinitionVersion value.

parameters

public Map parameters()

Get the parameters property: The parameter values for the referenced policy rule. The keys are the parameter names.

Returns:

the parameters value.

policyDefinitionId

public String policyDefinitionId()

Get the policyDefinitionId property: The ID of the policy definition or policy set definition.

Returns:

the policyDefinitionId value.

policyDefinitionReferenceId

public String policyDefinitionReferenceId()

Get the policyDefinitionReferenceId property: A unique id (within the policy set definition) for this policy definition reference.

Returns:

the policyDefinitionReferenceId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withDefinitionVersion

public PolicyDefinitionReference withDefinitionVersion(String definitionVersion)

Set the definitionVersion property: The version of the policy definition to use.

Parameters:

definitionVersion - the definitionVersion value to set.

Returns:

the PolicyDefinitionReference object itself.

withGroupNames

public PolicyDefinitionReference withGroupNames(List groupNames)

Set the groupNames property: The name of the groups that this policy definition reference belongs to.

Parameters:

groupNames - the groupNames value to set.

Returns:

the PolicyDefinitionReference object itself.

withParameters

public PolicyDefinitionReference withParameters(Map parameters)

Set the parameters property: The parameter values for the referenced policy rule. The keys are the parameter names.

Parameters:

parameters - the parameters value to set.

Returns:

the PolicyDefinitionReference object itself.

withPolicyDefinitionId

public PolicyDefinitionReference withPolicyDefinitionId(String policyDefinitionId)

Set the policyDefinitionId property: The ID of the policy definition or policy set definition.

Parameters:

policyDefinitionId - the policyDefinitionId value to set.

Returns:

the PolicyDefinitionReference object itself.

withPolicyDefinitionReferenceId

public PolicyDefinitionReference withPolicyDefinitionReferenceId(String policyDefinitionReferenceId)

Set the policyDefinitionReferenceId property: A unique id (within the policy set definition) for this policy definition reference.

Parameters:

policyDefinitionReferenceId - the policyDefinitionReferenceId value to set.

Returns:

the PolicyDefinitionReference object itself.