Class: Azure::Compute::Mgmt::V2020_06_01::ComputeManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ ComputeManagementClient

Creates initializes a new instance of the ComputeManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

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

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



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
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 113

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @operations = Operations.new(self)
  @availability_sets = AvailabilitySets.new(self)
  @proximity_placement_groups = ProximityPlacementGroups.new(self)
  @dedicated_host_groups = DedicatedHostGroups.new(self)
  @dedicated_hosts = DedicatedHosts.new(self)
  @ssh_public_keys = SshPublicKeys.new(self)
  @virtual_machine_extension_images = VirtualMachineExtensionImages.new(self)
  @virtual_machine_extensions = VirtualMachineExtensions.new(self)
  @virtual_machine_images = VirtualMachineImages.new(self)
  @usage_operations = UsageOperations.new(self)
  @virtual_machines = VirtualMachines.new(self)
  @virtual_machine_sizes = VirtualMachineSizes.new(self)
  @images = Images.new(self)
  @virtual_machine_scale_sets = VirtualMachineScaleSets.new(self)
  @virtual_machine_scale_set_extensions = VirtualMachineScaleSetExtensions.new(self)
  @virtual_machine_scale_set_rolling_upgrades = VirtualMachineScaleSetRollingUpgrades.new(self)
  @virtual_machine_scale_set_vmextensions = VirtualMachineScaleSetVMExtensions.new(self)
  @virtual_machine_scale_set_vms = VirtualMachineScaleSetVMs.new(self)
  @log_analytics = LogAnalytics.new(self)
  @virtual_machine_run_commands = VirtualMachineRunCommands.new(self)
  @virtual_machine_scale_set_vmrun_commands = VirtualMachineScaleSetVMRunCommands.new(self)
  @api_version = '2020-06-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



29
30
31
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 29

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns Client Api Version.

Returns:

  • (String) —

    Client Api Version.



26
27
28
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 26

def api_version
  @api_version
end

#availability_sets ⇒ AvailabilitySets (readonly)

Returns availability_sets.

Returns:



44
45
46
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 44

def availability_sets
  @availability_sets
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 18

def credentials
  @credentials
end

#dedicated_host_groups ⇒ DedicatedHostGroups (readonly)

Returns dedicated_host_groups.

Returns:



50
51
52
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 50

def dedicated_host_groups
  @dedicated_host_groups
end

#dedicated_hosts ⇒ DedicatedHosts (readonly)

Returns dedicated_hosts.

Returns:



53
54
55
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 53

def dedicated_hosts
  @dedicated_hosts
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



38
39
40
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#images ⇒ Images (readonly)

Returns images.

Returns:



77
78
79
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 77

def images
  @images
end

#log_analytics ⇒ LogAnalytics (readonly)

Returns log_analytics.

Returns:



98
99
100
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 98

def log_analytics
  @log_analytics
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



33
34
35
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



41
42
43
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 41

def operations
  @operations
end

#proximity_placement_groups ⇒ ProximityPlacementGroups (readonly)

Returns proximity_placement_groups.

Returns:



47
48
49
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 47

def proximity_placement_groups
  @proximity_placement_groups
end

#ssh_public_keys ⇒ SshPublicKeys (readonly)

Returns ssh_public_keys.

Returns:



56
57
58
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 56

def ssh_public_keys
  @ssh_public_keys
end

#subscription_id ⇒ String

Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Returns:

  • (String) —

    Subscription credentials which uniquely identify



23
24
25
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 23

def subscription_id
  @subscription_id
end

#usage_operations ⇒ UsageOperations (readonly)

Returns usage_operations.

Returns:



68
69
70
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 68

def usage_operations
  @usage_operations
end

#virtual_machine_extension_images ⇒ VirtualMachineExtensionImages (readonly)

Returns virtual_machine_extension_images.

Returns:



59
60
61
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 59

def virtual_machine_extension_images
  @virtual_machine_extension_images
end

#virtual_machine_extensions ⇒ VirtualMachineExtensions (readonly)

Returns virtual_machine_extensions.

Returns:



62
63
64
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 62

def virtual_machine_extensions
  @virtual_machine_extensions
end

#virtual_machine_images ⇒ VirtualMachineImages (readonly)

Returns virtual_machine_images.

Returns:



65
66
67
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 65

def virtual_machine_images
  @virtual_machine_images
end

#virtual_machine_run_commands ⇒ VirtualMachineRunCommands (readonly)

Returns virtual_machine_run_commands.

Returns:



101
102
103
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 101

def virtual_machine_run_commands
  @virtual_machine_run_commands
end

#virtual_machine_scale_set_extensions ⇒ VirtualMachineScaleSetExtensions (readonly)

virtual_machine_scale_set_extensions

Returns:



84
85
86
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 84

def virtual_machine_scale_set_extensions
  @virtual_machine_scale_set_extensions
end

#virtual_machine_scale_set_rolling_upgrades ⇒ VirtualMachineScaleSetRollingUpgrades (readonly)

virtual_machine_scale_set_rolling_upgrades

Returns:



88
89
90
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 88

def virtual_machine_scale_set_rolling_upgrades
  @virtual_machine_scale_set_rolling_upgrades
end

#virtual_machine_scale_set_vmextensions ⇒ VirtualMachineScaleSetVMExtensions (readonly)

virtual_machine_scale_set_vmextensions

Returns:



92
93
94
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 92

def virtual_machine_scale_set_vmextensions
  @virtual_machine_scale_set_vmextensions
end

#virtual_machine_scale_set_vmrun_commands ⇒ VirtualMachineScaleSetVMRunCommands (readonly)

virtual_machine_scale_set_vmrun_commands

Returns:



105
106
107
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 105

def virtual_machine_scale_set_vmrun_commands
  @virtual_machine_scale_set_vmrun_commands
end

#virtual_machine_scale_set_vms ⇒ VirtualMachineScaleSetVMs (readonly)

Returns virtual_machine_scale_set_vms.

Returns:



95
96
97
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 95

def virtual_machine_scale_set_vms
  @virtual_machine_scale_set_vms
end

#virtual_machine_scale_sets ⇒ VirtualMachineScaleSets (readonly)

Returns virtual_machine_scale_sets.

Returns:



80
81
82
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 80

def virtual_machine_scale_sets
  @virtual_machine_scale_sets
end

#virtual_machine_sizes ⇒ VirtualMachineSizes (readonly)

Returns virtual_machine_sizes.

Returns:



74
75
76
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 74

def virtual_machine_sizes
  @virtual_machine_sizes
end

#virtual_machines ⇒ VirtualMachines (readonly)

Returns virtual_machines.

Returns:



71
72
73
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 71

def virtual_machines
  @virtual_machines
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



164
165
166
167
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 164

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 189

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



176
177
178
179
180
 
# File 'lib/2020-06-01/generated/azure_mgmt_compute/compute_management_client.rb', line 176

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end