Class: Azure::ARM::Network::RouteFilters

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_network/route_filters.rb

Overview

Network Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ RouteFilters

Creates and initializes a new instance of the RouteFilters class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientNetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



22
23
24
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil) ⇒ RouteFilter

Creates or updates a route filter in a specified resource group.

create or update route filter operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • route_filter_parameters (RouteFilter)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (RouteFilter)

    operation results.



513
514
515
516
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 513

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

#begin_create_or_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil) ⇒ Concurrent::Promise

Creates or updates a route filter in a specified resource group.

create or update route filter operation. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • route_filter_parameters (RouteFilter)

    Parameters supplied to the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 546

def begin_create_or_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'route_filter_name is nil' if route_filter_name.nil?
  fail ArgumentError, 'route_filter_parameters is nil' if route_filter_parameters.nil?
  api_version = '2017-08-01'
  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::ARM::Network::Models::RouteFilter.mapper()
  request_content = @client.serialize(request_mapper,  route_filter_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}'

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Network::Models::RouteFilter.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Network::Models::RouteFilter.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, route_filter_name, route_filter_parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a route filter in a specified resource group.

create or update route filter operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • route_filter_parameters (RouteFilter)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



530
531
532
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 530

def begin_create_or_update_with_http_info(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers).value!
end

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

Deletes the specified route filter.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

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

    A hash of custom headers that



430
431
432
433
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 430

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

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

Deletes the specified route filter.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
499
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 459

def begin_delete_async(resource_group_name, route_filter_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'route_filter_name is nil' if route_filter_name.nil?
  api_version = '2017-08-01'
  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/routeFilters/{routeFilterName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'routeFilterName' => route_filter_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => 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 == 202 || status_code == 200 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

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

    result
  end

  promise.execute
end

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

Deletes the specified route filter.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



445
446
447
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 445

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

#begin_update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil) ⇒ RouteFilter

Updates a route filter in a specified resource group.

update route filter operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • route_filter_parameters (PatchRouteFilter)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (RouteFilter)

    operation results.



630
631
632
633
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 630

def begin_update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil)
  response = begin_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers).value!
  response.body unless response.nil?
end

#begin_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil) ⇒ Concurrent::Promise

Updates a route filter in a specified resource group.

update route filter operation. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • route_filter_parameters (PatchRouteFilter)

    Parameters supplied to the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
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
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 663

def begin_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'route_filter_name is nil' if route_filter_name.nil?
  fail ArgumentError, 'route_filter_parameters is nil' if route_filter_parameters.nil?
  api_version = '2017-08-01'
  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::ARM::Network::Models::PatchRouteFilter.mapper()
  request_content = @client.serialize(request_mapper,  route_filter_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'routeFilterName' => route_filter_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, 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::ARM::Network::Models::RouteFilter.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_update_with_http_info(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Updates a route filter in a specified resource group.

update route filter operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • route_filter_parameters (PatchRouteFilter)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



647
648
649
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 647

def begin_update_with_http_info(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil)
  begin_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers).value!
end

#create_or_update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil) ⇒ RouteFilter

Creates or updates a route filter in a specified resource group.

create or update route filter operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • route_filter_parameters (RouteFilter)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (RouteFilter)

    operation results.



171
172
173
174
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 171

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

#create_or_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil) ⇒ Concurrent::Promise

create or update route filter operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • route_filter_parameters (RouteFilter)

    Parameters supplied to the

  • 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/generated/azure_mgmt_network/route_filters.rb', line 187

def create_or_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers)

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

Deletes the specified route filter.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

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

    A hash of custom headers that



32
33
34
35
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 32

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

#delete_async(resource_group_name, route_filter_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.

  • route_filter_name (String)

    The name of the route filter.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 46

def delete_async(resource_group_name, route_filter_name, custom_headers = nil)
  # Send request
  promise = begin_delete_async(resource_group_name, route_filter_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, route_filter_name, expand = nil, custom_headers = nil) ⇒ RouteFilter

Gets the specified route filter.

resources. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • expand (String) (defaults to: nil)

    Expands referenced express route bgp peering

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

    A hash of custom headers that

Returns:

  • (RouteFilter)

    operation results.



74
75
76
77
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 74

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

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

Gets the specified route filter.

resources. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • expand (String) (defaults to: nil)

    Expands referenced express route bgp peering

  • 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/generated/azure_mgmt_network/route_filters.rb', line 107

def get_async(resource_group_name, route_filter_name, expand = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'route_filter_name is nil' if route_filter_name.nil?
  api_version = '2017-08-01'
  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/routeFilters/{routeFilterName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'routeFilterName' => route_filter_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => 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::ARM::Network::Models::RouteFilter.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(resource_group_name, route_filter_name, expand = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified route filter.

resources. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • expand (String) (defaults to: nil)

    Expands referenced express route bgp peering

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



91
92
93
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 91

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

#list(custom_headers = nil) ⇒ Array<RouteFilter>

Gets all route filters 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<RouteFilter>)

    operation results.



346
347
348
349
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 346

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

#list_as_lazy(custom_headers = nil) ⇒ RouteFilterListResult

Gets all route filters in a subscription.

will be added to the HTTP request.

response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (RouteFilterListResult)

    which provide lazy access to pages of the



929
930
931
932
933
934
935
936
937
938
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 929

def list_as_lazy(custom_headers = nil)
  response = list_async(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(custom_headers = nil) ⇒ Concurrent::Promise

Gets all route filters 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.



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 371

def list_async(custom_headers = nil)
  api_version = '2017-08-01'
  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/routeFilters'

  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' => 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::ARM::Network::Models::RouteFilterListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_resource_group(resource_group_name, custom_headers = nil) ⇒ Array<RouteFilter>

Gets all route filters 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<RouteFilter>)

    operation results.



260
261
262
263
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 260

def list_by_resource_group(resource_group_name, custom_headers = nil)
  first_page = list_by_resource_group_as_lazy(resource_group_name, custom_headers)
  first_page.get_all_items
end

#list_by_resource_group_as_lazy(resource_group_name, custom_headers = nil) ⇒ RouteFilterListResult

Gets all route filters in a resource group.

will be added to the HTTP request.

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:

  • (RouteFilterListResult)

    which provide lazy access to pages of the



909
910
911
912
913
914
915
916
917
918
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 909

def list_by_resource_group_as_lazy(resource_group_name, custom_headers = nil)
  response = list_by_resource_group_async(resource_group_name, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_resource_group_next_async(next_page_link, custom_headers)
    end
    page
  end
end

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

Gets all route filters 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.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 287

def list_by_resource_group_async(resource_group_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  api_version = '2017-08-01'
  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/routeFilters'

  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' => 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::ARM::Network::Models::RouteFilterListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_resource_group_next(next_page_link, custom_headers = nil) ⇒ RouteFilterListResult

Gets all route filters 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:

  • (RouteFilterListResult)

    operation results.



735
736
737
738
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 735

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

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

Gets all route filters 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.



764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
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
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 764

def list_by_resource_group_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::ARM::Network::Models::RouteFilterListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_resource_group_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all route filters 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.



750
751
752
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 750

def list_by_resource_group_next_with_http_info(next_page_link, custom_headers = nil)
  list_by_resource_group_next_async(next_page_link, custom_headers).value!
end

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

Gets all route filters 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.



274
275
276
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 274

def list_by_resource_group_with_http_info(resource_group_name, custom_headers = nil)
  list_by_resource_group_async(resource_group_name, custom_headers).value!
end

#list_next(next_page_link, custom_headers = nil) ⇒ RouteFilterListResult

Gets all route filters 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:

  • (RouteFilterListResult)

    operation results.



822
823
824
825
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 822

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 route filters 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.



851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 851

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::ARM::Network::Models::RouteFilterListResult.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 route filters 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.



837
838
839
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 837

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(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all route filters 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.



359
360
361
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 359

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

#update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil) ⇒ RouteFilter

Updates a route filter in a specified resource group.

update route filter operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • route_filter_parameters (PatchRouteFilter)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (RouteFilter)

    operation results.



217
218
219
220
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 217

def update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil)
  response = update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil) ⇒ Concurrent::Promise

update route filter operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • route_filter_name (String)

    The name of the route filter.

  • route_filter_parameters (PatchRouteFilter)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/generated/azure_mgmt_network/route_filters.rb', line 233

def update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers = nil)
  # Send request
  promise = begin_update_async(resource_group_name, route_filter_name, route_filter_parameters, custom_headers)

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