Class: Azure::SecurityInsights::Mgmt::V2019_01_01_preview::BookmarkRelations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb

Overview

API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ BookmarkRelations

Creates and initializes a new instance of the BookmarkRelations class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SecurityInsights (readonly)

Returns reference to the SecurityInsights.

Returns:



23
24
25
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 23

def client
  @client
end

Instance Method Details

#create_or_update_relation(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, relation, custom_headers: nil) ⇒ Relation

Creates the bookmark relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • relation_name (String) —

    Relation Name

  • relation (Relation) —

    The relation model

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

    A hash of custom headers that

Returns:

  • (Relation) —

    operation results.



297
298
299
300
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 297

def create_or_update_relation(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, relation, custom_headers:nil)
  response = create_or_update_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, relation, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, relation, custom_headers: nil) ⇒ Concurrent::Promise

Creates the bookmark relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • relation_name (String) —

    Relation Name

  • relation (Relation) —

    The relation model

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
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
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 338

def create_or_update_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, relation, custom_headers:nil)
  @client.api_version = '2019-01-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).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, 'operational_insights_resource_provider is nil' if operational_insights_resource_provider.nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '90'" if !workspace_name.nil? && workspace_name.length > 90
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '1'" if !workspace_name.nil? && workspace_name.length < 1
  fail ArgumentError, 'bookmark_id is nil' if bookmark_id.nil?
  fail ArgumentError, 'relation_name is nil' if relation_name.nil?
  fail ArgumentError, 'relation is nil' if relation.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::SecurityInsights::Mgmt::V2019_01_01_preview::Models::Relation.mapper()
  request_content = @client.serialize(request_mapper,  relation)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations/{relationName}'

  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,'operationalInsightsResourceProvider' => operational_insights_resource_provider,'workspaceName' => workspace_name,'bookmarkId' => bookmark_id,'relationName' => relation_name},
      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 || status_code == 201
      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::SecurityInsights::Mgmt::V2019_01_01_preview::Models::Relation.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::SecurityInsights::Mgmt::V2019_01_01_preview::Models::Relation.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_relation_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, relation, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates the bookmark relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • relation_name (String) —

    Relation Name

  • relation (Relation) —

    The relation model

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



318
319
320
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 318

def create_or_update_relation_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, relation, custom_headers:nil)
  create_or_update_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, relation, custom_headers:custom_headers).value!
end

#delete_relation(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers: nil) ⇒ Object

Delete the bookmark relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • relation_name (String) —

    Relation Name

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

    A hash of custom headers that



434
435
436
437
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 434

def delete_relation(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers:nil)
  response = delete_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers:custom_headers).value!
  nil
end

#delete_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers: nil) ⇒ Concurrent::Promise

Delete the bookmark relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • relation_name (String) —

    Relation Name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 473

def delete_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers:nil)
  @client.api_version = '2019-01-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).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, 'operational_insights_resource_provider is nil' if operational_insights_resource_provider.nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '90'" if !workspace_name.nil? && workspace_name.length > 90
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '1'" if !workspace_name.nil? && workspace_name.length < 1
  fail ArgumentError, 'bookmark_id is nil' if bookmark_id.nil?
  fail ArgumentError, 'relation_name is nil' if relation_name.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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations/{relationName}'

  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,'operationalInsightsResourceProvider' => operational_insights_resource_provider,'workspaceName' => workspace_name,'bookmarkId' => bookmark_id,'relationName' => relation_name},
      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 || status_code == 204
      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_relation_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete the bookmark relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • relation_name (String) —

    Relation Name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



454
455
456
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 454

def delete_relation_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers:nil)
  delete_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers:custom_headers).value!
end

#get_relation(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers: nil) ⇒ Relation

Gets a bookmark relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • relation_name (String) —

    Relation Name

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

    A hash of custom headers that

Returns:

  • (Relation) —

    operation results.



178
179
180
181
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 178

def get_relation(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers:nil)
  response = get_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a bookmark relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • relation_name (String) —

    Relation Name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 217

def get_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers:nil)
  @client.api_version = '2019-01-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).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, 'operational_insights_resource_provider is nil' if operational_insights_resource_provider.nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '90'" if !workspace_name.nil? && workspace_name.length > 90
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '1'" if !workspace_name.nil? && workspace_name.length < 1
  fail ArgumentError, 'bookmark_id is nil' if bookmark_id.nil?
  fail ArgumentError, 'relation_name is nil' if relation_name.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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations/{relationName}'

  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,'operationalInsightsResourceProvider' => operational_insights_resource_provider,'workspaceName' => workspace_name,'bookmarkId' => bookmark_id,'relationName' => relation_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 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::SecurityInsights::Mgmt::V2019_01_01_preview::Models::Relation.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_relation_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a bookmark relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • relation_name (String) —

    Relation Name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



198
199
200
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 198

def get_relation_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers:nil)
  get_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, relation_name, custom_headers:custom_headers).value!
end

#list(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Array<Relation>

Gets all bookmark relations.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • filter (String) (defaults to: nil) —

    Filters the results, based on a Boolean condition.

  • orderby (String) (defaults to: nil) —

    Sorts the results. Optional.

  • top (Integer) (defaults to: nil) —

    Returns only the first n results. Optional.

  • skip_token (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (Array<Relation>) —

    operation results.



47
48
49
50
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 47

def list(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter:filter, orderby:orderby, top:top, skip_token:skip_token, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ RelationList

Gets all bookmark relations.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • filter (String) (defaults to: nil) —

    Filters the results, based on a Boolean condition.

  • orderby (String) (defaults to: nil) —

    Sorts the results. Optional.

  • top (Integer) (defaults to: nil) —

    Returns only the first n results. Optional.

  • skip_token (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (RelationList) —

    which provide lazy access to pages of the response.



639
640
641
642
643
644
645
646
647
648
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 639

def list_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  response = list_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter:filter, orderby:orderby, top:top, skip_token:skip_token, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets all bookmark relations.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • filter (String) (defaults to: nil) —

    Filters the results, based on a Boolean condition.

  • orderby (String) (defaults to: nil) —

    Sorts the results. Optional.

  • top (Integer) (defaults to: nil) —

    Returns only the first n results. Optional.

  • skip_token (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 100

def list_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  @client.api_version = '2019-01-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).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, 'operational_insights_resource_provider is nil' if operational_insights_resource_provider.nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '90'" if !workspace_name.nil? && workspace_name.length > 90
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '1'" if !workspace_name.nil? && workspace_name.length < 1
  fail ArgumentError, 'bookmark_id is nil' if bookmark_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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations'

  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,'operationalInsightsResourceProvider' => operational_insights_resource_provider,'workspaceName' => workspace_name,'bookmarkId' => bookmark_id},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$orderby' => orderby,'$top' => top,'$skipToken' => skip_token},
      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::SecurityInsights::Mgmt::V2019_01_01_preview::Models::RelationList.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_next(next_page_link, custom_headers: nil) ⇒ RelationList

Gets all bookmark relations.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (RelationList) —

    operation results.



537
538
539
540
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 537

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Gets all bookmark relations.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 566

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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::SecurityInsights::Mgmt::V2019_01_01_preview::Models::RelationList.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all bookmark relations.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



552
553
554
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 552

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all bookmark relations.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • bookmark_id (String) —

    Bookmark ID

  • filter (String) (defaults to: nil) —

    Filters the results, based on a Boolean condition.

  • orderby (String) (defaults to: nil) —

    Sorts the results. Optional.

  • top (Integer) (defaults to: nil) —

    Returns only the first n results. Optional.

  • skip_token (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



74
75
76
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/bookmark_relations.rb', line 74

def list_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  list_async(resource_group_name, operational_insights_resource_provider, workspace_name, bookmark_id, filter:filter, orderby:orderby, top:top, skip_token:skip_token, custom_headers:custom_headers).value!
end