class Azure::SQL::Mgmt::V2015_05_01_preview::SyncAgents

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.

Attributes

client[R]

@return [SqlManagementClient] reference to the SqlManagementClient

Private Class Methods

new(client) click to toggle source

Creates and initializes a new instance of the SyncAgents class. @param client service class for accessing basic functionality.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 20
def initialize(client)
  @client = client
end

Private Instance Methods

begin_create_or_update(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:nil) click to toggle source

Creates or updates a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param parameters [SyncAgent] The requested sync agent resource state. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [SyncAgent] operation results.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 564
def begin_create_or_update(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
begin_create_or_update_async(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:nil) click to toggle source

Creates or updates a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param parameters [SyncAgent] The requested sync agent resource state. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 603
def begin_create_or_update_async(resource_group_name, server_name, sync_agent_name, parameters, custom_headers: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, 'sync_agent_name is nil' if sync_agent_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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?


  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 = Azure::SQL::Mgmt::V2015_05_01_preview::Models::SyncAgent.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}/syncAgents/{syncAgentName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'syncAgentName' => sync_agent_name,'subscriptionId' => @client.subscription_id},
      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(: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 == 200 || status_code == 202 || status_code == 201
      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.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::SQL::Mgmt::V2015_05_01_preview::Models::SyncAgent.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::SQL::Mgmt::V2015_05_01_preview::Models::SyncAgent.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, sync_agent_name, parameters, custom_headers:nil) click to toggle source

Creates or updates a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param parameters [SyncAgent] The requested sync agent resource state. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 584
def begin_create_or_update_with_http_info(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:custom_headers).value!
end
begin_delete(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Deletes a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 690
def begin_delete(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, server_name, sync_agent_name, custom_headers:custom_headers).value!
  nil
end
begin_delete_async(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Deletes a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 727
def begin_delete_async(resource_group_name, server_name, sync_agent_name, custom_headers: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, 'sync_agent_name is nil' if sync_agent_name.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?


  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.Sql/servers/{serverName}/syncAgents/{syncAgentName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'syncAgentName' => sync_agent_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.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 == 202 || 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.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_delete_with_http_info(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Deletes a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 709
def begin_delete_with_http_info(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  begin_delete_async(resource_group_name, server_name, sync_agent_name, custom_headers:custom_headers).value!
end
create_or_update(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:nil) click to toggle source

Creates or updates a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param parameters [SyncAgent] The requested sync agent resource state. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [SyncAgent] operation results.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 149
def create_or_update(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
create_or_update_async(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:nil) click to toggle source

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param parameters [SyncAgent] The requested sync agent resource state. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] promise which provides async access to http response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 168
def create_or_update_async(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, server_name, sync_agent_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::SQL::Mgmt::V2015_05_01_preview::Models::SyncAgent.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, sync_agent_name, custom_headers:nil) click to toggle source

Deletes a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 198
def delete(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  response = delete_async(resource_group_name, server_name, sync_agent_name, custom_headers:custom_headers).value!
  nil
end
delete_async(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] promise which provides async access to http response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 216
def delete_async(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, server_name, sync_agent_name, 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
generate_key(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Generates a sync agent key.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [SyncAgentKeyProperties] operation results.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 349
def generate_key(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  response = generate_key_async(resource_group_name, server_name, sync_agent_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
generate_key_async(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Generates a sync agent key.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 386
def generate_key_async(resource_group_name, server_name, sync_agent_name, custom_headers: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, 'sync_agent_name is nil' if sync_agent_name.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?


  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.Sql/servers/{serverName}/syncAgents/{syncAgentName}/generateKey'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'syncAgentName' => sync_agent_name,'subscriptionId' => @client.subscription_id},
      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 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.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::SQL::Mgmt::V2015_05_01_preview::Models::SyncAgentKeyProperties.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
generate_key_with_http_info(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Generates a sync agent key.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 368
def generate_key_with_http_info(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  generate_key_async(resource_group_name, server_name, sync_agent_name, custom_headers:custom_headers).value!
end
get(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Gets a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [SyncAgent] operation results.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 41
def get(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  response = get_async(resource_group_name, server_name, sync_agent_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Gets a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 78
def get_async(resource_group_name, server_name, sync_agent_name, custom_headers: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, 'sync_agent_name is nil' if sync_agent_name.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?


  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.Sql/servers/{serverName}/syncAgents/{syncAgentName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'syncAgentName' => sync_agent_name,'subscriptionId' => @client.subscription_id},
      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 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.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::SQL::Mgmt::V2015_05_01_preview::Models::SyncAgent.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, sync_agent_name, custom_headers:nil) click to toggle source

Gets a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 60
def get_with_http_info(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  get_async(resource_group_name, server_name, sync_agent_name, custom_headers:custom_headers).value!
end
list_by_server(resource_group_name, server_name, custom_headers:nil) click to toggle source

Lists sync agents in a server.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<SyncAgent>] operation results.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 245
def list_by_server(resource_group_name, server_name, custom_headers:nil)
  first_page = list_by_server_as_lazy(resource_group_name, server_name, custom_headers:custom_headers)
  first_page.get_all_items
end
list_by_server_as_lazy(resource_group_name, server_name, custom_headers:nil) click to toggle source

Lists sync agents in a server.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [SyncAgentListResult] which provide lazy access to pages of the response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 967
def list_by_server_as_lazy(resource_group_name, server_name, custom_headers:nil)
  response = list_by_server_async(resource_group_name, server_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_server_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end
list_by_server_async(resource_group_name, server_name, custom_headers:nil) click to toggle source

Lists sync agents in a server.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 280
def list_by_server_async(resource_group_name, server_name, custom_headers: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, '@client.subscription_id is nil' if @client.subscription_id.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.Sql/servers/{serverName}/syncAgents'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'subscriptionId' => @client.subscription_id},
      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 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.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::SQL::Mgmt::V2015_05_01_preview::Models::SyncAgentListResult.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_next(next_page_link, custom_headers:nil) click to toggle source

Lists sync agents in a server.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [SyncAgentListResult] operation results.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 783
def list_by_server_next(next_page_link, custom_headers:nil)
  response = list_by_server_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_by_server_next_async(next_page_link, custom_headers:nil) click to toggle source

Lists sync agents in a server.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 812
def list_by_server_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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?
    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::SQL::Mgmt::V2015_05_01_preview::Models::SyncAgentListResult.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_next_with_http_info(next_page_link, custom_headers:nil) click to toggle source

Lists sync agents in a server.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 798
def list_by_server_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_server_next_async(next_page_link, custom_headers:custom_headers).value!
end
list_by_server_with_http_info(resource_group_name, server_name, custom_headers:nil) click to toggle source

Lists sync agents in a server.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 263
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:custom_headers).value!
end
list_linked_databases(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Lists databases linked to a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<SyncAgentLinkedDatabase>] operation results.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 456
def list_linked_databases(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  first_page = list_linked_databases_as_lazy(resource_group_name, server_name, sync_agent_name, custom_headers:custom_headers)
  first_page.get_all_items
end
list_linked_databases_as_lazy(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Lists databases linked to a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [SyncAgentLinkedDatabaseListResult] which provide lazy access to pages of the response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 993
def list_linked_databases_as_lazy(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  response = list_linked_databases_async(resource_group_name, server_name, sync_agent_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_linked_databases_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end
list_linked_databases_async(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Lists databases linked to a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 493
def list_linked_databases_async(resource_group_name, server_name, sync_agent_name, custom_headers: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, 'sync_agent_name is nil' if sync_agent_name.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?


  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.Sql/servers/{serverName}/syncAgents/{syncAgentName}/linkedDatabases'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'syncAgentName' => sync_agent_name,'subscriptionId' => @client.subscription_id},
      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 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.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::SQL::Mgmt::V2015_05_01_preview::Models::SyncAgentLinkedDatabaseListResult.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_linked_databases_next(next_page_link, custom_headers:nil) click to toggle source

Lists databases linked to a sync agent.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [SyncAgentLinkedDatabaseListResult] operation results.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 873
def list_linked_databases_next(next_page_link, custom_headers:nil)
  response = list_linked_databases_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_linked_databases_next_async(next_page_link, custom_headers:nil) click to toggle source

Lists databases linked to a sync agent.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 902
def list_linked_databases_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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?
    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::SQL::Mgmt::V2015_05_01_preview::Models::SyncAgentLinkedDatabaseListResult.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_linked_databases_next_with_http_info(next_page_link, custom_headers:nil) click to toggle source

Lists databases linked to a sync agent.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 888
def list_linked_databases_next_with_http_info(next_page_link, custom_headers:nil)
  list_linked_databases_next_async(next_page_link, custom_headers:custom_headers).value!
end
list_linked_databases_with_http_info(resource_group_name, server_name, sync_agent_name, custom_headers:nil) click to toggle source

Lists databases linked to a sync agent.

@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. @param server_name [String] The name of the server on which the sync agent is hosted. @param sync_agent_name [String] The name of the sync agent. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2015-05-01-preview/generated/azure_mgmt_sql/sync_agents.rb, line 475
def list_linked_databases_with_http_info(resource_group_name, server_name, sync_agent_name, custom_headers:nil)
  list_linked_databases_async(resource_group_name, server_name, sync_agent_name, custom_headers:custom_headers).value!
end