Class: Azure::Network::Mgmt::V2019_09_01::Subnets

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-09-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/2019-09-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/2019-09-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.



499
500
501
502
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 499

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.



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
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
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 534

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::V2019_09_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::V2019_09_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::V2019_09_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.



517
518
519
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 517

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



409
410
411
412
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 409

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.



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 440

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.



425
426
427
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 425

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



621
622
623
624
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 621

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.



658
659
660
661
662
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
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 658

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::V2019_09_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.



640
641
642
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 640

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

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

Unprepares a subnet by removing network intent policies.

UnprepareNetworkPoliciesRequest

Parameters supplied to unprepare subnet to

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

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

    A hash of custom headers that



725
726
727
728
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 725

def begin_unprepare_network_policies(resource_group_name, virtual_network_name, subnet_name, unprepare_network_policies_request_parameters, custom_headers:nil)
  response = begin_unprepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, unprepare_network_policies_request_parameters, custom_headers:custom_headers).value!
  nil
end

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

Unprepares a subnet by removing network intent policies.

UnprepareNetworkPoliciesRequest

Parameters supplied to unprepare subnet to

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

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



762
763
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
811
812
813
814
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 762

def begin_unprepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, unprepare_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, 'unprepare_network_policies_request_parameters is nil' if unprepare_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::V2019_09_01::Models::UnprepareNetworkPoliciesRequest.mapper()
  request_content = @client.serialize(request_mapper,  unprepare_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}/UnprepareNetworkPolicies'

  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_unprepare_network_policies_with_http_info(resource_group_name, virtual_network_name, subnet_name, unprepare_network_policies_request_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Unprepares a subnet by removing network intent policies.

UnprepareNetworkPoliciesRequest

Parameters supplied to unprepare subnet to

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

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



744
745
746
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 744

def begin_unprepare_network_policies_with_http_info(resource_group_name, virtual_network_name, subnet_name, unprepare_network_policies_request_parameters, custom_headers:nil)
  begin_unprepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, unprepare_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/2019-09-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/2019-09-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::V2019_09_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/2019-09-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/2019-09-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/2019-09-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/2019-09-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::V2019_09_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/2019-09-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.



315
316
317
318
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 315

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



917
918
919
920
921
922
923
924
925
926
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 917

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.



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 344

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::V2019_09_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.



826
827
828
829
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 826

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.



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
898
899
900
901
902
903
904
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 855

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::V2019_09_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.



841
842
843
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 841

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.



330
331
332
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 330

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/2019-09-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/2019-09-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, FinalStateVia::LOCATION)
  end

  promise
end

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

Unprepares a subnet by removing network intent policies.

UnprepareNetworkPoliciesRequest

Parameters supplied to unprepare subnet to

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

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

    A hash of custom headers that



271
272
273
274
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 271

def unprepare_network_policies(resource_group_name, virtual_network_name, subnet_name, unprepare_network_policies_request_parameters, custom_headers:nil)
  response = unprepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, unprepare_network_policies_request_parameters, custom_headers:custom_headers).value!
  nil
end

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

UnprepareNetworkPoliciesRequest

Parameters supplied to unprepare subnet to

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

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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/subnets.rb', line 289

def unprepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, unprepare_network_policies_request_parameters, custom_headers:nil)
  # Send request
  promise = begin_unprepare_network_policies_async(resource_group_name, virtual_network_name, subnet_name, unprepare_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, FinalStateVia::LOCATION)
  end

  promise
end