Share via


PolicyAssignment Class

Definition

PolicyAssignment.

public class PolicyAssignment : Azure.Provisioning.Primitives.ProvisionableResource
type PolicyAssignment = class
    inherit ProvisionableResource
Public Class PolicyAssignment
Inherits ProvisionableResource
Inheritance

Constructors

Name Description
PolicyAssignment(String, String)

Creates a new PolicyAssignment.

Properties

Name Description
BicepIdentifier

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisionableConstruct)
DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
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}.

IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
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 System.BinaryData.FromObjectAsJson1(0,System.Text.Json.JsonSerializerOptions). To assign an already formatted json string to this property use System.BinaryData.FromString(System.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 policy assignment.

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

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
Scope

The scope for the policy assignment.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Methods

Name Description
AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from ProvisionableResource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableResource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of PolicyAssignment.

DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing PolicyAssignment.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableResource)

Explicit Interface Implementations

Name Description
IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Extension Methods

Name Description
ToBicepExpression(IBicepValue)

Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to