Class: Azure::Policy::Mgmt::V2019_09_01::Models::PolicyDefinition

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-09-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.



28
29
30
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 28

def description
  @description
end

#display_name ⇒ String

Returns The display name of the policy definition.

Returns:

  • (String) —

    The display name of the policy definition.



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

def display_name
  @display_name
end

#id ⇒ String

Returns The ID of the policy definition.

Returns:

  • (String) —

    The ID of the policy definition.



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

def id
  @id
end

#metadata ⇒ Object

object and is typically a collection of key value pairs.

Returns:

  • The policy definition metadata. Metadata is an open ended



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

def metadata
  @metadata
end

#mode ⇒ String

Indexed, Microsoft.KeyVault.Data.

Returns:

  • (String) —

    The policy definition mode. Some examples are All,



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

def mode
  @mode
end

#name ⇒ String

Returns The name of the policy definition.

Returns:

  • (String) —

    The name of the policy definition.



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

def name
  @name
end

#parameters ⇒ Hash{String => ParameterDefinitionsValue}

definitions for parameters used in the policy rule. The keys are the parameter names.

Returns:



40
41
42
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 40

def parameters
  @parameters
end

#policy_rule ⇒ Object

Returns The policy rule.

Returns:

  • The policy rule.



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

def policy_rule
  @policy_rule
end

#policy_type ⇒ PolicyType

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

Returns:

  • (PolicyType) —

    The type of policy definition. Possible values are



18
19
20
 
# File 'lib/2019-09-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



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

def type
  @type
end

Class Method Details

.mapper ⇒ Object

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



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
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/2019-09-01/generated/azure_mgmt_policy/models/policy_definition.rb', line 57

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: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ParameterDefinitionsValueElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ParameterDefinitionsValue'
                }
            }
          }
        },
        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