Class: Azure::Hdinsight::Mgmt::V2018_06_01_preview::Configurations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb

Overview

HDInsight Management Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Configurations

Creates and initializes a new instance of the Configurations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ HDInsightManagementClient (readonly)

Returns reference to the HDInsightManagementClient.

Returns:



22
23
24
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 22

def client
  @client
end

Instance Method Details

#begin_update(resource_group_name, cluster_name, configuration_name, parameters, custom_headers: nil) ⇒ Object

Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

  • configuration_name (String) —

    The name of the cluster configuration.

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

    The cluster configurations.

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

    A hash of custom headers that



292
293
294
295
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 292

def begin_update(resource_group_name, cluster_name, configuration_name, parameters, custom_headers:nil)
  response = begin_update_async(resource_group_name, cluster_name, configuration_name, parameters, custom_headers:custom_headers).value!
  nil
end

#begin_update_async(resource_group_name, cluster_name, configuration_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

  • configuration_name (String) —

    The name of the cluster configuration.

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

    The cluster configurations.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
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
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 327

def begin_update_async(resource_group_name, cluster_name, configuration_name, parameters, 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, 'cluster_name is nil' if cluster_name.nil?
  fail ArgumentError, 'configuration_name is nil' if configuration_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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 = {
    client_side_validation: true,
    required: true,
    serialized_name: 'parameters',
    type: {
      name: 'Dictionary',
      value: {
          client_side_validation: true,
          required: false,
          serialized_name: 'StringElementType',
          type: {
            name: 'String'
          }
      }
    }
  }
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}'

  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,'clusterName' => cluster_name,'configurationName' => configuration_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(: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 || 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_update_with_http_info(resource_group_name, cluster_name, configuration_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

  • configuration_name (String) —

    The name of the cluster configuration.

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

    The cluster configurations.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



310
311
312
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 310

def begin_update_with_http_info(resource_group_name, cluster_name, configuration_name, parameters, custom_headers:nil)
  begin_update_async(resource_group_name, cluster_name, configuration_name, parameters, custom_headers:custom_headers).value!
end

#get(resource_group_name, cluster_name, configuration_name, custom_headers: nil) ⇒ Hash

The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

  • configuration_name (String) —

    The name of the cluster configuration.

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

    A hash of custom headers that

Returns:

  • (Hash) —

    operation results.



174
175
176
177
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 174

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

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

The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

  • configuration_name (String) —

    The name of the cluster configuration.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 209

def get_async(resource_group_name, cluster_name, configuration_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, 'cluster_name is nil' if cluster_name.nil?
  fail ArgumentError, 'configuration_name is nil' if configuration_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.HDInsight/clusters/{clusterName}/configurations/{configurationName}'

  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,'clusterName' => cluster_name,'configurationName' => configuration_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 = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
        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, cluster_name, configuration_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

  • configuration_name (String) —

    The name of the cluster configuration.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



192
193
194
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 192

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

#list(resource_group_name, cluster_name, custom_headers: nil) ⇒ ClusterConfigurations

Gets all configuration information for an HDI cluster.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

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

    A hash of custom headers that

Returns:

  • (ClusterConfigurations) —

    operation results.



34
35
36
37
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 34

def list(resource_group_name, cluster_name, custom_headers:nil)
  response = list_async(resource_group_name, cluster_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Gets all configuration information for an HDI cluster.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



63
64
65
66
67
68
69
70
71
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
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 63

def list_async(resource_group_name, cluster_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, 'cluster_name is nil' if cluster_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.HDInsight/clusters/{clusterName}/configurations'

  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,'clusterName' => cluster_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
      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::Hdinsight::Mgmt::V2018_06_01_preview::Models::ClusterConfigurations.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_with_http_info(resource_group_name, cluster_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all configuration information for an HDI cluster.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



49
50
51
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 49

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

#update(resource_group_name, cluster_name, configuration_name, parameters, custom_headers: nil) ⇒ Object

Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

  • configuration_name (String) —

    The name of the cluster configuration.

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

    The cluster configurations.

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

    A hash of custom headers that



129
130
131
132
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 129

def update(resource_group_name, cluster_name, configuration_name, parameters, custom_headers:nil)
  response = update_async(resource_group_name, cluster_name, configuration_name, parameters, custom_headers:custom_headers).value!
  nil
end

#update_async(resource_group_name, cluster_name, configuration_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • cluster_name (String) —

    The name of the cluster.

  • configuration_name (String) —

    The name of the cluster configuration.

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

    The cluster configurations.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/configurations.rb', line 145

def update_async(resource_group_name, cluster_name, configuration_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_update_async(resource_group_name, cluster_name, configuration_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end