Class: Azure::Policy::Mgmt::V2018_03_01::Models::PolicyDefinition

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb

Overview

The policy definition.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#description ⇒ String

Returns The policy definition description.

Returns:

  • (String) —

    The policy definition description.



29
30
31
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 29

def description
  @description
end

#display_name ⇒ String

Returns The display name of the policy definition.

Returns:

  • (String) —

    The display name of the policy definition.



26
27
28
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 26

def display_name
  @display_name
end

#id ⇒ String

Returns The ID of the policy definition.

Returns:

  • (String) —

    The ID of the policy definition.



41
42
43
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 41

def id
  @id
end

#metadata ⇒ Object

Returns The policy definition metadata.

Returns:

  • The policy definition metadata.



35
36
37
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 35

def metadata
  @metadata
end

#mode ⇒ PolicyMode

NotSpecified, Indexed, and All. Possible values include: ‘NotSpecified’, ‘Indexed’, ‘All’

Returns:

  • (PolicyMode) —

    The policy definition mode. Possible values are



23
24
25
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 23

def mode
  @mode
end

#name ⇒ String

Returns The name of the policy definition.

Returns:

  • (String) —

    The name of the policy definition.



44
45
46
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 44

def name
  @name
end

#parameters ⇒ Object

Returns Required if a parameter is used in policy rule.

Returns:

  • Required if a parameter is used in policy rule.



38
39
40
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 38

def parameters
  @parameters
end

#policy_rule ⇒ Object

Returns The policy rule.

Returns:

  • The policy rule.



32
33
34
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 32

def policy_rule
  @policy_rule
end

#policy_type ⇒ PolicyType

NotSpecified, BuiltIn, and Custom. Possible values include: ‘NotSpecified’, ‘BuiltIn’, ‘Custom’

Returns:

  • (PolicyType) —

    The type of policy definition. Possible values are



18
19
20
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 18

def policy_type
  @policy_type
end

#type ⇒ String

(Microsoft.Authorization/policyDefinitions).

Returns:

  • (String) —

    The type of the resource



48
49
50
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 48

def type
  @type
end

Class Method Details

.mapper ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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
 
# File 'lib/2018-03-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 55

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'PolicyDefinition',
    type: {
      name: 'Composite',
      class_name: 'PolicyDefinition',
      model_properties: {
        policy_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.policyType',
          type: {
            name: 'String'
          }
        },
        mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.mode',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        policy_rule: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.policyRule',
          type: {
            name: 'Object'
          }
        },
        metadata: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.metadata',
          type: {
            name: 'Object'
          }
        },
        parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.parameters',
          type: {
            name: 'Object'
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end