Class: Azure::SQL::Mgmt::V2014_04_01::FirewallRules

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.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) ⇒ FirewallRules

Creates and initializes a new instance of the FirewallRules class.



20
21
22
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SqlManagementClient (readonly) 



25
26
27
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 25

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers: nil) ⇒ FirewallRule

Creates or updates a firewall rule.

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



42
43
44
45
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 42

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

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

Creates or updates a firewall rule.

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



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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 81

def create_or_update_async(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers: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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'firewall_rule_name is nil' if firewall_rule_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::SQL::Mgmt::V2014_04_01::Models::FirewallRule.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}/firewallRules/{firewallRuleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'serverName' => server_name,'firewallRuleName' => firewall_rule_name},
      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?
    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::V2014_04_01::Models::FirewallRule.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::SQL::Mgmt::V2014_04_01::Models::FirewallRule.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

#create_or_update_with_http_info(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a firewall rule.

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



62
63
64
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 62

def create_or_update_with_http_info(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers:nil)
  create_or_update_async(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers:custom_headers).value!
end

#delete(resource_group_name, server_name, firewall_rule_name, custom_headers: nil) ⇒ Object

Deletes a firewall rule.

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



167
168
169
170
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 167

def delete(resource_group_name, server_name, firewall_rule_name, custom_headers:nil)
  response = delete_async(resource_group_name, server_name, firewall_rule_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, server_name, firewall_rule_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a firewall rule.

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



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
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 202

def delete_async(resource_group_name, server_name, firewall_rule_name, custom_headers: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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'firewall_rule_name is nil' if firewall_rule_name.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}/firewallRules/{firewallRuleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'serverName' => server_name,'firewallRuleName' => firewall_rule_name},
      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 || status_code == 204
      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?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, server_name, firewall_rule_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a firewall rule.

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



185
186
187
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 185

def delete_with_http_info(resource_group_name, server_name, firewall_rule_name, custom_headers:nil)
  delete_async(resource_group_name, server_name, firewall_rule_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, server_name, firewall_rule_name, custom_headers: nil) ⇒ FirewallRule

Gets a firewall rule.

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



261
262
263
264
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 261

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

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

Gets a firewall rule.

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



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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 296

def get_async(resource_group_name, server_name, firewall_rule_name, custom_headers: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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'firewall_rule_name is nil' if firewall_rule_name.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}/firewallRules/{firewallRuleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'serverName' => server_name,'firewallRuleName' => firewall_rule_name},
      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::V2014_04_01::Models::FirewallRule.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, firewall_rule_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a firewall rule.

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



279
280
281
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 279

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

#list_by_server(resource_group_name, server_name, custom_headers: nil) ⇒ FirewallRuleListResult

Returns a list of firewall rules.

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



364
365
366
367
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 364

def list_by_server(resource_group_name, server_name, custom_headers:nil)
  response = list_by_server_async(resource_group_name, server_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Returns a list of firewall rules.

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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
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
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 397

def list_by_server_async(resource_group_name, server_name, custom_headers: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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.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}/firewallRules'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'serverName' => server_name},
      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::V2014_04_01::Models::FirewallRuleListResult.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_with_http_info(resource_group_name, server_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns a list of firewall rules.

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



381
382
383
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/firewall_rules.rb', line 381

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