Share via

PolicyAssignment interface

  • Reference
Package:
@azure/arm-policy-profile-2020-09-01-hybrid

The policy assignment.

Properties

description

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

The display name of the policy assignment.
id

The ID of the policy assignment. NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the policy assignment.
parameters

Required if a parameter is used in policy rule.
policyDefinitionId

The ID of the policy definition.
scope

The scope for the policy assignment.
type

The type of the policy assignment.

Property Details

description

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

description?: string

Property Value

string

displayName

The display name of the policy assignment.

displayName?: string

Property Value

string

id

The ID of the policy assignment. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

name

The name of the policy assignment.

name?: string

Property Value

string

parameters

Required if a parameter is used in policy rule.

parameters?: Record<string, unknown>

Property Value

Record<string, unknown>

policyDefinitionId

The ID of the policy definition.

policyDefinitionId?: string

Property Value

string

scope

The scope for the policy assignment.

scope?: string

Property Value

string

type

The type of the policy assignment.

type?: string

Property Value

string