Class: Azure::SQL::Mgmt::V2015_05_01_preview::EncryptionProtectors

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ EncryptionProtectors

Creates and initializes a new instance of the EncryptionProtectors class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, server_name, parameters, custom_headers = nil) ⇒ EncryptionProtector

Updates an existing encryption protector.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. resource state. 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.

  • parameters (EncryptionProtector) —

    The requested encryption protector

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

    A hash of custom headers that

Returns:

  • (EncryptionProtector) —

    operation results.



286
287
288
289
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 286

def begin_create_or_update(resource_group_name, server_name, parameters, custom_headers = nil)
  response = begin_create_or_update_async(resource_group_name, server_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, server_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Updates an existing encryption protector.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • parameters (EncryptionProtector) —

    The requested encryption protector

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 323

def begin_create_or_update_async(resource_group_name, server_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?
  encryption_protector_name = 'current'
  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 = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = Azure::SQL::Mgmt::V2015_05_01_preview::Models::EncryptionProtector.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}/encryptionProtector/{encryptionProtectorName}'

  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,'encryptionProtectorName' => encryption_protector_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
      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::SQL::Mgmt::V2015_05_01_preview::Models::EncryptionProtector.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, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Updates an existing encryption protector.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. resource state. 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.

  • parameters (EncryptionProtector) —

    The requested encryption protector

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



305
306
307
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 305

def begin_create_or_update_with_http_info(resource_group_name, server_name, parameters, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, server_name, parameters, custom_headers).value!
end

#create_or_update(resource_group_name, server_name, parameters, custom_headers = nil) ⇒ EncryptionProtector

Updates an existing encryption protector.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. resource state. 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.

  • parameters (EncryptionProtector) —

    The requested encryption protector

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

    A hash of custom headers that

Returns:

  • (EncryptionProtector) —

    operation results.



236
237
238
239
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 236

def create_or_update(resource_group_name, server_name, parameters, custom_headers = nil)
  response = create_or_update_async(resource_group_name, server_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, server_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. resource state. 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.

  • parameters (EncryptionProtector) —

    The requested encryption protector

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 254

def create_or_update_async(resource_group_name, server_name, parameters, custom_headers = nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, server_name, parameters, 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::EncryptionProtector.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

#get(resource_group_name, server_name, custom_headers = nil) ⇒ EncryptionProtector

Gets a server encryption protector.

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.

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

    A hash of custom headers that

Returns:

  • (EncryptionProtector) —

    operation results.



136
137
138
139
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 136

def get(resource_group_name, server_name, custom_headers = nil)
  response = get_async(resource_group_name, server_name, custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, server_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets a server encryption protector.

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.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
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
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 169

def get_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?
  encryption_protector_name = 'current'
  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 = {}

  # 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}/encryptionProtector/{encryptionProtectorName}'

  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,'encryptionProtectorName' => encryption_protector_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::SQL::Mgmt::V2015_05_01_preview::Models::EncryptionProtector.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, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a server encryption protector.

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.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



153
154
155
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 153

def get_with_http_info(resource_group_name, server_name, custom_headers = nil)
  get_async(resource_group_name, server_name, custom_headers).value!
end

#list_by_server(resource_group_name, server_name, custom_headers = nil) ⇒ Array<EncryptionProtector>

Gets a list of server encryption protectors

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.

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

    A hash of custom headers that

Returns:

  • (Array<EncryptionProtector>) —

    operation results.



39
40
41
42
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 39

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)
  first_page.get_all_items
end

#list_by_server_as_lazy(resource_group_name, server_name, custom_headers = nil) ⇒ EncryptionProtectorListResult

Gets a list of server encryption protectors

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

the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that

Returns:

  • (EncryptionProtectorListResult) —

    which provide lazy access to pages of



486
487
488
489
490
491
492
493
494
495
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 486

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).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)
    end
    page
  end
end

#list_by_server_async(resource_group_name, server_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets a list of server encryption protectors

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.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



72
73
74
75
76
77
78
79
80
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
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 72

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 = {}

  # 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}/encryptionProtector'

  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?
    # 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::EncryptionProtectorListResult.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) ⇒ EncryptionProtectorListResult

Gets a list of server encryption protectors

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:

  • (EncryptionProtectorListResult) —

    operation results.



396
397
398
399
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 396

def list_by_server_next(next_page_link, custom_headers = nil)
  response = list_by_server_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_by_server_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Gets a list of server encryption protectors

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.



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 425

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 = {}

  # 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::SQL::Mgmt::V2015_05_01_preview::Models::EncryptionProtectorListResult.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) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of server encryption protectors

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.



411
412
413
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 411

def list_by_server_next_with_http_info(next_page_link, custom_headers = nil)
  list_by_server_next_async(next_page_link, custom_headers).value!
end

#list_by_server_with_http_info(resource_group_name, server_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of server encryption protectors

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.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



56
57
58
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/encryption_protectors.rb', line 56

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).value!
end