Class: Azure::TimeSeriesInsights::Mgmt::V2017_11_15::Models::EnvironmentResource

Inherits:
TrackedResource show all
Includes:
MsRestAzure
Defined in:
lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb

Overview

An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource.

Instance Attribute Summary collapse

Attributes inherited from TrackedResource

#location, #tags

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#creation_time ⇒ DateTime

Returns The time the resource was created.

Returns:

  • (DateTime) —

    The time the resource was created.



43
44
45
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb', line 43

def creation_time
  @creation_time
end

#data_access_fqdn ⇒ String

environment data, e.g. to query the environment’s events or upload reference data for the environment.

Returns:

  • (String) —

    The fully qualified domain name used to access the



52
53
54
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb', line 52

def data_access_fqdn
  @data_access_fqdn
end

#data_access_id ⇒ Object

environment’s events or upload reference data for the environment.

Returns:

  • An id used to access the environment data, e.g. to query the



47
48
49
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb', line 47

def data_access_id
  @data_access_id
end

#data_retention_time ⇒ Duration

days the environment’s events will be available for query.

Returns:

  • (Duration) —

    ISO8601 timespan specifying the minimum number of



22
23
24
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb', line 22

def data_retention_time
  @data_retention_time
end

#partition_key_properties ⇒ Array<PartitionKeyProperty>

according to which the data in the environment will be ordered.

Returns:



35
36
37
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb', line 35

def partition_key_properties
  @partition_key_properties
end

#provisioning_state ⇒ ProvisioningState

Possible values include: ‘Accepted’, ‘Creating’, ‘Updating’, ‘Succeeded’, ‘Failed’, ‘Deleting’

Returns:



40
41
42
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb', line 40

def provisioning_state
  @provisioning_state
end

#sku ⇒ Sku

SLA (in queries-per-minute and total capacity), and the billing rate.

Returns:

  • (Sku) —

    The sku determines the capacity of the environment, the



18
19
20
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb', line 18

def sku
  @sku
end

#status ⇒ EnvironmentStatus

environment, and its internal state in the Time Series Insights service.

Returns:



57
58
59
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb', line 57

def status
  @status
end

#storage_limit_exceeded_behavior ⇒ StorageLimitExceededBehavior

Insights service should take when the environment’s capacity has been exceeded. If “PauseIngress” is specified, new events will not be read from the event source. If “PurgeOldData” is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData. Possible values include: ‘PurgeOldData’, ‘PauseIngress’

Returns:



31
32
33
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb', line 31

def storage_limit_exceeded_behavior
  @storage_limit_exceeded_behavior
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/environment_resource.rb', line 64

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'EnvironmentResource',
    type: {
      name: 'Composite',
      class_name: 'EnvironmentResource',
      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'
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'Sku'
          }
        },
        data_retention_time: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.dataRetentionTime',
          type: {
            name: 'TimeSpan'
          }
        },
        storage_limit_exceeded_behavior: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.storageLimitExceededBehavior',
          type: {
            name: 'Enum',
            module: 'StorageLimitExceededBehavior'
          }
        },
        partition_key_properties: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.partitionKeyProperties',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'PartitionKeyPropertyElementType',
                type: {
                  name: 'Composite',
                  class_name: 'PartitionKeyProperty'
                }
            }
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        creation_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.creationTime',
          type: {
            name: 'DateTime'
          }
        },
        data_access_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.dataAccessId',
          type: {
            name: 'String'
          }
        },
        data_access_fqdn: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.dataAccessFqdn',
          type: {
            name: 'String'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.status',
          type: {
            name: 'Composite',
            class_name: 'EnvironmentStatus'
          }
        }
      }
    }
  }
end