Class: Azure::Network::Mgmt::V2019_06_01::RouteFilterRules

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb

Overview

RouteFilterRules

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ RouteFilterRules

Creates and initializes a new instance of the RouteFilterRules class.

Parameters:

  • client

    service class for accessing basic functionality.


17
18
19
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.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/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers: nil) ⇒ RouteFilterRule

Creates or updates a route in the specified route filter.

the create or update route filter rule 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.

  • rule_name (String)

    The name of the route filter rule.

  • route_filter_rule_parameters (RouteFilterRule)

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (RouteFilterRule)

    operation results.


452
453
454
455
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 452

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

#begin_create_or_update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a route in the specified route filter.

the create or update route filter rule 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.

  • rule_name (String)

    The name of the route filter rule.

  • route_filter_rule_parameters (RouteFilterRule)

    Parameters supplied to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 487

def begin_create_or_update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_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, 'rule_name is nil' if rule_name.nil?
  fail ArgumentError, 'route_filter_rule_parameters is nil' if route_filter_rule_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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

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

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2019_06_01::Models::RouteFilterRule.mapper()
  request_content = @client.serialize(request_mapper,  route_filter_rule_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}/routeFilterRules/{ruleName}'

  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,'ruleName' => rule_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 == 200 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2019_06_01::Models::RouteFilterRule.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::Network::Mgmt::V2019_06_01::Models::RouteFilterRule.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, rule_name, route_filter_rule_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a route in the specified route filter.

the create or update route filter rule 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.

  • rule_name (String)

    The name of the route filter rule.

  • route_filter_rule_parameters (RouteFilterRule)

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


470
471
472
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 470

def begin_create_or_update_with_http_info(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, route_filter_name, rule_name, custom_headers: nil) ⇒ Object

Deletes the specified rule from a 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.

  • rule_name (String)

    The name of the rule.

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

    A hash of custom headers that


362
363
364
365
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 362

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

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

Deletes the specified rule from a 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.

  • rule_name (String)

    The name of the rule.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 393

def begin_delete_async(resource_group_name, route_filter_name, rule_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?
  fail ArgumentError, 'rule_name is nil' if rule_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}'

  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,'ruleName' => rule_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 == 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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

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

Deletes the specified rule from a 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.

  • rule_name (String)

    The name of the rule.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


378
379
380
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 378

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

#begin_update(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers: nil) ⇒ RouteFilterRule

Updates a route in the specified route filter.

supplied to the update route filter rule 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.

  • rule_name (String)

    The name of the route filter rule.

  • route_filter_rule_parameters (PatchRouteFilterRule)

    Parameters

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

    A hash of custom headers that

Returns:

  • (RouteFilterRule)

    operation results.


574
575
576
577
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 574

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

#begin_update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Updates a route in the specified route filter.

supplied to the update route filter rule 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.

  • rule_name (String)

    The name of the route filter rule.

  • route_filter_rule_parameters (PatchRouteFilterRule)

    Parameters

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


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
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 609

def begin_update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_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, 'rule_name is nil' if rule_name.nil?
  fail ArgumentError, 'route_filter_rule_parameters is nil' if route_filter_rule_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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

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

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2019_06_01::Models::PatchRouteFilterRule.mapper()
  request_content = @client.serialize(request_mapper,  route_filter_rule_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}/routeFilterRules/{ruleName}'

  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,'ruleName' => rule_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(: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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2019_06_01::Models::RouteFilterRule.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, rule_name, route_filter_rule_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates a route in the specified route filter.

supplied to the update route filter rule 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.

  • rule_name (String)

    The name of the route filter rule.

  • route_filter_rule_parameters (PatchRouteFilterRule)

    Parameters

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


592
593
594
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 592

def begin_update_with_http_info(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers:nil)
  begin_update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers: nil) ⇒ RouteFilterRule

Creates or updates a route in the specified route filter.

the create or update route filter rule 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.

  • rule_name (String)

    The name of the route filter rule.

  • route_filter_rule_parameters (RouteFilterRule)

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (RouteFilterRule)

    operation results.


175
176
177
178
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 175

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

#create_or_update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers: nil) ⇒ Concurrent::Promise

the create or update route filter rule 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.

  • rule_name (String)

    The name of the route filter rule.

  • route_filter_rule_parameters (RouteFilterRule)

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 192

def create_or_update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers:custom_headers)

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

Deletes the specified rule from a 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.

  • rule_name (String)

    The name of the rule.

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

    A hash of custom headers that


33
34
35
36
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 33

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

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

  • rule_name (String)

    The name of the rule.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 48

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

Gets the specified rule from a 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.

  • rule_name (String)

    The name of the rule.

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

    A hash of custom headers that

Returns:

  • (RouteFilterRule)

    operation results.


75
76
77
78
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 75

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

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

Gets the specified rule from a 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.

  • rule_name (String)

    The name of the rule.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 106

def get_async(resource_group_name, route_filter_name, rule_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?
  fail ArgumentError, 'rule_name is nil' if rule_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}'

  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,'ruleName' => rule_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2019_06_01::Models::RouteFilterRule.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, rule_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified rule from a 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.

  • rule_name (String)

    The name of the rule.

  • 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/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 91

def get_with_http_info(resource_group_name, route_filter_name, rule_name, custom_headers:nil)
  get_async(resource_group_name, route_filter_name, rule_name, custom_headers:custom_headers).value!
end

#list_by_route_filter(resource_group_name, route_filter_name, custom_headers: nil) ⇒ Array<RouteFilterRule>

Gets all RouteFilterRules in a 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:

  • (Array<RouteFilterRule>)

    operation results.


268
269
270
271
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 268

def list_by_route_filter(resource_group_name, route_filter_name, custom_headers:nil)
  first_page = list_by_route_filter_as_lazy(resource_group_name, route_filter_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_route_filter_as_lazy(resource_group_name, route_filter_name, custom_headers: nil) ⇒ RouteFilterRuleListResult

Gets all RouteFilterRules in a route filter.

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:

  • (RouteFilterRuleListResult)

    which provide lazy access to pages of the


774
775
776
777
778
779
780
781
782
783
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 774

def list_by_route_filter_as_lazy(resource_group_name, route_filter_name, custom_headers:nil)
  response = list_by_route_filter_async(resource_group_name, route_filter_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_route_filter_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Gets all RouteFilterRules in a 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.


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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 297

def list_by_route_filter_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?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules'

  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' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2019_06_01::Models::RouteFilterRuleListResult.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_route_filter_next(next_page_link, custom_headers: nil) ⇒ RouteFilterRuleListResult

Gets all RouteFilterRules in a route filter.

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:

  • (RouteFilterRuleListResult)

    operation results.


683
684
685
686
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 683

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

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

Gets all RouteFilterRules in a route filter.

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.


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
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 712

def list_by_route_filter_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2019_06_01::Models::RouteFilterRuleListResult.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_route_filter_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all RouteFilterRules in a route filter.

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.


698
699
700
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 698

def list_by_route_filter_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_route_filter_next_async(next_page_link, custom_headers:custom_headers).value!
end

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

Gets all RouteFilterRules in a 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.


283
284
285
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 283

def list_by_route_filter_with_http_info(resource_group_name, route_filter_name, custom_headers:nil)
  list_by_route_filter_async(resource_group_name, route_filter_name, custom_headers:custom_headers).value!
end

#update(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers: nil) ⇒ RouteFilterRule

Updates a route in the specified route filter.

supplied to the update route filter rule 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.

  • rule_name (String)

    The name of the route filter rule.

  • route_filter_rule_parameters (PatchRouteFilterRule)

    Parameters

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

    A hash of custom headers that

Returns:

  • (RouteFilterRule)

    operation results.


223
224
225
226
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 223

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

#update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers: nil) ⇒ Concurrent::Promise

supplied to the update route filter rule 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.

  • rule_name (String)

    The name of the route filter rule.

  • route_filter_rule_parameters (PatchRouteFilterRule)

    Parameters

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/2019-06-01/generated/azure_mgmt_network/route_filter_rules.rb', line 240

def update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers:nil)
  # Send request
  promise = begin_update_async(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers:custom_headers)

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