Class: Azure::VMwareCloudSimple::Mgmt::V2019_04_01::VirtualMachines

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb

Overview

Description of the new service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VirtualMachines

Creates and initializes a new instance of the VirtualMachines class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientVMwareCloudSimpleClient (readonly)

Returns reference to the VMwareCloudSimpleClient.

Returns:



22
23
24
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers: nil) ⇒ VirtualMachine

Implements virtual machine PUT method

Create Or Update Virtual Machine

Machine request will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • virtual_machine_request (VirtualMachine)

    Create or Update Virtual

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

    A hash of custom headers that

Returns:

  • (VirtualMachine)

    operation results.



566
567
568
569
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 566

def begin_create_or_update(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers: nil) ⇒ Concurrent::Promise

Implements virtual machine PUT method

Create Or Update Virtual Machine

Machine request to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • virtual_machine_request (VirtualMachine)

    Create or Update Virtual

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 603

def begin_create_or_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.referer is nil' if @client.referer.nil?
  fail ArgumentError, 'virtual_machine_name is nil' if virtual_machine_name.nil?
  fail ArgumentError, "'virtual_machine_name' should satisfy the constraint - 'Pattern': '^[-a-zA-Z0-9]+$'" if !virtual_machine_name.nil? && virtual_machine_name.match(Regexp.new('^^[-a-zA-Z0-9]+$$')).nil?
  fail ArgumentError, 'virtual_machine_request is nil' if virtual_machine_request.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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['Referer'] = @client.referer unless @client.referer.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::VMwareCloudSimple::Mgmt::V2019_04_01::Models::VirtualMachine.mapper()
  request_content = @client.serialize(request_mapper,  virtual_machine_request)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'virtualMachineName' => virtual_machine_name},
      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 MsRest::HttpOperationError.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::VMwareCloudSimple::Mgmt::V2019_04_01::Models::VirtualMachine.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::VMwareCloudSimple::Mgmt::V2019_04_01::Models::VirtualMachine.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_machine_name, virtual_machine_request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements virtual machine PUT method

Create Or Update Virtual Machine

Machine request will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • virtual_machine_request (VirtualMachine)

    Create or Update Virtual

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



585
586
587
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 585

def begin_create_or_update_with_http_info(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, virtual_machine_name, custom_headers: nil) ⇒ Object

Implements virtual machine DELETE method

Delete virtual machine

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

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

    A hash of custom headers that



690
691
692
693
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 690

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

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

Implements virtual machine DELETE method

Delete virtual machine

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 723

def begin_delete_async(resource_group_name, virtual_machine_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.referer is nil' if @client.referer.nil?
  fail ArgumentError, 'virtual_machine_name is nil' if virtual_machine_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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['Referer'] = @client.referer unless @client.referer.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}'

  request_url = @base_url || @client.base_url

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

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 202 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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_machine_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements virtual machine DELETE method

Delete virtual machine

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



707
708
709
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 707

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

#begin_start(resource_group_name, virtual_machine_name, custom_headers: nil) ⇒ Object

Implements a start method for a virtual machine

Power on virtual machine

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

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

    A hash of custom headers that



892
893
894
895
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 892

def begin_start(resource_group_name, virtual_machine_name, custom_headers:nil)
  response = begin_start_async(resource_group_name, virtual_machine_name, custom_headers:custom_headers).value!
  nil
end

#begin_start_async(resource_group_name, virtual_machine_name, custom_headers: nil) ⇒ Concurrent::Promise

Implements a start method for a virtual machine

Power on virtual machine

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 925

def begin_start_async(resource_group_name, virtual_machine_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.referer is nil' if @client.referer.nil?
  fail ArgumentError, 'virtual_machine_name is nil' if virtual_machine_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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['Referer'] = @client.referer unless @client.referer.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}/start'

  request_url = @base_url || @client.base_url

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

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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_start_with_http_info(resource_group_name, virtual_machine_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements a start method for a virtual machine

Power on virtual machine

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



909
910
911
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 909

def begin_start_with_http_info(resource_group_name, virtual_machine_name, custom_headers:nil)
  begin_start_async(resource_group_name, virtual_machine_name, custom_headers:custom_headers).value!
end

#begin_stop(resource_group_name, virtual_machine_name, m: nil, mode: nil, custom_headers: nil) ⇒ Object

Implements shutdown, poweroff, and suspend method for a virtual machine

Power off virtual machine, options: shutdown, poweroff, and suspend

etc…) Possible values include: ‘reboot’, ‘suspend’, ‘shutdown’, ‘poweroff’ will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • m (VirtualMachineStopMode) (defaults to: nil)

    body stop mode parameter (reboot, shutdown,

  • mode (StopMode) (defaults to: nil)

    query stop mode parameter (reboot, shutdown, etc…).

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

    A hash of custom headers that



987
988
989
990
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 987

def begin_stop(resource_group_name, virtual_machine_name, m:nil, mode:nil, custom_headers:nil)
  response = begin_stop_async(resource_group_name, virtual_machine_name, m:m, mode:mode, custom_headers:custom_headers).value!
  nil
end

#begin_stop_async(resource_group_name, virtual_machine_name, m: nil, mode: nil, custom_headers: nil) ⇒ Concurrent::Promise

Implements shutdown, poweroff, and suspend method for a virtual machine

Power off virtual machine, options: shutdown, poweroff, and suspend

etc…) Possible values include: ‘reboot’, ‘suspend’, ‘shutdown’, ‘poweroff’ to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • m (VirtualMachineStopMode) (defaults to: nil)

    body stop mode parameter (reboot, shutdown,

  • mode (StopMode) (defaults to: nil)

    query stop mode parameter (reboot, shutdown, etc…).

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 1028

def begin_stop_async(resource_group_name, virtual_machine_name, m:nil, mode:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.referer is nil' if @client.referer.nil?
  fail ArgumentError, 'virtual_machine_name is nil' if virtual_machine_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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['Referer'] = @client.referer unless @client.referer.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::VMwareCloudSimple::Mgmt::V2019_04_01::Models::VirtualMachineStopMode.mapper()
  request_content = @client.serialize(request_mapper,  m)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}/stop'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'virtualMachineName' => virtual_machine_name},
      query_params: {'mode' => mode,'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 MsRest::HttpOperationError.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_stop_with_http_info(resource_group_name, virtual_machine_name, m: nil, mode: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements shutdown, poweroff, and suspend method for a virtual machine

Power off virtual machine, options: shutdown, poweroff, and suspend

etc…) Possible values include: ‘reboot’, ‘suspend’, ‘shutdown’, ‘poweroff’ will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • m (VirtualMachineStopMode) (defaults to: nil)

    body stop mode parameter (reboot, shutdown,

  • mode (StopMode) (defaults to: nil)

    query stop mode parameter (reboot, shutdown, etc…).

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1008
1009
1010
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 1008

def begin_stop_with_http_info(resource_group_name, virtual_machine_name, m:nil, mode:nil, custom_headers:nil)
  begin_stop_async(resource_group_name, virtual_machine_name, m:m, mode:mode, custom_headers:custom_headers).value!
end

#begin_update(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers: nil) ⇒ VirtualMachine

Implements virtual machine PATCH method

Patch virtual machine properties

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • virtual_machine_request (PatchPayload)

    Patch virtual machine request

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

    A hash of custom headers that

Returns:

  • (VirtualMachine)

    operation results.



783
784
785
786
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 783

def begin_update(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:nil)
  response = begin_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers: nil) ⇒ Concurrent::Promise

Implements virtual machine PATCH method

Patch virtual machine properties

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • virtual_machine_request (PatchPayload)

    Patch virtual machine request

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 818

def begin_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'virtual_machine_name is nil' if virtual_machine_name.nil?
  fail ArgumentError, 'virtual_machine_request is nil' if virtual_machine_request.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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::VMwareCloudSimple::Mgmt::V2019_04_01::Models::PatchPayload.mapper()
  request_content = @client.serialize(request_mapper,  virtual_machine_request)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}'

  request_url = @base_url || @client.base_url

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

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::VMwareCloudSimple::Mgmt::V2019_04_01::Models::VirtualMachine.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_update_with_http_info(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements virtual machine PATCH method

Patch virtual machine properties

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • virtual_machine_request (PatchPayload)

    Patch virtual machine request

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



801
802
803
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 801

def begin_update_with_http_info(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:nil)
  begin_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers: nil) ⇒ VirtualMachine

Implements virtual machine PUT method

Create Or Update Virtual Machine

Machine request will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • virtual_machine_request (VirtualMachine)

    Create or Update Virtual

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

    A hash of custom headers that

Returns:

  • (VirtualMachine)

    operation results.



344
345
346
347
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 344

def create_or_update(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:nil)
  response = create_or_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers: nil) ⇒ Concurrent::Promise

Machine request will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • virtual_machine_request (VirtualMachine)

    Create or Update Virtual

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 360

def create_or_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:custom_headers)

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

Implements virtual machine DELETE method

Delete virtual machine

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

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

    A hash of custom headers that



388
389
390
391
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 388

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

#delete_async(resource_group_name, virtual_machine_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_machine_name (String)

    virtual machine name

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 402

def delete_async(resource_group_name, virtual_machine_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, virtual_machine_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_machine_name, custom_headers: nil) ⇒ VirtualMachine

Implements virtual machine GET method

Get virtual machine

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

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

    A hash of custom headers that

Returns:

  • (VirtualMachine)

    operation results.



242
243
244
245
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 242

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

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

Implements virtual machine GET method

Get virtual machine

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 275

def get_async(resource_group_name, virtual_machine_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'virtual_machine_name is nil' if virtual_machine_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.VMwareCloudSimple/virtualMachines/{virtualMachineName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'virtualMachineName' => virtual_machine_name},
      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 MsRest::HttpOperationError.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::VMwareCloudSimple::Mgmt::V2019_04_01::Models::VirtualMachine.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_machine_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements virtual machine GET method

Get virtual machine

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



259
260
261
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 259

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

#list_by_resource_group(resource_group_name, filter: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Array<VirtualMachine>

Implements list virtual machine within RG method

Returns list of virtual machine within resource group

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • filter (String) (defaults to: nil)

    The filter to apply on the list operation

  • top (Integer) (defaults to: nil)

    The maximum number of record sets to return

  • skip_token (String) (defaults to: nil)

    to be used by nextLink implementation

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

    A hash of custom headers that

Returns:

  • (Array<VirtualMachine>)

    operation results.



139
140
141
142
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 139

def list_by_resource_group(resource_group_name, filter:nil, top:nil, skip_token:nil, custom_headers:nil)
  first_page = list_by_resource_group_as_lazy(resource_group_name, filter:filter, top:top, skip_token:skip_token, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_resource_group_as_lazy(resource_group_name, filter: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ VirtualMachineListResponse

Implements list virtual machine within RG method

Returns list of virtual machine within resource group

will be added to the HTTP request.

the response.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • filter (String) (defaults to: nil)

    The filter to apply on the list operation

  • top (Integer) (defaults to: nil)

    The maximum number of record sets to return

  • skip_token (String) (defaults to: nil)

    to be used by nextLink implementation

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

    A hash of custom headers that

Returns:

  • (VirtualMachineListResponse)

    which provide lazy access to pages of



1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 1314

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

#list_by_resource_group_async(resource_group_name, filter: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise

Implements list virtual machine within RG method

Returns list of virtual machine within resource group

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • filter (String) (defaults to: nil)

    The filter to apply on the list operation

  • top (Integer) (defaults to: nil)

    The maximum number of record sets to return

  • skip_token (String) (defaults to: nil)

    to be used by nextLink implementation

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 176

def list_by_resource_group_async(resource_group_name, filter:nil, top:nil, skip_token:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  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.VMwareCloudSimple/virtualMachines'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$top' => top,'$skipToken' => skip_token},
      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 MsRest::HttpOperationError.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::VMwareCloudSimple::Mgmt::V2019_04_01::Models::VirtualMachineListResponse.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_resource_group_next(next_page_link, custom_headers: nil) ⇒ VirtualMachineListResponse

Implements list virtual machine within RG method

Returns list of virtual machine within resource group

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (VirtualMachineListResponse)

    operation results.



1190
1191
1192
1193
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 1190

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

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

Implements list virtual machine within RG method

Returns list of virtual machine within resource group

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 1223

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


  request_headers = {}
  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 MsRest::HttpOperationError.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::VMwareCloudSimple::Mgmt::V2019_04_01::Models::VirtualMachineListResponse.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Implements list virtual machine within RG method

Returns list of virtual machine within resource group

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1207
1208
1209
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 1207

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

#list_by_resource_group_with_http_info(resource_group_name, filter: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements list virtual machine within RG method

Returns list of virtual machine within resource group

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • filter (String) (defaults to: nil)

    The filter to apply on the list operation

  • top (Integer) (defaults to: nil)

    The maximum number of record sets to return

  • skip_token (String) (defaults to: nil)

    to be used by nextLink implementation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



158
159
160
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 158

def list_by_resource_group_with_http_info(resource_group_name, filter:nil, top:nil, skip_token:nil, custom_headers:nil)
  list_by_resource_group_async(resource_group_name, filter:filter, top:top, skip_token:skip_token, custom_headers:custom_headers).value!
end

#list_by_subscription(filter: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Array<VirtualMachine>

Implements list virtual machine within subscription method

Returns list virtual machine within subscription

will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the list operation

  • top (Integer) (defaults to: nil)

    The maximum number of record sets to return

  • skip_token (String) (defaults to: nil)

    to be used by nextLink implementation

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

    A hash of custom headers that

Returns:

  • (Array<VirtualMachine>)

    operation results.



37
38
39
40
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 37

def list_by_subscription(filter:nil, top:nil, skip_token:nil, custom_headers:nil)
  first_page = list_by_subscription_as_lazy(filter:filter, top:top, skip_token:skip_token, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_subscription_as_lazy(filter: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ VirtualMachineListResponse

Implements list virtual machine within subscription method

Returns list virtual machine within subscription

will be added to the HTTP request.

the response.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the list operation

  • top (Integer) (defaults to: nil)

    The maximum number of record sets to return

  • skip_token (String) (defaults to: nil)

    to be used by nextLink implementation

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

    A hash of custom headers that

Returns:

  • (VirtualMachineListResponse)

    which provide lazy access to pages of



1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 1288

def list_by_subscription_as_lazy(filter:nil, top:nil, skip_token:nil, custom_headers:nil)
  response = list_by_subscription_async(filter:filter, top:top, skip_token:skip_token, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_subscription_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_subscription_async(filter: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise

Implements list virtual machine within subscription method

Returns list virtual machine within subscription

to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the list operation

  • top (Integer) (defaults to: nil)

    The maximum number of record sets to return

  • skip_token (String) (defaults to: nil)

    to be used by nextLink implementation

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 72

def list_by_subscription_async(filter:nil, top:nil, skip_token:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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}/providers/Microsoft.VMwareCloudSimple/virtualMachines'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$top' => top,'$skipToken' => skip_token},
      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 MsRest::HttpOperationError.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::VMwareCloudSimple::Mgmt::V2019_04_01::Models::VirtualMachineListResponse.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_subscription_next(next_page_link, custom_headers: nil) ⇒ VirtualMachineListResponse

Implements list virtual machine within subscription method

Returns list virtual machine within subscription

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (VirtualMachineListResponse)

    operation results.



1094
1095
1096
1097
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 1094

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

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

Implements list virtual machine within subscription method

Returns list virtual machine within subscription

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 1127

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

    result
  end

  promise.execute
end

#list_by_subscription_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements list virtual machine within subscription method

Returns list virtual machine within subscription

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1111
1112
1113
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 1111

def list_by_subscription_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_subscription_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_subscription_with_http_info(filter: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements list virtual machine within subscription method

Returns list virtual machine within subscription

will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the list operation

  • top (Integer) (defaults to: nil)

    The maximum number of record sets to return

  • skip_token (String) (defaults to: nil)

    to be used by nextLink implementation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



55
56
57
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 55

def list_by_subscription_with_http_info(filter:nil, top:nil, skip_token:nil, custom_headers:nil)
  list_by_subscription_async(filter:filter, top:top, skip_token:skip_token, custom_headers:custom_headers).value!
end

#start(resource_group_name, virtual_machine_name, custom_headers: nil) ⇒ Object

Implements a start method for a virtual machine

Power on virtual machine

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

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

    A hash of custom headers that



474
475
476
477
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 474

def start(resource_group_name, virtual_machine_name, custom_headers:nil)
  response = start_async(resource_group_name, virtual_machine_name, custom_headers:custom_headers).value!
  nil
end

#start_async(resource_group_name, virtual_machine_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_machine_name (String)

    virtual machine name

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 488

def start_async(resource_group_name, virtual_machine_name, custom_headers:nil)
  # Send request
  promise = begin_start_async(resource_group_name, virtual_machine_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

#stop(resource_group_name, virtual_machine_name, m: nil, mode: nil, custom_headers: nil) ⇒ Object

Implements shutdown, poweroff, and suspend method for a virtual machine

Power off virtual machine, options: shutdown, poweroff, and suspend

etc…) Possible values include: ‘reboot’, ‘suspend’, ‘shutdown’, ‘poweroff’ will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • m (VirtualMachineStopMode) (defaults to: nil)

    body stop mode parameter (reboot, shutdown,

  • mode (StopMode) (defaults to: nil)

    query stop mode parameter (reboot, shutdown, etc…).

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

    A hash of custom headers that



518
519
520
521
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 518

def stop(resource_group_name, virtual_machine_name, m:nil, mode:nil, custom_headers:nil)
  response = stop_async(resource_group_name, virtual_machine_name, m:m, mode:mode, custom_headers:custom_headers).value!
  nil
end

#stop_async(resource_group_name, virtual_machine_name, m: nil, mode: nil, custom_headers: nil) ⇒ Concurrent::Promise

etc…) Possible values include: ‘reboot’, ‘suspend’, ‘shutdown’, ‘poweroff’ will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • m (VirtualMachineStopMode) (defaults to: nil)

    body stop mode parameter (reboot, shutdown,

  • mode (StopMode) (defaults to: nil)

    query stop mode parameter (reboot, shutdown, etc…).

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 536

def stop_async(resource_group_name, virtual_machine_name, m:nil, mode:nil, custom_headers:nil)
  # Send request
  promise = begin_stop_async(resource_group_name, virtual_machine_name, m:m, mode:mode, 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

#update(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers: nil) ⇒ VirtualMachine

Implements virtual machine PATCH method

Patch virtual machine properties

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group

  • virtual_machine_name (String)

    virtual machine name

  • virtual_machine_request (PatchPayload)

    Patch virtual machine request

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

    A hash of custom headers that

Returns:

  • (VirtualMachine)

    operation results.



431
432
433
434
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 431

def update(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:nil)
  response = update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, virtual_machine_name, virtual_machine_request, 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_machine_name (String)

    virtual machine name

  • virtual_machine_request (PatchPayload)

    Patch virtual machine request

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machines.rb', line 446

def update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:nil)
  # Send request
  promise = begin_update_async(resource_group_name, virtual_machine_name, virtual_machine_request, custom_headers:custom_headers)

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