Class: Azure::CostManagement::Mgmt::V2019_04_01_preview::Models::View

Inherits:
ProxyResource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb

Overview

States and configurations of Cost Analysis.

Instance Attribute Summary collapse

Attributes inherited from ProxyResource

#e_tag, #id, #name, #type

Class Method Summary collapse

Instance Attribute Details

#accumulated ⇒ AccumulatedType

values include: ‘true’, ‘false’

Returns:



72
73
74
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 72

def accumulated
  @accumulated
end

#chart ⇒ ChartType

Required. Possible values include: ‘Area’, ‘Line’, ‘StackedColumn’, ‘GroupedColumn’, ‘Table’

Returns:

  • (ChartType) —

    Chart type of the main view in Cost Analysis.



68
69
70
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 68

def chart
  @chart
end

#created_on ⇒ DateTime

Returns Date the user created this view.

Returns:

  • (DateTime) —

    Date the user created this view.



41
42
43
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 41

def created_on
  @created_on
end

#dataset ⇒ ReportConfigDataset

config.

Returns:



63
64
65
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 63

def dataset
  @dataset
end

#display_name ⇒ String

Returns User input name of the view. Required.

Returns:

  • (String) —

    User input name of the view. Required.



16
17
18
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 16

def display_name
  @display_name
end

#kpis ⇒ Array<KpiProperties>

UI.

Returns:

  • (Array<KpiProperties>) —

    List of KPIs to show in Cost Analysis



80
81
82
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 80

def kpis
  @kpis
end

#metric ⇒ MetricType

values include: ‘ActualCost’, ‘AmortizedCost’, ‘AHUB’

Returns:

  • (MetricType) —

    Metric to use when displaying costs. Possible



76
77
78
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 76

def metric
  @metric
end

#modified_on ⇒ DateTime

Returns Date when the user last modified this view.

Returns:

  • (DateTime) —

    Date when the user last modified this view.



44
45
46
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 44

def modified_on
  @modified_on
end

#pivots ⇒ Array<PivotProperties>

Cost Analysis UI.

Returns:



84
85
86
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 84

def pivots
  @pivots
end

#scope ⇒ String

includes ‘subscriptions/subscriptionId’ for subscription scope, ‘subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for BillingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for InvoiceSection scope, ‘providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.CostManagement/externalBillingAccounts/externalBillingAccountName’ for ExternalBillingAccount scope, and ‘/providers/Microsoft.CostManagement/externalSubscriptions/externalSubscriptionName’ for ExternalSubscription scope.

Returns:

  • (String) —

    Cost Management scope to save the view on. This



38
39
40
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 38

def scope
  @scope
end

#time_period ⇒ ReportConfigTimePeriod

the report.

Returns:



59
60
61
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 59

def time_period
  @time_period
end

#timeframe ⇒ TimeframeType

If custom, then a specific time period must be provided. Possible values include: ‘WeekToDate’, ‘MonthToDate’, ‘YearToDate’, ‘Custom’

Returns:

  • (TimeframeType) —

    The time frame for pulling data for the report.



55
56
57
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 55

def timeframe
  @timeframe
end

#view_type ⇒ String

forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. Default value: ‘Usage’ .

Returns:

  • (String) —

    The type of the report. Usage represents actual usage,



50
51
52
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 50

def view_type
  @view_type
end

Class Method Details

.mapper ⇒ Object

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



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/models/view.rb', line 91

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'View',
    type: {
      name: 'Composite',
      class_name: 'View',
      model_properties: {
        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'
          }
        },
        e_tag: {
          client_side_validation: true,
          required: false,
          serialized_name: 'eTag',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        scope: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.scope',
          type: {
            name: 'String'
          }
        },
        created_on: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.createdOn',
          type: {
            name: 'DateTime'
          }
        },
        modified_on: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.modifiedOn',
          type: {
            name: 'DateTime'
          }
        },
        view_type: {
          client_side_validation: true,
          required: true,
          is_constant: true,
          serialized_name: 'properties.query.type',
          default_value: 'Usage',
          type: {
            name: 'String'
          }
        },
        timeframe: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.query.timeframe',
          type: {
            name: 'String'
          }
        },
        time_period: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.query.timePeriod',
          type: {
            name: 'Composite',
            class_name: 'ReportConfigTimePeriod'
          }
        },
        dataset: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.query.dataset',
          type: {
            name: 'Composite',
            class_name: 'ReportConfigDataset'
          }
        },
        chart: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.chart',
          type: {
            name: 'String'
          }
        },
        accumulated: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.accumulated',
          type: {
            name: 'String'
          }
        },
        metric: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.metric',
          type: {
            name: 'String'
          }
        },
        kpis: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.kpis',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'KpiPropertiesElementType',
                type: {
                  name: 'Composite',
                  class_name: 'KpiProperties'
                }
            }
          }
        },
        pivots: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.pivots',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'PivotPropertiesElementType',
                type: {
                  name: 'Composite',
                  class_name: 'PivotProperties'
                }
            }
          }
        }
      }
    }
  }
end