Class: Azure::Network::Mgmt::V2018_12_01::Subnets

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

Overview

Subnets

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Subnets

Creates and initializes a new instance of the Subnets class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ NetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers: nil) ⇒ Subnet

Creates or updates a subnet in the specified virtual network.

subnet operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

  • subnet_parameters (Subnet) —

    Parameters supplied to the create or update

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

    A hash of custom headers that

Returns:

  • (Subnet) —

    operation results.



453
454
455
456
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 453

def begin_create_or_update(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a subnet in the specified virtual network.

subnet operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

  • subnet_parameters (Subnet) —

    Parameters supplied to the create or update

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
560
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 488

def begin_create_or_update_async(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'virtual_network_name is nil' if virtual_network_name.nil?
  fail ArgumentError, 'subnet_name is nil' if subnet_name.nil?
  fail ArgumentError, 'subnet_parameters is nil' if subnet_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::V2018_12_01::Models::Subnet.mapper()
  request_content = @client.serialize(request_mapper,  subnet_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'virtualNetworkName' => virtual_network_name,'subnetName' => subnet_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::V2018_12_01::Models::Subnet.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::V2018_12_01::Models::Subnet.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, virtual_network_name, subnet_name, subnet_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a subnet in the specified virtual network.

subnet operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

  • subnet_parameters (Subnet) —

    Parameters supplied to the create or update

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



471
472
473
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 471

def begin_create_or_update_with_http_info(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, virtual_network_name, subnet_name, custom_headers: nil) ⇒ Object

Deletes the specified subnet.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

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

    A hash of custom headers that



363
364
365
366
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 363

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

#begin_delete_async(resource_group_name, virtual_network_name, subnet_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes the specified subnet.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
438
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 394

def begin_delete_async(resource_group_name, virtual_network_name, subnet_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'virtual_network_name is nil' if virtual_network_name.nil?
  fail ArgumentError, 'subnet_name is nil' if subnet_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/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'virtualNetworkName' => virtual_network_name,'subnetName' => subnet_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 == 200 || status_code == 204 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.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, virtual_network_name, subnet_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified subnet.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



379
380
381
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 379

def begin_delete_with_http_info(resource_group_name, virtual_network_name, subnet_name, custom_headers:nil)
  begin_delete_async(resource_group_name, virtual_network_name, subnet_name, custom_headers:custom_headers).value!
end

#begin_prepare_network_policies(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers: nil) ⇒ Object

Prepares a subnet by applying network intent policies.

PrepareNetworkPoliciesRequest

Parameters supplied to prepare subnet by

applying network intent policies. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

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

    A hash of custom headers that



575
576
577
578
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 575

def begin_prepare_network_policies(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers:nil)
  response = begin_prepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers:custom_headers).value!
  nil
end

#begin_prepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Prepares a subnet by applying network intent policies.

PrepareNetworkPoliciesRequest

Parameters supplied to prepare subnet by

applying network intent policies. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 612

def begin_prepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'virtual_network_name is nil' if virtual_network_name.nil?
  fail ArgumentError, 'subnet_name is nil' if subnet_name.nil?
  fail ArgumentError, 'prepare_network_policies_request_parameters is nil' if prepare_network_policies_request_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::V2018_12_01::Models::PrepareNetworkPoliciesRequest.mapper()
  request_content = @client.serialize(request_mapper,  prepare_network_policies_request_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/PrepareNetworkPolicies'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'virtualNetworkName' => virtual_network_name,'subnetName' => subnet_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(:post, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.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_prepare_network_policies_with_http_info(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Prepares a subnet by applying network intent policies.

PrepareNetworkPoliciesRequest

Parameters supplied to prepare subnet by

applying network intent policies. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



594
595
596
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 594

def begin_prepare_network_policies_with_http_info(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers:nil)
  begin_prepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers: nil) ⇒ Subnet

Creates or updates a subnet in the specified virtual network.

subnet operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

  • subnet_parameters (Subnet) —

    Parameters supplied to the create or update

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

    A hash of custom headers that

Returns:

  • (Subnet) —

    operation results.



178
179
180
181
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 178

def create_or_update(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers: nil) ⇒ Concurrent::Promise

subnet operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

  • subnet_parameters (Subnet) —

    Parameters supplied to the create or update

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 195

def create_or_update_async(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers:custom_headers)

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

Deletes the specified subnet.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

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

    A hash of custom headers that



33
34
35
36
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 33

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

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

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

  • 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/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 48

def delete_async(resource_group_name, virtual_network_name, subnet_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, virtual_network_name, subnet_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, virtual_network_name, subnet_name, expand: nil, custom_headers: nil) ⇒ Subnet

Gets the specified subnet by virtual network and resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

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

    Expands referenced resources.

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

    A hash of custom headers that

Returns:

  • (Subnet) —

    operation results.



76
77
78
79
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 76

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

#get_async(resource_group_name, virtual_network_name, subnet_name, expand: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets the specified subnet by virtual network and resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

  • 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.



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

def get_async(resource_group_name, virtual_network_name, subnet_name, expand:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'virtual_network_name is nil' if virtual_network_name.nil?
  fail ArgumentError, 'subnet_name is nil' if subnet_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/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'virtualNetworkName' => virtual_network_name,'subnetName' => subnet_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?
    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::V2018_12_01::Models::Subnet.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, virtual_network_name, subnet_name, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified subnet by virtual network and resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

  • 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.



93
94
95
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 93

def get_with_http_info(resource_group_name, virtual_network_name, subnet_name, expand:nil, custom_headers:nil)
  get_async(resource_group_name, virtual_network_name, subnet_name, expand:expand, custom_headers:custom_headers).value!
end

#list(resource_group_name, virtual_network_name, custom_headers: nil) ⇒ Array<Subnet>

Gets all subnets in a virtual network.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

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

    A hash of custom headers that

Returns:

  • (Array<Subnet>) —

    operation results.



269
270
271
272
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 269

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

#list_as_lazy(resource_group_name, virtual_network_name, custom_headers: nil) ⇒ SubnetListResult

Gets all subnets in a virtual network.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

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

    A hash of custom headers that

Returns:

  • (SubnetListResult) —

    which provide lazy access to pages of the



767
768
769
770
771
772
773
774
775
776
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 767

def list_as_lazy(resource_group_name, virtual_network_name, custom_headers:nil)
  response = list_async(resource_group_name, virtual_network_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Gets all subnets in a virtual network.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
351
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 298

def list_async(resource_group_name, virtual_network_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'virtual_network_name is nil' if virtual_network_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/virtualNetworks/{virtualNetworkName}/subnets'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'virtualNetworkName' => virtual_network_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::V2018_12_01::Models::SubnetListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers: nil) ⇒ SubnetListResult

Gets all subnets in a virtual network.

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:

  • (SubnetListResult) —

    operation results.



676
677
678
679
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 676

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

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

Gets all subnets in a virtual network.

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.



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
746
747
748
749
750
751
752
753
754
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 705

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


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

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

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2018_12_01::Models::SubnetListResult.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 subnets in a virtual network.

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.



691
692
693
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 691

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

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

Gets all subnets in a virtual network.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



284
285
286
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 284

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

#prepare_network_policies(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers: nil) ⇒ Object

Prepares a subnet by applying network intent policies.

PrepareNetworkPoliciesRequest

Parameters supplied to prepare subnet by

applying network intent policies. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

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

    A hash of custom headers that



225
226
227
228
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 225

def prepare_network_policies(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers:nil)
  response = prepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers:custom_headers).value!
  nil
end

#prepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers: nil) ⇒ Concurrent::Promise

PrepareNetworkPoliciesRequest

Parameters supplied to prepare subnet by

applying network intent policies. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • virtual_network_name (String) —

    The name of the virtual network.

  • subnet_name (String) —

    The name of the subnet.

  • prepare_network_policies_request_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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/subnets.rb', line 243

def prepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers:nil)
  # Send request
  promise = begin_prepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, 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