Language

PolicyDefinitionReference Class

Definition

The policy definition reference.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.PolicyDefinitionReferenceTypeConverter))]
public class PolicyDefinitionReference : Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.IPolicyDefinitionReference
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.PolicyDefinitionReferenceTypeConverter))>]
type PolicyDefinitionReference = class
    interface IPolicyDefinitionReference
    interface IJsonSerializable
Public Class PolicyDefinitionReference
Implements IPolicyDefinitionReference
Inheritance
PolicyDefinitionReference
Attributes
Implements

Constructors

Name Description
PolicyDefinitionReference()

Creates an new PolicyDefinitionReference instance.

Properties

Name Description
DefinitionVersion

The version of the policy definition to use.

EffectiveDefinitionVersion

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

GroupName

The name of the groups that this policy definition reference belongs to.

Id

A unique id (within the policy set definition) for this policy definition reference.

LatestDefinitionVersion

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

Parameter

The policy definition reference parameter values, exposed with its pre-migration named type IParameterValues (the emitter renamed it to IPolicyDefinitionReferenceParameters). The generated property is renamed to ParameterRaw (see tspconfig.yaml) so this back-compatible accessor owns the Parameter name, reading/writing the same underlying storage.

ParameterRaw

The parameter values for the referenced policy rule. The keys are the parameter names.

PolicyDefinitionId

The ID of the policy definition or policy set definition.

Methods

Name Description
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of PolicyDefinitionReference.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of PolicyDefinitionReference.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.IPolicyDefinitionReference.

FromJsonString(String)

Creates a new instance of PolicyDefinitionReference, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of PolicyDefinitionReference into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to