Class: Azure::SQL::Mgmt::V2017_10_01_preview::InstanceFailoverGroups

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

Creates and initializes a new instance of the InstanceFailoverGroups class.

Parameters:

  • client

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, location_name, failover_group_name, parameters, custom_headers: nil) ⇒ InstanceFailoverGroup

Creates or updates a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

  • parameters (InstanceFailoverGroup)

    The failover group parameters.

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

    A hash of custom headers that

Returns:

  • (InstanceFailoverGroup)

    operation results.



452
453
454
455
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 452

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

#begin_create_or_update_async(resource_group_name, location_name, failover_group_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

  • parameters (InstanceFailoverGroup)

    The failover group parameters.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 491

def begin_create_or_update_async(resource_group_name, location_name, failover_group_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'location_name is nil' if location_name.nil?
  fail ArgumentError, 'failover_group_name is nil' if failover_group_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_10_01_preview::Models::InstanceFailoverGroup.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/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'locationName' => location_name,'failoverGroupName' => failover_group_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 || 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_10_01_preview::Models::InstanceFailoverGroup.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_10_01_preview::Models::InstanceFailoverGroup.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, location_name, failover_group_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

  • parameters (InstanceFailoverGroup)

    The failover group parameters.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



472
473
474
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 472

def begin_create_or_update_with_http_info(resource_group_name, location_name, failover_group_name, parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, location_name, failover_group_name, parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ Object

Deletes a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that



578
579
580
581
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 578

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

#begin_delete_async(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 615

def begin_delete_async(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'location_name is nil' if location_name.nil?
  fail ArgumentError, 'failover_group_name is nil' if failover_group_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/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'locationName' => location_name,'failoverGroupName' => failover_group_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, location_name, failover_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



597
598
599
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 597

def begin_delete_with_http_info(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  begin_delete_async(resource_group_name, location_name, failover_group_name, custom_headers:custom_headers).value!
end

#begin_failover(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ InstanceFailoverGroup

Fails over from the current primary managed instance to this managed instance.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (InstanceFailoverGroup)

    operation results.



676
677
678
679
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 676

def begin_failover(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  response = begin_failover_async(resource_group_name, location_name, failover_group_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_failover_async(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Fails over from the current primary managed instance to this managed instance.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
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
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 715

def begin_failover_async(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'location_name is nil' if location_name.nil?
  fail ArgumentError, 'failover_group_name is nil' if failover_group_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/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}/failover'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'locationName' => location_name,'failoverGroupName' => failover_group_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(: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?
    # 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_10_01_preview::Models::InstanceFailoverGroup.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_failover_with_http_info(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Fails over from the current primary managed instance to this managed instance.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



696
697
698
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 696

def begin_failover_with_http_info(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  begin_failover_async(resource_group_name, location_name, failover_group_name, custom_headers:custom_headers).value!
end

#begin_force_failover_allow_data_loss(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ InstanceFailoverGroup

Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (InstanceFailoverGroup)

    operation results.



786
787
788
789
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 786

def begin_force_failover_allow_data_loss(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  response = begin_force_failover_allow_data_loss_async(resource_group_name, location_name, failover_group_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_force_failover_allow_data_loss_async(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 825

def begin_force_failover_allow_data_loss_async(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'location_name is nil' if location_name.nil?
  fail ArgumentError, 'failover_group_name is nil' if failover_group_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/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}/forceFailoverAllowDataLoss'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'locationName' => location_name,'failoverGroupName' => failover_group_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(: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?
    # 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_10_01_preview::Models::InstanceFailoverGroup.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_force_failover_allow_data_loss_with_http_info(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



806
807
808
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 806

def begin_force_failover_allow_data_loss_with_http_info(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  begin_force_failover_allow_data_loss_async(resource_group_name, location_name, failover_group_name, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, location_name, failover_group_name, parameters, custom_headers: nil) ⇒ InstanceFailoverGroup

Creates or updates a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

  • parameters (InstanceFailoverGroup)

    The failover group parameters.

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

    A hash of custom headers that

Returns:

  • (InstanceFailoverGroup)

    operation results.



149
150
151
152
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 149

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

#create_or_update_async(resource_group_name, location_name, failover_group_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

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

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

  • parameters (InstanceFailoverGroup)

    The failover group parameters.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 168

def create_or_update_async(resource_group_name, location_name, failover_group_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, location_name, failover_group_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::SQL::Mgmt::V2017_10_01_preview::Models::InstanceFailoverGroup.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, location_name, failover_group_name, custom_headers: nil) ⇒ Object

Deletes a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that



198
199
200
201
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 198

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

#delete_async(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ Concurrent::Promise

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

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 216

def delete_async(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, location_name, failover_group_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

#failover(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ InstanceFailoverGroup

Fails over from the current primary managed instance to this managed instance.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (InstanceFailoverGroup)

    operation results.



350
351
352
353
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 350

def failover(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  response = failover_async(resource_group_name, location_name, failover_group_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#failover_async(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ Concurrent::Promise

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

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 368

def failover_async(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  # Send request
  promise = begin_failover_async(resource_group_name, location_name, failover_group_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_10_01_preview::Models::InstanceFailoverGroup.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

#force_failover_allow_data_loss(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ InstanceFailoverGroup

Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (InstanceFailoverGroup)

    operation results.



401
402
403
404
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 401

def force_failover_allow_data_loss(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  response = force_failover_allow_data_loss_async(resource_group_name, location_name, failover_group_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#force_failover_allow_data_loss_async(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ Concurrent::Promise

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

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 419

def force_failover_allow_data_loss_async(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  # Send request
  promise = begin_force_failover_allow_data_loss_async(resource_group_name, location_name, failover_group_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_10_01_preview::Models::InstanceFailoverGroup.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, location_name, failover_group_name, custom_headers: nil) ⇒ InstanceFailoverGroup

Gets a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

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

    A hash of custom headers that

Returns:

  • (InstanceFailoverGroup)

    operation results.



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

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

#get_async(resource_group_name, location_name, failover_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

  • 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-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 78

def get_async(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'location_name is nil' if location_name.nil?
  fail ArgumentError, 'failover_group_name is nil' if failover_group_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/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'locationName' => location_name,'failoverGroupName' => failover_group_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_10_01_preview::Models::InstanceFailoverGroup.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, location_name, failover_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a failover group.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • failover_group_name (String)

    The name of the failover group.

  • 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-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 60

def get_with_http_info(resource_group_name, location_name, failover_group_name, custom_headers:nil)
  get_async(resource_group_name, location_name, failover_group_name, custom_headers:custom_headers).value!
end

#list_by_location(resource_group_name, location_name, custom_headers: nil) ⇒ Array<InstanceFailoverGroup>

Lists the failover groups in a location.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

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

    A hash of custom headers that

Returns:

  • (Array<InstanceFailoverGroup>)

    operation results.



245
246
247
248
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 245

def list_by_location(resource_group_name, location_name, custom_headers:nil)
  first_page = list_by_location_as_lazy(resource_group_name, location_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_location_as_lazy(resource_group_name, location_name, custom_headers: nil) ⇒ InstanceFailoverGroupListResult

Lists the failover groups in a location.

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

of the response.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

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

    A hash of custom headers that

Returns:

  • (InstanceFailoverGroupListResult)

    which provide lazy access to pages



985
986
987
988
989
990
991
992
993
994
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 985

def list_by_location_as_lazy(resource_group_name, location_name, custom_headers:nil)
  response = list_by_location_async(resource_group_name, location_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_location_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_location_async(resource_group_name, location_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists the failover groups in a location.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
332
333
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 280

def list_by_location_async(resource_group_name, location_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'location_name is nil' if location_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/locations/{locationName}/instanceFailoverGroups'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'locationName' => location_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_10_01_preview::Models::InstanceFailoverGroupListResult.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_location_next(next_page_link, custom_headers: nil) ⇒ InstanceFailoverGroupListResult

Lists the failover groups in a location.

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:

  • (InstanceFailoverGroupListResult)

    operation results.



891
892
893
894
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 891

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

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

Lists the failover groups in a location.

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.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 920

def list_by_location_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_10_01_preview::Models::InstanceFailoverGroupListResult.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_location_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the failover groups in a location.

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.



906
907
908
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 906

def list_by_location_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_location_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_location_with_http_info(resource_group_name, location_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the failover groups in a location.

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

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • location_name (String)

    The name of the region where the resource is

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



263
264
265
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/instance_failover_groups.rb', line 263

def list_by_location_with_http_info(resource_group_name, location_name, custom_headers:nil)
  list_by_location_async(resource_group_name, location_name, custom_headers:custom_headers).value!
end