Class: Azure::Network::Mgmt::V2017_03_01::NetworkInterfaces

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb

Overview

The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ NetworkInterfaces

Creates and initializes a new instance of the NetworkInterfaces class.

Parameters:

  • client

    service class for accessing basic functionality.



20
21
22
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientNetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



25
26
27
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 25

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, network_interface_name, parameters, custom_headers = nil) ⇒ NetworkInterface

Creates or updates a network interface.

update network interface operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • parameters (NetworkInterface)

    Parameters supplied to the create or

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

    A hash of custom headers that

Returns:

  • (NetworkInterface)

    operation results.



551
552
553
554
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 551

def begin_create_or_update(resource_group_name, network_interface_name, parameters, custom_headers = nil)
  response = begin_create_or_update_async(resource_group_name, network_interface_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, network_interface_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Creates or updates a network interface.

update network interface operation. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • parameters (NetworkInterface)

    Parameters supplied to the create or

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
616
617
618
619
620
621
622
623
624
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
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 584

def begin_create_or_update_async(resource_group_name, network_interface_name, parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_interface_name is nil' if network_interface_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::V2017_03_01::Models::NetworkInterface.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/networkInterfaces/{networkInterfaceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkInterfaceName' => network_interface_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 || 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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2017_03_01::Models::NetworkInterface.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 == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2017_03_01::Models::NetworkInterface.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_or_update_with_http_info(resource_group_name, network_interface_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a network interface.

update network interface operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • parameters (NetworkInterface)

    Parameters supplied to the create or

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



568
569
570
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 568

def begin_create_or_update_with_http_info(resource_group_name, network_interface_name, parameters, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, network_interface_name, parameters, custom_headers).value!
end

#begin_delete(resource_group_name, network_interface_name, custom_headers = nil) ⇒ Object

Deletes the specified network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that



468
469
470
471
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 468

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

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

Deletes the specified network interface.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
526
527
528
529
530
531
532
533
534
535
536
537
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 497

def begin_delete_async(resource_group_name, network_interface_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_interface_name is nil' if network_interface_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/networkInterfaces/{networkInterfaceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkInterfaceName' => network_interface_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 || 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
  end

  promise.execute
end

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

Deletes the specified network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



483
484
485
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 483

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

#begin_get_effective_route_table(resource_group_name, network_interface_name, custom_headers = nil) ⇒ EffectiveRouteListResult

Gets all route tables applied to a network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (EffectiveRouteListResult)

    operation results.



666
667
668
669
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 666

def begin_get_effective_route_table(resource_group_name, network_interface_name, custom_headers = nil)
  response = begin_get_effective_route_table_async(resource_group_name, network_interface_name, custom_headers).value!
  response.body unless response.nil?
end

#begin_get_effective_route_table_async(resource_group_name, network_interface_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets all route tables applied to a network interface.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
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
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 695

def begin_get_effective_route_table_async(resource_group_name, network_interface_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_interface_name is nil' if network_interface_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/networkInterfaces/{networkInterfaceName}/effectiveRouteTable'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkInterfaceName' => network_interface_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::V2017_03_01::Models::EffectiveRouteListResult.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_effective_route_table_with_http_info(resource_group_name, network_interface_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all route tables applied to a network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



681
682
683
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 681

def begin_get_effective_route_table_with_http_info(resource_group_name, network_interface_name, custom_headers = nil)
  begin_get_effective_route_table_async(resource_group_name, network_interface_name, custom_headers).value!
end

#begin_list_effective_network_security_groups(resource_group_name, network_interface_name, custom_headers = nil) ⇒ EffectiveNetworkSecurityGroupListResult

Gets all network security groups applied to a network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (EffectiveNetworkSecurityGroupListResult)

    operation results.



757
758
759
760
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 757

def begin_list_effective_network_security_groups(resource_group_name, network_interface_name, custom_headers = nil)
  response = begin_list_effective_network_security_groups_async(resource_group_name, network_interface_name, custom_headers).value!
  response.body unless response.nil?
end

#begin_list_effective_network_security_groups_async(resource_group_name, network_interface_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets all network security groups applied to a network interface.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 786

def begin_list_effective_network_security_groups_async(resource_group_name, network_interface_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_interface_name is nil' if network_interface_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/networkInterfaces/{networkInterfaceName}/effectiveNetworkSecurityGroups'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkInterfaceName' => network_interface_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::V2017_03_01::Models::EffectiveNetworkSecurityGroupListResult.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_list_effective_network_security_groups_with_http_info(resource_group_name, network_interface_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all network security groups applied to a network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



772
773
774
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 772

def begin_list_effective_network_security_groups_with_http_info(resource_group_name, network_interface_name, custom_headers = nil)
  begin_list_effective_network_security_groups_async(resource_group_name, network_interface_name, custom_headers).value!
end

#create_or_update(resource_group_name, network_interface_name, parameters, custom_headers = nil) ⇒ NetworkInterface

Creates or updates a network interface.

update network interface operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • parameters (NetworkInterface)

    Parameters supplied to the create or

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

    A hash of custom headers that

Returns:

  • (NetworkInterface)

    operation results.



171
172
173
174
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 171

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

#create_or_update_async(resource_group_name, network_interface_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

update network interface operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • parameters (NetworkInterface)

    Parameters supplied to the create or

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 187

def create_or_update_async(resource_group_name, network_interface_name, parameters, custom_headers = nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, network_interface_name, parameters, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2017_03_01::Models::NetworkInterface.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_interface_name, custom_headers = nil) ⇒ Object

Deletes the specified network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that



35
36
37
38
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 35

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

#delete_async(resource_group_name, network_interface_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_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 49

def delete_async(resource_group_name, network_interface_name, custom_headers = nil)
  # Send request
  promise = begin_delete_async(resource_group_name, network_interface_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_interface_name, expand = nil, custom_headers = nil) ⇒ NetworkInterface

Gets information about the specified network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • expand (String) (defaults to: nil)

    Expands referenced resources.

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

    A hash of custom headers that

Returns:

  • (NetworkInterface)

    operation results.



76
77
78
79
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 76

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

#get_async(resource_group_name, network_interface_name, expand = nil, custom_headers = nil) ⇒ Concurrent::Promise

Gets information about the specified network interface.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • expand (String) (defaults to: nil)

    Expands referenced resources.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 107

def get_async(resource_group_name, network_interface_name, expand = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_interface_name is nil' if network_interface_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/networkInterfaces/{networkInterfaceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkInterfaceName' => network_interface_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'$expand' => expand},
      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::V2017_03_01::Models::NetworkInterface.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_effective_route_table(resource_group_name, network_interface_name, custom_headers = nil) ⇒ EffectiveRouteListResult

Gets all route tables applied to a network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (EffectiveRouteListResult)

    operation results.



385
386
387
388
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 385

def get_effective_route_table(resource_group_name, network_interface_name, custom_headers = nil)
  response = get_effective_route_table_async(resource_group_name, network_interface_name, custom_headers).value!
  response.body unless response.nil?
end

#get_effective_route_table_async(resource_group_name, network_interface_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_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 399

def get_effective_route_table_async(resource_group_name, network_interface_name, custom_headers = nil)
  # Send request
  promise = begin_get_effective_route_table_async(resource_group_name, network_interface_name, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2017_03_01::Models::EffectiveRouteListResult.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_interface_name, expand = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about the specified network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

  • expand (String) (defaults to: nil)

    Expands referenced resources.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



92
93
94
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 92

def get_with_http_info(resource_group_name, network_interface_name, expand = nil, custom_headers = nil)
  get_async(resource_group_name, network_interface_name, expand, custom_headers).value!
end

#list(resource_group_name, custom_headers = nil) ⇒ Array<NetworkInterface>

Gets all network interfaces in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (Array<NetworkInterface>)

    operation results.



297
298
299
300
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 297

def list(resource_group_name, custom_headers = nil)
  first_page = list_as_lazy(resource_group_name, custom_headers)
  first_page.get_all_items
end

#list_all(custom_headers = nil) ⇒ Array<NetworkInterface>

Gets all network interfaces in a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<NetworkInterface>)

    operation results.



213
214
215
216
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 213

def list_all(custom_headers = nil)
  first_page = list_all_as_lazy(custom_headers)
  first_page.get_all_items
end

#list_all_as_lazy(custom_headers = nil) ⇒ NetworkInterfaceListResult

Gets all network interfaces in a subscription.

will be added to the HTTP request.

the response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (NetworkInterfaceListResult)

    which provide lazy access to pages of



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 1021

def list_all_as_lazy(custom_headers = nil)
  response = list_all_async(custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_all_next_async(next_page_link, custom_headers)
    end
    page
  end
end

#list_all_async(custom_headers = nil) ⇒ Concurrent::Promise

Gets all network interfaces in a subscription.

to the HTTP request.

Parameters:

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
280
281
282
283
284
285
286
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 238

def list_all_async(custom_headers = 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}/providers/Microsoft.Network/networkInterfaces'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'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::V2017_03_01::Models::NetworkInterfaceListResult.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_all_next(next_page_link, custom_headers = nil) ⇒ NetworkInterfaceListResult

Gets all network interfaces in a subscription.

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:

  • (NetworkInterfaceListResult)

    operation results.



848
849
850
851
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 848

def list_all_next(next_page_link, custom_headers = nil)
  response = list_all_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_all_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Gets all network interfaces in a subscription.

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.



877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 877

def list_all_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2017_03_01::Models::NetworkInterfaceListResult.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_all_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all network interfaces in a subscription.

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.



863
864
865
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 863

def list_all_next_with_http_info(next_page_link, custom_headers = nil)
  list_all_next_async(next_page_link, custom_headers).value!
end

#list_all_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all network interfaces in a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



226
227
228
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 226

def list_all_with_http_info(custom_headers = nil)
  list_all_async(custom_headers).value!
end

#list_as_lazy(resource_group_name, custom_headers = nil) ⇒ NetworkInterfaceListResult

Gets all network interfaces in a resource group.

will be added to the HTTP request.

the response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (NetworkInterfaceListResult)

    which provide lazy access to pages of



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 1042

def list_as_lazy(resource_group_name, custom_headers = nil)
  response = list_async(resource_group_name, 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)
    end
    page
  end
end

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

Gets all network interfaces in a resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 324

def list_async(resource_group_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_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/networkInterfaces'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_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::V2017_03_01::Models::NetworkInterfaceListResult.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_effective_network_security_groups(resource_group_name, network_interface_name, custom_headers = nil) ⇒ EffectiveNetworkSecurityGroupListResult

Gets all network security groups applied to a network interface.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • network_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (EffectiveNetworkSecurityGroupListResult)

    operation results.



427
428
429
430
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 427

def list_effective_network_security_groups(resource_group_name, network_interface_name, custom_headers = nil)
  response = list_effective_network_security_groups_async(resource_group_name, network_interface_name, custom_headers).value!
  response.body unless response.nil?
end

#list_effective_network_security_groups_async(resource_group_name, network_interface_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_interface_name (String)

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 441

def list_effective_network_security_groups_async(resource_group_name, network_interface_name, custom_headers = nil)
  # Send request
  promise = begin_list_effective_network_security_groups_async(resource_group_name, network_interface_name, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2017_03_01::Models::EffectiveNetworkSecurityGroupListResult.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

#list_next(next_page_link, custom_headers = nil) ⇒ NetworkInterfaceListResult

Gets all network interfaces in a resource group.

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:

  • (NetworkInterfaceListResult)

    operation results.



935
936
937
938
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 935

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

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

Gets all network interfaces in a resource group.

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.



964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 964

def list_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2017_03_01::Models::NetworkInterfaceListResult.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 network interfaces in a resource group.

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.



950
951
952
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 950

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

#list_with_http_info(resource_group_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all network interfaces in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



311
312
313
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_interfaces.rb', line 311

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