Class: Azure::OperationalInsights::Mgmt::V2020_03_01_preview::DataCollectorLogs

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb

Overview

Operational Insights Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ DataCollectorLogs

Creates and initializes a new instance of the DataCollectorLogs class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ OperationalInsightsManagementClient (readonly)

Returns reference to the OperationalInsightsManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 22

def client
  @client
end

Instance Method Details

#delete(resource_group_name, workspace_name, table_name, force: nil, custom_headers: nil) ⇒ Object

Deletes a specify data collector log table.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • table_name (String) —

    DataCollector table name.

  • force (Boolean) (defaults to: nil) —

    When true, enables bypassing retention validation.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that



36
37
38
39
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 36

def delete(resource_group_name, workspace_name, table_name, force:nil, custom_headers:nil)
  response = delete_async(resource_group_name, workspace_name, table_name, force:force, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, workspace_name, table_name, force: nil, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a specify data collector log table.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • table_name (String) —

    DataCollector table name.

  • force (Boolean) (defaults to: nil) —

    When true, enables bypassing retention validation.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 71

def delete_async(resource_group_name, workspace_name, table_name, force:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '63'" if !workspace_name.nil? && workspace_name.length > 63
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '4'" if !workspace_name.nil? && workspace_name.length < 4
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$'" if !workspace_name.nil? && workspace_name.match(Regexp.new('^^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$$')).nil?
  fail ArgumentError, 'table_name is nil' if table_name.nil?
  fail ArgumentError, "'table_name' should satisfy the constraint - 'MaxLength': '63'" if !table_name.nil? && table_name.length > 63
  fail ArgumentError, "'table_name' should satisfy the constraint - 'MinLength': '4'" if !table_name.nil? && table_name.length < 4
  fail ArgumentError, "'table_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+[A-Za-z0-9]_CL$'" if !table_name.nil? && table_name.match(Regexp.new('^^[A-Za-z0-9]+[A-Za-z0-9]_CL$$')).nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataCollectorLogs/{tableName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'workspaceName' => workspace_name,'tableName' => table_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'force' => force},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, workspace_name, table_name, force: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a specify data collector log table.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • table_name (String) —

    DataCollector table name.

  • force (Boolean) (defaults to: nil) —

    When true, enables bypassing retention validation.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



54
55
56
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 54

def delete_with_http_info(resource_group_name, workspace_name, table_name, force:nil, custom_headers:nil)
  delete_async(resource_group_name, workspace_name, table_name, force:force, custom_headers:custom_headers).value!
end

#get(resource_group_name, workspace_name, table_name, force: nil, custom_headers: nil) ⇒ DataCollectorLog

Retrieves a specify data collector log table.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • table_name (String) —

    DataCollector table name.

  • force (Boolean) (defaults to: nil) —

    When true, enables bypassing retention validation.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (DataCollectorLog) —

    operation results.



141
142
143
144
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 141

def get(resource_group_name, workspace_name, table_name, force:nil, custom_headers:nil)
  response = get_async(resource_group_name, workspace_name, table_name, force:force, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, workspace_name, table_name, force: nil, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves a specify data collector log table.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • table_name (String) —

    DataCollector table name.

  • force (Boolean) (defaults to: nil) —

    When true, enables bypassing retention validation.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 176

def get_async(resource_group_name, workspace_name, table_name, force:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '63'" if !workspace_name.nil? && workspace_name.length > 63
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '4'" if !workspace_name.nil? && workspace_name.length < 4
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$'" if !workspace_name.nil? && workspace_name.match(Regexp.new('^^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$$')).nil?
  fail ArgumentError, 'table_name is nil' if table_name.nil?
  fail ArgumentError, "'table_name' should satisfy the constraint - 'MaxLength': '63'" if !table_name.nil? && table_name.length > 63
  fail ArgumentError, "'table_name' should satisfy the constraint - 'MinLength': '4'" if !table_name.nil? && table_name.length < 4
  fail ArgumentError, "'table_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+[A-Za-z0-9]_CL$'" if !table_name.nil? && table_name.match(Regexp.new('^^[A-Za-z0-9]+[A-Za-z0-9]_CL$$')).nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataCollectorLogs/{tableName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'workspaceName' => workspace_name,'tableName' => table_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'force' => force},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::OperationalInsights::Mgmt::V2020_03_01_preview::Models::DataCollectorLog.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(resource_group_name, workspace_name, table_name, force: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves a specify data collector log table.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • table_name (String) —

    DataCollector table name.

  • force (Boolean) (defaults to: nil) —

    When true, enables bypassing retention validation.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



159
160
161
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 159

def get_with_http_info(resource_group_name, workspace_name, table_name, force:nil, custom_headers:nil)
  get_async(resource_group_name, workspace_name, table_name, force:force, custom_headers:custom_headers).value!
end

#list_by_workspace(resource_group_name, workspace_name, custom_headers: nil) ⇒ DataCollectorLogsListResult

Listing all data collector log tables, being created via data collector endpoint and scoped to the specified workspace

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (DataCollectorLogsListResult) —

    operation results.



255
256
257
258
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 255

def list_by_workspace(resource_group_name, workspace_name, custom_headers:nil)
  response = list_by_workspace_async(resource_group_name, workspace_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_workspace_async(resource_group_name, workspace_name, custom_headers: nil) ⇒ Concurrent::Promise

Listing all data collector log tables, being created via data collector endpoint and scoped to the specified workspace

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 288

def list_by_workspace_async(resource_group_name, workspace_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '63'" if !workspace_name.nil? && workspace_name.length > 63
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '4'" if !workspace_name.nil? && workspace_name.length < 4
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$'" if !workspace_name.nil? && workspace_name.match(Regexp.new('^^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$$')).nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataCollectorLogs'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'workspaceName' => workspace_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::OperationalInsights::Mgmt::V2020_03_01_preview::Models::DataCollectorLogsListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_workspace_with_http_info(resource_group_name, workspace_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Listing all data collector log tables, being created via data collector endpoint and scoped to the specified workspace

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



272
273
274
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/data_collector_logs.rb', line 272

def list_by_workspace_with_http_info(resource_group_name, workspace_name, custom_headers:nil)
  list_by_workspace_async(resource_group_name, workspace_name, custom_headers:custom_headers).value!
end