Class: Azure::SQL::Mgmt::V2018_06_01_preview::ManagedDatabaseColumns

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ManagedDatabaseColumns

Creates and initializes a new instance of the ManagedDatabaseColumns class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SqlManagementClient (readonly)

Returns reference to the SqlManagementClient.

Returns:



25
26
27
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 25

def client
  @client
end

Instance Method Details

#get(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers: nil) ⇒ DatabaseColumn

Get managed database column

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

  • managed_instance_name (String) —

    The name of the managed instance.

  • database_name (String) —

    The name of the database.

  • schema_name (String) —

    The name of the schema.

  • table_name (String) —

    The name of the table.

  • column_name (String) —

    The name of the column.

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

    A hash of custom headers that

Returns:

  • (DatabaseColumn) —

    operation results.



161
162
163
164
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 161

def get(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers:nil)
  response = get_async(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers: nil) ⇒ Concurrent::Promise

Get managed database column

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

  • managed_instance_name (String) —

    The name of the managed instance.

  • database_name (String) —

    The name of the database.

  • schema_name (String) —

    The name of the schema.

  • table_name (String) —

    The name of the table.

  • column_name (String) —

    The name of the column.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 202

def get_async(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'managed_instance_name is nil' if managed_instance_name.nil?
  fail ArgumentError, 'database_name is nil' if database_name.nil?
  fail ArgumentError, 'schema_name is nil' if schema_name.nil?
  fail ArgumentError, 'table_name is nil' if table_name.nil?
  fail ArgumentError, 'column_name is nil' if column_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/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'managedInstanceName' => managed_instance_name,'databaseName' => database_name,'schemaName' => schema_name,'tableName' => table_name,'columnName' => column_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::DatabaseColumn.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, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get managed database column

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

  • managed_instance_name (String) —

    The name of the managed instance.

  • database_name (String) —

    The name of the database.

  • schema_name (String) —

    The name of the schema.

  • table_name (String) —

    The name of the table.

  • column_name (String) —

    The name of the column.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



182
183
184
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 182

def get_with_http_info(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers:nil)
  get_async(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers:custom_headers).value!
end

#list_by_table(resource_group_name, managed_instance_name, database_name, schema_name, table_name, filter: nil, custom_headers: nil) ⇒ Array<DatabaseColumn>

List managed database columns

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • database_name (String) —

    The name of the database.

  • schema_name (String) —

    The name of the schema.

  • table_name (String) —

    The name of the table.

  • filter (String) (defaults to: nil) —

    An OData filter expression that filters elements in

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

    A hash of custom headers that

Returns:

  • (Array<DatabaseColumn>) —

    operation results.



44
45
46
47
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 44

def list_by_table(resource_group_name, managed_instance_name, database_name, schema_name, table_name, filter:nil, custom_headers:nil)
  first_page = list_by_table_as_lazy(resource_group_name, managed_instance_name, database_name, schema_name, table_name, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_table_as_lazy(resource_group_name, managed_instance_name, database_name, schema_name, table_name, filter: nil, custom_headers: nil) ⇒ DatabaseColumnListResult

List managed database columns

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

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • database_name (String) —

    The name of the database.

  • schema_name (String) —

    The name of the schema.

  • table_name (String) —

    The name of the table.

  • filter (String) (defaults to: nil) —

    An OData filter expression that filters elements in

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

    A hash of custom headers that

Returns:

  • (DatabaseColumnListResult) —

    which provide lazy access to pages of the



369
370
371
372
373
374
375
376
377
378
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 369

def list_by_table_as_lazy(resource_group_name, managed_instance_name, database_name, schema_name, table_name, filter:nil, custom_headers:nil)
  response = list_by_table_async(resource_group_name, managed_instance_name, database_name, schema_name, table_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_table_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_table_async(resource_group_name, managed_instance_name, database_name, schema_name, table_name, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

List managed database columns

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • database_name (String) —

    The name of the database.

  • schema_name (String) —

    The name of the schema.

  • table_name (String) —

    The name of the table.

  • filter (String) (defaults to: nil) —

    An OData filter expression that filters elements in

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 87

def list_by_table_async(resource_group_name, managed_instance_name, database_name, schema_name, table_name, filter:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'managed_instance_name is nil' if managed_instance_name.nil?
  fail ArgumentError, 'database_name is nil' if database_name.nil?
  fail ArgumentError, 'schema_name is nil' if schema_name.nil?
  fail ArgumentError, 'table_name is nil' if table_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/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'managedInstanceName' => managed_instance_name,'databaseName' => database_name,'schemaName' => schema_name,'tableName' => table_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::DatabaseColumnListResult.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_table_next(next_page_link, custom_headers: nil) ⇒ DatabaseColumnListResult

List managed database columns

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (DatabaseColumnListResult) —

    operation results.



271
272
273
274
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 271

def list_by_table_next(next_page_link, custom_headers:nil)
  response = list_by_table_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_table_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List managed database columns

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 300

def list_by_table_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::DatabaseColumnListResult.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_table_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List managed database columns

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



286
287
288
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 286

def list_by_table_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_table_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_table_with_http_info(resource_group_name, managed_instance_name, database_name, schema_name, table_name, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List managed database columns

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • database_name (String) —

    The name of the database.

  • schema_name (String) —

    The name of the schema.

  • table_name (String) —

    The name of the table.

  • filter (String) (defaults to: nil) —

    An OData filter expression that filters elements in

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



66
67
68
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/managed_database_columns.rb', line 66

def list_by_table_with_http_info(resource_group_name, managed_instance_name, database_name, schema_name, table_name, filter:nil, custom_headers:nil)
  list_by_table_async(resource_group_name, managed_instance_name, database_name, schema_name, table_name, filter:filter, custom_headers:custom_headers).value!
end