Class: Azure::StorageSync::Mgmt::V2019_02_01::CloudEndpoints

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb

Overview

Microsoft Storage Sync Service API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ CloudEndpoints

Creates and initializes a new instance of the CloudEndpoints class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientStorageSyncManagementClient (readonly)

Returns reference to the StorageSyncManagementClient.

Returns:



22
23
24
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ CloudEndpoint

Create a new CloudEndpoint.

is case insensitive. resource. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (CloudEndpointCreateParameters)

    Body of Cloud Endpoint

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

    A hash of custom headers that

Returns:

  • (CloudEndpoint)

    operation results.



660
661
662
663
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 660

def begin_create(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  response = begin_create_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Create a new CloudEndpoint.

is case insensitive. resource. resource. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (CloudEndpointCreateParameters)

    Body of Cloud Endpoint

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



701
702
703
704
705
706
707
708
709
710
711
712
713
714
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/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 701

def begin_create_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_name.nil?
  fail ArgumentError, 'cloud_endpoint_name is nil' if cloud_endpoint_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?


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

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

  # Serialize Request
  request_mapper = Azure::StorageSync::Mgmt::V2019_02_01::Models::CloudEndpointCreateParameters.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.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'storageSyncServiceName' => storage_sync_service_name,'syncGroupName' => sync_group_name,'cloudEndpointName' => cloud_endpoint_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::StorageSync::Mgmt::V2019_02_01::Models::CloudEndpoint.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_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create a new CloudEndpoint.

is case insensitive. resource. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (CloudEndpointCreateParameters)

    Body of Cloud Endpoint

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



681
682
683
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 681

def begin_create_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  begin_create_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ Object

Delete a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

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

    A hash of custom headers that



784
785
786
787
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 784

def begin_delete(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ Concurrent::Promise

Delete a given CloudEndpoint.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



821
822
823
824
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
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 821

def begin_delete_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_name.nil?
  fail ArgumentError, 'cloud_endpoint_name is nil' if cloud_endpoint_name.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'storageSyncServiceName' => storage_sync_service_name,'syncGroupName' => sync_group_name,'cloudEndpointName' => cloud_endpoint_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



803
804
805
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 803

def begin_delete_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  begin_delete_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:custom_headers).value!
end

#begin_post_backup(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ PostBackupResponse

Post Backup a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (BackupRequest)

    Body of Backup request.

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

    A hash of custom headers that

Returns:

  • (PostBackupResponse)

    operation results.



1001
1002
1003
1004
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 1001

def begin_post_backup(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  response = begin_post_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_post_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Post Backup a given CloudEndpoint.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (BackupRequest)

    Body of Backup request.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 1040

def begin_post_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_name.nil?
  fail ArgumentError, 'cloud_endpoint_name is nil' if cloud_endpoint_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?


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

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

  # Serialize Request
  request_mapper = Azure::StorageSync::Mgmt::V2019_02_01::Models::BackupRequest.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.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'storageSyncServiceName' => storage_sync_service_name,'syncGroupName' => sync_group_name,'cloudEndpointName' => cloud_endpoint_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(: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 MsRest::HttpOperationError.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::StorageSync::Mgmt::V2019_02_01::Models::PostBackupResponse.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_post_backup_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Post Backup a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (BackupRequest)

    Body of Backup request.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1021
1022
1023
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 1021

def begin_post_backup_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  begin_post_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
end

#begin_post_restore(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Object

Post Restore a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (PostRestoreRequest)

    Body of Cloud Endpoint object.

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

    A hash of custom headers that



1237
1238
1239
1240
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 1237

def begin_post_restore(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  response = begin_post_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
  nil
end

#begin_post_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Post Restore a given CloudEndpoint.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (PostRestoreRequest)

    Body of Cloud Endpoint object.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 1276

def begin_post_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_name.nil?
  fail ArgumentError, 'cloud_endpoint_name is nil' if cloud_endpoint_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?


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

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

  # Serialize Request
  request_mapper = Azure::StorageSync::Mgmt::V2019_02_01::Models::PostRestoreRequest.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.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'storageSyncServiceName' => storage_sync_service_name,'syncGroupName' => sync_group_name,'cloudEndpointName' => cloud_endpoint_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(: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 MsRest::HttpOperationError.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_post_restore_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Post Restore a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (PostRestoreRequest)

    Body of Cloud Endpoint object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1257
1258
1259
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 1257

def begin_post_restore_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  begin_post_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
end

#begin_pre_backup(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Object

Pre Backup a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (BackupRequest)

    Body of Backup request.

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

    A hash of custom headers that



887
888
889
890
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 887

def begin_pre_backup(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  response = begin_pre_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
  nil
end

#begin_pre_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Pre Backup a given CloudEndpoint.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (BackupRequest)

    Body of Backup request.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 926

def begin_pre_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_name.nil?
  fail ArgumentError, 'cloud_endpoint_name is nil' if cloud_endpoint_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?


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

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

  # Serialize Request
  request_mapper = Azure::StorageSync::Mgmt::V2019_02_01::Models::BackupRequest.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.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'storageSyncServiceName' => storage_sync_service_name,'syncGroupName' => sync_group_name,'cloudEndpointName' => cloud_endpoint_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(: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 MsRest::HttpOperationError.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_pre_backup_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Pre Backup a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (BackupRequest)

    Body of Backup request.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



907
908
909
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 907

def begin_pre_backup_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  begin_pre_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
end

#begin_pre_restore(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Object

Pre Restore a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (PreRestoreRequest)

    Body of Cloud Endpoint object.

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

    A hash of custom headers that



1124
1125
1126
1127
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 1124

def begin_pre_restore(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  response = begin_pre_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
  nil
end

#begin_pre_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Pre Restore a given CloudEndpoint.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (PreRestoreRequest)

    Body of Cloud Endpoint object.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 1163

def begin_pre_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_name.nil?
  fail ArgumentError, 'cloud_endpoint_name is nil' if cloud_endpoint_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?


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

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

  # Serialize Request
  request_mapper = Azure::StorageSync::Mgmt::V2019_02_01::Models::PreRestoreRequest.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.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'storageSyncServiceName' => storage_sync_service_name,'syncGroupName' => sync_group_name,'cloudEndpointName' => cloud_endpoint_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(: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 MsRest::HttpOperationError.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_pre_restore_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Pre Restore a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (PreRestoreRequest)

    Body of Cloud Endpoint object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1144
1145
1146
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 1144

def begin_pre_restore_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  begin_pre_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
end

#create(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ CloudEndpoint

Create a new CloudEndpoint.

is case insensitive. resource. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (CloudEndpointCreateParameters)

    Body of Cloud Endpoint

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

    A hash of custom headers that

Returns:

  • (CloudEndpoint)

    operation results.



40
41
42
43
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 40

def create(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  response = create_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. resource. resource. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (CloudEndpointCreateParameters)

    Body of Cloud Endpoint

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 60

def create_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::StorageSync::Mgmt::V2019_02_01::Models::CloudEndpoint.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, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ Object

Delete a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

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

    A hash of custom headers that



203
204
205
206
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 203

def delete(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  response = delete_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. resource. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 221

def delete_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_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, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ CloudEndpoint

Get a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

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

    A hash of custom headers that

Returns:

  • (CloudEndpoint)

    operation results.



92
93
94
95
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 92

def get(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  response = get_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ Concurrent::Promise

Get a given CloudEndpoint.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 129

def get_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_name.nil?
  fail ArgumentError, 'cloud_endpoint_name is nil' if cloud_endpoint_name.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'storageSyncServiceName' => storage_sync_service_name,'syncGroupName' => sync_group_name,'cloudEndpointName' => cloud_endpoint_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::StorageSync::Mgmt::V2019_02_01::Models::CloudEndpoint.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, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



111
112
113
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 111

def get_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  get_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:custom_headers).value!
end

#list_by_sync_group(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers: nil) ⇒ CloudEndpointArray

Get a CloudEndpoint List.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

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

    A hash of custom headers that

Returns:

  • (CloudEndpointArray)

    operation results.



250
251
252
253
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 250

def list_by_sync_group(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers:nil)
  response = list_by_sync_group_async(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_sync_group_async(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Get a CloudEndpoint List.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
334
335
336
337
338
339
340
341
342
343
344
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 285

def list_by_sync_group_async(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_name.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'storageSyncServiceName' => storage_sync_service_name,'syncGroupName' => sync_group_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::StorageSync::Mgmt::V2019_02_01::Models::CloudEndpointArray.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_sync_group_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a CloudEndpoint List.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



268
269
270
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 268

def list_by_sync_group_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers:nil)
  list_by_sync_group_async(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers:custom_headers).value!
end

#post_backup(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ PostBackupResponse

Post Backup a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (BackupRequest)

    Body of Backup request.

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

    A hash of custom headers that

Returns:

  • (PostBackupResponse)

    operation results.



409
410
411
412
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 409

def post_backup(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  response = post_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#post_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. resource. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (BackupRequest)

    Body of Backup request.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 428

def post_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_post_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers)

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

#post_restore(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Object

Post Restore a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (PostRestoreRequest)

    Body of Cloud Endpoint object.

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

    A hash of custom headers that



609
610
611
612
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 609

def post_restore(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  response = post_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
  nil
end

#post_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. resource. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (PostRestoreRequest)

    Body of Cloud Endpoint object.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 628

def post_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_post_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_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

#pre_backup(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Object

Pre Backup a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (BackupRequest)

    Body of Backup request.

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

    A hash of custom headers that



359
360
361
362
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 359

def pre_backup(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  response = pre_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
  nil
end

#pre_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. resource. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (BackupRequest)

    Body of Backup request.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 378

def pre_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_pre_backup_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_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

#pre_restore(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Object

Pre Restore a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (PreRestoreRequest)

    Body of Cloud Endpoint object.

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

    A hash of custom headers that



459
460
461
462
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 459

def pre_restore(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  response = pre_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:custom_headers).value!
  nil
end

#pre_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. resource. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • parameters (PreRestoreRequest)

    Body of Cloud Endpoint object.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 478

def pre_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_pre_restore_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_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

#restoreheartbeat(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ Object

Restore Heartbeat a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

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

    A hash of custom headers that



507
508
509
510
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 507

def restoreheartbeat(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  response = restoreheartbeat_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:custom_headers).value!
  nil
end

#restoreheartbeat_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ Concurrent::Promise

Restore Heartbeat a given CloudEndpoint.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



544
545
546
547
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
593
594
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 544

def restoreheartbeat_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_name.nil?
  fail ArgumentError, 'cloud_endpoint_name is nil' if cloud_endpoint_name.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'storageSyncServiceName' => storage_sync_service_name,'syncGroupName' => sync_group_name,'cloudEndpointName' => cloud_endpoint_name},
      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
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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

#restoreheartbeat_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restore Heartbeat a given CloudEndpoint.

is case insensitive. resource. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group. The name

  • storage_sync_service_name (String)

    Name of Storage Sync Service

  • sync_group_name (String)

    Name of Sync Group resource.

  • cloud_endpoint_name (String)

    Name of Cloud Endpoint object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



526
527
528
# File 'lib/2019-02-01/generated/azure_mgmt_storagesync/cloud_endpoints.rb', line 526

def restoreheartbeat_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:nil)
  restoreheartbeat_async(resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, custom_headers:custom_headers).value!
end