Class: Azure::SQL::Mgmt::V2017_03_01_preview::ServerDnsAliases

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.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) ⇒ ServerDnsAliases

Creates and initializes a new instance of the ServerDnsAliases class.

Parameters:

  • client

    service class for accessing basic functionality.



20
21
22
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientSqlManagementClient (readonly)

Returns reference to the SqlManagementClient.

Returns:



25
26
27
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 25

def client
  @client
end

Instance Method Details

#acquire(resource_group_name, server_name, dns_alias_name, parameters, custom_headers: nil) ⇒ Object

Acquires server DNS alias from another server.

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

  • dns_alias_name (String)

    The name of the server dns alias.

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

    A hash of custom headers that



346
347
348
349
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 346

def acquire(resource_group_name, server_name, dns_alias_name, parameters, custom_headers:nil)
  response = acquire_async(resource_group_name, server_name, dns_alias_name, parameters, custom_headers:custom_headers).value!
  nil
end

#acquire_async(resource_group_name, server_name, dns_alias_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

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

  • dns_alias_name (String)

    The name of the server dns alias.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 365

def acquire_async(resource_group_name, server_name, dns_alias_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_acquire_async(resource_group_name, server_name, dns_alias_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#begin_acquire(resource_group_name, server_name, dns_alias_name, parameters, custom_headers: nil) ⇒ Object

Acquires server DNS alias from another server.

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

  • dns_alias_name (String)

    The name of the server dns alias.

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

    A hash of custom headers that



608
609
610
611
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 608

def begin_acquire(resource_group_name, server_name, dns_alias_name, parameters, custom_headers:nil)
  response = begin_acquire_async(resource_group_name, server_name, dns_alias_name, parameters, custom_headers:custom_headers).value!
  nil
end

#begin_acquire_async(resource_group_name, server_name, dns_alias_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Acquires server DNS alias from another server.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • server_name (String)

    The name of the server that the alias is pointing

  • dns_alias_name (String)

    The name of the server dns alias.

  • parameters (ServerDnsAliasAcquisition)
  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 647

def begin_acquire_async(resource_group_name, server_name, dns_alias_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?
  fail ArgumentError, 'dns_alias_name is nil' if dns_alias_name.nil?
  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 = {}
  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::V2017_03_01_preview::Models::ServerDnsAliasAcquisition.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}/dnsAliases/{dnsAliasName}/acquire'

  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,'dnsAliasName' => dns_alias_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(:post, 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?
    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

#begin_acquire_with_http_info(resource_group_name, server_name, dns_alias_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Acquires server DNS alias from another server.

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

  • dns_alias_name (String)

    The name of the server dns alias.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



628
629
630
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 628

def begin_acquire_with_http_info(resource_group_name, server_name, dns_alias_name, parameters, custom_headers:nil)
  begin_acquire_async(resource_group_name, server_name, dns_alias_name, parameters, custom_headers:custom_headers).value!
end

#begin_create_or_update(resource_group_name, server_name, dns_alias_name, custom_headers: nil) ⇒ ServerDnsAlias

Creates a server dns alias.

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

  • dns_alias_name (String)

    The name of the server DNS alias.

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

    A hash of custom headers that

Returns:

  • (ServerDnsAlias)

    operation results.



395
396
397
398
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 395

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

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

Creates a server dns alias.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • server_name (String)

    The name of the server that the alias is pointing

  • dns_alias_name (String)

    The name of the server DNS alias.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 432

def begin_create_or_update_async(resource_group_name, server_name, dns_alias_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, 'dns_alias_name is nil' if dns_alias_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}/dnsAliases/{dnsAliasName}'

  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,'dnsAliasName' => dns_alias_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(: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 || 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::V2017_03_01_preview::Models::ServerDnsAlias.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::V2017_03_01_preview::Models::ServerDnsAlias.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, dns_alias_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a server dns alias.

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

  • dns_alias_name (String)

    The name of the server DNS alias.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



414
415
416
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 414

def begin_create_or_update_with_http_info(resource_group_name, server_name, dns_alias_name, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, server_name, dns_alias_name, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, server_name, dns_alias_name, custom_headers: nil) ⇒ Object

Deletes the server DNS alias with the given name.

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

  • dns_alias_name (String)

    The name of the server DNS alias.

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

    A hash of custom headers that



511
512
513
514
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 511

def begin_delete(resource_group_name, server_name, dns_alias_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, server_name, dns_alias_name, custom_headers:custom_headers).value!
  nil
end

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

Deletes the server DNS alias with the given name.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • server_name (String)

    The name of the server that the alias is pointing

  • dns_alias_name (String)

    The name of the server DNS alias.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 548

def begin_delete_async(resource_group_name, server_name, dns_alias_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, 'dns_alias_name is nil' if dns_alias_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}/dnsAliases/{dnsAliasName}'

  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,'dnsAliasName' => dns_alias_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(: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 == 202 || 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

#begin_delete_with_http_info(resource_group_name, server_name, dns_alias_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the server DNS alias with the given name.

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

  • dns_alias_name (String)

    The name of the server DNS alias.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



530
531
532
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 530

def begin_delete_with_http_info(resource_group_name, server_name, dns_alias_name, custom_headers:nil)
  begin_delete_async(resource_group_name, server_name, dns_alias_name, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, server_name, dns_alias_name, custom_headers: nil) ⇒ ServerDnsAlias

Creates a server dns alias.

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

  • dns_alias_name (String)

    The name of the server DNS alias.

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

    A hash of custom headers that

Returns:

  • (ServerDnsAlias)

    operation results.



148
149
150
151
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 148

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

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

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

  • dns_alias_name (String)

    The name of the server DNS alias.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 166

def create_or_update_async(resource_group_name, server_name, dns_alias_name, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, server_name, dns_alias_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::SQL::Mgmt::V2017_03_01_preview::Models::ServerDnsAlias.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

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

Deletes the server DNS alias with the given name.

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

  • dns_alias_name (String)

    The name of the server DNS alias.

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

    A hash of custom headers that



196
197
198
199
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 196

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

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

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

  • dns_alias_name (String)

    The name of the server DNS alias.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 214

def delete_async(resource_group_name, server_name, dns_alias_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, server_name, dns_alias_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(resource_group_name, server_name, dns_alias_name, custom_headers: nil) ⇒ ServerDnsAlias

Gets a server DNS alias.

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

  • dns_alias_name (String)

    The name of the server DNS alias.

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

    A hash of custom headers that

Returns:

  • (ServerDnsAlias)

    operation results.



41
42
43
44
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 41

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

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

Gets a server DNS alias.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • server_name (String)

    The name of the server that the alias is pointing

  • dns_alias_name (String)

    The name of the server DNS alias.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
123
124
125
126
127
128
129
130
131
132
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 78

def get_async(resource_group_name, server_name, dns_alias_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, 'dns_alias_name is nil' if dns_alias_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}/dnsAliases/{dnsAliasName}'

  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,'dnsAliasName' => dns_alias_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::V2017_03_01_preview::Models::ServerDnsAlias.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, dns_alias_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a server DNS alias.

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

  • dns_alias_name (String)

    The name of the server DNS alias.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



60
61
62
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 60

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

#list_by_server(resource_group_name, server_name, custom_headers: nil) ⇒ Array<ServerDnsAlias>

Gets a list of server DNS aliases for a server.

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

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

    A hash of custom headers that

Returns:

  • (Array<ServerDnsAlias>)

    operation results.



243
244
245
246
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 243

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

#list_by_server_as_lazy(resource_group_name, server_name, custom_headers: nil) ⇒ ServerDnsAliasListResult

Gets a list of server DNS aliases for a server.

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

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

    A hash of custom headers that

Returns:

  • (ServerDnsAliasListResult)

    which provide lazy access to pages of the



805
806
807
808
809
810
811
812
813
814
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 805

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: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: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 DNS aliases for a server.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • server_name (String)

    The name of the server that the alias is pointing

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



278
279
280
281
282
283
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
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 278

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 = {}
  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}/dnsAliases'

  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?
    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::V2017_03_01_preview::Models::ServerDnsAliasListResult.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) ⇒ ServerDnsAliasListResult

Gets a list of server DNS aliases for a server.

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:

  • (ServerDnsAliasListResult)

    operation results.



711
712
713
714
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 711

def list_by_server_next(next_page_link, custom_headers:nil)
  response = list_by_server_next_async(next_page_link, custom_headers: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 DNS aliases for a server.

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.



740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 740

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 = {}
  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::V2017_03_01_preview::Models::ServerDnsAliasListResult.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 DNS aliases for a server.

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.



726
727
728
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 726

def list_by_server_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_server_next_async(next_page_link, custom_headers: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 DNS aliases for a server.

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

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



261
262
263
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/server_dns_aliases.rb', line 261

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