Class: Azure::Network::Mgmt::V2016_12_01::PacketCaptures

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb

Overview

Network Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PacketCaptures

Creates and initializes a new instance of the PacketCaptures class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ NetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



22
23
24
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers = nil) ⇒ PacketCaptureResult

Create and start a packet capture on the specified VM.

capture operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

  • parameters (PacketCapture) —

    Parameters that define the create packet

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

    A hash of custom headers that

Returns:

  • (PacketCaptureResult) —

    operation results.



402
403
404
405
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 402

def begin_create(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers = nil)
  response = begin_create_async(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#begin_create_async(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Create and start a packet capture on the specified VM.

capture operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

  • parameters (PacketCapture) —

    Parameters that define the create packet

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
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
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 437

def begin_create_async(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_watcher_name is nil' if network_watcher_name.nil?
  fail ArgumentError, 'packet_capture_name is nil' if packet_capture_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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 = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

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

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2016_12_01::Models::PacketCapture.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.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkWatcherName' => network_watcher_name,'packetCaptureName' => packet_capture_name,'subscriptionId' => @client.subscription_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 == 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?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2016_12_01::Models::PacketCaptureResult.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

#begin_create_with_http_info(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Create and start a packet capture on the specified VM.

capture operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

  • parameters (PacketCapture) —

    Parameters that define the create packet

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



420
421
422
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 420

def begin_create_with_http_info(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers = nil)
  begin_create_async(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers).value!
end

#begin_delete(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Object

Deletes the specified packet capture session.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    A hash of custom headers that



510
511
512
513
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 510

def begin_delete(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  response = begin_delete_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Concurrent::Promise

Deletes the specified packet capture session.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 541

def begin_delete_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_watcher_name is nil' if network_watcher_name.nil?
  fail ArgumentError, 'packet_capture_name is nil' if packet_capture_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 = {}

  # 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.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkWatcherName' => network_watcher_name,'packetCaptureName' => packet_capture_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(: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 == 204 || status_code == 202
      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
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified packet capture session.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



526
527
528
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 526

def begin_delete_with_http_info(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  begin_delete_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
end

#begin_get_status(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ PacketCaptureQueryStatusResult

Query the status of a running packet capture session.

resource. session. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the Network Watcher

  • packet_capture_name (String) —

    The name given to the packet capture

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

    A hash of custom headers that

Returns:

  • (PacketCaptureQueryStatusResult) —

    operation results.



681
682
683
684
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 681

def begin_get_status(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  response = begin_get_status_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
  response.body unless response.nil?
end

#begin_get_status_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Concurrent::Promise

Query the status of a running packet capture session.

resource. session. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the Network Watcher

  • packet_capture_name (String) —

    The name given to the packet capture

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 716

def begin_get_status_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_watcher_name is nil' if network_watcher_name.nil?
  fail ArgumentError, 'packet_capture_name is nil' if packet_capture_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 = {}

  # 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.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/queryStatus'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkWatcherName' => network_watcher_name,'packetCaptureName' => packet_capture_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(:post, 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 == 202
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2016_12_01::Models::PacketCaptureQueryStatusResult.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2016_12_01::Models::PacketCaptureQueryStatusResult.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

#begin_get_status_with_http_info(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Query the status of a running packet capture session.

resource. session. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the Network Watcher

  • packet_capture_name (String) —

    The name given to the packet capture

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



699
700
701
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 699

def begin_get_status_with_http_info(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  begin_get_status_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
end

#begin_stop(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Object

Stops a specified packet capture session.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    A hash of custom headers that



594
595
596
597
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 594

def begin_stop(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  response = begin_stop_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
  nil
end

#begin_stop_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Concurrent::Promise

Stops a specified packet capture session.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 625

def begin_stop_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_watcher_name is nil' if network_watcher_name.nil?
  fail ArgumentError, 'packet_capture_name is nil' if packet_capture_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 = {}

  # 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.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/stop'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkWatcherName' => network_watcher_name,'packetCaptureName' => packet_capture_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(:post, 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 == 202
      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
  end

  promise.execute
end

#begin_stop_with_http_info(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Stops a specified packet capture session.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



610
611
612
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 610

def begin_stop_with_http_info(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  begin_stop_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
end

#create(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers = nil) ⇒ PacketCaptureResult

Create and start a packet capture on the specified VM.

capture operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

  • parameters (PacketCapture) —

    Parameters that define the create packet

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

    A hash of custom headers that

Returns:

  • (PacketCaptureResult) —

    operation results.



37
38
39
40
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 37

def create(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers = nil)
  response = create_async(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

capture operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

  • parameters (PacketCapture) —

    Parameters that define the create packet

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 54

def create_async(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers = nil)
  # Send request
  promise = begin_create_async(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2016_12_01::Models::PacketCaptureResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Object

Deletes the specified packet capture session.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    A hash of custom headers that



176
177
178
179
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 176

def delete(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  response = delete_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
  nil
end

#delete_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 191

def delete_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  # Send request
  promise = begin_delete_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ PacketCaptureResult

Gets a packet capture session by name.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    A hash of custom headers that

Returns:

  • (PacketCaptureResult) —

    operation results.



83
84
85
86
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 83

def get(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  response = get_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets a packet capture session by name.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 114

def get_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_watcher_name is nil' if network_watcher_name.nil?
  fail ArgumentError, 'packet_capture_name is nil' if packet_capture_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 = {}

  # 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.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkWatcherName' => network_watcher_name,'packetCaptureName' => packet_capture_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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2016_12_01::Models::PacketCaptureResult.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_status(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ PacketCaptureQueryStatusResult

Query the status of a running packet capture session.

resource. session. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the Network Watcher

  • packet_capture_name (String) —

    The name given to the packet capture

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

    A hash of custom headers that

Returns:

  • (PacketCaptureQueryStatusResult) —

    operation results.



260
261
262
263
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 260

def get_status(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  response = get_status_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
  response.body unless response.nil?
end

#get_status_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Concurrent::Promise

resource. session. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the Network Watcher

  • packet_capture_name (String) —

    The name given to the packet capture

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 277

def get_status_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  # Send request
  promise = begin_get_status_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2016_12_01::Models::PacketCaptureQueryStatusResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get_with_http_info(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a packet capture session by name.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



99
100
101
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 99

def get_with_http_info(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  get_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
end

#list(resource_group_name, network_watcher_name, custom_headers = nil) ⇒ PacketCaptureListResult

Lists all packet capture sessions within the specified resource group.

resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the Network Watcher

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

    A hash of custom headers that

Returns:

  • (PacketCaptureListResult) —

    operation results.



306
307
308
309
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 306

def list(resource_group_name, network_watcher_name, custom_headers = nil)
  response = list_async(resource_group_name, network_watcher_name, custom_headers).value!
  response.body unless response.nil?
end

#list_async(resource_group_name, network_watcher_name, custom_headers = nil) ⇒ Concurrent::Promise

Lists all packet capture sessions within the specified resource group.

resource. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the Network Watcher

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



337
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
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 337

def list_async(resource_group_name, network_watcher_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_watcher_name is nil' if network_watcher_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 = {}

  # 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.Network/networkWatchers/{networkWatcherName}/packetCaptures'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkWatcherName' => network_watcher_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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2016_12_01::Models::PacketCaptureListResult.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_with_http_info(resource_group_name, network_watcher_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all packet capture sessions within the specified resource group.

resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the Network Watcher

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



322
323
324
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 322

def list_with_http_info(resource_group_name, network_watcher_name, custom_headers = nil)
  list_async(resource_group_name, network_watcher_name, custom_headers).value!
end

#stop(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Object

Stops a specified packet capture session.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    A hash of custom headers that



216
217
218
219
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 216

def stop(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  response = stop_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers).value!
  nil
end

#stop_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_watcher_name (String) —

    The name of the network watcher.

  • packet_capture_name (String) —

    The name of the packet capture session.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/2016-12-01/generated/azure_mgmt_network/packet_captures.rb', line 231

def stop_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers = nil)
  # Send request
  promise = begin_stop_async(resource_group_name, network_watcher_name, packet_capture_name, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end