Package com.azure.resourcemanager.resources.models

Class PolicyDefinitionReference

java.lang.Object
com.azure.resourcemanager.resources.models.PolicyDefinitionReference
All Implemented Interfaces:
com.azure.json.JsonSerializable<PolicyDefinitionReference>
public final class PolicyDefinitionReference extends Object implements com.azure.json.JsonSerializable<PolicyDefinitionReference>
The policy definition reference.

  • Constructor Details

    • PolicyDefinitionReference

      public PolicyDefinitionReference()
      Creates an instance of PolicyDefinitionReference class.

  • Method Details

    • policyDefinitionId

      public String policyDefinitionId()
      Get the policyDefinitionId property: The ID of the policy definition or policy set definition.
      Returns:
      the policyDefinitionId value.

    • 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.

    • definitionVersion

      public String definitionVersion()
      Get the definitionVersion property: The version of the policy definition to use.
      Returns:
      the definitionVersion value.

    • 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.

    • 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.

    • 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.

    • parameters

      public Map<String,ParameterValuesValue> parameters()
      Get the parameters property: The parameter values for the referenced policy rule. The keys are the parameter names.
      Returns:
      the parameters value.

    • withParameters

      public PolicyDefinitionReference withParameters(Map<String,ParameterValuesValue> 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.

    • 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.

    • 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.

    • groupNames

      public List<String> groupNames()
      Get the groupNames property: The name of the groups that this policy definition reference belongs to.
      Returns:
      the groupNames value.

    • withGroupNames

      public PolicyDefinitionReference withGroupNames(List<String> 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.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<PolicyDefinitionReference>
      Throws:
      IOException

    • fromJson

      public static PolicyDefinitionReference fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the PolicyDefinitionReference.