Class: Azure::OperationalInsights::Mgmt::V2015_03_20::SavedSearches

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb

Overview

Operational Insights Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SavedSearches

Creates and initializes a new instance of the SavedSearches class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.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/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 22

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, workspace_name, saved_search_id, parameters, custom_headers: nil) ⇒ SavedSearch

Creates or updates a saved search for a given workspace.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

  • saved_search_id (String) —

    The id of the saved search.

  • parameters (SavedSearch) —

    The parameters required to save a search.

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

    A hash of custom headers that

Returns:

  • (SavedSearch) —

    operation results.



126
127
128
129
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 126

def create_or_update(resource_group_name, workspace_name, saved_search_id, parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, workspace_name, saved_search_id, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, workspace_name, saved_search_id, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a saved search for a given workspace.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

  • saved_search_id (String) —

    The id of the saved search.

  • parameters (SavedSearch) —

    The parameters required to save a search.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 159

def create_or_update_async(resource_group_name, workspace_name, saved_search_id, parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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, 'saved_search_id is nil' if saved_search_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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?

  # Serialize Request
  request_mapper = Azure::OperationalInsights::Mgmt::V2015_03_20::Models::SavedSearch.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}'

  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,'savedSearchId' => saved_search_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 MsRestAzure::AzureOperationError.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::V2015_03_20::Models::SavedSearch.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

#create_or_update_with_http_info(resource_group_name, workspace_name, saved_search_id, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a saved search for a given workspace.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

  • saved_search_id (String) —

    The id of the saved search.

  • parameters (SavedSearch) —

    The parameters required to save a search.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



143
144
145
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 143

def create_or_update_with_http_info(resource_group_name, workspace_name, saved_search_id, parameters, custom_headers:nil)
  create_or_update_async(resource_group_name, workspace_name, saved_search_id, parameters, custom_headers:custom_headers).value!
end

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

Deletes the specified saved search in a given workspace.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

  • saved_search_id (String) —

    The id of the saved search.

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

    A hash of custom headers that



34
35
36
37
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 34

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

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

Deletes the specified saved search in a given workspace.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

  • saved_search_id (String) —

    The id of the saved search.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 65

def delete_async(resource_group_name, workspace_name, saved_search_id, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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, 'saved_search_id is nil' if saved_search_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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}/savedSearches/{savedSearchId}'

  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,'savedSearchId' => saved_search_id},
      query_params: {'api-version' => @client.api_version},
      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 MsRestAzure::AzureOperationError.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, saved_search_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified saved search in a given workspace.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

  • saved_search_id (String) —

    The id of the saved search.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



50
51
52
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 50

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

#get(resource_group_name, workspace_name, saved_search_id, custom_headers: nil) ⇒ SavedSearch

Gets the specified saved search for a given workspace.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

  • saved_search_id (String) —

    The id of the saved search.

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

    A hash of custom headers that

Returns:

  • (SavedSearch) —

    operation results.



237
238
239
240
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 237

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

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

Gets the specified saved search for a given workspace.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

  • saved_search_id (String) —

    The id of the saved search.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
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
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 268

def get_async(resource_group_name, workspace_name, saved_search_id, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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, 'saved_search_id is nil' if saved_search_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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}/savedSearches/{savedSearchId}'

  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,'savedSearchId' => saved_search_id},
      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 MsRestAzure::AzureOperationError.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::V2015_03_20::Models::SavedSearch.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, saved_search_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified saved search for a given workspace.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

  • saved_search_id (String) —

    The id of the saved search.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



253
254
255
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 253

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

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

Gets the saved searches for a given Log Analytics Workspace

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

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

    A hash of custom headers that

Returns:

  • (SavedSearchesListResult) —

    operation results.



337
338
339
340
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 337

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

Gets the saved searches for a given Log Analytics Workspace

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 366

def list_by_workspace_async(resource_group_name, workspace_name, 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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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}/savedSearches'

  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,'subscriptionId' => @client.subscription_id},
      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 MsRestAzure::AzureOperationError.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::V2015_03_20::Models::SavedSearchesListResult.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

Gets the saved searches for a given Log Analytics Workspace

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The Resource Group name.

  • workspace_name (String) —

    The Log Analytics Workspace name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



352
353
354
 
# File 'lib/2015-03-20/generated/azure_mgmt_operational_insights/saved_searches.rb', line 352

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