class Azure::SQL::Mgmt::V2018_06_01_preview::DatabaseSchemas

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

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 DatabaseSchemas class. @param client service class for accessing basic functionality.

# File lib/2018-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 20
def initialize(client)
  @client = client
end

Private Instance Methods

get(resource_group_name, server_name, database_name, schema_name, custom_headers:nil) click to toggle source

Get database schema

@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. @param database_name [String] The name of the database. @param schema_name [String] The name of the schema. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [DatabaseSchema] operation results.

# File lib/2018-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 151
def get(resource_group_name, server_name, database_name, schema_name, custom_headers:nil)
  response = get_async(resource_group_name, server_name, database_name, schema_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(resource_group_name, server_name, database_name, schema_name, custom_headers:nil) click to toggle source

Get database schema

@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. @param database_name [String] The name of the database. @param schema_name [String] The name of the schema. @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-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 188
def get_async(resource_group_name, server_name, database_name, schema_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, 'database_name is nil' if database_name.nil?
  fail ArgumentError, 'schema_name is nil' if schema_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}/databases/{databaseName}/schemas/{schemaName}'

  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,'databaseName' => database_name,'schemaName' => schema_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::V2018_06_01_preview::Models::DatabaseSchema.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, schema_name, custom_headers:nil) click to toggle source

Get database schema

@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. @param database_name [String] The name of the database. @param schema_name [String] The name of the schema. @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-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 170
def get_with_http_info(resource_group_name, server_name, database_name, schema_name, custom_headers:nil)
  get_async(resource_group_name, server_name, database_name, schema_name, custom_headers:custom_headers).value!
end
list_by_database(resource_group_name, server_name, database_name, filter:nil, custom_headers:nil) click to toggle source

List database schemas

@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. @param database_name [String] The name of the database. @param filter [String] An OData filter expression that filters elements in the collection. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<DatabaseSchema>] operation results.

# File lib/2018-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 42
def list_by_database(resource_group_name, server_name, database_name, filter:nil, custom_headers:nil)
  first_page = list_by_database_as_lazy(resource_group_name, server_name, database_name, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end
list_by_database_as_lazy(resource_group_name, server_name, database_name, filter:nil, custom_headers:nil) click to toggle source

List database schemas

@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. @param database_name [String] The name of the database. @param filter [String] An OData filter expression that filters elements in the collection. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

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

# File lib/2018-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 351
def list_by_database_as_lazy(resource_group_name, server_name, database_name, filter:nil, custom_headers:nil)
  response = list_by_database_async(resource_group_name, server_name, database_name, filter:filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_database_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end
list_by_database_async(resource_group_name, server_name, database_name, filter:nil, custom_headers:nil) click to toggle source

List database schemas

@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. @param database_name [String] The name of the database. @param filter [String] An OData filter expression that filters elements in the collection. @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-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 81
def list_by_database_async(resource_group_name, server_name, database_name, filter:nil, 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, 'database_name is nil' if database_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}/databases/{databaseName}/schemas'

  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,'databaseName' => database_name,'subscriptionId' => @client.subscription_id},
      query_params: {'$filter' => filter,'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::V2018_06_01_preview::Models::DatabaseSchemaListResult.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_next(next_page_link, custom_headers:nil) click to toggle source

List database schemas

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

# File lib/2018-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 255
def list_by_database_next(next_page_link, custom_headers:nil)
  response = list_by_database_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_by_database_next_async(next_page_link, custom_headers:nil) click to toggle source

List database schemas

@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-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 284
def list_by_database_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::V2018_06_01_preview::Models::DatabaseSchemaListResult.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_next_with_http_info(next_page_link, custom_headers:nil) click to toggle source

List database schemas

@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-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 270
def list_by_database_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_database_next_async(next_page_link, custom_headers:custom_headers).value!
end
list_by_database_with_http_info(resource_group_name, server_name, database_name, filter:nil, custom_headers:nil) click to toggle source

List database schemas

@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. @param database_name [String] The name of the database. @param filter [String] An OData filter expression that filters elements in the collection. @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-06-01-preview/generated/azure_mgmt_sql/database_schemas.rb, line 62
def list_by_database_with_http_info(resource_group_name, server_name, database_name, filter:nil, custom_headers:nil)
  list_by_database_async(resource_group_name, server_name, database_name, filter:filter, custom_headers:custom_headers).value!
end