azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties"
fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties"
name: "PolicyDefinitionProperties"
nameWithType: "PolicyDefinitionProperties"
summary: "The policy definition properties."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **PolicyDefinitionProperties**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties?alt=com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties&text=PolicyDefinitionProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.PolicyDefinitionProperties()"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.PolicyDefinitionProperties()"
  name: "PolicyDefinitionProperties()"
  nameWithType: "PolicyDefinitionProperties.PolicyDefinitionProperties()"
  summary: "Creates an instance of Policy<wbr>Definition<wbr>Properties class."
  syntax: "public PolicyDefinitionProperties()"
  desc: "Creates an instance of PolicyDefinitionProperties class."
methods:
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.description()"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.description()"
  name: "description()"
  nameWithType: "PolicyDefinitionProperties.description()"
  summary: "Get the description property: The policy definition description."
  syntax: "public String description()"
  desc: "Get the description property: The policy definition description."
  returns:
    description: "the description value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.displayName()"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.displayName()"
  name: "displayName()"
  nameWithType: "PolicyDefinitionProperties.displayName()"
  summary: "Get the display<wbr>Name property: The display name of the policy definition."
  syntax: "public String displayName()"
  desc: "Get the displayName property: The display name of the policy definition."
  returns:
    description: "the displayName value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "PolicyDefinitionProperties.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Policy<wbr>Definition<wbr>Properties from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static PolicyDefinitionProperties fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If an error occurs while reading the PolicyDefinitionProperties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of PolicyDefinitionProperties from the JsonReader."
  returns:
    description: "An instance of PolicyDefinitionProperties if the JsonReader was pointing to an instance of it, or null if\n it was pointing to JSON null."
    type: "<xref href=\"com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties?alt=com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties&text=PolicyDefinitionProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.metadata()"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.metadata()"
  name: "metadata()"
  nameWithType: "PolicyDefinitionProperties.metadata()"
  summary: "Get the metadata property: The policy definition metadata."
  syntax: "public Object metadata()"
  desc: "Get the metadata property: The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs."
  returns:
    description: "the metadata value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.mode()"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.mode()"
  name: "mode()"
  nameWithType: "PolicyDefinitionProperties.mode()"
  summary: "Get the mode property: The policy definition mode."
  syntax: "public String mode()"
  desc: "Get the mode property: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data."
  returns:
    description: "the mode value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.parameters()"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.parameters()"
  name: "parameters()"
  nameWithType: "PolicyDefinitionProperties.parameters()"
  summary: "Get the parameters property: The parameter definitions for parameters used in the policy rule."
  syntax: "public Map<String,ParameterDefinitionsValue> parameters()"
  desc: "Get the parameters property: The parameter definitions for parameters used in the policy rule. The keys are the parameter names."
  returns:
    description: "the parameters value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.resourcemanager.resources.models.ParameterDefinitionsValue?alt=com.azure.resourcemanager.resources.models.ParameterDefinitionsValue&text=ParameterDefinitionsValue\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.policyRule()"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.policyRule()"
  name: "policyRule()"
  nameWithType: "PolicyDefinitionProperties.policyRule()"
  summary: "Get the policy<wbr>Rule property: The policy rule."
  syntax: "public Object policyRule()"
  desc: "Get the policyRule property: The policy rule."
  returns:
    description: "the policyRule value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.policyType()"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.policyType()"
  name: "policyType()"
  nameWithType: "PolicyDefinitionProperties.policyType()"
  summary: "Get the policy<wbr>Type property: The type of policy definition."
  syntax: "public PolicyType policyType()"
  desc: "Get the policyType property: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static."
  returns:
    description: "the policyType value."
    type: "<xref href=\"com.azure.resourcemanager.resources.models.PolicyType?alt=com.azure.resourcemanager.resources.models.PolicyType&text=PolicyType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "PolicyDefinitionProperties.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.validate()"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.validate()"
  name: "validate()"
  nameWithType: "PolicyDefinitionProperties.validate()"
  summary: "Validates the instance."
  syntax: "public void validate()"
  desc: "Validates the instance."
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withDescription(java.lang.String)"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withDescription(String description)"
  name: "withDescription(String description)"
  nameWithType: "PolicyDefinitionProperties.withDescription(String description)"
  summary: "Set the description property: The policy definition description."
  parameters:
  - description: "the description value to set."
    name: "description"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public PolicyDefinitionProperties withDescription(String description)"
  desc: "Set the description property: The policy definition description."
  returns:
    description: "the PolicyDefinitionProperties object itself."
    type: "<xref href=\"com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties?alt=com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties&text=PolicyDefinitionProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withDisplayName(java.lang.String)"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withDisplayName(String displayName)"
  name: "withDisplayName(String displayName)"
  nameWithType: "PolicyDefinitionProperties.withDisplayName(String displayName)"
  summary: "Set the display<wbr>Name property: The display name of the policy definition."
  parameters:
  - description: "the displayName value to set."
    name: "displayName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public PolicyDefinitionProperties withDisplayName(String displayName)"
  desc: "Set the displayName property: The display name of the policy definition."
  returns:
    description: "the PolicyDefinitionProperties object itself."
    type: "<xref href=\"com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties?alt=com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties&text=PolicyDefinitionProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withMetadata(java.lang.Object)"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withMetadata(Object metadata)"
  name: "withMetadata(Object metadata)"
  nameWithType: "PolicyDefinitionProperties.withMetadata(Object metadata)"
  summary: "Set the metadata property: The policy definition metadata."
  parameters:
  - description: "the metadata value to set."
    name: "metadata"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  syntax: "public PolicyDefinitionProperties withMetadata(Object metadata)"
  desc: "Set the metadata property: The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs."
  returns:
    description: "the PolicyDefinitionProperties object itself."
    type: "<xref href=\"com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties?alt=com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties&text=PolicyDefinitionProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withMode(java.lang.String)"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withMode(String mode)"
  name: "withMode(String mode)"
  nameWithType: "PolicyDefinitionProperties.withMode(String mode)"
  summary: "Set the mode property: The policy definition mode."
  parameters:
  - description: "the mode value to set."
    name: "mode"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public PolicyDefinitionProperties withMode(String mode)"
  desc: "Set the mode property: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data."
  returns:
    description: "the PolicyDefinitionProperties object itself."
    type: "<xref href=\"com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties?alt=com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties&text=PolicyDefinitionProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withParameters(java.util.Map<java.lang.String,com.azure.resourcemanager.resources.models.ParameterDefinitionsValue>)"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withParameters(Map<String,ParameterDefinitionsValue> parameters)"
  name: "withParameters(Map<String,ParameterDefinitionsValue> parameters)"
  nameWithType: "PolicyDefinitionProperties.withParameters(Map<String,ParameterDefinitionsValue> parameters)"
  summary: "Set the parameters property: The parameter definitions for parameters used in the policy rule."
  parameters:
  - description: "the parameters value to set."
    name: "parameters"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.resourcemanager.resources.models.ParameterDefinitionsValue?alt=com.azure.resourcemanager.resources.models.ParameterDefinitionsValue&text=ParameterDefinitionsValue\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public PolicyDefinitionProperties withParameters(Map<String,ParameterDefinitionsValue> parameters)"
  desc: "Set the parameters property: The parameter definitions for parameters used in the policy rule. The keys are the parameter names."
  returns:
    description: "the PolicyDefinitionProperties object itself."
    type: "<xref href=\"com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties?alt=com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties&text=PolicyDefinitionProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withPolicyRule(java.lang.Object)"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withPolicyRule(Object policyRule)"
  name: "withPolicyRule(Object policyRule)"
  nameWithType: "PolicyDefinitionProperties.withPolicyRule(Object policyRule)"
  summary: "Set the policy<wbr>Rule property: The policy rule."
  parameters:
  - description: "the policyRule value to set."
    name: "policyRule"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  syntax: "public PolicyDefinitionProperties withPolicyRule(Object policyRule)"
  desc: "Set the policyRule property: The policy rule."
  returns:
    description: "the PolicyDefinitionProperties object itself."
    type: "<xref href=\"com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties?alt=com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties&text=PolicyDefinitionProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withPolicyType(com.azure.resourcemanager.resources.models.PolicyType)"
  fullName: "com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties.withPolicyType(PolicyType policyType)"
  name: "withPolicyType(PolicyType policyType)"
  nameWithType: "PolicyDefinitionProperties.withPolicyType(PolicyType policyType)"
  summary: "Set the policy<wbr>Type property: The type of policy definition."
  parameters:
  - description: "the policyType value to set."
    name: "policyType"
    type: "<xref href=\"com.azure.resourcemanager.resources.models.PolicyType?alt=com.azure.resourcemanager.resources.models.PolicyType&text=PolicyType\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public PolicyDefinitionProperties withPolicyType(PolicyType policyType)"
  desc: "Set the policyType property: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static."
  returns:
    description: "the PolicyDefinitionProperties object itself."
    type: "<xref href=\"com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties?alt=com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties&text=PolicyDefinitionProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The policy definition properties."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties?alt=com.azure.resourcemanager.resources.fluent.models.PolicyDefinitionProperties&text=PolicyDefinitionProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.resources.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-resources:2.44.0