Class: Azure::ARM::SQL::ReplicationLinks

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_sql/replication_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) ⇒ ReplicationLinks

Creates and initializes a new instance of the ReplicationLinks class.

Parameters:

  • client

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientSqlManagementClient (readonly)

Returns reference to the SqlManagementClient.

Returns:



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

def client
  @client
end

Instance Method Details

#begin_failover(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ Object

Sets which replica database is primary by failing over from the current primary replica database.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. replication link to be failed over. 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.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be failed over.

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

    A hash of custom headers that



443
444
445
446
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 443

def begin_failover(resource_group_name, server_name, database_name, link_id, custom_headers = nil)
  response = begin_failover_async(resource_group_name, server_name, database_name, link_id, custom_headers).value!
  nil
end

#begin_failover_allow_data_loss(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ Object

Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. replication link to be failed over. 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.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be failed over.

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

    A hash of custom headers that



543
544
545
546
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 543

def begin_failover_allow_data_loss(resource_group_name, server_name, database_name, link_id, custom_headers = nil)
  response = begin_failover_allow_data_loss_async(resource_group_name, server_name, database_name, link_id, custom_headers).value!
  nil
end

#begin_failover_allow_data_loss_async(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ Concurrent::Promise

Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • server_name (String)

    The name of the server.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be failed over.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 584

def begin_failover_allow_data_loss_async(resource_group_name, server_name, database_name, link_id, 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, 'database_name is nil' if database_name.nil?
  fail ArgumentError, 'link_id is nil' if link_id.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}/databases/{databaseName}/replicationLinks/{linkId}/forceFailoverAllowDataLoss'

  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,'databaseName' => database_name,'linkId' => link_id},
      query_params: {'api-version' => 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 == 204 || 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?

    result
  end

  promise.execute
end

#begin_failover_allow_data_loss_with_http_info(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. replication link to be failed over. 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.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be failed over.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



564
565
566
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 564

def begin_failover_allow_data_loss_with_http_info(resource_group_name, server_name, database_name, link_id, custom_headers = nil)
  begin_failover_allow_data_loss_async(resource_group_name, server_name, database_name, link_id, custom_headers).value!
end

#begin_failover_async(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ Concurrent::Promise

Sets which replica database is primary by failing over from the current primary replica database.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • server_name (String)

    The name of the server.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be failed over.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 484

def begin_failover_async(resource_group_name, server_name, database_name, link_id, 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, 'database_name is nil' if database_name.nil?
  fail ArgumentError, 'link_id is nil' if link_id.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}/databases/{databaseName}/replicationLinks/{linkId}/failover'

  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,'databaseName' => database_name,'linkId' => link_id},
      query_params: {'api-version' => 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 == 204 || 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?

    result
  end

  promise.execute
end

#begin_failover_with_http_info(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Sets which replica database is primary by failing over from the current primary replica database.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. replication link to be failed over. 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.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be failed over.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



464
465
466
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 464

def begin_failover_with_http_info(resource_group_name, server_name, database_name, link_id, custom_headers = nil)
  begin_failover_async(resource_group_name, server_name, database_name, link_id, custom_headers).value!
end

#delete(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ Object

Deletes a database replication link. Cannot be done during failover.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. replication link to be dropped. 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.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be deleted.

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

    A hash of custom headers that



41
42
43
44
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 41

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

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

Deletes a database replication link. Cannot be done during failover.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • server_name (String)

    The name of the server.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be deleted.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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

def delete_async(resource_group_name, server_name, database_name, link_id, 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, 'database_name is nil' if database_name.nil?
  fail ArgumentError, 'link_id is nil' if link_id.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}/databases/{databaseName}/replicationLinks/{linkId}'

  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,'databaseName' => database_name,'linkId' => link_id},
      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 || status_code == 204
      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, database_name, link_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a database replication link. Cannot be done during failover.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. replication link to be dropped. 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.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be deleted.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



61
62
63
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 61

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

#failover(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ Object

Sets which replica database is primary by failing over from the current primary replica database.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. replication link to be failed over. 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.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be failed over.

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

    A hash of custom headers that



243
244
245
246
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 243

def failover(resource_group_name, server_name, database_name, link_id, custom_headers = nil)
  response = failover_async(resource_group_name, server_name, database_name, link_id, custom_headers).value!
  nil
end

#failover_allow_data_loss(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ Object

Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. replication link to be failed over. 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.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be failed over.

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

    A hash of custom headers that



292
293
294
295
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 292

def failover_allow_data_loss(resource_group_name, server_name, database_name, link_id, custom_headers = nil)
  response = failover_allow_data_loss_async(resource_group_name, server_name, database_name, link_id, custom_headers).value!
  nil
end

#failover_allow_data_loss_async(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ Concurrent::Promise

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. replication link to be failed over. 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.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be failed over.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 311

def failover_allow_data_loss_async(resource_group_name, server_name, database_name, link_id, custom_headers = nil)
  # Send request
  promise = begin_failover_allow_data_loss_async(resource_group_name, server_name, database_name, link_id, 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

#failover_async(resource_group_name, server_name, database_name, link_id, custom_headers = nil) ⇒ Concurrent::Promise

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. replication link to be failed over. 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.

  • database_name (String)

    The name of the database that has the

  • link_id (String)

    The ID of the replication link to be failed over.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



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

def failover_async(resource_group_name, server_name, database_name, link_id, custom_headers = nil)
  # Send request
  promise = begin_failover_async(resource_group_name, server_name, database_name, link_id, 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, server_name, database_name, link_id, custom_headers = nil) ⇒ ReplicationLink

Gets a database replication link.

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.

  • database_name (String)

    The name of the database to get the link for.

  • link_id (String)

    The replication link ID to be retrieved.

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

    A hash of custom headers that

Returns:

  • (ReplicationLink)

    operation results.



138
139
140
141
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 138

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

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

Gets a database replication link.

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.

  • database_name (String)

    The name of the database to get the link for.

  • link_id (String)

    The replication link ID to be retrieved.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
223
224
225
226
227
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 175

def get_async(resource_group_name, server_name, database_name, link_id, 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, 'database_name is nil' if database_name.nil?
  fail ArgumentError, 'link_id is nil' if link_id.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}/databases/{databaseName}/replicationLinks/{linkId}'

  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,'databaseName' => database_name,'linkId' => link_id},
      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::ReplicationLink.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, database_name, link_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a database replication link.

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.

  • database_name (String)

    The name of the database to get the link for.

  • link_id (String)

    The replication link ID to be retrieved.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



157
158
159
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 157

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

#list_by_database(resource_group_name, server_name, database_name, custom_headers = nil) ⇒ ReplicationLinkListResult

Lists a database’s replication 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.

  • database_name (String)

    The name of the database to retrieve links for.

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

    A hash of custom headers that

Returns:

  • (ReplicationLinkListResult)

    operation results.



340
341
342
343
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 340

def list_by_database(resource_group_name, server_name, database_name, custom_headers = nil)
  response = list_by_database_async(resource_group_name, server_name, database_name, custom_headers).value!
  response.body unless response.nil?
end

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

Lists a database’s replication 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.

  • database_name (String)

    The name of the database to retrieve links for.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 375

def list_by_database_async(resource_group_name, server_name, database_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, 'database_name is nil' if database_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}/databases/{databaseName}/replicationLinks'

  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,'databaseName' => database_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::ReplicationLinkListResult.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_database_with_http_info(resource_group_name, server_name, database_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists a database’s replication 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.

  • database_name (String)

    The name of the database to retrieve links for.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



358
359
360
# File 'lib/generated/azure_mgmt_sql/replication_links.rb', line 358

def list_by_database_with_http_info(resource_group_name, server_name, database_name, custom_headers = nil)
  list_by_database_async(resource_group_name, server_name, database_name, custom_headers).value!
end