Class: Azure::SQL::Mgmt::V2018_06_01_preview::DatabaseSchemas

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01-preview/generated/azure_mgmt_sql/database_schemas.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) ⇒ DatabaseSchemas

Creates and initializes a new instance of the DatabaseSchemas class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/database_schemas.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/database_schemas.rb', line 25

def client
  @client
end

Instance Method Details

#get(resource_group_name, server_name, database_name, schema_name, custom_headers: nil) ⇒ DatabaseSchema

Get database schema

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • schema_name (String) —

    The name of the schema.

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

    A hash of custom headers that

Returns:

  • (DatabaseSchema) —

    operation results.



151
152
153
154
 
# 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) ⇒ Concurrent::Promise

Get database schema

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • schema_name (String) —

    The name of the schema.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# 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) ⇒ MsRestAzure::AzureOperationResponse

Get database schema

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • schema_name (String) —

    The name of the schema.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



170
171
172
 
# 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) ⇒ Array<DatabaseSchema>

List database schemas

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

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • 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<DatabaseSchema>) —

    operation results.



42
43
44
45
 
# 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) ⇒ DatabaseSchemaListResult

List database schemas

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

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • 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:

  • (DatabaseSchemaListResult) —

    which provide lazy access to pages of the



351
352
353
354
355
356
357
358
359
360
 
# 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) ⇒ Concurrent::Promise

List database schemas

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

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • 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.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# 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) ⇒ DatabaseSchemaListResult

List database schemas

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:

  • (DatabaseSchemaListResult) —

    operation results.



255
256
257
258
 
# 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) ⇒ Concurrent::Promise

List database schemas

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.



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
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
 
# 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) ⇒ MsRestAzure::AzureOperationResponse

List database schemas

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.



270
271
272
 
# 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) ⇒ MsRestAzure::AzureOperationResponse

List database schemas

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

  • server_name (String) —

    The name of the server.

  • database_name (String) —

    The name of the database.

  • 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.



62
63
64
 
# 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