Share via


PolicyAssignmentData Class

Definition

A class representing the PolicyAssignment data model.

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

Constructors

PolicyAssignmentData()

Initializes a new instance of PolicyAssignmentData.

Properties

Description

This message will be part of response in case of policy violation.

DisplayName

The display name of the policy assignment.

EnforcementMode

The policy assignment enforcement mode. Possible values are Default and DoNotEnforce.

ExcludedScopes

The policy's excluded scopes.

Id

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

(Inherited from ResourceData)
Location

The location of the policy assignment. Only required when utilizing managed identity.

ManagedIdentity

The managed identity associated with the policy assignment. Current supported identity types: None, SystemAssigned, UserAssigned.

Metadata

The policy assignment 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" }.

Name

The name of the resource.

(Inherited from ResourceData)
NonComplianceMessages

The messages that describe why a resource is non-compliant with the policy.

Overrides

The policy property value override.

Parameters

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

PolicyDefinitionId

The ID of the policy definition or policy set definition being assigned.

ResourceSelectors

The resource selector list to filter policies by resource properties.

ResourceType

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

(Inherited from ResourceData)
Scope

The scope for the policy assignment.

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<PolicyAssignmentData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<PolicyAssignmentData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<PolicyAssignmentData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<PolicyAssignmentData>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<PolicyAssignmentData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to