class Azure::Redis::Mgmt::V2018_03_01::LinkedServer

REST API for Azure Redis Cache Service.

Attributes

client[R]

@return [RedisManagementClient] reference to the RedisManagementClient

Private Class Methods

new(client) click to toggle source

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

# File lib/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

begin_create(resource_group_name, name, linked_server_name, parameters, custom_headers:nil) click to toggle source

Adds a linked server to the Redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the Redis cache. @param linked_server_name [String] The name of the linked server that is being added to the Redis cache. @param parameters [RedisLinkedServerCreateParameters] Parameters supplied to the Create Linked server operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [RedisLinkedServerWithProperties] operation results.

# File lib/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 370
def begin_create(resource_group_name, name, linked_server_name, parameters, custom_headers:nil)
  response = begin_create_async(resource_group_name, name, linked_server_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
begin_create_async(resource_group_name, name, linked_server_name, parameters, custom_headers:nil) click to toggle source

Adds a linked server to the Redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the Redis cache. @param linked_server_name [String] The name of the linked server that is being added to the Redis cache. @param parameters [RedisLinkedServerCreateParameters] Parameters supplied to the Create Linked server 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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 407
def begin_create_async(resource_group_name, name, linked_server_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, 'linked_server_name is nil' if linked_server_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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::Redis::Mgmt::V2018_03_01::Models::RedisLinkedServerCreateParameters.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.Cache/Redis/{name}/linkedServers/{linkedServerName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'name' => name,'linkedServerName' => linked_server_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 == 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Redis::Mgmt::V2018_03_01::Models::RedisLinkedServerWithProperties.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::Redis::Mgmt::V2018_03_01::Models::RedisLinkedServerWithProperties.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_with_http_info(resource_group_name, name, linked_server_name, parameters, custom_headers:nil) click to toggle source

Adds a linked server to the Redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the Redis cache. @param linked_server_name [String] The name of the linked server that is being added to the Redis cache. @param parameters [RedisLinkedServerCreateParameters] Parameters supplied to the Create Linked server 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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 389
def begin_create_with_http_info(resource_group_name, name, linked_server_name, parameters, custom_headers:nil)
  begin_create_async(resource_group_name, name, linked_server_name, parameters, custom_headers:custom_headers).value!
end
create(resource_group_name, name, linked_server_name, parameters, custom_headers:nil) click to toggle source

Adds a linked server to the Redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the Redis cache. @param linked_server_name [String] The name of the linked server that is being added to the Redis cache. @param parameters [RedisLinkedServerCreateParameters] Parameters supplied to the Create Linked server operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [RedisLinkedServerWithProperties] operation results.

# File lib/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 38
def create(resource_group_name, name, linked_server_name, parameters, custom_headers:nil)
  response = create_async(resource_group_name, name, linked_server_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
create_async(resource_group_name, name, linked_server_name, parameters, custom_headers:nil) click to toggle source

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the Redis cache. @param linked_server_name [String] The name of the linked server that is being added to the Redis cache. @param parameters [RedisLinkedServerCreateParameters] Parameters supplied to the Create Linked server operation. @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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 56
def create_async(resource_group_name, name, linked_server_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_async(resource_group_name, name, linked_server_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Redis::Mgmt::V2018_03_01::Models::RedisLinkedServerWithProperties.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, name, linked_server_name, custom_headers:nil) click to toggle source

Deletes the linked server from a redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the redis cache. @param linked_server_name [String] The name of the linked server that is being added to the Redis cache. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 85
def delete(resource_group_name, name, linked_server_name, custom_headers:nil)
  response = delete_async(resource_group_name, name, linked_server_name, custom_headers:custom_headers).value!
  nil
end
delete_async(resource_group_name, name, linked_server_name, custom_headers:nil) click to toggle source

Deletes the linked server from a redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the redis cache. @param linked_server_name [String] The name of the linked server that is being added to the Redis cache. @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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 118
def delete_async(resource_group_name, name, linked_server_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, 'linked_server_name is nil' if linked_server_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Cache/Redis/{name}/linkedServers/{linkedServerName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'name' => name,'linkedServerName' => linked_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(: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, name, linked_server_name, custom_headers:nil) click to toggle source

Deletes the linked server from a redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the redis cache. @param linked_server_name [String] The name of the linked server that is being added to the Redis cache. @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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 102
def delete_with_http_info(resource_group_name, name, linked_server_name, custom_headers:nil)
  delete_async(resource_group_name, name, linked_server_name, custom_headers:custom_headers).value!
end
get(resource_group_name, name, linked_server_name, custom_headers:nil) click to toggle source

Gets the detailed information about a linked server of a redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the redis cache. @param linked_server_name [String] The name of the linked server. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [RedisLinkedServerWithProperties] operation results.

# File lib/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 174
def get(resource_group_name, name, linked_server_name, custom_headers:nil)
  response = get_async(resource_group_name, name, linked_server_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(resource_group_name, name, linked_server_name, custom_headers:nil) click to toggle source

Gets the detailed information about a linked server of a redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the redis cache. @param linked_server_name [String] The name of the linked server. @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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 207
def get_async(resource_group_name, name, linked_server_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, 'linked_server_name is nil' if linked_server_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Cache/Redis/{name}/linkedServers/{linkedServerName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'name' => name,'linkedServerName' => linked_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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Redis::Mgmt::V2018_03_01::Models::RedisLinkedServerWithProperties.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, name, linked_server_name, custom_headers:nil) click to toggle source

Gets the detailed information about a linked server of a redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the redis cache. @param linked_server_name [String] The name of the linked server. @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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 191
def get_with_http_info(resource_group_name, name, linked_server_name, custom_headers:nil)
  get_async(resource_group_name, name, linked_server_name, custom_headers:custom_headers).value!
end
list(resource_group_name, name, custom_headers:nil) click to toggle source

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the redis cache. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<RedisLinkedServerWithProperties>] operation results.

# File lib/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 272
def list(resource_group_name, name, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, name, custom_headers:custom_headers)
  first_page.get_all_items
end
list_as_lazy(resource_group_name, name, custom_headers:nil) click to toggle source

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the redis cache. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

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

# File lib/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 582
def list_as_lazy(resource_group_name, name, custom_headers:nil)
  response = list_async(resource_group_name, name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end
list_async(resource_group_name, name, custom_headers:nil) click to toggle source

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the redis cache. @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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 303
def list_async(resource_group_name, name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Cache/Redis/{name}/linkedServers'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'name' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Redis::Mgmt::V2018_03_01::Models::RedisLinkedServerWithPropertiesList.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_next(next_page_link, custom_headers:nil) click to toggle source

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

@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 [RedisLinkedServerWithPropertiesList] operation results.

# File lib/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 490
def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_next_async(next_page_link, custom_headers:nil) click to toggle source

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

@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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 521
def list_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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Redis::Mgmt::V2018_03_01::Models::RedisLinkedServerWithPropertiesList.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_next_with_http_info(next_page_link, custom_headers:nil) click to toggle source

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

@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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 506
def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end
list_with_http_info(resource_group_name, name, custom_headers:nil) click to toggle source

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

@param resource_group_name [String] The name of the resource group. @param name [String] The name of the redis cache. @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/2018-03-01/generated/azure_mgmt_redis/linked_server.rb, line 288
def list_with_http_info(resource_group_name, name, custom_headers:nil)
  list_async(resource_group_name, name, custom_headers:custom_headers).value!
end