Class: Azure::ARM::SQL::ServerCommunicationLinks

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_sql/server_communication_links.rb

Overview

The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ServerCommunicationLinks

Creates and initializes a new instance of the ServerCommunicationLinks class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SqlManagementClient (readonly)

Returns reference to the SqlManagementClient.

Returns:



25
26
27
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 25

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, server_name, communication_link_name, parameters, custom_headers = nil) ⇒ ServerCommunicationLink

Creates a server communication link.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. creating a server communication link. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

  • parameters (ServerCommunicationLink) —

    The required parameters for

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

    A hash of custom headers that

Returns:

  • (ServerCommunicationLink) —

    operation results.



391
392
393
394
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 391

def begin_create_or_update(resource_group_name, server_name, communication_link_name, parameters, custom_headers = nil)
  response = begin_create_or_update_async(resource_group_name, server_name, communication_link_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, server_name, communication_link_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Creates a server communication link.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. creating a server communication link. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

  • parameters (ServerCommunicationLink) —

    The required parameters for

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 432

def begin_create_or_update_async(resource_group_name, server_name, communication_link_name, parameters, custom_headers = nil)
  api_version = '2014-04-01'
  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, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'communication_link_name is nil' if communication_link_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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?

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

  # Serialize Request
  request_mapper = Azure::ARM::SQL::Models::ServerCommunicationLink.mapper()
  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.Sql/servers/{serverName}/communicationLinks/{communicationLinkName}'

  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,'serverName' => server_name,'communicationLinkName' => communication_link_name},
      query_params: {'api-version' => 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 == 201 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::SQL::Models::ServerCommunicationLink.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, server_name, communication_link_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a server communication link.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. creating a server communication link. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

  • parameters (ServerCommunicationLink) —

    The required parameters for

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



412
413
414
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 412

def begin_create_or_update_with_http_info(resource_group_name, server_name, communication_link_name, parameters, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, server_name, communication_link_name, parameters, custom_headers).value!
end

#create_or_update(resource_group_name, server_name, communication_link_name, parameters, custom_headers = nil) ⇒ ServerCommunicationLink

Creates a server communication link.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. creating a server communication link. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

  • parameters (ServerCommunicationLink) —

    The required parameters for

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

    A hash of custom headers that

Returns:

  • (ServerCommunicationLink) —

    operation results.



240
241
242
243
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 240

def create_or_update(resource_group_name, server_name, communication_link_name, parameters, custom_headers = nil)
  response = create_or_update_async(resource_group_name, server_name, communication_link_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, server_name, communication_link_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. creating a server communication link. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

  • parameters (ServerCommunicationLink) —

    The required parameters for

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 260

def create_or_update_async(resource_group_name, server_name, communication_link_name, parameters, custom_headers = nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, server_name, communication_link_name, parameters, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::ARM::SQL::Models::ServerCommunicationLink.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, server_name, communication_link_name, custom_headers = nil) ⇒ Object

Deletes a server communication link.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

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

    A hash of custom headers that



40
41
42
43
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 40

def delete(resource_group_name, server_name, communication_link_name, custom_headers = nil)
  response = delete_async(resource_group_name, server_name, communication_link_name, custom_headers).value!
  nil
end

#delete_async(resource_group_name, server_name, communication_link_name, custom_headers = nil) ⇒ Concurrent::Promise

Deletes a server communication link.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 77

def delete_async(resource_group_name, server_name, communication_link_name, custom_headers = nil)
  api_version = '2014-04-01'
  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, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'communication_link_name is nil' if communication_link_name.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.Sql/servers/{serverName}/communicationLinks/{communicationLinkName}'

  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,'serverName' => server_name,'communicationLinkName' => communication_link_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, server_name, communication_link_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a server communication link.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



59
60
61
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 59

def delete_with_http_info(resource_group_name, server_name, communication_link_name, custom_headers = nil)
  delete_async(resource_group_name, server_name, communication_link_name, custom_headers).value!
end

#get(resource_group_name, server_name, communication_link_name, custom_headers = nil) ⇒ ServerCommunicationLink

Returns a server communication link.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

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

    A hash of custom headers that

Returns:

  • (ServerCommunicationLink) —

    operation results.



134
135
136
137
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 134

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

#get_async(resource_group_name, server_name, communication_link_name, custom_headers = nil) ⇒ Concurrent::Promise

Returns a server communication link.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 171

def get_async(resource_group_name, server_name, communication_link_name, custom_headers = nil)
  api_version = '2014-04-01'
  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, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'communication_link_name is nil' if communication_link_name.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.Sql/servers/{serverName}/communicationLinks/{communicationLinkName}'

  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,'serverName' => server_name,'communicationLinkName' => communication_link_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::SQL::Models::ServerCommunicationLink.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, server_name, communication_link_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Returns a server communication link.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. link. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • communication_link_name (String) —

    The name of the server communication

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



153
154
155
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 153

def get_with_http_info(resource_group_name, server_name, communication_link_name, custom_headers = nil)
  get_async(resource_group_name, server_name, communication_link_name, custom_headers).value!
end

#list_by_server(resource_group_name, server_name, custom_headers = nil) ⇒ ServerCommunicationLinkListResult

Gets a list of server communication links.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that

Returns:

  • (ServerCommunicationLinkListResult) —

    operation results.



290
291
292
293
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 290

def list_by_server(resource_group_name, server_name, custom_headers = nil)
  response = list_by_server_async(resource_group_name, server_name, custom_headers).value!
  response.body unless response.nil?
end

#list_by_server_async(resource_group_name, server_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets a list of server communication links.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



323
324
325
326
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
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 323

def list_by_server_async(resource_group_name, server_name, custom_headers = nil)
  api_version = '2014-04-01'
  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, 'server_name is nil' if server_name.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.Sql/servers/{serverName}/communicationLinks'

  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,'serverName' => server_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::SQL::Models::ServerCommunicationLinkListResult.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_server_with_http_info(resource_group_name, server_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of server communication links.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



307
308
309
 
# File 'lib/generated/azure_mgmt_sql/server_communication_links.rb', line 307

def list_by_server_with_http_info(resource_group_name, server_name, custom_headers = nil)
  list_by_server_async(resource_group_name, server_name, custom_headers).value!
end