Class: Azure::ARM::ServerManagement::Session

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_server_management/session.rb

Overview

REST API for Azure Server Management Service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Session

Creates and initializes a new instance of the Session class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ServerManagement (readonly)

Returns reference to the ServerManagement.

Returns:



23
24
25
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 23

def client
  @client
end

Instance Method Details

#begin_create(resource_group_name, node_name, session, user_name = nil, password = nil, custom_headers = nil) ⇒ SessionResource

Creates a session for a node

identifies the resource group within the user subscriptionId. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    User name to be used to connect to node

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

    Password associated with user name

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

    A hash of custom headers that

Returns:



89
90
91
92
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 89

def begin_create(resource_group_name, node_name, session, user_name = nil, password = nil, custom_headers = nil)
  response = begin_create_async(resource_group_name, node_name, session, user_name, password, custom_headers).value!
  response.body unless response.nil?
end

#begin_create_async(resource_group_name, node_name, session, user_name = nil, password = nil, custom_headers = nil) ⇒ Concurrent::Promise

Creates a session for a node

identifies the resource group within the user subscriptionId. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    User name to be used to connect to node

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

    Password associated with user name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
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
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 126

def begin_create_async(resource_group_name, node_name, session, user_name = nil, password = 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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'node_name is nil' if node_name.nil?
  fail ArgumentError, 'session is nil' if session.nil?

  session_parameters = SessionParameters.new
  unless user_name.nil? && password.nil?
    session_parameters.user_name = user_name
    session_parameters.password = password
  end

  request_headers = {}

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

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

  # Serialize Request
  request_mapper = SessionParameters.mapper()
  request_content = @client.serialize(request_mapper,  session_parameters, 'session_parameters')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'nodeName' => node_name,'session' => session},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :put, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_response|
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 201 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = SessionResource.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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 = SessionResource.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_with_http_info(resource_group_name, node_name, session, user_name = nil, password = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a session for a node

identifies the resource group within the user subscriptionId. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    User name to be used to connect to node

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

    Password associated with user name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



108
109
110
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 108

def begin_create_with_http_info(resource_group_name, node_name, session, user_name = nil, password = nil, custom_headers = nil)
  begin_create_async(resource_group_name, node_name, session, user_name, password, custom_headers).value!
end

#create(resource_group_name, node_name, session, user_name = nil, password = nil, custom_headers = nil) ⇒ SessionResource

Creates a session for a node

identifies the resource group within the user subscriptionId. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    User name to be used to connect to node

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

    Password associated with user name

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

    A hash of custom headers that

Returns:



39
40
41
42
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 39

def create(resource_group_name, node_name, session, user_name = nil, password = nil, custom_headers = nil)
  response = create_async(resource_group_name, node_name, session, user_name, password, custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, node_name, session, user_name = nil, password = nil, custom_headers = nil) ⇒ Concurrent::Promise

identifies the resource group within the user subscriptionId. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    User name to be used to connect to node

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

    Password associated with user 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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 57

def create_async(resource_group_name, node_name, session, user_name = nil, password = nil, custom_headers = nil)
  # Send request
  promise = begin_create_async(resource_group_name, node_name, session, user_name, password, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = SessionResource.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response, 'parsed_response')
    end

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

  promise
end

#delete(resource_group_name, node_name, session, custom_headers = nil) ⇒ Object

Deletes a session for a node

identifies the resource group within the user subscriptionId. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    A hash of custom headers that



217
218
219
220
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 217

def delete(resource_group_name, node_name, session, custom_headers = nil)
  response = delete_async(resource_group_name, node_name, session, custom_headers).value!
  nil
end

#delete_async(resource_group_name, node_name, session, custom_headers = nil) ⇒ Concurrent::Promise

Deletes a session for a node

identifies the resource group within the user subscriptionId. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 250

def delete_async(resource_group_name, node_name, session, 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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'node_name is nil' if node_name.nil?
  fail ArgumentError, 'session is nil' if session.nil?


  request_headers = {}

  # 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.ServerManagement/nodes/{nodeName}/sessions/{session}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'nodeName' => node_name,'session' => session},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :delete, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_response|
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, node_name, session, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a session for a node

identifies the resource group within the user subscriptionId. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



234
235
236
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 234

def delete_with_http_info(resource_group_name, node_name, session, custom_headers = nil)
  delete_async(resource_group_name, node_name, session, custom_headers).value!
end

#get(resource_group_name, node_name, session, custom_headers = nil) ⇒ SessionResource

Gets a session for a node

identifies the resource group within the user subscriptionId. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    A hash of custom headers that

Returns:



308
309
310
311
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 308

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

#get_async(resource_group_name, node_name, session, custom_headers = nil) ⇒ Concurrent::Promise

Gets a session for a node

identifies the resource group within the user subscriptionId. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
395
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 341

def get_async(resource_group_name, node_name, session, 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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'node_name is nil' if node_name.nil?
  fail ArgumentError, 'session is nil' if session.nil?


  request_headers = {}

  # 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.ServerManagement/nodes/{nodeName}/sessions/{session}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'nodeName' => node_name,'session' => session},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = SessionResource.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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, node_name, session, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a session for a node

identifies the resource group within the user subscriptionId. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name uniquely

  • node_name (String) —

    The node name (256 characters maximum).

  • session (String) —

    The sessionId from the user

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



325
326
327
 
# File 'lib/generated/azure_mgmt_server_management/session.rb', line 325

def get_with_http_info(resource_group_name, node_name, session, custom_headers = nil)
  get_async(resource_group_name, node_name, session, custom_headers).value!
end