Class: Azure::Policy::Mgmt::V2019_09_01::Models::PolicyAssignment

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb

Overview

The policy assignment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#description ⇒ String

policy violation.

Returns:

  • (String) —

    This message will be part of response in case of



34
35
36
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 34

def description
  @description
end

#display_name ⇒ String

Returns The display name of the policy assignment.

Returns:

  • (String) —

    The display name of the policy assignment.



16
17
18
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 16

def display_name
  @display_name
end

#enforcement_mode ⇒ EnforcementMode

Possible values are Default and DoNotEnforce. Possible values include: ‘Default’, ‘DoNotEnforce’

Returns:



43
44
45
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 43

def enforcement_mode
  @enforcement_mode
end

#id ⇒ String

Returns The ID of the policy assignment.

Returns:

  • (String) —

    The ID of the policy assignment.



46
47
48
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 46

def id
  @id
end

#identity ⇒ Identity

assignment.

Returns:

  • (Identity) —

    The managed identity associated with the policy



64
65
66
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 64

def identity
  @identity
end

#location ⇒ String

when utilizing managed identity.

Returns:

  • (String) —

    The location of the policy assignment. Only required



60
61
62
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 60

def location
  @location
end

#metadata ⇒ Object

object and is typically a collection of key value pairs.

Returns:

  • The policy assignment metadata. Metadata is an open ended



38
39
40
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 38

def metadata
  @metadata
end

#name ⇒ String

Returns The name of the policy assignment.

Returns:

  • (String) —

    The name of the policy assignment.



52
53
54
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 52

def name
  @name
end

#not_scopes ⇒ Array<String>

Returns The policy’s excluded scopes.

Returns:

  • (Array<String>) —

    The policy’s excluded scopes.



26
27
28
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 26

def not_scopes
  @not_scopes
end

#parameters ⇒ Hash{String => ParameterValuesValue}

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

Returns:



30
31
32
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 30

def parameters
  @parameters
end

#policy_definition_id ⇒ String

definition being assigned.

Returns:

  • (String) —

    The ID of the policy definition or policy set



20
21
22
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 20

def policy_definition_id
  @policy_definition_id
end

#scope ⇒ String

Returns The scope for the policy assignment.

Returns:

  • (String) —

    The scope for the policy assignment.



23
24
25
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 23

def scope
  @scope
end

#sku ⇒ PolicySku

obsolete, and will be ignored.

Returns:

  • (PolicySku) —

    The policy sku. This property is optional,



56
57
58
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 56

def sku
  @sku
end

#type ⇒ String

Returns The type of the policy assignment.

Returns:

  • (String) —

    The type of the policy assignment.



49
50
51
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 49

def type
  @type
end

Class Method Details

.mapper ⇒ Object

Mapper for PolicyAssignment class as Ruby Hash. This will be used for serialization/deserialization.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_assignment.rb', line 71

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'PolicyAssignment',
    type: {
      name: 'Composite',
      class_name: 'PolicyAssignment',
      model_properties: {
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        policy_definition_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.policyDefinitionId',
          type: {
            name: 'String'
          }
        },
        scope: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.scope',
          type: {
            name: 'String'
          }
        },
        not_scopes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.notScopes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.parameters',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ParameterValuesValueElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ParameterValuesValue'
                }
            }
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        metadata: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.metadata',
          type: {
            name: 'Object'
          }
        },
        enforcement_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enforcementMode',
          type: {
            name: 'String'
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'PolicySku'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        identity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'identity',
          type: {
            name: 'Composite',
            class_name: 'Identity'
          }
        }
      }
    }
  }
end