Share via


PolicyDefinitionData Class

Definition

A class representing the PolicyDefinition data model. The policy definition.

public class PolicyDefinitionData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Resources.PolicyDefinitionData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Resources.PolicyDefinitionData>
type PolicyDefinitionData = class
    inherit ResourceData
    interface IJsonModel<PolicyDefinitionData>
    interface IPersistableModel<PolicyDefinitionData>
Public Class PolicyDefinitionData
Inherits ResourceData
Implements IJsonModel(Of PolicyDefinitionData), IPersistableModel(Of PolicyDefinitionData)
Inheritance
PolicyDefinitionData
Implements

Constructors

PolicyDefinitionData()

Initializes a new instance of PolicyDefinitionData.

Properties

Description

The policy definition description.

DisplayName

The display name of the policy definition.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Metadata

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

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

Mode

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

Name

The name of the resource.

(Inherited from ResourceData)
Parameters

The parameter definitions for parameters used in the policy rule. The keys are the parameter names.

PolicyRule

The policy rule.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

PolicyType

The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<PolicyDefinitionData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<PolicyDefinitionData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<PolicyDefinitionData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<PolicyDefinitionData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<PolicyDefinitionData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to